Mod API Reference:GameOrderEvent

From WarLight Wiki
Jump to: navigation, search

GameOrderEvent: Subclass of GameOrder. This is a generic event that can present a message or modify territories. It can also control which players can see it. It was added for use by Mods and is not used by any built-in game mechanics.

  • Message string: The message displayed in the orders list. Must be specified.
  • TerritoryModifications Array<TerritoryModification>: Optionally, can modify territories, such as changing ownership or armies.
  • VisibleToOpt HashSet<PlayerID>: Defines who this event is visible to. Note that the player this event is assigned to can always see it, and any player who can see the effects of a territory modification can always see it as well. Set this to nil to mean that it should be visible to everyone (public). Set this to an empty list to indicate that the event should not be visible to anyone, except those that can see it by a previously mentioned rule.
  • SetResourceOpt Table<PlayerID,Table<ResourceType (enum),integer>>: Sets the resource value of a player, such as their gold, to a specific value.

[edit] Functions

Personal tools