Mod API Reference:GameOrderDeploy: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| 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]]: | ||
Revision as of 23:01, 8 August 2017
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: