War.app Wiki - Recent changes [en]

Order Priority Card

JK 3 — Wed, 02 Sep 2026 17:04:16 GMT

Fixed typo: "random" -> "order"

← Older revision		Revision as of 17:04, 2 September 2026
Line 3:		Line 3:
	}}		}}

	The '''Order Priority Card''' will allow you to get the first move for the next turn. After playing an Order Priority Card, your first order will happen before your opponent's first order. After the first orders are executed, the rest of the orders will be executed normally, just as if you were selected to go first in the ~~random~~ that normally happens.		The '''Order Priority Card''' will allow you to get the first move for the next turn. After playing an Order Priority Card, your first order will happen before your opponent's first order. After the first orders are executed, the rest of the orders will be executed normally, just as if you were selected to go first in the order that normally happens.

	If multiple players play an Order Priority Card in the same turn, the move order will be determined normally between those players. The players that didn't play an Order Priority Card will also be determined normally between each other, but their first order will not go before someone who played the card.		If multiple players play an Order Priority Card in the same turn, the move order will be determined normally between those players. The players that didn't play an Order Priority Card will also be determined normally between each other, but their first order will not go before someone who played the card.

Mod Developers Guide

JustADutchman — Tue, 01 Sep 2026 13:12:26 GMT

Sharing code with "require"

← Older revision		Revision as of 13:12, 1 September 2026
Line 78:		Line 78:
	For example, if you have utility functions in a file named 'Utilities.lua', simply write <code>require('Utilities')</code> at the top of another file to include it (omit the <code>.lua</code>).		For example, if you have utility functions in a file named 'Utilities.lua', simply write <code>require('Utilities')</code> at the top of another file to include it (omit the <code>.lua</code>).

	~~Note that all~~ lua files ~~must be~~ in ~~the same directory~~ (~~subdirectories are currently not supported~~).		You can also require lua files in subdirectories. If you have a subdirectory called 'Util', and in that subdirectory a file called 'Player.lua', simply write <code>require('Util.Player')</code>.

	== Printing Output ==		== Printing Output ==

Mod Developers Guide

Fizzer — Mon, 31 Aug 2026 06:40:53 GMT

← Older revision		Revision as of 06:40, 31 August 2026
Line 7:		Line 7:
	== Getting started creating a mod ==		== Getting started creating a mod ==

	There are ~~two~~ ways to load mod code into War.app: Using the Standalone Client, or directly uploading from your ~~editor~~. ~~Uploading from your editor is the preferred way since it allows for more rapid iteration. However, it also requires an extension to your editor, which only exists for VS Code.~~ If ~~you want to develop from an editor other than VS Code, or if~~ you want to develop without an active internet connection, you should use the Standalone Client method.		There are three ways to load mod code into War.app: Using the Standalone Client, directly uploading from VSCode, or directly uploading from a folder on your disk. If you want to develop without an active internet connection, you should use the Standalone Client method, otherwise the other methods are recommended since they allow for more rapid iteration.

	=== Developing with ~~the Standalone Client~~ ===		=== Developing with direct upload from your disk ===

	# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.		# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
	# Download the ~~[[Standalone Client]]~~ and ~~run~~ it.		# Ensure you have python 3 installed.
	# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. ~~(The easiest way is to use Github's "Download zip" button if you're not a git user)~~		# Download the python uploader script from https://raw.githubusercontent.com/FizzerWL/War.app-Mod-Uploader/refs/heads/main/UpdateMod.py
	# ~~Launch~~ the ~~Standalone Client~~, ~~sign in. Click~~ the ~~"Mod Development Console" button. You can also use the hotkey Ctrl+Shift+M~~ to ~~bring up this dialog any time~~, and ~~also note that this dialog can be docked to sides of your screen if you wish~~.		# Open the Mod Development Console at https://www.war.app/Mods/Develop
	# ~~Click the "Create New Mod" button and give~~ your mod ~~a name~~.		# Click the "Create New Mod" button and give your mod a name. Ensure the "Development" box is checked. After creating it, make note of your Mod ID.
	~~# Provide path to your folder with lua files that you downloaded in step 3~~.		# Visit https://www.war.app/API/GetAPIToken and note your API Token.
	~~# Click Submit to create the mod~~.		# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device.
	~~# From the single-player main menu, click "Custom Game", then scroll down~~ and click Change Mods.		# Run the attached python script, providing the folder to your example mod, mod ID, and API token.
	# You should see the mod you created here. Check the box to turn it on and click Submit.		# Now that your mod is updated, let's run it. Visit https://www.war.app/SinglePlayer?CustomGame=1 and click Change Mods. You should see the mod you created here. Check the box to turn it on and click Submit.
	# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!		# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!

			You can now make modifications to the mod on your disk, and the python script will automatically notice those changes, upload them to the War.app server, and your opened browser window will automatically notice the new code and re-load it immediately. There's no need to refresh your browser to see your code changes.

	~~Now you can make modifications~~ to the ~~lua code, press the "Reload code" button and try them out!~~		Be sure to read the rest of this page for essential information on mod development.

	=== Developing with direct upload from ~~your editor~~ ===		=== Developing with direct upload from VSCode ===

	# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.		# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
Line 42:		Line 44:

	Be sure to read the rest of this page for essential information on mod development.		Be sure to read the rest of this page for essential information on mod development.


			=== Developing with the Standalone Client ===

			# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
			# Download the [[Standalone Client]] and run it.
			# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. (The easiest way is to use Github's "Download zip" button if you're not a git user)
			# Launch the Standalone Client, sign in. Click the "Mod Development Console" button. You can also use the hotkey Ctrl+Shift+M to bring up this dialog any time, and also note that this dialog can be docked to sides of your screen if you wish.
			# Click the "Create New Mod" button and give your mod a name.
			# Provide path to your folder with lua files that you downloaded in step 3.
			# Click Submit to create the mod.
			# From the single-player main menu, click "Custom Game", then scroll down and click Change Mods.
			# You should see the mod you created here. Check the box to turn it on and click Submit.
			# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!

			Now you can make modifications to the lua code, press the "Reload code" button and try them out!


	== Video Tutorial ==		== Video Tutorial ==

Mod API Reference:GamePlayer

Fizzer — Fri, 28 Aug 2026 15:08:27 GMT

← Older revision		Revision as of 15:08, 28 August 2026
Line 29:		Line 29:
	* '''State''' ''[[Mod API Reference:GamePlayerState\|GamePlayerState]] (enum)'':		* '''State''' ''[[Mod API Reference:GamePlayerState\|GamePlayerState]] (enum)'':
	* '''Surrendered''' ''boolean'':		* '''Surrendered''' ''boolean'':
	* '''Team''' ''[[Mod API Reference:TeamID\|TeamID]]'':		* '''Team''' ''[[Mod API Reference:TeamID\|TeamID]]'': Specifies the team the player started the game on. Note that if a team is changed by a GameOrderEvent, this field will still show the team the player started on. Use GameStanding to determine if a player's team has been overridden.
	* '''TimesBooted''' ''integer'':		* '''TimesBooted''' ''integer'':
	* '''TimesComeBackFromAI''' ''integer'':		* '''TimesComeBackFromAI''' ''integer'':

Mod API Reference:GameStanding

Fizzer — Fri, 28 Aug 2026 15:07:07 GMT

← Older revision		Revision as of 15:07, 28 August 2026
Line 5:		Line 5:
	* '''Resources''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],Table<[[Mod API Reference:ResourceType\|ResourceType]] (enum),integer>>'': The resources owned by each player		* '''Resources''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],Table<[[Mod API Reference:ResourceType\|ResourceType]] (enum),integer>>'': The resources owned by each player
	* '''IncomeMods''' ''Array<[[Mod API Reference:IncomeMod\|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		* '''IncomeMods''' ''Array<[[Mod API Reference:IncomeMod\|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		* '''FogModsOpt''' ''Array<[[Mod API Reference:FogMod]]>'': FogMods currenty applied. Associates properties ID, FogLevel, Priority, Territories impacted, Player affected and the message the mod provided when creating the FogMod
			* '''TeamOverridesOpt''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:TeamID\|TeamID]]>'': Overridden teams, by GameOrderEvent (Added in version 6.05.0)


	== Functions ==		== Functions ==

	* '''NumResources'''('''playerID''' ''[[Mod API Reference:PlayerID\|PlayerID]]'', '''type''' ''[[Mod API Reference:ResourceType\|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)		* '''NumResources'''('''playerID''' ''[[Mod API Reference:PlayerID\|PlayerID]]'', '''type''' ''[[Mod API Reference:ResourceType\|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)
	[[Category:Mod API Reference]]		[[Category:Mod API Reference]]

Mod API Reference:GameOrderEvent

Fizzer — Fri, 28 Aug 2026 15:06:19 GMT

← Older revision		Revision as of 15:06, 28 August 2026
Line 15:		Line 15:
	* '''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)
	* '''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)		* '''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)
			* '''AssignTeamOpt''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:TeamID\|TeamID]]>'': Assign the given player ID(s) to the assigned team. Pass a value of -1 to team to signal that they should be unteamed. Note that cards stay with players who are joining a team, but do not follow a player who is leaving a team (cards are owned by the team), so if you want a different card behavior you must modify the cards with the above fields. Team changes are always visible to all players. (Added in version 6.05.0)

	== Functions ==		== Functions ==

Mod API Reference:Custom Cards

Fizzer — Fri, 28 Aug 2026 15:02:30 GMT

← Older revision		Revision as of 15:02, 28 August 2026
Line 37:		Line 37:
	## (optional) ''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)		## (optional) ''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)
	## (optional) ''[[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)		## (optional) ''[[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)
			## (optional) '''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)
	# closeCardsDialog: A function that, when called, closes the main cards dialog. This is commonly used when your mod creates a new dialog that wants to interact with the map, since the cards dialog could overlap the map making it cumbersome for the player. Added in version 5.34.0		# closeCardsDialog: A function that, when called, closes the main cards dialog. This is commonly used when your mod creates a new dialog that wants to interact with the map, since the cards dialog could overlap the map making it cumbersome for the player. Added in version 5.34.0

Update Mod API

Fizzer — Sun, 16 Aug 2026 22:38:32 GMT

← Older revision		Revision as of 22:38, 16 August 2026
Line 9:		Line 9:
	To use the API, you must first have created a development mod (not public) through the Mod Development Console. After doing that, take note of the Mod ID shown here when clicking "Edit" next to that mod.		To use the API, you must first have created a development mod (not public) through the Mod Development Console. After doing that, take note of the Mod ID shown here when clicking "Edit" next to that mod.

	To use the API, POST some JSON to https://~~www.~~war.app/API/UpdateMod?ModID=###&APIToken=XXX		To use the API, POST some JSON to https://war.app/API/UpdateMod?ModID=###&APIToken=XXX

	The ID of your mod and your [[Get API Token API\|API Token]] are passed on the querystring, as shown.		The ID of your mod and your [[Get API Token API\|API Token]] are passed on the querystring, as shown.

Mod API Reference:UI

Fizzer — Sun, 09 Aug 2026 22:39:03 GMT

← Older revision		Revision as of 22:39, 9 August 2026
Line 91:		Line 91:
	* '''CharacterLimit''' ''integer'': The maximum number of characters that players can type into this text field.		* '''CharacterLimit''' ''integer'': The maximum number of characters that players can type into this text field.
	* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.		* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.
			* '''OnValueChanged''' ''function'': Pass the name of a lua function to be called whenever the Text property changes, either by your code or by the player typing into the text box.

	'''NumberInputField''': Allows players to input a number. Presents an input box and a slider that are linked, so players can either use the box to type a number or slide the slider. This makes it friendly for mobile users who don't have a hardware keyboard, while also allowing any number to be entered if someone wants to exceed the range allowable by the slider.		'''NumberInputField''': Allows players to input a number. Presents an input box and a slider that are linked, so players can either use the box to type a number or slide the slider. This makes it friendly for mobile users who don't have a hardware keyboard, while also allowing any number to be entered if someone wants to exceed the range allowable by the slider.
Line 101:		Line 101:
	* '''SliderPreferredWidth''' ''number'': Allows setting the preferred width of just the slider. See '''Common Properties''' above.		* '''SliderPreferredWidth''' ''number'': Allows setting the preferred width of just the slider. See '''Common Properties''' above.
	* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.		* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.
			* '''OnValueChanged''' ''function'': Pass the name of a lua function to be called whenever the Value property changes, either by your code or by the player.

	== Helper Functions ==		== Helper Functions ==

Mod API Reference:GameOrderPlayCardCustom

Fizzer — Sun, 09 Aug 2026 22:37:30 GMT

← Older revision		Revision as of 22:37, 9 August 2026
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]]

Mod API Reference:GameOrderEvent

Fizzer — Sun, 09 Aug 2026 22:37:12 GMT

← Older revision		Revision as of 22:37, 9 August 2026
Line 14:		Line 14:
	* '''RemoveFogModsOpt''' ''Array<[[Mod API Reference:Guid\|Guid]]>'': Removes [[Mod API Reference:FogMod\|FogMods]]		* '''RemoveFogModsOpt''' ''Array<[[Mod API Reference:Guid\|Guid]]>'': Removes [[Mod API Reference:FogMod\|FogMods]]
	* '''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)
	* '''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.		* '''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)

	== Functions ==		== Functions ==

Mod API Reference:GameOrderCustom

Fizzer — Sun, 09 Aug 2026 22:37:03 GMT

← Older revision		Revision as of 22:37, 9 August 2026
Line 9:		Line 9:
	* '''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)

	[[Mod_Security\|Mod security]] should be applied to [[Mod_Hooks\|Mod Hooks]] working with this card		[[Mod_Security\|Mod security]] should be applied to [[Mod_Hooks\|Mod Hooks]] working with this card

Mod API Reference:GameOrderEvent

Fizzer — Sun, 09 Aug 2026 22:36:45 GMT

← Older revision		Revision as of 22:36, 9 August 2026
Line 14:		Line 14:
	* '''RemoveFogModsOpt''' ''Array<[[Mod API Reference:Guid\|Guid]]>'': Removes [[Mod API Reference:FogMod\|FogMods]]		* '''RemoveFogModsOpt''' ''Array<[[Mod API Reference:Guid\|Guid]]>'': Removes [[Mod API Reference:FogMod\|FogMods]]
	* '''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)
			* '''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.

	== Functions ==		== Functions ==

← Older revision		Revision as of 22:37, 9 August 2026
Line 9:		Line 9:
	* '''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)

	[[Mod_Security\|Mod security]] should be applied to [[Mod_Hooks\|Mod Hooks]] working with this card		[[Mod_Security\|Mod security]] should be applied to [[Mod_Hooks\|Mod Hooks]] working with this card