Editing Mod API Reference:Armies

Jump to: navigation, search

Warning: You are not logged in.

Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
'''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.
+
'''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.
 
* '''ArmiesOrZero''' ''integer'': A helper that returns the number of armies, or zero if the structure is fogged.
 
* '''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.
 
* '''AttackPower''' ''integer'': A helper that calculates the attack power of special units plus the number of armies here.
Line 7: Line 7:
 
* '''NumArmies''' ''integer'': Number of normal armies here.
 
* '''NumArmies''' ''integer'': Number of normal armies here.
 
* '''SpecialUnits''' ''Array<[[Mod API Reference:SpecialUnit|SpecialUnit]]>'': An array of special units here.
 
* '''SpecialUnits''' ''Array<[[Mod API Reference:SpecialUnit|SpecialUnit]]>'': An array of special units here.
 
== Functions ==
 
 
* '''Add'''('''armies''' ''[[Mod API Reference:Armies|Armies]]'') returns [[Mod API Reference:Armies|Armies]]:  Combines two armies structures and returns the result.  The normal armies are added together, and special units from both Armies structures are returned in the resulting one.  As Armies is an immutable class, neither army structures are changed and instead a third Armies instance is created.
 
* '''Subtract'''('''armies''' ''[[Mod API Reference:Armies|Armies]]'') returns [[Mod API Reference:Armies|Armies]]:  Similar to Add, except removes the armies and special units in the passed structure.
 
* '''WL.Armies.Create'''('''armies''' ''integer'', '''specialUnitsOpt''' ''Array<[[Mod API Reference:SpecialUnit|SpecialUnit]]>'') (static) returns [[Mod API Reference:Armies|Armies]]:  Creates an army instance with the passed armies and special units.  Special units can be nil, omitted, or an empty array if there aren't any.
 
[[Category:Mod API Reference]]
 

Please note that all contributions to Warzone Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Warzone Wiki:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox