Mod API Reference:Armies

From Warzone Wiki
Revision as of 21:57, 8 April 2017 by Fizzer (talk | contribs)
Jump to navigation Jump to search

Armies: Represents the number of armies on a territory (access NumArmies), what special units are there (access SpecialUnits), and also has the possibility if being the special 'fogged' value which indicates that a client cannot see the armies here. Armies is an immutable object and can never be modified. Instead of modifying it, create a new Armies object and assign this back to wherever it's assigned.

  • ArmiesOrZero integer: A helper that returns the number of armies, or zero if the structure is fogged.
  • AttackPower integer: A helper that calculates the attack power of special units plus the number of armies here.
  • DefensePower integer: A helper that calculates the defense power of special units plus the number of armies here.
  • Fogged boolean: True if the client cannot see how many armies or special units are here.
  • IsEmpty boolean: A helper that returns true if NumArmies == 0 and no special units are here.
  • NumArmies integer: Number of normal armies here.
  • SpecialUnits Array<SpecialUnit>: An array of special units here.