Mod API Reference:GameStanding

From Warzone Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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>>: The resources owned by each player
  • IncomeMods Array<IncomeMod>: Mods can assign income mods here from the Server_StartGame hook in order to modify player's incomes on the first turn of the game. Modifying on later turns requires using GameOrderEvent
  • FogModsOpt Array<Mod API Reference:FogMod>: FogMods current applied. Associates properties ID, FogLevel, Priority, Territories impacted, Player affected and the message the mod provided when creating the FogMod

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)