2025-04-19T20:52:19Z

DanWL60: add icon field support

<includeonly>[[Category:Mods]][[Category:Mods made public during {{{madePublicOnYear|????}}}]][[Category:{{{category|Experimental}}} Mods]]</includeonly>
{{Mod infobox main
|name={{{name|{{FULLPAGENAME}}}}}
|icon={{{icon|}}}
|creatorToken={{{creatorToken|creatorToken}}}
|creatorName={{{creatorName|creatorName}}}
|madePublicOnYear={{{madePublicOnYear|????}}}
|madePublicOnMonth={{{madePublicOnMonth|??}}}
|madePublicOnDay={{{madePublicOnDay|??}}}
|madePublicOnRef={{{madePublicOnRef|}}}
|madePublicOnAlt={{{madePublicOnAlt|}}}
|category={{{category|Experimental}}}
|tags={{{tags|tags}}}
|appversion={{{appversion|4.14.2}}}
|source={{{source|https://example.com}}}
|sourcehost={{{sourcehost|GitHub}}}
}}<noinclude>

There is an optional <code><nowiki>icon</nowiki></code> field that appears underneath <code><nowiki>name</nowiki></code>. See [[Template:Mod infobox/row/icon]] for details.

For giving info about available public mods. [[:Category:Deleted Mods|Deleted mods]] should use [[Template:Mod infobox main]], as categories will not be automatically included using that template, unlike this one.
== Usage ==
<pre>
<nowiki>
{{Mod infobox
|name=(name of mod, defaults to page name)
|creatorToken=(the ?p=<numbers> on a player URL)
|creatorName=(name of player who created the mod)
|madePublicOnYear=yyyy (forced)
|madePublicOnMonth=mm (defaults to ??)
|madePublicOnDay=dd (defaults to ??)
|madePublicOnRef=(optional)
|madePublicOnAlt=(optional)
|category=(one of Promoted, Standard or Experimental, defaults to Experimental)
|tags={{modtag|Tag1}} {{modtag|Tag2}} {{modtag|Tag3}}
|appversion=(optional, defaults to 4.14.2)
|source=url
|sourcehost=(optional, defaults to GitHub)
}}
</nowiki>
</pre>
[[Tanks|Tank]] example:
<pre>
<nowiki>
{{Mod infobox
|creatorToken=62456969
|creatorName=Fizzer
|madePublicOnYear=2022
|madePublicOnMonth=10
|madePublicOnDay=26
|madePublicOnRef={{ref|https://www.warzone.com/blog/index.php/2022/10/update-5-21-tanks-mod-improvements-commander-improvements/}}
|tags={{modtag|Diplomacy}} {{modtag|Strategic}} {{modtag|Commerce}}
|appversion=5.24.1
|source=https://github.com/FizzerWL/ExampleMods/tree/master/TanksMod
}}
</nowiki>
</pre>
If the mod was announced public but there isn't a way to verify it using means which require having certain accounts or access to other places outside of Warzone such as Discord servers, you should still include the date but include a comment such as one of the below beneath the <code>madePublicOn</code> fields:
<pre>
<nowiki>






</nowiki>
</pre>
Do not use links to them in the <code>madePublicOnRef</code> field.

<code>madePublicOnAlt</code> is for if a mod was made not public after being made public and then made public again. Add dates using [[Template:Mod infobox/date]].
</noinclude><noinclude>[[Category:Infobox Templates]]</noinclude>

Template:Mod infobox/row/icon

2025-04-19T20:48:45Z

DanWL60: Created page with "<includeonly>{{Mod infobox/row|Icon|{{{1|Icon}}}}}</includeonly><noinclude> For use on these templates: * Mod infobox main * Mod infobox </noinclude>"

<includeonly>{{Mod infobox/row|Icon|{{{1|Icon}}}}}</includeonly><noinclude>
For use on these templates:
* [[Template:Mod infobox main|Mod infobox main]]
* [[Template:Mod infobox|Mod infobox]]
</noinclude>

Template:Mod infobox main

2025-04-19T20:41:57Z

DanWL60: add icon field support

<div class="infobox">{{Mod infobox/row|Mod name|{{{name|{{FULLPAGENAME}}}}}}}{{{icon|}}}{{Mod infobox/row|Creator|{{{1|[https://www.warzone.com/Profile?p={{{creatorToken|creatorToken}}} {{{creatorName|creatorName}}}]}}}}}{{Mod infobox/row|[[:Category:Mods made public by year|Made public on]]|{{Mod infobox/date|{{{madePublicOnYear|????}}}|{{{madePublicOnMonth|??}}}|{{{madePublicOnDay|??}}}|{{{madePublicOnRef|}}}}}{{{madePublicOnAlt|}}}}}{{Mod infobox/row|[[Mod Categories|Category]]|[[:Category:{{{category|Deleted}}} Mods|{{{category|Deleted}}}]]}}{{Mod infobox/row|[[:Category:Mods by tag|Tags]]|{{{tags|tags}}}}}{{Mod infobox/row|Requires Warzone version|{{{appversion|4.14.2}}}+}}{{Mod infobox/row|Source code|[{{{source|https://example.com}}} {{{sourcehost|GitHub}}}]}}</div><noinclude>
== Usage ==
This template should only be used by [[Template:Mod infobox]] or [[:Category:Deleted Mods|deleted mods]]. [[Template:Deleted Mod]] should be used at the top of the page, before the template is included: <code><nowiki>{{Deleted Mod}}</nowiki></code>.
<pre>
<nowiki>
{{Mod infobox main
|name=(name of mod, defaults to page name)
|creatorToken=(the ?p=<numbers> on a player URL)
|creatorName=(name of player who created the mod)
|madePublicOnYear=yyyy (forced)
|madePublicOnMonth=mm (defaults to ??)
|madePublicOnDay=dd (defaults to ??)
|madePublicOnRef=(optional)
|madePublicOnAlt=(optional)
|category=(one of Promoted, Standard, Experimental or Deleted, defaults to Deleted)
|tags={{ModtagMain|Tag1}} {{ModtagMain|Tag2}} {{ModtagMain|Tag3}}
|appversion=(optional, defaults to 4.14.2)
|source=url
|sourcehost=(optional, defaults to GitHub)
}}
</nowiki>
</pre>

There is an optional field <code><nowiki>icon</nowiki></code> that appears underneath <code><nowiki>name</nowiki></code>. See [[Template:Mod infobox/row/icon]] for details.

</noinclude><noinclude>[[Category:Infobox Templates]]</noinclude>

Mod Images

2025-04-19T20:20:31Z

DanWL60: add category

Every mod gets two images they can optionally include, an '''icon''' and a '''feature image'''. Additionally, mods can use images in conjunction with other mod features, such as custom special units and cards. This page describes how to give your mod an '''icon''' and '''feature image'''.

== Icon ==

Your mod's icon will show up in the mod browser when a player searches for mods to include in their game. You can see icons at https://www.warzone.com/Mods/

To give your mod an icon, place it in the root folder of your mod and name it Icon.png. The image must be in png format and must be exactly 50 pixels wide and 50 pixels high.

== Feature ==

Your mod's feature image will show up on its mod page, for example https://www.warzone.com/Mods/Mod?ID=448

To give your mod a feature image, place it in the root folder of your mod and name it Feature.png. The image must be in png format and must be exactly 500 pixels wide and 300 pixels high.

[[Category: Mod Developers Guide]]

Mod Developers Guide

2025-04-19T20:14:28Z

DanWL60: /* Tips */ licensing clarification

This page describes information necessary for making [[Mods]].

This guide assumes that you know the Lua programming language. If you've worked with other languages, such as Javascript, Lua should be very easy to learn. Many tutorials are available on the internet if you search for them.

Note that you must be a Warzone [[member]] to develop mods, as mods are a member feature.

== Getting started creating a mod ==

There are two ways to load mod code into Warzone: 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.

=== Developing with the Standalone Client ===

# Open the page https://www.warzone.com/EnableModDevelopment to enable mod development for your Warzone 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!

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

# Open the page https://www.warzone.com/EnableModDevelopment to enable mod development for your Warzone account.
# Install VS Code from https://code.visualstudio.com/
# 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 Warzone Mod Helper VS Code extension VSIX file from https://github.com/FizzerWL/WarzoneModHelper/releases. Install it by launching VS Code, pressing Ctrl+Shift+P, entering "Install from VSIX" and selecting the VSIX file you downloaded.
# (optional) Install the Lua IDE extension: https://marketplace.visualstudio.com/items?itemName=sumneko.lua
# Open the Mod Development Console at https://www.warzone.com/Mods/Develop
# 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.
# In VS Code, open the RandomizedWastelandsMod folder you downloaded earlier. Open one of the lua files in this folder.
# Visit https://www.warzone.com/API/GetAPIToken and copy your API Token to the clipboard.
# In VS Code, press Ctrl+Shift+P and select "Upload Mod". Enter your Mod ID you noted earlier, and paste your API Token when prompted. Ensure it says "Mod updated successfully" in the bottom right corner.
# Now that your mod is updated, let's run it. Visit https://www.warzone.com/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!

Now you can make modifications to the lua code, press and invoke the "Upload Mod" feature again to try them out!

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

== Video Tutorial ==

If you prefer to learn via video, check out this YouTube tutorial on how to make a mod: https://www.youtube.com/watch?v=mwVDv5PXyrg

== Hooks ==

Warzone will call into a mod's lua code using what are called '''hooks'''. For example, it will call a hook named <code>Server_StartGame</code> when a game is beginning and give your mod an opportunity to change things about how the map is set up.

For full details on what hooks are available, see [[Mod Hooks]].

== Sharing code with "require" ==

You can call the "require" function to share code between different lua files.

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).

== Printing Output ==

In lua, you can print output with lua's <code>print</code> function. For example: <code>print("Hello, world!")</code>

To see this output, open the Mod Development Console (Ctrl+Shift+M) and click View Mod Output. Then create a single-player game using that mod, and when the print statement runs, you'll see the output appear in this window in real-time.

This is useful to assist in debugging.

In multi-player games, the output of mods that run on the server is currently not viewable anywhere, unless the mod crashes which will display recently printed lines in a report in the Mod Development Console. For this reason, it's easier to debug mods in single-player before moving to multi-player.

== Global State ==

Never assume any state will persist, unless specifically called out in the documentation. For example, don't write to a global variable in one hook and access it in another.

If you try to in a single-player game, you may find that global state does persist. However, don't be tempted to rely on this, since globals are always wiped in multi-player, and globals will also get wiped in single-player if someone saves and re-loads their game. Therefore, ensure you code as if globals will never persist between hook calls, except where explicitly allowed.

== Data Storage ==

Mods can store public, private, or player-specific data within a game. See [[Mod Game Data Storage]] for details.

== Mod Timeout ==

Note that if a game takes more than a minute to advance, the mods will time out and the game will not advance. This time counts all mods enabled for that game combined, so mod authors should work to ensure their mods are efficient as possible.

If a game times out more than 10 times in a row, Warzone will end the game automatically.

== Tips ==

Be sure to test in multi-player! When running Server code in multi-player, your lua code runs on the Warzone server which uses a different lua engine. In theory, everything should be the same, but there is still an opportunity for differences. To ensure everything you're doing works, it's recommended you test in multi-player, not only before you're ready to go public, but also occasionally during your development process.

Note that all mods uploaded to Warzone must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT.  Additionally, for mods to be used by Warzone, they must use the MIT license, or something equally or more permissable.

== See Also ==
* [[Mod Security]]
* [[Mod API Reference]]
* [[Mod Backwards Compatibility]]
* [[Public Mods]]
* [[Mod Hooks]]
* [[Mod Game Data Storage]]
* [[Mod Images]]
* [https://discord.gg/hqGkVXagyt Warzone Mod Makers Discord]

[[Category:Mod Developers Guide|!]]

Mod Framework Capabilities

2025-04-16T19:25:53Z

DanWL60: Mention fog modifications

Below is a list of features that can be accomplished when creating [[mods]]:

* Create menus - [[Mod API Reference:UI]], [[Mod API Reference:ClientGame]]
* Read and write data that persists over multiple turns - [[Mod Game Data Storage]]
* Read details about the game - [[Mod API Reference:Game]]
** Read map details (territories names, territory connections, bonuses) - [[Mod API Reference:MapDetails]]
** Read and write all game settings (except for other mods) - [[Mod API Reference:GameSettings]]
** Read which players have joined the game and details about players - [[Mod API Reference:GamePlayer]]
** Read game history - [[Mod API Reference:ClientGame]]
* Create, read, write and skip player orders - [[Mod API Reference:ClientGame]], [[Mod API Reference:ServerGame]], [[Mod API Reference:GameOrder]]
* Read and write the amount of armies on territories - [[Mod API Reference:GameStanding]], [[Mod API Reference:GameOrder]]
* Read and write which structures are on territories - [[Mod API Reference:GameStanding]], [[Mod API Reference:GameOrder]]
* Read and write the owner of territories - [[Mod API Reference:GameStanding]], [[Mod API Reference:GameOrder]]
* Create custom special units - [[Mod API Reference:SpecialUnit]]
* Create structures using Idle the icons - [[Mod API Reference:StructureType]]
* Perform calculations using armies - [[Mod API Reference:Armies]]
* Create custom cards - [[Mod API Reference:Custom Cards]]
* Modify fog levels - [[Mod API Reference:FogMod]]

[[Category:Mod API Reference]]

Template:Mod infobox main

2025-04-01T23:15:03Z

DanWL60: Wording of app version

<div class="infobox">{{Mod infobox/row|Mod name|{{{name|{{FULLPAGENAME}}}}}}}{{Mod infobox/row|Creator|{{{1|[https://www.warzone.com/Profile?p={{{creatorToken|creatorToken}}} {{{creatorName|creatorName}}}]}}}}}{{Mod infobox/row|[[:Category:Mods made public by year|Made public on]]|{{Mod infobox/date|{{{madePublicOnYear|????}}}|{{{madePublicOnMonth|??}}}|{{{madePublicOnDay|??}}}|{{{madePublicOnRef|}}}}}{{{madePublicOnAlt|}}}}}{{Mod infobox/row|[[Mod Categories|Category]]|[[:Category:{{{category|Deleted}}} Mods|{{{category|Deleted}}}]]}}{{Mod infobox/row|[[:Category:Mods by tag|Tags]]|{{{tags|tags}}}}}{{Mod infobox/row|Requires Warzone version|{{{appversion|4.14.2}}}+}}{{Mod infobox/row|Source code|[{{{source|https://example.com}}} {{{sourcehost|GitHub}}}]}}</div><noinclude>
== Usage ==
This template should only be used by [[Template:Mod infobox]] or [[:Category:Deleted Mods|deleted mods]]. [[Template:Deleted Mod]] should be used at the top of the page, before the template is included: <code><nowiki>{{Deleted Mod}}</nowiki></code>.
<pre>
<nowiki>
{{Mod infobox main
|name=(name of mod, defaults to page name)
|creatorToken=(the ?p=<numbers> on a player URL)
|creatorName=(name of player who created the mod)
|madePublicOnYear=yyyy (forced)
|madePublicOnMonth=mm (defaults to ??)
|madePublicOnDay=dd (defaults to ??)
|madePublicOnRef=(optional)
|madePublicOnAlt=(optional)
|category=(one of Promoted, Standard, Experimental or Deleted, defaults to Deleted)
|tags={{ModtagMain|Tag1}} {{ModtagMain|Tag2}} {{ModtagMain|Tag3}}
|appversion=(optional, defaults to 4.14.2)
|source=url
|sourcehost=(optional, defaults to GitHub)
}}
</nowiki>
</pre></noinclude><noinclude>[[Category:Infobox Templates]]</noinclude>

Mystery Card

2025-03-31T18:50:33Z

DanWL60: version requirements changed

{{Mod infobox
|creatorToken=9522268564
|creatorName=DanWL
|madePublicOnYear=2025
|madePublicOnMonth=03
|madePublicOnDay=01
|tags={{Modtag|Strategic}}
|appversion=5.34.1
|source=https://github.com/DanWaLes/Warzone/tree/main/mods/Mystery%20Card
}}

{{Card infobox
|img=https://raw.githubusercontent.com/DanWaLes/Warzone/refs/heads/main/mods/Mystery%20Card/CardImages/MysteryCard.png
}}

This [[mod]] adds a custom [[cards|card]] to the game: a [[Mystery Card]].

When a Mystery Card is played, the player who played the card will be given a full random card (excluding the Mystery Card itself). These cards are played during the receive cards turn phase. If the player who tried to play the card before then gets eliminated, the card will not take affect but the card will be lost.

Playing this card happens during the same [[turn phases|turn phase]] as receiving new cards.

== Settings ==
=== Mod Settings ===
* Number of pieces to divide the card into (defaults to 7, min 1, max 20)
* Card weight (defaults to 1, min 0, max 5)
* Minimum pieces awarded per turn (defaults to 1, min 0, max 5)
* Pieces given to each player at the start (defaults to 5, min 0, max 5)

All these settings have an absolute max value of 1000 if the value is typed in rather than using the number slider.

{{Cards}}

Mod API Reference:WL

2025-03-31T13:42:21Z

DanWL60: /* Other */ add TextAlignmentOptions

== Army Related ==
* [[Mod_API_Reference:Armies|WL.Armies]]
* [[Mod_API_Reference:Boss1|WL.Boss1]]
* [[Mod_API_Reference:Boss2|WL.Boss2]]
* [[Mod_API_Reference:Boss3|WL.Boss3]]
* [[Mod_API_Reference:Boss4|WL.Boss4]]
* [[Mod_API_Reference:Commander|WL.Commander]]
* [[Mod_API_Reference:CustomSpecialUnit|WL.CustomSpecialUnitBuilder]]
* [[Mod_API_Reference:IncomeMod|WL.IncomeMod]]
* [[Mod_API_Reference:ResourceType|WL.ResourceType]]

== Game Order ==
* [[Mod API Reference:AttackTransferEnum|WL.AttackTransferEnum]]
* [[Mod API Reference:GameOrderAttackTransfer|WL.GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderCustom|WL.GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|WL.GameOrderDeploy]]
* [[Mod API Reference:GameOrderEvent|WL.GameOrderEvent]]
* [[Mod API Reference:TerritoryAnnotation|WL.TerritoryAnnotation]]
* [[Mod API Reference:TerritoryModification|WL.TerritoryModification]]
* [[Mod API Reference:TurnPhase|WL.TurnPhase]]
=== Card ===
* [[Mod API Reference:GameOrderDiscard|WL.GameOrderDiscard]]
* [[Mod API Reference:GameOrderReceiveCard|WL.GameOrderReceiveCard]]
* [[Mod API Reference:NoParameterCardInstance|WL.NoParameterCardInstance]]
* [[Mod API Reference:ReinforcementCardInstance|WL.ReinforcementCardInstance]]
==== Play Card ====
* [[Mod API Reference:GameOrderPlayCardAbandon|WL.GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|WL.GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardBlockade|WL.GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|WL.GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|WL.GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardGift|WL.GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|WL.GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|WL.GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|WL.GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|WL.GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|WL.GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|WL.GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|WL.GameOrderPlayCardSurveillance]]

== Settings ==
* [[Mod_API_Reference:CustomScenario|WL.CustomScenario]]
* [[Mod API Reference:MoveOrderEnum|WL.MoveOrderEnum]]
* [[Mod_API_Reference:GameFogLevel|WL.GameFogLevel]]
* [[Mod_API_Reference:RoundingModeEnum|WL.RoundingModeEnum]]
=== Cards ===
* [[Mod_API_Reference:CardGameAbandon|WL.CardGameAbandon]]
* [[Mod_API_Reference:CardGameAirlift|WL.CardGameAirlift]]
* [[Mod_API_Reference:CardGameBlockade|WL.CardGameBlockade]]
* [[Mod_API_Reference:CardGameBomb|WL.CardGameBomb]]
* [[Mod_API_Reference:CardGameDiplomacy|WL.CardGameDiplomacy]]
* [[Mod_API_Reference:CardGameGift|WL.CardGameGift]]
* [[Mod_API_Reference:CardGameOrderDelay|WL.CardGameOrderDelay]]
* [[Mod_API_Reference:CardGameOrderPriority|WL.CardGameOrderPriority]]
* [[Mod_API_Reference:CardGameReconnaissance|WL.CardGameReconnaissance]]
* [[Mod_API_Reference:CardGameReinforcement|WL.CardGameReinforcement]]
* [[Mod_API_Reference:CardGameSanctions|WL.CardGameSanctions]]
* [[Mod_API_Reference:CardGameSpy|WL.CardGameSpy]]
* [[Mod_API_Reference:CardGameSurveillance|WL.CardGameSurveillance]]

== Other ==
* [[Mod_API_Reference:ActiveCardExpireBehaviorOptions|WL.ActiveCardExpireBehaviorOptions]]
* [[Mod_API_Reference:CardID|WL.CardID]]
* [[Mod API Reference:FogMod|WL.FogMod]]
* [[Mod API Reference:GamePlayerState|WL.GamePlayerState]]
* [[Mod API Reference:GameState|WL.GameState]]
* [[Mod API Reference:IsVersionOrHigher|WL.IsVersionOrHigher]]
* [[Mod API Reference:PlayerID|WL.PlayerID]]
* [[Mod API Reference:PlayerCards|WL.PlayerCards]]
* [[Mod API Reference:RectangleVM|WL.RectangleVM]]
* [[Mod API Reference:ReinforcementCardMode|WL.ReinforcementCardMode]]
* [[Mod API Reference:StandingFogLevel|WL.StandingFogLevel]]
* [[Mod API Reference:StructureType|WL.StructureType]]
* [[Mod API Reference:TerritoryConnectionWrap|WL.TerritoryConnectionWrap]]
* [[Mod API Reference:TextAlignmentOptions|WL.TextAlignmentOptions]]
* [[Mod API Reference:TickCount|WL.TickCount]]

[[Category:Mod API Reference]]

Mod API Reference:WL

2025-03-31T13:39:50Z

DanWL60: /* Game Order */ add TerritoryAnnotation

== Army Related ==
* [[Mod_API_Reference:Armies|WL.Armies]]
* [[Mod_API_Reference:Boss1|WL.Boss1]]
* [[Mod_API_Reference:Boss2|WL.Boss2]]
* [[Mod_API_Reference:Boss3|WL.Boss3]]
* [[Mod_API_Reference:Boss4|WL.Boss4]]
* [[Mod_API_Reference:Commander|WL.Commander]]
* [[Mod_API_Reference:CustomSpecialUnit|WL.CustomSpecialUnitBuilder]]
* [[Mod_API_Reference:IncomeMod|WL.IncomeMod]]
* [[Mod_API_Reference:ResourceType|WL.ResourceType]]

== Game Order ==
* [[Mod API Reference:AttackTransferEnum|WL.AttackTransferEnum]]
* [[Mod API Reference:GameOrderAttackTransfer|WL.GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderCustom|WL.GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|WL.GameOrderDeploy]]
* [[Mod API Reference:GameOrderEvent|WL.GameOrderEvent]]
* [[Mod API Reference:TerritoryAnnotation|WL.TerritoryAnnotation]]
* [[Mod API Reference:TerritoryModification|WL.TerritoryModification]]
* [[Mod API Reference:TurnPhase|WL.TurnPhase]]
=== Card ===
* [[Mod API Reference:GameOrderDiscard|WL.GameOrderDiscard]]
* [[Mod API Reference:GameOrderReceiveCard|WL.GameOrderReceiveCard]]
* [[Mod API Reference:NoParameterCardInstance|WL.NoParameterCardInstance]]
* [[Mod API Reference:ReinforcementCardInstance|WL.ReinforcementCardInstance]]
==== Play Card ====
* [[Mod API Reference:GameOrderPlayCardAbandon|WL.GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|WL.GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardBlockade|WL.GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|WL.GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|WL.GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardGift|WL.GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|WL.GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|WL.GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|WL.GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|WL.GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|WL.GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|WL.GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|WL.GameOrderPlayCardSurveillance]]

== Settings ==
* [[Mod_API_Reference:CustomScenario|WL.CustomScenario]]
* [[Mod API Reference:MoveOrderEnum|WL.MoveOrderEnum]]
* [[Mod_API_Reference:GameFogLevel|WL.GameFogLevel]]
* [[Mod_API_Reference:RoundingModeEnum|WL.RoundingModeEnum]]
=== Cards ===
* [[Mod_API_Reference:CardGameAbandon|WL.CardGameAbandon]]
* [[Mod_API_Reference:CardGameAirlift|WL.CardGameAirlift]]
* [[Mod_API_Reference:CardGameBlockade|WL.CardGameBlockade]]
* [[Mod_API_Reference:CardGameBomb|WL.CardGameBomb]]
* [[Mod_API_Reference:CardGameDiplomacy|WL.CardGameDiplomacy]]
* [[Mod_API_Reference:CardGameGift|WL.CardGameGift]]
* [[Mod_API_Reference:CardGameOrderDelay|WL.CardGameOrderDelay]]
* [[Mod_API_Reference:CardGameOrderPriority|WL.CardGameOrderPriority]]
* [[Mod_API_Reference:CardGameReconnaissance|WL.CardGameReconnaissance]]
* [[Mod_API_Reference:CardGameReinforcement|WL.CardGameReinforcement]]
* [[Mod_API_Reference:CardGameSanctions|WL.CardGameSanctions]]
* [[Mod_API_Reference:CardGameSpy|WL.CardGameSpy]]
* [[Mod_API_Reference:CardGameSurveillance|WL.CardGameSurveillance]]

== Other ==
* [[Mod_API_Reference:ActiveCardExpireBehaviorOptions|WL.ActiveCardExpireBehaviorOptions]]
* [[Mod_API_Reference:CardID|WL.CardID]]
* [[Mod API Reference:FogMod|WL.FogMod]]
* [[Mod API Reference:GamePlayerState|WL.GamePlayerState]]
* [[Mod API Reference:GameState|WL.GameState]]
* [[Mod API Reference:IsVersionOrHigher|WL.IsVersionOrHigher]]
* [[Mod API Reference:PlayerID|WL.PlayerID]]
* [[Mod API Reference:PlayerCards|WL.PlayerCards]]
* [[Mod API Reference:RectangleVM|WL.RectangleVM]]
* [[Mod API Reference:ReinforcementCardMode|WL.ReinforcementCardMode]]
* [[Mod API Reference:StandingFogLevel|WL.StandingFogLevel]]
* [[Mod API Reference:StructureType|WL.StructureType]]
* [[Mod API Reference:TerritoryConnectionWrap|WL.TerritoryConnectionWrap]]
* [[Mod API Reference:TickCount|WL.TickCount]]

[[Category:Mod API Reference]]

Mod API Reference

2025-03-31T13:22:16Z

DanWL60: /* Newer API features */

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
| Features
|-
| 5.34.1
| [[Mod Hooks#Client Hooks|Client_CreateGame]] Add TerritoryAnnotationsOpt to [[Mod API Reference:GameOrderEvent|GameOrderEvent]], [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add JumpToActionSpotOpt to [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add parameter 9 (ActiveCardExpireBehaviorOptions) to addCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add optional parameters 4 and 5 to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add MinWidth and MinHeight to all [[Mod API Reference:UI|UI]] elements Add Alignment to UI Label element Fixed a bug that caused stack traces to not show up in mod errors in some cases in Unity Fixed fog mods on No-Fog games from giving errors Fixed skipping of deploy orders in Client_GameOrderCreated making the deployment status report incorrectly Fixed copying a game that used a mod that used the Server_Created hook
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can't transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference

2025-03-31T13:18:47Z

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

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
| Features
|-
| 5.34.1
| [[Mod Hooks#Client Hooks|Client_CreateGame]] Add TerritoryAnnotationsOpt to [[Mod API Reference:GameOrderEvent|GameOrderEvent]], [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add JumpToActionSpotOpt to [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add parameter 9 (ActiveCardExpireBehaviorOptions) to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add optional parameters 4 and 5 to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add MinWidth and MinHeight to all [[Mod API Reference:UI|UI]] elements Add Alignment to UI Label element Fixed a bug that caused stack traces to not show up in mod errors in some cases in Unity Fixed fog mods on No-Fog games from giving errors Fixed skipping of deploy orders in Client_GameOrderCreated making the deployment status report incorrectly Fixed copying a game that used a mod that used the Server_Created hook
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can't transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference

2025-03-31T13:11:44Z

DanWL60: /* Newer API features */

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
| Features
|-
| 5.34.1
| Add TerritoryAnnotationsOpt to [[Mod API Reference:GameOrderEvent|GameOrderEvent]], [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add JumpToActionSpotOpt to [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add parameter 9 (ActiveCardExpireBehaviorOptions) to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add optional parameters 4 and 5 to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add MinWidth and MinHeight to all [[Mod API Reference:UI|UI]] elements Add Alignment to UI Label element
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can't transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference

2025-03-31T13:11:03Z

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

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
| Features
|-
| 5.34.1
| Add TerritoryAnnotationsOpt to [[Mod API Reference:GameOrderEvent|GameOrderEvent]], [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add JumpToActionSpotOpt to [[Mod API Reference:GameOrderCustom|GameOrderCustom]] and [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]] Add parameter 9 (ActiveCardExpireBehaviorOptions) to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add optional parameters 4 and 5 to playCard when using [[Mod API Reference:Custom Cards|Custom Cards]] Add MinWidth and MinHeight to all [[Help
Mod API Reference:UI|UI]] elements Add Alignment to UI Label element
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can't transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Spy, Reconnaissance, and Surveillance Cards

2025-03-24T05:59:15Z

DanWL60: /* Surveillance Card */

In a fog game, these cards allow you to view territories through the [[fog]]. Simply play it, choose the destination, and next turn you will see those territories as well as any attacks that happen in those territories.

What you see on this turn will always be available via the History button later if you return to the turn where you played the card.

Game creators can configure the number of turns that the card lasts for.

== Reconnaissance Card ==
<table>
<tr>
<td style="vertical-align: top; width: 100%;">
Allows you to choose a [[territory]]. You will be able to see the selected territory and all adjacent territories.
</td>
<td style="vertical-align: top;">
{{Card infobox
|name=Reconnaissance Card
|img=https://warzonecdn.com/ujs/Resources/ReconCard.png
|extra={{Card infobox/row|Duration}}
}}
</td>
</tr>
</table>

== Surveillance Card ==
<table>
<tr>
<td style="vertical-align: top; width: 100%;">
Allows you to choose a [[bonus]]. You will be able to see every territory in that bonus.
</td>
<td style="vertical-align: top;">
{{Card infobox
|name=Surveillance Card
|img=https://warzonecdn.com/ujs/Resources/SurvCard.png
|extra={{Card infobox/row|Duration}}
}}
</td>
</tr>
</table>

== Spy Card ==
<table>
<tr>
<td style="vertical-align: top; width: 100%;">
Allows you to choose an opponent. You will be able to see every territory controlled by the selected opponent. If the game creator enables it, you can also spy on Neutral.
</td>
<td style="vertical-align: top;">
{{Card infobox
|name=Spy Card
|img=https://warzonecdn.com/ujs/Resources/SpyCard.png
|extra={{Card infobox/row|Duration}}{{Card infobox/row|Can spy on neutral}}
}}
</td>
</tr>
</table>

== See also ==
* [[Cards]]

{{Cards}}

[[Category:Cards]]

Custom Card Package 2

2025-03-22T11:52:20Z

DanWL60:

{{Deleted Mod}}

{{Mod infobox main
|name=Custom Card Package 2
|creatorToken=9522268564
|creatorName=DanWL
|madePublicOnYear=2023
|madePublicOnMonth=09
|madePublicOnDay=01

|tags={{ModtagMain|Diplomacy}} {{ModtagMain|Strategic}} {{ModtagMain|Commerce}}
|appversion=5.22
|source=https://github.com/DanWaLes/Warzone/tree/main/mods/Custom%20Card%20Package%202
}}

This [[mod]] adds more custom [[cards]] to the game. To view which cards you have and play any, see Game > Mod: Custom Card Package 2.

== Cards ==
All these cards can:
* Have a customizable number of pieces to split the card into
* Have a fixed amount of pieces awarded per turn
* Have initial starting pieces given to all players
* Be [[commerce|bought]] (using [[gold]])
* Have pieces awarded regardless of having any successful attacks

=== Double Tap ===
Allows you to make a second attack/transfer from a territory that you already issued an attack/transfer from. The attack must have failed for the card to take affect.

=== Immobilize ===
Prevents all army movement (including [[airlift card|airlifts]]) to and from a territory that is next to or is one of yours.

The duration of the card is customizable.

=== Reconnaissance+ ===
[[Reconnaissance Card]]s with customizable range.
Note that Reconnaissance Cards must be enabled in the game settings to use this card. You should set the card weight to 0 or minimum pieces earned per turn to 0 to prevent normal Reconnaissance Card pieces from being earned.
Currently this card lasts 1 turn, rather than the amount set by the Reconnaissance Card.

=== Recycle ===
Sets the number armies on a territory to be the amount that was on it on the first turn and changes the owner to neutral. The armies that used to be on the territory get added to your income. Can only be played on one of your own territories.

It is optional to have recycling [[Commanders]] to cause elimination.

=== Rushed Blockade ===
Like normal [[Blockade Cards]] but happen during the [[turn phases|attacks phase]].

=== Trap ===
Like [[Blockade Cards]] except the territory become neutral when an enemy captures it.

It is optional to have trapping [[Commanders]] to cause elimination.

{{Cards}}

Custom Card Package 2

2025-03-22T11:51:21Z

DanWL60: removed card design request mention. the request is already on forum and that has higher visibility

{{Deleted Mod}}

{{Mod infobox main
|name=Custom Card Package 2
|creatorToken=9522268564
|creatorName=DanWL
|madePublicOnYear=2023
|madePublicOnMonth=09
|madePublicOnDay=01

|tags={{ModtagMain|Diplomacy}} {{ModtagMain|Strategic}} {{ModtagMain|Commerce}}
|appversion=5.22
|source=https://github.com/DanWaLes/Warzone/tree/main/mods/Custom%20Card%20Package%202
}}

This [[mods|mod]] adds more custom [[cards]] to the game. To view which cards you have and play any, see Game > Mod: Custom Card Package 2.

== Cards ==
All these cards can:
* Have a customizable number of pieces to split the card into
* Have a fixed amount of pieces awarded per turn
* Have initial starting pieces given to all players
* Be [[commerce|bought]] (using [[gold]])
* Have pieces awarded regardless of having any successful attacks

=== Double Tap ===
Allows you to make a second attack/transfer from a territory that you already issued an attack/transfer from. The attack must have failed for the card to take affect.

=== Immobilize ===
Prevents all army movement (including [[airlift card|airlifts]]) to and from a territory that is next to or is one of yours.

The duration of the card is customisable.

=== Reconnaissance+ ===
[[Reconnaissance Card]]s with customizable range.
Note that Reconnaissance Cards must be enabled in the game settings to use this card. You should set the card weight to 0 or minimum pieces earned per turn to 0 to prevent normal Reconnaissance Card pieces from being earned.
Currently this card lasts 1 turn, rather than the amount set by the Reconnaissance Card.

=== Recycle ===
Sets the number armies on a territory to be the amount that was on it on the first turn and changes the owner to neutral. The armies that used to be on the territory get added to your income. Can only be played on one of your own territories.

It is optional to have recycling [[Commanders]] to cause elimination.

=== Rushed Blockade ===
Like normal [[Blockade Cards]] but happen during the [[turn phases|attacks phase]].

=== Trap ===
Like [[Blockade Cards]] except the territory become neutral when an enemy captures it.

It is optional to have trapping [[Commanders]] to cause elimination.

{{Cards}}

Levels

2025-03-15T20:52:47Z

DanWL60: Being highest levelled player isn’t a reward

By earning [[points]], players can gain '''levels'''. Gaining levels unlocks additional features or [[map]]s that players can use, among other things.

== Levels don't make you stronger ==
The idea of leveling up is familiar to anyone who's played an RPG. However, Warzone’s leveling system has an important distinction: In Warzone, levels don’t actually make you stronger. Warzone is fundamentally a competitive strategy game, and games will always be won or lost based on your strategy alone. Levels will not do anything that gives you an advantage in a game. It’s just as easy for a level 1 player to defeat a level 30 player as it is for a level 40 player.

== Rewards ==
Leveling up unlocks rewards. Once a reward is unlocked, you have it permanently.

{| class="wikitable" width="90%"
|-
! width="5%" | Level
! width="5%" | Points (Delta)
! width="5%" | Points (Sum)
! width="40%" | Reward
|-
| style="text-align:center;" | 2 || style="text-align:right;" | 7,000 || style="text-align:right;" | 7,000 || Can create 6 player games
|-
| style="text-align:center;" | 3 || style="text-align:right;" | 7,300 || style="text-align:right;" | 14,300 || Can join tournaments
|-
| style="text-align:center;" | 4 || style="text-align:right;" | 7,800 || style="text-align:right;" | 22,100 || Can post to the [[forums]] (all except [[Ladder]])
|-
| style="text-align:center;" | 5 || style="text-align:right;" | 8,100 || style="text-align:right;" | 30,200 || Three days of ad-free play
|-
| style="text-align:center;" | 6 || style="text-align:right;" | 8,600 || style="text-align:right;" | 38,800|| Can create 7 player games
|-
| style="text-align:center;" | 7 || style="text-align:right;" | 9,100 || style="text-align:right;" | 47,900|| Can use the [[Statistics Window]]
|-
| style="text-align:center;" | 8 || style="text-align:right;" | 9,500 || style="text-align:right;" | 57,400|| Can include the [[Diplomacy Card]] when creating games
|-
| style="text-align:center;" | 9 || style="text-align:right;" | 10,000 || style="text-align:right;" | 67,400|| Can create 8 player games
|-
| style="text-align:center;" | 10 || style="text-align:right;" | 10,500 || style="text-align:right;" | 77,900|| Can include the [[Emergency Blockade Card]] when creating games
|-
| style="text-align:center;" | 11 || style="text-align:right;" | 11,100 || style="text-align:right;" | 89,000|| Can use [[Open Seat Prerequisites]] when creating games
|-
| style="text-align:center;" | 12 || style="text-align:right;" | 11,700 || style="text-align:right;" | 100,700|| Can create 10 player games
|-
| style="text-align:center;" | 13 || style="text-align:right;" | 12,300 || style="text-align:right;" | 113,000|| Can create [[tournaments]]
|-
| style="text-align:center;" | 14 || style="text-align:right;" | 12,900 || style="text-align:right;" | 125,900|| Can include the [[Airlift Card]] when creating games
|-
| style="text-align:center;" | 15 || style="text-align:right;" | 13,600 || style="text-align:right;" | 139,500|| Can create 12 player games
|-
| style="text-align:center;" | 16 || style="text-align:right;" | 14,300 || style="text-align:right;" | 153,800|| Can use [[vacations]]
|-
| style="text-align:center;" | 17 || style="text-align:right;" | 15,100 || style="text-align:right;" | 168,900|| Can include the [[Sanctions Card]] when creating games
|-
| style="text-align:center;" | 18 || style="text-align:right;" | 15,900 || style="text-align:right;" | 184,800|| Can create 14 player games
|-
| style="text-align:center;" | 19 || style="text-align:right;" | 16,700 || style="text-align:right;" | 201,500|| Can use the [[extra armies for territories]] setting when creating games
|-
| style="text-align:center;" | 20 || style="text-align:right;" | 17,600 || style="text-align:right;" | 219,100|| Can change the [[offensive and defensive kill rate]] when creating games
|-
| style="text-align:center;" | 21 || style="text-align:right;" | 18,500 || style="text-align:right;" | 237,600|| Can create 16 player games
|-
| style="text-align:center;" | 22 || style="text-align:right;" | 19,400 || style="text-align:right;" | 257,000|| Can have two created [[tournaments]] at a time
|-
| style="text-align:center;" | 23 || style="text-align:right;" | 20,500 || style="text-align:right;" | 277,500|| Can include the [[spy card]], [[surveillance card]], and [[reconnaissance card]] when creating games
|-
| style="text-align:center;" | 24 || style="text-align:right;" | 21,600 || style="text-align:right;" | 299,100|| Can create 18 player games
|-
| style="text-align:center;" | 25 || style="text-align:right;" | 22,700 || style="text-align:right;" | 321,800|| Can include [[wastelands]] when creating games
|-
| style="text-align:center;" | 26 || style="text-align:right;" | 23,900 || style="text-align:right;" | 345,700|| Can enable the [[attack only and transfer only]] settings when creating games
|-
| style="text-align:center;" | 27 || style="text-align:right;" | 25,100 || style="text-align:right;" | 370,800|| Can create 20 player games
|-
| style="text-align:center;" | 28 || style="text-align:right;" | 26,400 || style="text-align:right;" | 397,200|| Can include the [[blockade card]] when creating games
|-
| style="text-align:center;" | 29 || style="text-align:right;" | 27,900 || style="text-align:right;" | 425,100|| Can take up to 3 [[vacations]] per year
|-
| style="text-align:center;" | 30 || style="text-align:right;" | 29,300 || style="text-align:right;" | 454,400|| Can create 22 player games
|-
| style="text-align:center;" | 31 || style="text-align:right;" | 30,800 || style="text-align:right;" | 485,200|| Can enable the [[local deployments]] setting when creating games
|-
| style="text-align:center;" | 32 || style="text-align:right;" | 32,500 || style="text-align:right;" | 517,700|| Can have up to three created [[tournaments]] at a time
|-
| style="text-align:center;" | 33 || style="text-align:right;" | 34,200 || style="text-align:right;" | 551,900|| Can create 24 player games
|-
| style="text-align:center;" | 34 || style="text-align:right;" | 35,900 || style="text-align:right;" | 587,800|| Can use Dense, Heavy, and Complete [[fog]] levels
|-
| style="text-align:center;" | 35 || style="text-align:right;" | 37,900 || style="text-align:right;" | 625,700|| Can include the [[gift card]] when creating games
|-
| style="text-align:center;" | 36 || style="text-align:right;" | 39,800 || style="text-align:right;" | 665,500|| Can create 26 player games
|-
| style="text-align:center;" | 37 || style="text-align:right;" | 41,900 || style="text-align:right;" | 707,400|| Can enable [[multi-attack]] and [[attack by percentage]] settings when creating games
|-
| style="text-align:center;" | 38 || style="text-align:right;" | 44,200 || style="text-align:right;" | 751,600|| Can have up to four created [[tournaments]] at a time, and use [[commanders]] when creating games
|-
| style="text-align:center;" | 39 || style="text-align:right;" | 46,400 || style="text-align:right;" | 798,000|| Can create 28 player games
|-
| style="text-align:center;" | 40 || style="text-align:right;" | 48,900 || style="text-align:right;" | 846,900|| Can enable [[no-split mode]] when creating games
|-
| style="text-align:center;" | 41 || style="text-align:right;" | 51,400 || style="text-align:right;" | 898,300|| Can include the [[order priority card]] and [[order delay card]] when creating games
|-
| style="text-align:center;" | 42 || style="text-align:right;" | 54,100 || style="text-align:right;" | 952,400|| Can create 30 player games
|-
| style="text-align:center;" | 43 || style="text-align:right;" | 57,000 || style="text-align:right;" | 1,009,400|| Can have up to five created [[tournaments]] at a time
|-
| style="text-align:center;" | 44 || style="text-align:right;" | 60,000 || style="text-align:right;" | 1,069,400|| Can create 32 player games
|-
| style="text-align:center;" | 45 || style="text-align:right;" | 63,100 || style="text-align:right;" | 1,132,500|| Can [[override bonuses]] when creating games
|-
| style="text-align:center;" | 46 || style="text-align:right;" | 66,400 || style="text-align:right;" | 1,198,900|| Can create 34 player games
|-
| style="text-align:center;" | 47 || style="text-align:right;" | 69,900 || style="text-align:right;" | 1,268,800|| Can use [[custom scenarios]] when creating multi-player games
|-
| style="text-align:center;" | 48 || style="text-align:right;" | 73,600 || style="text-align:right;" | 1,342,400|| Can join the [[1 v 1 Ladder]]
|-
| style="text-align:center;" | 49 || style="text-align:right;" | 77,400 || style="text-align:right;" | 1,419,800|| Can take up to 5 [[vacations]] per year
|-
| style="text-align:center;" | 50 || style="text-align:right;" | 81,500 || style="text-align:right;" | 1,501,300|| Can create 37 player games
|-
| style="text-align:center;" | 51 || style="text-align:right;" | 85,800 || style="text-align:right;" | 1,587,100|| Can join the [[2 v 2 Ladder]]
|-
| style="text-align:center;" | 52 || style="text-align:right;" | 90,300 || style="text-align:right;" | 1,677,400 || Can join the [[Seasonal Ladder]]
|-
| style="text-align:center;" | 53 || style="text-align:right;" | 95,000 || style="text-align:right;" | 1,772,400 || Can create 40 player games
|-
| style="text-align:center;" | 54 || style="text-align:right;" | 100,000 || style="text-align:right;" | 1,872,400 || Can join the [[3 v 3 Ladder]]
|-
| style="text-align:center;" | 55 || style="text-align:right;" | 220,400 || style="text-align:right;" | 2,092,800 || -
|-
| style="text-align:center;" | 56 || style="text-align:right;" | 479,000 || style="text-align:right;" | 2,571,800 || -
|-
| style="text-align:center;" | 57 || style="text-align:right;" | 830,600 || style="text-align:right;" | 3,402,400 || -
|-
| style="text-align:center;" | 58 || style="text-align:right;" | 1,308,400 || style="text-align:right;" | 4,710,900 || -
|-
| style="text-align:center;" | 59 || style="text-align:right;" | 1,957,900 || style="text-align:right;" | 6,668,800 || -
|-
| style="text-align:center;" | 60 || style="text-align:right;" | 2,840,700 || style="text-align:right;" | 9,509,500 || -
|-
| style="text-align:center;" | 61 || style="text-align:right;" | 4,040,300 || style="text-align:right;" | 13,549,800 || -
|-
| style="text-align:center;" | 62 || style="text-align:right;" | 5,670,900 || style="text-align:right;" | 19,220,700 || -
|-
| style="text-align:center;" | 63 || style="text-align:right;" | 7,886,900 || style="text-align:right;" | 27,107,600 || -
|-
| style="text-align:center;" | 64 || style="text-align:right;" | 10,898,900 || style="text-align:right;" | 38,006,500 || -
|-
| style="text-align:center;" | 65 || style="text-align:right;" | 14,992,400 || style="text-align:right;" | 52,998,900 || -
|-
| style="text-align:center;" | 66 || style="text-align:right;" | 20,556,000 || style="text-align:right;" | 73,554,900 || -
|-
| style="text-align:center;" | 67 || style="text-align:right;" | 28,117,800 || style="text-align:right;" | 101,672,700 || -
|-
| style="text-align:center;" | 68 || style="text-align:right;" | 38,394,900 || style="text-align:right;" | 140,067,600 || -
|-
| style="text-align:center;" | 69 || style="text-align:right;" | 52,362,900 || style="text-align:right;" | 192,430,500 || -
|-
| style="text-align:center;" | 70 || style="text-align:right;" | 71,347,000 || style="text-align:right;" | 263,777,500 || -
|}

== Map Levels ==
By gaining levels, players can gain access to additional maps. Players only need access to a map in order to ''create'' games or tournaments on that map. If they are invited to a game or tournament, they can always join it no matter what level they are.

Map creators are in full control of what level their maps unlock. As a map creator, you can log into your map at any time, click the "Edit Name/Description" button and set the level. You can do this even after it's public. If you want your map available to everyone regardless of their level, you can just set your map to level 1 and everyone will be able to use it.

The advantage of setting a level to your map is increased visibility. For example, if you set your map to level 10, whenever someone levels up to 10 it'll pop up a message on their screen letting them know they've unlocked your map. For best visibility, you should try to set your map to a level that has few other maps assigned to it (or at least, where your map is rated more highly than the others at that level.)

== See also ==
* [[Points]]
* [[Hidden settings]]

[[Category:Warzone]]

Levels

2025-03-15T20:51:30Z

DanWL60: Map creators can set unlock levels higher than 57

By earning [[points]], players can gain '''levels'''. Gaining levels unlocks additional features or [[map]]s that players can use, among other things.

== Levels don't make you stronger ==
The idea of leveling up is familiar to anyone who's played an RPG. However, Warzone’s leveling system has an important distinction: In Warzone, levels don’t actually make you stronger. Warzone is fundamentally a competitive strategy game, and games will always be won or lost based on your strategy alone. Levels will not do anything that gives you an advantage in a game. It’s just as easy for a level 1 player to defeat a level 30 player as it is for a level 40 player.

== Rewards ==
Leveling up unlocks rewards. Once a reward is unlocked, you have it permanently.

{| class="wikitable" width="90%"
|-
! width="5%" | Level
! width="5%" | Points (Delta)
! width="5%" | Points (Sum)
! width="40%" | Reward
|-
| style="text-align:center;" | 2 || style="text-align:right;" | 7,000 || style="text-align:right;" | 7,000 || Can create 6 player games
|-
| style="text-align:center;" | 3 || style="text-align:right;" | 7,300 || style="text-align:right;" | 14,300 || Can join tournaments
|-
| style="text-align:center;" | 4 || style="text-align:right;" | 7,800 || style="text-align:right;" | 22,100 || Can post to the [[forums]] (all except [[Ladder]])
|-
| style="text-align:center;" | 5 || style="text-align:right;" | 8,100 || style="text-align:right;" | 30,200 || Three days of ad-free play
|-
| style="text-align:center;" | 6 || style="text-align:right;" | 8,600 || style="text-align:right;" | 38,800|| Can create 7 player games
|-
| style="text-align:center;" | 7 || style="text-align:right;" | 9,100 || style="text-align:right;" | 47,900|| Can use the [[Statistics Window]]
|-
| style="text-align:center;" | 8 || style="text-align:right;" | 9,500 || style="text-align:right;" | 57,400|| Can include the [[Diplomacy Card]] when creating games
|-
| style="text-align:center;" | 9 || style="text-align:right;" | 10,000 || style="text-align:right;" | 67,400|| Can create 8 player games
|-
| style="text-align:center;" | 10 || style="text-align:right;" | 10,500 || style="text-align:right;" | 77,900|| Can include the [[Emergency Blockade Card]] when creating games
|-
| style="text-align:center;" | 11 || style="text-align:right;" | 11,100 || style="text-align:right;" | 89,000|| Can use [[Open Seat Prerequisites]] when creating games
|-
| style="text-align:center;" | 12 || style="text-align:right;" | 11,700 || style="text-align:right;" | 100,700|| Can create 10 player games
|-
| style="text-align:center;" | 13 || style="text-align:right;" | 12,300 || style="text-align:right;" | 113,000|| Can create [[tournaments]]
|-
| style="text-align:center;" | 14 || style="text-align:right;" | 12,900 || style="text-align:right;" | 125,900|| Can include the [[Airlift Card]] when creating games
|-
| style="text-align:center;" | 15 || style="text-align:right;" | 13,600 || style="text-align:right;" | 139,500|| Can create 12 player games
|-
| style="text-align:center;" | 16 || style="text-align:right;" | 14,300 || style="text-align:right;" | 153,800|| Can use [[vacations]]
|-
| style="text-align:center;" | 17 || style="text-align:right;" | 15,100 || style="text-align:right;" | 168,900|| Can include the [[Sanctions Card]] when creating games
|-
| style="text-align:center;" | 18 || style="text-align:right;" | 15,900 || style="text-align:right;" | 184,800|| Can create 14 player games
|-
| style="text-align:center;" | 19 || style="text-align:right;" | 16,700 || style="text-align:right;" | 201,500|| Can use the [[extra armies for territories]] setting when creating games
|-
| style="text-align:center;" | 20 || style="text-align:right;" | 17,600 || style="text-align:right;" | 219,100|| Can change the [[offensive and defensive kill rate]] when creating games
|-
| style="text-align:center;" | 21 || style="text-align:right;" | 18,500 || style="text-align:right;" | 237,600|| Can create 16 player games
|-
| style="text-align:center;" | 22 || style="text-align:right;" | 19,400 || style="text-align:right;" | 257,000|| Can have two created [[tournaments]] at a time
|-
| style="text-align:center;" | 23 || style="text-align:right;" | 20,500 || style="text-align:right;" | 277,500|| Can include the [[spy card]], [[surveillance card]], and [[reconnaissance card]] when creating games
|-
| style="text-align:center;" | 24 || style="text-align:right;" | 21,600 || style="text-align:right;" | 299,100|| Can create 18 player games
|-
| style="text-align:center;" | 25 || style="text-align:right;" | 22,700 || style="text-align:right;" | 321,800|| Can include [[wastelands]] when creating games
|-
| style="text-align:center;" | 26 || style="text-align:right;" | 23,900 || style="text-align:right;" | 345,700|| Can enable the [[attack only and transfer only]] settings when creating games
|-
| style="text-align:center;" | 27 || style="text-align:right;" | 25,100 || style="text-align:right;" | 370,800|| Can create 20 player games
|-
| style="text-align:center;" | 28 || style="text-align:right;" | 26,400 || style="text-align:right;" | 397,200|| Can include the [[blockade card]] when creating games
|-
| style="text-align:center;" | 29 || style="text-align:right;" | 27,900 || style="text-align:right;" | 425,100|| Can take up to 3 [[vacations]] per year
|-
| style="text-align:center;" | 30 || style="text-align:right;" | 29,300 || style="text-align:right;" | 454,400|| Can create 22 player games
|-
| style="text-align:center;" | 31 || style="text-align:right;" | 30,800 || style="text-align:right;" | 485,200|| Can enable the [[local deployments]] setting when creating games
|-
| style="text-align:center;" | 32 || style="text-align:right;" | 32,500 || style="text-align:right;" | 517,700|| Can have up to three created [[tournaments]] at a time
|-
| style="text-align:center;" | 33 || style="text-align:right;" | 34,200 || style="text-align:right;" | 551,900|| Can create 24 player games
|-
| style="text-align:center;" | 34 || style="text-align:right;" | 35,900 || style="text-align:right;" | 587,800|| Can use Dense, Heavy, and Complete [[fog]] levels
|-
| style="text-align:center;" | 35 || style="text-align:right;" | 37,900 || style="text-align:right;" | 625,700|| Can include the [[gift card]] when creating games
|-
| style="text-align:center;" | 36 || style="text-align:right;" | 39,800 || style="text-align:right;" | 665,500|| Can create 26 player games
|-
| style="text-align:center;" | 37 || style="text-align:right;" | 41,900 || style="text-align:right;" | 707,400|| Can enable [[multi-attack]] and [[attack by percentage]] settings when creating games
|-
| style="text-align:center;" | 38 || style="text-align:right;" | 44,200 || style="text-align:right;" | 751,600|| Can have up to four created [[tournaments]] at a time, and use [[commanders]] when creating games
|-
| style="text-align:center;" | 39 || style="text-align:right;" | 46,400 || style="text-align:right;" | 798,000|| Can create 28 player games
|-
| style="text-align:center;" | 40 || style="text-align:right;" | 48,900 || style="text-align:right;" | 846,900|| Can enable [[no-split mode]] when creating games
|-
| style="text-align:center;" | 41 || style="text-align:right;" | 51,400 || style="text-align:right;" | 898,300|| Can include the [[order priority card]] and [[order delay card]] when creating games
|-
| style="text-align:center;" | 42 || style="text-align:right;" | 54,100 || style="text-align:right;" | 952,400|| Can create 30 player games
|-
| style="text-align:center;" | 43 || style="text-align:right;" | 57,000 || style="text-align:right;" | 1,009,400|| Can have up to five created [[tournaments]] at a time
|-
| style="text-align:center;" | 44 || style="text-align:right;" | 60,000 || style="text-align:right;" | 1,069,400|| Can create 32 player games
|-
| style="text-align:center;" | 45 || style="text-align:right;" | 63,100 || style="text-align:right;" | 1,132,500|| Can [[override bonuses]] when creating games
|-
| style="text-align:center;" | 46 || style="text-align:right;" | 66,400 || style="text-align:right;" | 1,198,900|| Can create 34 player games
|-
| style="text-align:center;" | 47 || style="text-align:right;" | 69,900 || style="text-align:right;" | 1,268,800|| Can use [[custom scenarios]] when creating multi-player games
|-
| style="text-align:center;" | 48 || style="text-align:right;" | 73,600 || style="text-align:right;" | 1,342,400|| Can join the [[1 v 1 Ladder]]
|-
| style="text-align:center;" | 49 || style="text-align:right;" | 77,400 || style="text-align:right;" | 1,419,800|| Can take up to 5 [[vacations]] per year
|-
| style="text-align:center;" | 50 || style="text-align:right;" | 81,500 || style="text-align:right;" | 1,501,300|| Can create 37 player games
|-
| style="text-align:center;" | 51 || style="text-align:right;" | 85,800 || style="text-align:right;" | 1,587,100|| Can join the [[2 v 2 Ladder]]
|-
| style="text-align:center;" | 52 || style="text-align:right;" | 90,300 || style="text-align:right;" | 1,677,400 || Can join the [[Seasonal Ladder]]
|-
| style="text-align:center;" | 53 || style="text-align:right;" | 95,000 || style="text-align:right;" | 1,772,400 || Can create 40 player games
|-
| style="text-align:center;" | 54 || style="text-align:right;" | 100,000 || style="text-align:right;" | 1,872,400 || Can join the [[3 v 3 Ladder]]
|-
| style="text-align:center;" | 55 || style="text-align:right;" | 220,400 || style="text-align:right;" | 2,092,800 || -
|-
| style="text-align:center;" | 56 || style="text-align:right;" | 479,000 || style="text-align:right;" | 2,571,800 || -
|-
| style="text-align:center;" | 57 || style="text-align:right;" | 830,600 || style="text-align:right;" | 3,402,400 || -
|-
| style="text-align:center;" | 58 || style="text-align:right;" | 1,308,400 || style="text-align:right;" | 4,710,900 || -
|-
| style="text-align:center;" | 59 || style="text-align:right;" | 1,957,900 || style="text-align:right;" | 6,668,800 || -
|-
| style="text-align:center;" | 60 || style="text-align:right;" | 2,840,700 || style="text-align:right;" | 9,509,500 || -
|-
| style="text-align:center;" | 61 || style="text-align:right;" | 4,040,300 || style="text-align:right;" | 13,549,800 || -
|-
| style="text-align:center;" | 62 || style="text-align:right;" | 5,670,900 || style="text-align:right;" | 19,220,700 || -
|-
| style="text-align:center;" | 63 || style="text-align:right;" | 7,886,900 || style="text-align:right;" | 27,107,600 || -
|-
| style="text-align:center;" | 64 || style="text-align:right;" | 10,898,900 || style="text-align:right;" | 38,006,500 || -
|-
| style="text-align:center;" | 65 || style="text-align:right;" | 14,992,400 || style="text-align:right;" | 52,998,900 || -
|-
| style="text-align:center;" | 66 || style="text-align:right;" | 20,556,000 || style="text-align:right;" | 73,554,900 || -
|-
| style="text-align:center;" | 67 || style="text-align:right;" | 28,117,800 || style="text-align:right;" | 101,672,700 || -
|-
| style="text-align:center;" | 68 || style="text-align:right;" | 38,394,900 || style="text-align:right;" | 140,067,600 || -
|-
| style="text-align:center;" | 69 || style="text-align:right;" | 52,362,900 || style="text-align:right;" | 192,430,500 || Highest players levels for now (
|-
| style="text-align:center;" | 70 || style="text-align:right;" | 71,347,000 || style="text-align:right;" | 263,777,500 || -
|}

== Map Levels ==
By gaining levels, players can gain access to additional maps. Players only need access to a map in order to ''create'' games or tournaments on that map. If they are invited to a game or tournament, they can always join it no matter what level they are.

Map creators are in full control of what level their maps unlock. As a map creator, you can log into your map at any time, click the "Edit Name/Description" button and set the level. You can do this even after it's public. If you want your map available to everyone regardless of their level, you can just set your map to level 1 and everyone will be able to use it.

The advantage of setting a level to your map is increased visibility. For example, if you set your map to level 10, whenever someone levels up to 10 it'll pop up a message on their screen letting them know they've unlocked your map. For best visibility, you should try to set your map to a level that has few other maps assigned to it (or at least, where your map is rated more highly than the others at that level.)

== See also ==
* [[Points]]
* [[Hidden settings]]

[[Category:Warzone]]

Mod API Reference:UI

2025-03-11T14:16:44Z

DanWL60: /* UI Elements */ mention in which version RadioButton added in

Mods can put UI (user interface) onto the screen when called from one of the Client '''Present''' [[Mod Hooks|hooks]]. This page describes how to create and update UI elements.

UI elements are created by accessing the <code>UI</code> global. For example, mods can call UI.CreateButton(...) to create a button. Any UI element listed below can be created in a similar manner.

Behind the scenes, these objects are implemented using Unity's UI and layout system. Being familiar with Unity's UI system will make understanding how to build UI easier, but it's not a requirement.

== Parents ==
All UI constructors take a single <code>parent</code> argument. This allows you to construct hierarchies. For example, mods can create a vertical stack of three buttons like this:

local vert = UI.CreateVerticalLayoutGroup(rootParent);
local btn1 = UI.CreateButton(vert);
local btn2 = UI.CreateButton(vert);
local btn3 = UI.CreateButton(vert);

When a mod is called to present UI, it will be passed a root UI element (rootParent). Your mod should pass the rootParent to a UI element that will be the root of all other elements you need. This element is most often a VerticalLayoutGroup, as shown in the example above.

You can never make more than one element a child of the rootParent. If you need more than one, simply make your own container to house them.

== Properties ==

UI elements have properties that can be read or set. For example, Buttons have a Text property that allows you to set the text that appears on the button.

To read or write a UI element's property, you must use getter/setter functions named GetX() and SetX(). For example, to set the text of a button you can write <code>btn1.SetText('Click me!')</code> and can retrieve it using <code>btn1.GetText()</code>.

All getter and setter functions return the UI element, which means you can chain them together to easily set lots of properties. For example:

UI.CreateButton(vert)
.SetText('Click me!')
.SetColor('#00FF00')
.SetOnClick(someFunction);

== Common Properties ==

All UI elements have the following properties:
* '''PreferredWidth''' ''number'': How wide the element prefers to be. It may not be this wide if there is not enough space, and it may be wider if FlexibleWidth is greater than 0. Defaults to -1, which is a special value meaning the object will meansure its own size based on its contents.
* '''PreferredHeight''' ''number'': How tall the element prefers to be. It may not be this tall if there is not enough space, and it may be taller if FlexibleHeight is greater than 0. Defaults to -1, which is a special value meaning the object will meansure its own size based on its contents.
* '''FlexibleWidth''' ''number'': A number from 0 to 1 indicating how much of the remaining space this element wishes to take up. Defaults to 0, which means the element will be no wider than PreferredWidth. Set it to 1 to indicate the object should grow to encompass all remaining horizontal space it can.
* '''FlexibleHeight''' ''number'': A number from 0 to 1 indicating how much of the remaining space this element wishes to take up. Defaults to 0, which means the element will be no taller than PreferredHeight. Set it to 1 to indicate the object should grow to encompass all remaining vertical space it can.

== UI Elements ==

'''Empty''': A simple UI element that displays nothing. This can be used as a container or to create space.

'''VerticalLayoutGroup''': A container that stacks its children vertically.

'''HorizontalLayoutGroup''': A container that stacks its children horizontally.

'''Label''': A way to display text on the screen.
* '''Text''' ''string'': The text to display.
* '''Color''' ''string'': The color of the text. Pass this as a string in #RRGGBB format.

'''Button''': A button that players can click on to do something.
* '''Text''' ''string'': The text to display on the button.
* '''Color''' ''string'': The color of the button. Pass this as a string in #RRGGBB format. Only the following colors are supported for buttons:
{{Color2|BABABC}} {{Color2|6C73D1}} {{Color2|FF00ED}} {{Color2|FFC200}} {{Color2|00A0FF}} {{Color2|00B5FF}} {{Color2|F3FFAE}} {{Color2|43C731}} {{Color2|43C631}} {{Color2|1274A4}} {{Color2|1274A5}} {{Color2|B03B3B}} {{Color2|0021FF}} {{Color2|359029}} {{Color2|00E9FF}} {{Color2|00FF21}} {{Color2|FFF700}} {{Color2|AA3A3A}} {{Color2|43C732}} {{Color2|00D4FF}} {{Color2|B03C3C}} {{Color2|00F4FF}} {{Color2|00BFFF}} {{Color2|4EC4FF}} {{Color2|615DDF}} {{Color2|100C08}} {{Color2|0000FF}} {{Color2|4EFFFF}} {{Color2|59009D}} {{Color2|008000}} {{Color2|FF7D00}} {{Color2|FF0000}} {{Color2|606060}} {{Color2|00FF05}} {{Color2|FF697A}} {{Color2|94652E}} {{Color2|00FF8C}} {{Color2|FF4700}} {{Color2|009B9D}} {{Color2|23A0FF}} {{Color2|AC0059}} {{Color2|FF87FF}} {{Color2|FFFF00}} {{Color2|943E3E}} {{Color2|FEFF9B}} {{Color2|AD7E7E}} {{Color2|B70AFF}} {{Color2|FFAF56}} {{Color2|FF00B1}} {{Color2|8EBE57}} {{Color2|DAA520}} {{Color2|990024}} {{Color2|00FFFF}} {{Color2|8F9779}} {{Color2|880085}} {{Color2|00755E}} {{Color2|FFE5B4}} {{Color2|4169E1}} {{Color2|FF43A4}} {{Color2|8DB600}} {{Color2|40826D}} {{Color2|C04000}} {{Color2|FFDDF4}} {{Color2|CD7F32}} {{Color2|C19A6B}} {{Color2|C09999}} {{Color2|B0BF1A}} {{Color2|3B7A57}} {{Color2|4B5320}} {{Color2|664C28}} {{Color2|893F45}} {{Color2|D2691E}} {{Color2|36454F}} {{Color2|FF00FF}} {{Color2|76FF7A}}
* '''TextColor''' ''string'': The color of the text on the button. Pass this as a string in #RRGGBB format.
* '''OnClick''' ''function'': Pass the name of a lua function to be called whenever the player clicks the button.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

'''CheckBox''': A toggleable check box that players can check and uncheck.
* '''IsChecked''' ''bool'': Whether the check box is checked or unchecked.
* '''Text''' ''string'': The label displayed to the right of the check box.
* '''OnValueChanged''' ''function'': Pass the name of a lua function to be called whenever the IsChecked property changes, either by your code or by the player clicking the check box.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.

'''RadioButton''': Added in [[Mod API Reference:IsVersionOrHigher|5.34.0]]. Like a CheckBox except circular, and when assigned into a group, only one may be selected at a time.
* '''IsChecked''' ''bool'': Whether it's checked or unchecked.
* '''Text''' ''string'': The label displayed to the right of the radio button.
* '''OnValueChanged''' ''function'': Pass the name of a lua function to be called whenever the IsChecked property changes, either by your code or by the player clicking the check box.
* '''Interactable''' ''bool'': If false, the control will be grayed out and unusable by the player.
* '''Group''': ''RadioButtonGroup'': Created by using UI.CreateRadioButtonGroup. Create one group and assign it to multiple radio buttons to group them together. CreateRadioButtonGroup must be passed a UI element that it will live on. It does not matter what UI element you pass in as long as it doesn't get destroyed before the radio buttons. A common choice is to pass in the first radio button itself, or pass in the VerticalLayoutGroup that all the radio buttons live in together. For example:

local vert = UI.CreateVerticalLayoutGroup(rootParent);
local group = UI.CreateRadioButtonGroup(vert);
UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 1');
UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 2');
UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 3');
UI.CreateRadioButton(vert).SetGroup(group).SetText('Radio 4');

'''TextInputField''': A box where players can type a string.
* '''Text''' ''string'': The string that appears in the box, or that players typed.
* '''PlaceholderText''' ''string'': The text that appears in the box grayed out when it's empty. For example, "Enter name here..."
* '''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.

'''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.
* '''Value''' ''number'': The value to show in the box+slider, or the value entered by the player.
* '''WholeNumbers''' ''bool'': If true, only integers will be selectable by the player. If false, partial numbers will be selectable. Defaults to true.
* '''SliderMinValue''' ''number'': The minimum value selectable by the slider. Numbers below this can still be entered by typing them into the box, so ensure to always validate the number you retrieve.
* '''SliderMaxValue''' ''number'': The maxium value selectable by the slider. Numbers above this can still be entered by typing them into the box, so ensure to always validate the number you retrieve.
* '''BoxPreferredWidth''' ''number'': Allows setting the preferred width of just the box. 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.

== Helper Functions ==

'''UI.Destroy''': Destroys (removes) any UI that the mod previously created. Simply pass a UI element created by one of the UI.CreateXXX functions to UI.Destroy and it will disappear forever.

'''UI.IsDestroyed''': Tests if any UI element has been destroyed. Also returns true if passed nil.

'''UI.Alert''': Pops up a dialog with a message and an Okay button to close the message. Call this as simply <code>UI.Alert(msg)</code>. Only one mod can use this at a time.

'''UI.PromptFromList''': Pops up a dialog with a series of buttons to choose from. This takes two arguments:
* '''Message''' ''string'': Text to appear at the top of the dialog.
* '''Options''' ''array'': A list of options, each of which will show up as a button. Each entry in this array should be a table with two fields, '''text''' and '''selected'''. '''text''' populates the text that will appear on that button, and '''selected''' is a zero-argument function that gets called if the player selects that option.

'''UI.InterceptNextTerritoryClick''': Added in [[Mod_API_Reference:IsVersionOrHigher|5.17.0]]. After calling this function, the next time the player clicks a territory on the map, your mod will be notified of the click. After calling this, you should also instruct the player to click a territory, and it's also a good idea to let them know they can move dialogs out of the way to see the map.
* '''Callback''' ''function'': Pass a function that will be called on the next click. This function will be passed a [[Mod_API_Reference:TerritoryDetails|TerritoryDetails]] object, which can be used to get the Territory ID or the name of the territory that was clicked. This function can also be called with nil if the intercept request is cancelled, which can happen if another mod calls UI.InterceptNextTerritoryClick before a territory is clicked. If you want to cancel the intercept request, you can return WL.CancelClickIntercept from the callback which will make the client behave as if you never called intercept. Return nil, or leave off the return statement entirely, for normal operation.

'''UI.InterceptNextBonusLinkClick''': Added in [[Mod_API_Reference:IsVersionOrHigher|5.17.0]]. After calling this function, the next time the player clicks a bonus link on the map, your mod will be notified of the click. After calling this, you should also instruct the player to click a bonus link, and it's also a good idea to let them know they can move dialogs out of the way to see the map.
* '''Callback''' ''function'': Pass a function that will be called on the next click. This function will be passed a [[Mod_API_Reference:BonusDetails|BonusDetails]] object, which can be used to get the bonus ID or the name of the bonus that was clicked. This function can also be called with nil if the intercept request is cancelled, which can happen if another mod calls UI.InterceptNextBonusLinkClick before a bonus link is clicked. If you want to cancel the intercept request, you can return WL.CancelClickIntercept from the callback which will make the client behave as if you never called intercept. Return nil, or leave off the return statement entirely, for normal operation.

[[Category:Mod API Reference]]

Mod API Reference

2025-03-10T22:48:20Z

DanWL60: /* Newer API features */

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
! Features
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can't transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference

2025-03-10T22:44:54Z

DanWL60: /* Newer API features */

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
! Features
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference

2025-03-10T22:43:44Z

DanWL60: /* Newer API features */

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
! Features
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed [[Mod Hooks#Client Hooks|Client_GameOrderCreated]] not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference

2025-03-10T22:41:18Z

DanWL60: /* Newer API features */ add 5.34 newer features/fixes

This explains how to use Warzone's [[Mods|mod]] API and links to the documentation for each object type.

== Types ==

When writing a mod, you'll encounter variables/objects of three basic types:
* 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.
* Proxy objects: Discussed in the next section.

== 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:

* proxyType: A string identifying the type of proxy object.
* readOnly: False if you're allowed to make changes to this proxy object, or true if it's read-only.
* readableKeys: An array containing all fields you're allowed to read from this object.
* writableKeys: An array containing all fields you're allowed to change on this object if readOnly is False.

To read a field, simply read it like a property: <code>obj.field</code>. Similarly, to write to a proxy object, just assign to that field: <code>obj.field = newVal</code>.

Here's a handy function you can include in your mod to print out everything on a proxy object:

<pre style="overflow: auto">
function PrintProxyInfo(obj)
print('type=' .. obj.proxyType .. ' readOnly=' .. tostring(obj.readonly) .. ' readableKeys=' .. table.concat(obj.readableKeys, ',') .. ' writableKeys=' .. table.concat(obj.writableKeys, ','));
end
</pre>

== 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:

standing.Cards[9] = something --WRONG!

This code won't work since the proxy object isn't having anything assigned to it. Proxy objects are only aware of changes when something is directly assigned into them. To make this work, you must assign the table into the proxy object's field:
local cards = standing.Cards
cards[9] = something
standing.Cards = cards; --Right

Note: If you use lua's <code>type</code> function, proxy objects will identify themselves as tables. However, that should be considered an implementation detail. For the purposes of this wiki, proxy objects aren't considered tables.

== API Reference ==

* [[Mod API Reference:ActiveCard|ActiveCard]]
* [[Mod API Reference:ActiveCardWoreOff|ActiveCardWoreOff]]
* [[Mod API Reference:Armies|Armies]]
* [[Mod API Reference:BonusDetails|BonusDetails]]
* [[Mod API Reference:Boss1|Boss1]]
* [[Mod API Reference:Boss2|Boss2]]
* [[Mod API Reference:Boss3|Boss3]]
* [[Mod API Reference:Boss4|Boss4]]
* [[Mod API Reference:CardGame|CardGame]]
* [[Mod API Reference:CardGameAbandon|CardGameAbandon]]
* [[Mod API Reference:CardGameAirlift|CardGameAirlift]]
* [[Mod API Reference:CardGameBlockade|CardGameBlockade]]
* [[Mod API Reference:CardGameBomb|CardGameBomb]]
* [[Mod API Reference:CardGameCustom|CardGameCustom]]
* [[Mod API Reference:CardGameDiplomacy|CardGameDiplomacy]]
* [[Mod API Reference:CardGameGift|CardGameGift]]
* [[Mod API Reference:CardGameOrderDelay|CardGameOrderDelay]]
* [[Mod API Reference:CardGameOrderPriority|CardGameOrderPriority]]
* [[Mod API Reference:CardGameReconnaissance|CardGameReconnaissance]]
* [[Mod API Reference:CardGameReinforcement|CardGameReinforcement]]
* [[Mod API Reference:CardGameSanctions|CardGameSanctions]]
* [[Mod API Reference:CardGameSpy|CardGameSpy]]
* [[Mod API Reference:CardGameSurveillance|CardGameSurveillance]]
* [[Mod API Reference:CardInstance|CardInstance]]
* [[Mod API Reference:ClanPlayerInfo|ClanPlayerInfo]]
* [[Mod API Reference:ClientGame|ClientGame]]
* [[Mod API Reference:Commander|Commander]]
* [[Mod API Reference:CustomScenario|CustomScenario]]
* [[Mod API Reference:CustomScenarioTerritory|CustomScenarioTerritory]]
* [[Mod API Reference:DistributionMode|DistributionMode]]
* [[Mod API Reference:Game|Game]]
* [[Mod API Reference:GameColor|GameColor]]
* [[Mod API Reference:GameOpenSeat|GameOpenSeat]]
* [[Mod API Reference:GameOrder|GameOrder]]
* [[Mod API Reference:GameOrderAttackTransfer|GameOrderAttackTransfer]]
* [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]]
* [[Mod API Reference:GameOrderBossEvent|GameOrderBossEvent]]
* [[Mod API Reference:GameOrderCustom|GameOrderCustom]]
* [[Mod API Reference:GameOrderDeploy|GameOrderDeploy]]
* [[Mod API Reference:GameOrderDiscard|GameOrderDiscard]]
* [[Mod API Reference:GameOrderEvent|GameOrderEvent]]
* [[Mod API Reference:GameOrderPlayCard|GameOrderPlayCard]]
* [[Mod API Reference:GameOrderPlayCardAbandon|GameOrderPlayCardAbandon]]
* [[Mod API Reference:GameOrderPlayCardAirlift|GameOrderPlayCardAirlift]]
* [[Mod API Reference:GameOrderPlayCardAirliftResult|GameOrderPlayCardAirliftResult]]
* [[Mod API Reference:GameOrderPlayCardBlockade|GameOrderPlayCardBlockade]]
* [[Mod API Reference:GameOrderPlayCardBomb|GameOrderPlayCardBomb]]
* [[Mod API Reference:GameOrderPlayCardCustom|GameOrderPlayCardCustom]]
* [[Mod API Reference:GameOrderPlayCardDiplomacy|GameOrderPlayCardDiplomacy]]
* [[Mod API Reference:GameOrderPlayCardFogged|GameOrderPlayCardFogged]]
* [[Mod API Reference:GameOrderPlayCardGift|GameOrderPlayCardGift]]
* [[Mod API Reference:GameOrderPlayCardOrderDelay|GameOrderPlayCardOrderDelay]]
* [[Mod API Reference:GameOrderPlayCardOrderPriority|GameOrderPlayCardOrderPriority]]
* [[Mod API Reference:GameOrderPlayCardReconnaissance|GameOrderPlayCardReconnaissance]]
* [[Mod API Reference:GameOrderPlayCardReinforcement|GameOrderPlayCardReinforcement]]
* [[Mod API Reference:GameOrderPlayCardSanctions|GameOrderPlayCardSanctions]]
* [[Mod API Reference:GameOrderPlayCardSpy|GameOrderPlayCardSpy]]
* [[Mod API Reference:GameOrderPlayCardSurveillance|GameOrderPlayCardSurveillance]]
* [[Mod API Reference:GameOrderReceiveCard|GameOrderReceiveCard]]
* [[Mod API Reference:GameOrderStateTransition|GameOrderStateTransition]]
* [[Mod API Reference:GamePlayer|GamePlayer]]
* [[Mod API Reference:GameSettings|GameSettings]]
* [[Mod API Reference:GameStanding|GameStanding]]
* [[Mod API Reference:GameWL|GameWL]]
* [[Mod API Reference:IncomeMod|IncomeMod]]
* [[Mod API Reference:IsVersionOrHigher|IsVersionOrHigher]]
* [[Mod API Reference:MapDetails|MapDetails]]
* [[Mod API Reference:MapFamily|MapFamily]]
* [[Mod API Reference:NoParameterCardInstance|NoParameterCardInstance]]
* [[Mod API Reference:PendingStateTransition|PendingStateTransition]]
* [[Mod API Reference:PlayerCards|PlayerCards]]
* [[Mod API Reference:PlayerInfo2|PlayerInfo2]]
* [[Mod API Reference:ReinforcementCardInstance|ReinforcementCardInstance]]
* [[Mod API Reference:ServerGame|ServerGame]]
* [[Mod API Reference:SpecialUnit|SpecialUnit]]
* [[Mod API Reference:TerritoryConnection|TerritoryConnection]]
* [[Mod API Reference:TerritoryDetails|TerritoryDetails]]
* [[Mod API Reference:TerritoryModification|TerritoryModification]]
* [[Mod API Reference:TerritoryStanding|TerritoryStanding]]
* [[Mod API Reference:TickCount|TickCount]]
* [[Mod API Reference:UI|UI]]
* [[Mod API Reference:WL|WL]]

== Newer API features ==
Some features were introduced after the first version of the Mod API framework and should be checked for using [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]]:

{| class="wikitable"
|-
! Version
! Features
|-
| 5.34
| Create [[Mod_API_Reference:UI|radio buttons]] Lua errors in the browser now give stack traces with line numbers in the mod-crashed dialog [[Mod API Reference:Custom Cards|Client_PresentPlayCardUI]] now gives mods the ability to close the cards dialog - closeCardsDialog Fixed Client_GameOrderCreated not being able to read territory picks in manual distribution games Fixed WL.enumtype.ToString() functions 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 Fixed an error if you set number of card pieces to 0 or negative Fixed [[Mod API Reference:GameOrderAirliftResult|GameOrderAirliftResult]].Results throwing an error instead of returning nil when there are no results yet Fixed allowing [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]].ActualArmies to be set to a negative number Fixed "can’t transfer to a neutral" error that occurred when a mod resurrected a failed transfer
|-
| 5.33
| [[Mod API Reference:FogMod|WL.FogMod]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.FogModsOpt]] [[Mod API Reference:GameOrderEvent|GameOrderEvent.RemoveFogModsOpt]] [[Mod API Reference:GameStanding|GameStanding.IncomeMods]] 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) 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)
|-
| 5.32.0.1
| "addCard" callback function now returns the card ID of the newly added card Fixed a bug with custom cards that made old clients produce an error
|-
| 5.32
| [[Mod_Hooks#Client_Hooks|Client_GameOrderCreated]] [[Mod_Hooks#Client_Hooks|Client_GameCommit]] [[Mod API Reference:Custom Cards|Custom Cards]]
|-
| 5.31
| Proper support for Neutral Special Units Fixed GameOrderCustom.TurnPhase not correctly persisting in multi-player Fixed Lua global state not persisting in some cases on the website Note: this update may have prevented the use of custom turn phases
|-
| 5.26
| Use [[Mod_API_Reference:ServerGame|ServerGame.SetPlayerResource]] in [[Mod_Hooks#Server_Hooks|Server_StartGame]] Fixed a bug with airlifting special units that are set to always visible
|-
| 5.24.2
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.Health]]
|-
| 5.24.1
| [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit.CombatOrder]] [[Mod_API_Reference:TickCount|WL.TickCount]]
|-
| 5.22.2
| [[Mod_API_Reference:Boss1|Boss1.CombatOrder]] [[Mod_API_Reference:Boss2|Boss2.CombatOrder]] [[Mod_API_Reference:Boss3|Boss3.CombatOrder]] [[Mod_API_Reference:Boss4|Boss4.CombatOrder]] [[Mod_API_Reference:Commander|Commander.CombatOrder]] [[Mod_API_Reference:CustomSpecialUnitBuilder|CustomSpecialUnitBuilder.Health]]
|-
| 5.22
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom.OccursInPhaseOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.RemoveSpecialUnitsOpt]]
|-
| 5.21
| [[Mod_Hooks#Client_Hooks|Client_PresentCommercePurchaseUI]] [[Mod_API_Reference:ClientGame|ClientGame.CreateLocatorCircle]] [[Mod_API_Reference:ClientGame|ClientGame.HighlightTerritories]] [[Mod_API_Reference:CustomSpecialUnit|CustomSpecialUnit]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.JumpToActionSpotOpt]] [[Mod_API_Reference:GameOrderEventResult|GameOrderEventResult.CardInstancesCreated]] [[Mod_API Reference:UI|UI.IsDestroyed]] [[Mod_API_Reference:UI|WL.CancelClickIntercept]]
|-
| 5.20
| Setting [[Mod_API_Reference:TerritoryStanding|TerritoryStanding]].OwnerPlayerID to [[Mod_API_Reference:PlayerID|WL.PlayerID.AvailableForDistribution]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddCardPiecesOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.AddResourceOpt]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.RemoveWholeCardsOpt]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddArmies]] [[Mod_API_Reference:TerritoryModification|TerritoryModification.AddStructuresOpt]]
|-
| 5.17
| Using argument two of <code>addNewOrder</code> in [[Mod_Hooks#Server_Hooks|Server_AdvanceTurn_Order]] [[Mod_API_Reference:GameOrderEvent|GameOrderEvent.IncomeMods]] [[Mod_API_Reference:IncomeMod|IncomeMod]] [[Mod_API_Reference:UI|UI.InterceptNextBonusLinkClick]] [[Mod_API_Reference:UI|UI.InterceptNextTerritoryClick]] [[Mod_API_Reference:IsVersionOrHigher|WL.IsVersionOrHigher]] [[Mod_API_Reference:StructureType|WL.StructureType.Arena]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.ArmyCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Attack]] [[Mod_API_Reference:StructureType|WL.StructureType.Crafter]] [[Mod_API_Reference:StructureType|WL.StructureType.DigSite]] [[Mod_API_Reference:StructureType|WL.StructureType.Draft]] [[Mod_API_Reference:StructureType|WL.StructureType.Hospital]] [[Mod_API_Reference:StructureType|WL.StructureType.Market]] [[Mod_API_Reference:StructureType|WL.StructureType.MercenaryCamp]] [[Mod_API_Reference:StructureType|WL.StructureType.Mine]] [[Mod_API_Reference:StructureType|WL.StructureType.MoneyCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Mortar]] [[Mod_API_Reference:StructureType|WL.StructureType.Power]] [[Mod_API_Reference:StructureType|WL.StructureType.Recipe]] [[Mod_API_Reference:StructureType|WL.StructureType.ResourceCache]] [[Mod_API_Reference:StructureType|WL.StructureType.Smelter]]
|}

There is a chance that a player has a version of the app that pre-dates the introduction of the [[Mod_API_Reference:IsVersionOrHigher|IsVersionOrHigher]] function. Many features were added after the first version of the Mod API Framework, but before the introduction of the function:

{| class="wikitable"
|-
! Version
! Features
|-
| Up to 4.14.2
| Various bug fixes / performance enhancements relating to mods. No other changes made to mod API framework until version 5.17.
|-
| 3.20.2
| Mod support for Commerce games (Commerce added in 3.20.0)
|-
| 3.19.3
| Bug fixes for GameOrderPlayCard, Armies.Add, Armies.Subtract [[Mod_Hooks#Client_Hooks|Client_GameRefresh]] [[Mod_Hooks#Client_Hooks|Client_PresentMenuUI]] [[Mod_Game_Data_Storage|Data storage]] [[Mod_API_Reference:Game|Game]].CreateDialog [[Mod_API_Reference:Game|Game]].SendGameCustomMessage [[Mod_API_Reference:GamePlayer|GamePlayer]].Income [[Mod_Hooks#Server_Hooks|Server_GameCustomMessage]]
|-
| 3.19.2
| [[Mod_API_Reference:GameOrderCustom|GameOrderCustom]] [[Mod_API_Reference:UI|UI]].Alert UI.Destroy UI.PromptFromList
|-
| 3.18.2
| Moved all WarLight mod classes into the global "WL" namespace. For example, to create an Armies object instead of just saying "Armies()", you now say WL.Armies.Create()
|-
| 3.18.0
| Mod API Framework added
|}

[[Category:Mod Developers Guide]][[Category:Mod API Reference|!]]

Mod API Reference:Custom Cards

2025-03-10T22:29:53Z

DanWL60: /* Playing the Card */ note about Mod and UI not directly accessible in Client_PresentPlayCardUI in older versions

A Warzone [[Mods|mod]] can create '''custom cards''' for use in a game. Custom cards show up the cards dialog right alongside all the other cards for the game.

== Card Definition ==

A mod defines the custom cards in the Client_SaveConfigureUI [[Mod Hooks|mod hook]]. The second parameter to this function is a callback that adds a card.

This function takes the following arguments:
# ''string'': Name of the card
# ''string'': Description of the card
# ''string'': Image filename (see Image below)
# ''integer'': Number of pieces to divide the card into
# ''integer'': Minimum number of pieces that Warzone will award to each player who takes a territory each turn
# ''.integer'': Number of pieces of the card given to each player at the start of the game (initial pieces)
# ''double'': The card's weight, which determines how likely it is to be selected when using random card distribution

This function returns the [[Mod API Reference:CardID|CardID]] in [[Mod API Reference:IsVersionOrHigher|versions 5.32.0.1 and later]].

If you'd like for your card to be configurable by the player like a normal card, you should let the player select values for the number of pieces, minimum pieces, initial pieces, and weight.

If you'd like your card to only be distributed at the beginning of the game and never again, you can pass 1 for the number of pieces, 0 for weight and minimum pieces, and initial pieces to the number of cards you want distributed at the game start.

If you desire full control over when players receive your card and want to override Warzone's normal card distribution, you can pass 0 for weight, minimum pieces and initial pieces, and then you can use [[Mod API Reference:GameOrderEvent|GameOrderEvent]] yourself to award your card to players.

== Playing the Card ==

Mods get complete control exactly what happens when the card is played. When the player attempts to play your card, it will call the function Client_PresentPlayCardUI in Client_PresentPlayCardUI.lua for your mod only.

Client_PresentPlayCardUI is passed four arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# [[Mod API Reference:CardInstance|CardInstance]]: Provides read-only information about the card the player is attempting to play.
# playCard: A function that, when called, will cause the card to be played. It takes three arguments: 1. The text to appear in the orders list next to the play-card order, 2. a string that will be stored with the order in a field called ModData, and 3. (optional) the [[Mod API Reference:TurnPhase|turn phase]] in which the card should be played. Custom turn phases cannot be used.
# 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

If you don't require any additional information from the user, you can simply call playCard immediately, for example:

<pre>
function Client_PresentPlayCardUI(game, cardInstance, playCard, closeCardsDialog)
playCard('Play a magic card', '')
end
</pre>

If you do require additional infirmation from the user, you can call game.CreateDialog to create a dialog and later call playCard from a button callback, for example.

Note: in versions under 5.34.0, [[Mod Game Data Storage|Mod]] and [[Mod API Reference:UI|UI]] are not directly accessible in Client_PresentPlayCardUI. They can be accessed in the callback function in [[Mod API Reference:ClientGame|Game]].CreateDialog. [[Mod API Reference:WL|WL]] was always accessible when the hook was introduced.

== Image ==

Mods can upload their own image to define what the card looks like in the cards dialog. These should be a png file that's exactly 130 pixels wide and 180 pixels tall. Place this image into a sub-folder in your mod folder named CardImages. Then pass the name of your image to the third parameter of the add card function defined above.

== See also ==
* [[Mod Developers Guide]]

[[Category:Mod Developers Guide]]

Settings

2025-03-08T19:46:47Z

DanWL60: /* Initial Territory Distribution */ rename Custom Distribution to Custom Scenario

One of Warzone's greatest features is how configurable games are. This page enumerates all of the settings that go into a game or tournament.

==Core Game Settings==

* [[Game Name]]
* [[Map]]
* [[Ranked versus Practice]]
* [[Fog|Fog Level]]
* [[Multi Attack]]
* [[Move Order]]
* [[Private Messaging]]
* [[Team Games|Random Teams]]
* [[Open Seat Prerequisites]]
* [[Game creator's personal message]]
* [[Linking your Game]]

==Initial Territory Distribution==

* [[Manual Distribution|Automatic versus Manual distribution]]
* [[Initial Territory Distribution|Distribution Mode]]
* [[Territory Limit]]
* [[Initial Armies per Territory]]
* [[Non-distribution neutrals]]
* [[In-distribution neutrals]]
* [[Wastelands|Number of Wastelands]]
* [[Wastelands|Size of Wastelands]]
* [[Custom Scenario]]

==Army Settings==

* [[Base armies per turn]]
* [[Luck Modifier]]
* [[Rounding mode]]
* [[Extra armies for territories]]
* [[Army Cap]]
* [[Offense and defense kill rates|Offensive Kill Rate]]
* [[Offense and defense kill rates|Defensive Kill Rate]]
* [[Local deployments]]
* [[No-split mode]]
* [[Overridden Bonuses]]
* [[Percentage attacks|Attacking by Percentage]]
* [[One Army Must Stand Guard]]
* [[Commanders]]
* [[Boss]]es

==Boot/Surrender Settings==

* [[Real-Time versus Multi-Day]]
* [[Vote-to-boot time]]
* [[Direct boot time]]
* [[Automatic boot time]]
* [[Banking boot amount]]
* [[Vacations honored]]
* [[Players turning into AIs|Booted players turn into AIs]]
* [[Players turning into AIs|Surrendered players turn into AIs]]
* [[Surrendering|Surrenders must be accepted]]
* [[AI surrenders when one human remains]]

==Card Settings==
* [[Number of card pieces per turn]]
* [[Maximum number of cards you can hold]]
* [[Card fog|Visibility of opponents playing cards]]
* [[Card fog|Visibility of opponent's cards]]

==[[Tournament Settings]]==

* [[Tournaments|Tournament Type]]
* Team Size
* Can Forward Invites
* Open Tournament
* Number of Rounds
* Teams per Game (single-elimination only)
* Games at a time (round-robin only)

==Sample Settings Screen==

https://d32kaghj56y4ei.cloudfront.net/static/img/SampleSettings.png

== See also ==
* [[Settings highlight]]

[[Category:Game Settings|!]]

Link to Game

2025-03-06T12:59:32Z

DanWL60: Undo revision 7372 by Rex Imperator (talk) unnecessary to mention that

Each Warzone game has a unique URL that uniquely identifies it. The URL looks like this:

<pre><nowiki>https://www.warzone.com/MultiPlayer?GameID=1234567</nowiki></pre>

It can be shared with other players or posted on the [[forum]] which helps when discussing games.

Whenever you open a game on the Warzone website, that game's URL will appear in your browser's address bar. It is also under Game > Settings > Full Settings > Link. While using the app, tapping the link will copy the link to the clipboard. Tap again to paste.

[[Category:Game Settings]]

User:Rex Imperator

2025-03-06T12:56:25Z

DanWL60: Created page with "'''Rex Imperator''' is a Warzone player, playing since 2022. He created his account exactely the same day of '''Benyyl'''. [https://www.warzone.com/Profile?p=15147121372&u=Rex+Imperator_1 Rex Imperator's Profile] ==Rex Imperator's Games== Rex Imperator's like diplos and lotteries, this is the most of the game he's playing. he like also some strategic games, and creative games. Sometimes, he's creating some. Here's his most popular template : [https://www.warzone.com/M..."

'''Rex Imperator''' is a Warzone player, playing since 2022. He created his account exactely the same day of '''Benyyl'''.

[https://www.warzone.com/Profile?p=15147121372&u=Rex+Imperator_1 Rex Imperator's Profile]

==Rex Imperator's Games==

Rex Imperator's like diplos and lotteries, this is the most of the game he's playing. he like also some strategic games, and creative games.
Sometimes, he's creating some. Here's his most popular template : [https://www.warzone.com/MultiPlayer?TemplateID=1511622 If You Want Blood, You've Got It]

==Rex Imperator's Maps==

Rex Imperators publied some maps. Go add five stars on them !
(The maps are listed by orders of coming out)

[https://www.warzone.com/SinglePlayer?PreviewMap=105049 France by Vaction]

[https://www.warzone.com/SinglePlayer?PreviewMap=104163 France by Population]

[https://www.warzone.com/SinglePlayer?PreviewMap=106324 Alnilam]

Don't worry, Rex Imperator is working on some new maps and will publish them in a few moment !