Mod API Reference:GameOrderPlayCardCustom: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryAnnotation|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1) | * '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryAnnotation|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1) | ||
* '''JumpToActionSpotOpt''' ''[[Mod API Reference:RectangleVM|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails|TerritoryDetails]] object. (Added in version 5.34.1) | * '''JumpToActionSpotOpt''' ''[[Mod API Reference:RectangleVM|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails|TerritoryDetails]] object. (Added in version 5.34.1) | ||
* '''Icon''' ''string'': If specified, this specifies the image that will appear in the orders list (upper right of the main game screen). This should the name of a 40x40 png file placed in the "OrderIcons" subfolder of your mod. Each mod may have up to 15 order icon images. (Added in version 6.04.0) | |||
[[Category:Mod API Reference]] | [[Category:Mod API Reference]] | ||
Latest revision as of 22:37, 9 August 2026
GameOrderPlayCardCustom: Subclass of GameOrderPlayCard used by Custom Cards.
- CustomCardID integer:
- Description string:
- ModData string:
- Phase Nullable<TurnPhase (enum)>:
- TerritoryAnnotationsOpt Table<TerritoryID,TerritoryAnnotation>: When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)
- JumpToActionSpotOpt RectangleVM: If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a TerritoryDetails object. (Added in version 5.34.1)
- Icon string: If specified, this specifies the image that will appear in the orders list (upper right of the main game screen). This should the name of a 40x40 png file placed in the "OrderIcons" subfolder of your mod. Each mod may have up to 15 order icon images. (Added in version 6.04.0)