Mod API Reference:GameOrderDeploy: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
* '''DeployOn''' ''[[Mod API Reference:TerritoryID|TerritoryID]]'': | * '''DeployOn''' ''[[Mod API Reference:TerritoryID|TerritoryID]]'': | ||
* '''NumArmies''' ''integer'': | * '''NumArmies''' ''integer'': | ||
* '''Free''' ''boolean'': If true, and the game is a [[commerce]] game, then the player will not be charged gold for this deployment. | |||
== Functions == | == Functions == | ||
* '''WL.GameOrderDeploy.Create'''('''playerID''' ''[[Mod API Reference:PlayerID|PlayerID]]'', '''numArmies''' ''integer'', '''deployOn''' ''[[Mod API Reference:TerritoryID|TerritoryID]]'') (static) returns [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]: | * '''WL.GameOrderDeploy.Create'''('''playerID''' ''[[Mod API Reference:PlayerID|PlayerID]]'', '''numArmies''' ''integer'', '''deployOn''' ''[[Mod API Reference:TerritoryID|TerritoryID]]'', '''free''' ''boolean'') (static) returns [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]: For backwards compatibility, if the '''free''' parameter is not specified, it defaults to true. | ||
[[Category:Mod API Reference]] | |||
Latest revision as of 17:09, 4 December 2018
GameOrderDeploy: Subclass of GameOrder. Represents a basic deployment of armies to a territory.
- DeployOn TerritoryID:
- NumArmies integer:
- Free boolean: If true, and the game is a commerce game, then the player will not be charged gold for this deployment.
Functions
- WL.GameOrderDeploy.Create(playerID PlayerID, numArmies integer, deployOn TerritoryID, free boolean) (static) returns GameOrderDeploy: For backwards compatibility, if the free parameter is not specified, it defaults to true.