Mod API Reference:Armies - Revision history

DanWL60 at 16:46, 4 December 2018

2018-12-04T16:46:44Z

← Older revision		Revision as of 16:46, 4 December 2018
Line 13:		Line 13:
	* '''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.		* '''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.		* '''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]]

Fizzer at 23:19, 10 April 2017

2017-04-10T23:19:32Z

← Older revision		Revision as of 23:19, 10 April 2017
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.

Fizzer at 21:57, 8 April 2017

2017-04-08T21:57:03Z

← Older revision		Revision as of 21:57, 8 April 2017
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''': 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.		* '''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.

Fizzer: Created page with "'''Armies''': Represents the number of armies on a territory (access '''NumArmies'''), what special units are there (access '''SpecialUnits'''), and also has the possibility i..."

2017-04-04T06:19:20Z

Created page with "'''Armies''': Represents the number of armies on a territory (access '''NumArmies'''), what special units are there (access '''SpecialUnits'''), and also has the possibility i..."

New page

'''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.
* '''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<[[Mod API Reference:SpecialUnit|SpecialUnit]]>'': An array of special units here.