Mod API Reference - Revision history

Fizzer at 02:36, 18 April 2026

2026-04-18T02:36:06Z

← Older revision		Revision as of 02:36, 18 April 2026
Line 1:		Line 1:
	This explains how to use ~~Warzone~~'s [[Mods\|mod]] API and links to the documentation for each object type.		This explains how to use War.app's [[Mods\|mod]] API and links to the documentation for each object type.

	== Types ==		== Types ==
Line 5:		Line 5:
	When writing a mod, you'll encounter variables/objects of three basic types:		When writing a mod, you'll encounter variables/objects of three basic types:
	* Primitives: strings, numbers, booleans, etc.		* Primitives: strings, numbers, booleans, etc.
	* Tables: collections of key/value pairs. A table is a lot like a hashmap or dictionary in other languages. Note that in ~~Warzone~~, the key of a table will always be either a string or an integer. Some places in this reference will refer to Arrays which are just tables with numeric keys starting at 1.		* Tables: collections of key/value pairs. A table is a lot like a hashmap or dictionary in other languages. Note that in War.app, the key of a table will always be either a string or an integer. Some places in this reference will refer to Arrays which are just tables with numeric keys starting at 1.
	* Proxy objects: Discussed in the next section.		* Proxy objects: Discussed in the next section.

	== Proxy Objects ==		== Proxy Objects ==

	A '''proxy object''' proxies information back and forth between your mod and ~~Warzone~~. You can tell if an object is a proxy object by looking for a <code>proxyType</code> field. All proxy objects always have the following fields:		A '''proxy object''' proxies information back and forth between your mod and War.app. You can tell if an object is a proxy object by looking for a <code>proxyType</code> field. All proxy objects always have the following fields:

	* proxyType: A string identifying the type of proxy object.		* proxyType: A string identifying the type of proxy object.
Line 29:		Line 29:
	== Writing Tables ==		== Writing Tables ==

	If a writable ~~Warzone~~ proxy object exposes a table, and you wish to make changes to that table, you must assign the table back to the proxy object. For example, assume you have a <code>GameStanding</code> object named <code>standing</code> which exposes the <code>Cards</code> table, and you want to add something at index 9:		If a writable War.app proxy object exposes a table, and you wish to make changes to that table, you must assign the table back to the proxy object. For example, assume you have a <code>GameStanding</code> object named <code>standing</code> which exposes the <code>Cards</code> table, and you want to add something at index 9:

	standing.Cards[9] = something --WRONG!		standing.Cards[9] = something --WRONG!
Line 137:		Line 137:
	\|-		\|-
	\| 5.35		\| 5.35
	\| Added mod browser, with sort/filter/search options, for easily finding or sorting through mods. It's viewable at https://www.~~warzone~~.~~com~~/Mods/, or integrated into the Create Game page when you click Change Mods.<br>Mega games now allow mods<br>Added a dedicated page for each mod, to replace the small mod info dialog<br>Mods can now have icons and images to show themselves off to players when browsing mods<br>Territory annotations now show in a faded form on the map when the order is not selected<br>Fixed a bug that caused an error if a mod sent a custom message without having a custom message handler, and at least one other mod in the game did have a custom message handler<br>Fixed annotation font sizes<br>Fixed guids so they're consistently converted to strings on different platforms<br>Fixed multi-attack games assuming no special units exist if commanders were turned off		\| Added mod browser, with sort/filter/search options, for easily finding or sorting through mods. It's viewable at https://www.war.app/Mods/, or integrated into the Create Game page when you click Change Mods.<br>Mega games now allow mods<br>Added a dedicated page for each mod, to replace the small mod info dialog<br>Mods can now have icons and images to show themselves off to players when browsing mods<br>Territory annotations now show in a faded form on the map when the order is not selected<br>Fixed a bug that caused an error if a mod sent a custom message without having a custom message handler, and at least one other mod in the game did have a custom message handler<br>Fixed annotation font sizes<br>Fixed guids so they're consistently converted to strings on different platforms<br>Fixed multi-attack games assuming no special units exist if commanders were turned off
	\|-		\|-
	\| 5.34.1		\| 5.34.1
Line 146:		Line 146:
	\|-		\|-
	\| 5.33		\| 5.33
	\| [[Mod API Reference:FogMod\|WL.FogMod]]<br>[[Mod API Reference:GameOrderEvent\|GameOrderEvent.FogModsOpt]]<br>[[Mod API Reference:GameOrderEvent\|GameOrderEvent.RemoveFogModsOpt]]<br>[[Mod API Reference:GameStanding\|GameStanding.IncomeMods]]<br>Fixed the AI trying to move its commander even if it doesn't control the territory the commander is on (which can happen with mods)<br>Fixed a bug that could make a generic ~~Warzone~~ error instead of a mod failed error if you tried to set a property on a destroyed object (for example, Button's SetInteractable)		\| [[Mod API Reference:FogMod\|WL.FogMod]]<br>[[Mod API Reference:GameOrderEvent\|GameOrderEvent.FogModsOpt]]<br>[[Mod API Reference:GameOrderEvent\|GameOrderEvent.RemoveFogModsOpt]]<br>[[Mod API Reference:GameStanding\|GameStanding.IncomeMods]]<br>Fixed the AI trying to move its commander even if it doesn't control the territory the commander is on (which can happen with mods)<br>Fixed a bug that could make a generic War.app error instead of a mod failed error if you tried to set a property on a destroyed object (for example, Button's SetInteractable)
	\|-		\|-
	\| 5.32.0.1		\| 5.32.0.1

DanWL60: /* Newer API features */ 5.36 changes

2025-05-18T07:37:57Z

Newer API features: 5.36 changes

← Older revision		Revision as of 07:37, 18 May 2025
Line 132:		Line 132:
	! Version		! Version
	\| Features		\| Features
			\|-
			\| 5.36
			\| Transferring or airlifting a special unit to a teammate now updates the unit's owner<br>Added new tags: Special Units, Cards, Random<br>Fixed not being able to assign owner of a special unit to neutral<br>Fixed deployment not updating properly if a mod changed orders from Client_GameOrderCreated<br>Fixed Feature.png not showing correctly while mod was in development
	\|-		\|-
	\| 5.35		\| 5.35

DanWL60: /* Newer API features */ 5.35 features

2025-04-22T14:57:21Z

Newer API features: 5.35 features

← Older revision		Revision as of 14:57, 22 April 2025
Line 132:		Line 132:
	! Version		! Version
	\| Features		\| Features
			\|-
			\| 5.35
			\| Added mod browser, with sort/filter/search options, for easily finding or sorting through mods. It's viewable at https://www.warzone.com/Mods/, or integrated into the Create Game page when you click Change Mods.<br>Mega games now allow mods<br>Added a dedicated page for each mod, to replace the small mod info dialog<br>Mods can now have icons and images to show themselves off to players when browsing mods<br>Territory annotations now show in a faded form on the map when the order is not selected<br>Fixed a bug that caused an error if a mod sent a custom message without having a custom message handler, and at least one other mod in the game did have a custom message handler<br>Fixed annotation font sizes<br>Fixed guids so they're consistently converted to strings on different platforms<br>Fixed multi-attack games assuming no special units exist if commanders were turned off
	\|-		\|-
	\| 5.34.1		\| 5.34.1

DanWL60: /* Newer API features */

2025-03-31T13:22:16Z

Newer API features

← Older revision		Revision as of 13:22, 31 March 2025
Line 134:		Line 134:
	\|-		\|-
	\| 5.34.1		\| 5.34.1
	\| [[Mod Hooks#Client Hooks\|Client_CreateGame]]<br>Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>~~playCard~~</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element<br>Fixed a bug that caused stack traces to not show up in mod errors in some cases in Unity<br>Fixed fog mods on No-Fog games from giving errors<br>Fixed skipping of deploy orders in Client_GameOrderCreated making the deployment status report incorrectly<br>Fixed copying a game that used a mod that used the Server_Created hook		\| [[Mod Hooks#Client Hooks\|Client_CreateGame]]<br>Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>addCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element<br>Fixed a bug that caused stack traces to not show up in mod errors in some cases in Unity<br>Fixed fog mods on No-Fog games from giving errors<br>Fixed skipping of deploy orders in Client_GameOrderCreated making the deployment status report incorrectly<br>Fixed copying a game that used a mod that used the Server_Created hook
	\|-		\|-
	\| 5.34		\| 5.34

DanWL60: /* Newer API features */ 5.34.1 new hook and bug fixes

2025-03-31T13:18:47Z

Newer API features: 5.34.1 new hook and bug fixes

← Older revision		Revision as of 13:18, 31 March 2025
Line 134:		Line 134:
	\|-		\|-
	\| 5.34.1		\| 5.34.1
	\| Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element		\| [[Mod Hooks#Client Hooks\|Client_CreateGame]]<br>Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element<br>Fixed a bug that caused stack traces to not show up in mod errors in some cases in Unity<br>Fixed fog mods on No-Fog games from giving errors<br>Fixed skipping of deploy orders in Client_GameOrderCreated making the deployment status report incorrectly<br>Fixed copying a game that used a mod that used the Server_Created hook
	\|-		\|-
	\| 5.34		\| 5.34

DanWL60: /* Newer API features */

2025-03-31T13:11:44Z

Newer API features

← Older revision		Revision as of 13:11, 31 March 2025
Line 134:		Line 134:
	\|-		\|-
	\| 5.34.1		\| 5.34.1
	\| Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[~~Help~~		\| Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element
	Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element
	\|-		\|-
	\| 5.34		\| 5.34

DanWL60: /* Newer API features */ add 5.34.1 changes

2025-03-31T13:11:03Z

Newer API features: add 5.34.1 changes

← Older revision		Revision as of 13:11, 31 March 2025
Line 131:		Line 131:
	\|-		\|-
	! Version		! Version
	! Features		\| Features
			\|-
			\| 5.34.1
			\| Add <em>TerritoryAnnotationsOpt</em> to [[Mod API Reference:GameOrderEvent\|GameOrderEvent]], [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add <em>JumpToActionSpotOpt</em> to [[Mod API Reference:GameOrderCustom\|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom\|GameOrderPlayCardCustom]]<br>Add parameter 9 (<em>ActiveCardExpireBehaviorOptions</em>) to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add optional parameters 4 and 5 to <em>playCard</em> when using [[Mod API Reference:Custom Cards\|Custom Cards]]<br>Add <em>MinWidth</em> and <em>MinHeight</em> to all [[Help
			Mod API Reference:UI\|UI]] elements<br>Add <em>Alignment</em> to UI Label element
	\|-		\|-
	\| 5.34		\| 5.34

DanWL60: /* Newer API features */

2025-03-10T22:48:20Z

Newer API features

← Older revision		Revision as of 22:48, 10 March 2025
Line 134:		Line 134:
	\|-		\|-
	\| 5.34		\| 5.34
	\| Create [[Mod_API_Reference:UI\|radio buttons]]<br>Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog<br>[[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - <em>closeCardsDialog</em><br>Fixed [[Mod Hooks#Client Hooks\|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games<br>Fixed WL.enumtype.ToString() functions<br>Fixed [[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] not registering [[Mod Game Data Storage\|Mod]] and [[Mod API Reference:UI\|UI]] hooks if it was called before other client hooks<br>Fixed an error if you set number of card pieces to 0 or negative<br>Fixed [[Mod API Reference:GameOrderAirliftResult\|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet<br>Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult\|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number<br>Fixed "~~can’t~~ transfer to a neutral" error that occurred when a mod resurrected a failed transfer		\| Create [[Mod_API_Reference:UI\|radio buttons]]<br>Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog<br>[[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - <em>closeCardsDialog</em><br>Fixed [[Mod Hooks#Client Hooks\|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games<br>Fixed WL.enumtype.ToString() functions<br>Fixed [[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] not registering [[Mod Game Data Storage\|Mod]] and [[Mod API Reference:UI\|UI]] hooks if it was called before other client hooks<br>Fixed an error if you set number of card pieces to 0 or negative<br>Fixed [[Mod API Reference:GameOrderAirliftResult\|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet<br>Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult\|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number<br>Fixed "can't transfer to a neutral" error that occurred when a mod resurrected a failed transfer
	\|-		\|-
	\| 5.33		\| 5.33

DanWL60: /* Newer API features */

2025-03-10T22:44:54Z

Newer API features

← Older revision		Revision as of 22:44, 10 March 2025
Line 134:		Line 134:
	\|-		\|-
	\| 5.34		\| 5.34
	\| Create [[Mod_API_Reference:UI\|radio buttons]]<br>Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog<br>[[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - <em>closeCardsDialog</em><br>Fixed [[Mod Hooks#Client Hooks\|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games<br>Fixed WL.enumtype.ToString() functions<br>Fixed Client_PresentPlayCardUI not registering [[Mod Game Data Storage\|Mod]] and [[Mod API Reference:UI\|UI]] hooks if it was called before other client hooks<br>Fixed an error if you set number of card pieces to 0 or negative<br>Fixed [[Mod API Reference:GameOrderAirliftResult\|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet<br>Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult\|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number<br>Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer		\| Create [[Mod_API_Reference:UI\|radio buttons]]<br>Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog<br>[[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - <em>closeCardsDialog</em><br>Fixed [[Mod Hooks#Client Hooks\|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games<br>Fixed WL.enumtype.ToString() functions<br>Fixed [[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] not registering [[Mod Game Data Storage\|Mod]] and [[Mod API Reference:UI\|UI]] hooks if it was called before other client hooks<br>Fixed an error if you set number of card pieces to 0 or negative<br>Fixed [[Mod API Reference:GameOrderAirliftResult\|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet<br>Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult\|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number<br>Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer
	\|-		\|-
	\| 5.33		\| 5.33

DanWL60: /* Newer API features */

2025-03-10T22:43:44Z

Newer API features

← Older revision		Revision as of 22:43, 10 March 2025
Line 134:		Line 134:
	\|-		\|-
	\| 5.34		\| 5.34
	\| Create [[Mod_API_Reference:UI\|radio buttons]]<br>Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog<br>[[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - <em>closeCardsDialog</em><br>Fixed Client_GameOrderCreated not being able to read territory picks in manual distribution games<br>Fixed WL.enumtype.ToString() functions<br>Fixed Client_PresentPlayCardUI not registering [[Mod Game Data Storage\|Mod]] and [[Mod API Reference:UI\|UI]] hooks if it was called before other client hooks<br>Fixed an error if you set number of card pieces to 0 or negative<br>Fixed [[Mod API Reference:GameOrderAirliftResult\|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet<br>Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult\|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number<br>Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer		\| Create [[Mod_API_Reference:UI\|radio buttons]]<br>Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog<br>[[Mod API Reference:Custom Cards\|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - <em>closeCardsDialog</em><br>Fixed [[Mod Hooks#Client Hooks\|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games<br>Fixed WL.enumtype.ToString() functions<br>Fixed Client_PresentPlayCardUI not registering [[Mod Game Data Storage\|Mod]] and [[Mod API Reference:UI\|UI]] hooks if it was called before other client hooks<br>Fixed an error if you set number of card pieces to 0 or negative<br>Fixed [[Mod API Reference:GameOrderAirliftResult\|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet<br>Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult\|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number<br>Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer
	\|-		\|-
	\| 5.33		\| 5.33