Mod API Reference:GameStanding: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
* '''Territories''' ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryStanding|TerritoryStanding]]>'': Who owns each territory and how many armies are on it. | * '''Territories''' ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryStanding|TerritoryStanding]]>'': Who owns each territory and how many armies are on it. | ||
* '''Resources''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>>'': | * '''Resources''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>>'': | ||
* '''IncomeMods''' ''Array<[[Mod API Reference:IncomeMod|IncomeMod]]>'': Mods can assign income mods here from the Client_GameOrderCreated hook in order to modify player's incomes on the first turn of the game. Modifying on later turns requires using GameOrderEvent | |||
== Functions == | == Functions == | ||
Revision as of 06:03, 15 February 2025
GameStanding: Represents the state of a game's map at a single point in time. This describes who owns each territory, how many armies/special units are on it, what cards each player has, and what cards are in effect.
- ActiveCards Array<ActiveCard>: Cards in effect.
- Cards Table<PlayerID,PlayerCards>: Cards each player has.
- Territories Table<TerritoryID,TerritoryStanding>: Who owns each territory and how many armies are on it.
- Resources Table<PlayerID,Table<ResourceType (enum),integer>>:
- IncomeMods Array<IncomeMod>: Mods can assign income mods here from the Client_GameOrderCreated hook in order to modify player's incomes on the first turn of the game. Modifying on later turns requires using GameOrderEvent
Functions
- NumResources(playerID PlayerID, type ResourceType (enum)) returns integer: Determines how many resources, such as gold in a commerce game, the passed player has (or had at this point in time if this standing is from history)