War.app Wiki - User contributions [en]

Mod API Reference:UI

2026-04-17T19:21:53Z

JustADutchman: /* Helper Functions */

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 measure 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 measure 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.
* '''MinWidth''' ''number'': The minimum width an element can be, up to a maximum of 60. Developers should take special care when using MinWidth since many players play Warzone on phones in portrait mode where there is very limited horizontal space. This setting is limited to 60 since it's intended to be used only for smaller elements, for example when you need to line things up vertically. (Added in version 5.34.1)
* '''MinHeight''' ''number'': The minimum height an element can be. (Added in version 5.34.1)

== 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.
* '''Center''' ''bool'': If true, the container will center elements within it horizontally. Defaults to false.

'''HorizontalLayoutGroup''': A container that stacks its children horizontally.
* '''Center''' ''bool'': If true, the container will center elements within it vertically. Defaults to false.

'''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.
* '''Alignment''' ''[[Mod API Reference:TextAlignmentOptions|TextAlignmentOptions]] (enum)'': Sets text alignment, vertically and horizontally, within the label. This will usually only have an effect if the label is made larger by increasing its Preferred, Minimum, or Flexible width/height. (Added in version 5.34.1)

'''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, '''selected''' and either '''text''' or '''player'''. '''selected''' is a zero-argument function that gets called if the player selects that option, '''text''' populates the text that will appear on that button. '''player''' should be set to a [[Mod_API_Reference:PlayerID|playerID]], this will also give the button the corresponding color of the player.

'''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 Developers Guide

2025-12-08T16:35:07Z

JustADutchman: Added Community Annotations to the tips page

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.

The [[Mod API Reference]] can be found here on the wiki, but there is also a community project that brings the Mod API documentation into Visual Studio Code using annotations. Since this is community driven, it won't always be up to date if Warzone releases a new update and it could contain mistakes. The project and documentation to include it in your visual studio code editor can be found here: https://github.com/JustMe003/ModTemplates

== 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 API Reference:Custom Cards

2025-11-23T14:08:45Z

JustADutchman: /* Playing the Card */

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
# ''integer'': The duration, in turns, that the card should remain in effect. Pass -1, nil, or omit this argument to indicate that the card should not have a duration.
# ''[[Mod API Reference:ActiveCardExpireBehaviorOptions|ActiveCardExpireBehaviorOptions]]'': If a duration is specified, this controls whether the card expires at the beginning or end of the turn. Pass nil or omit this argument for cards where a duration is not passed. If omitted or nil is passed for a card with duration, it will default to EndOfTurn. (Added in version 5.34.1)

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 the following arguments:
## The text to appear in the orders list next to the play-card order
## a string that will be stored with the order in a field called ModData
## (optional) the [[Mod API Reference:TurnPhase|turn phase]] in which the card should be played. Custom turn phases cannot be used.
## (optional) ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryAnnotation|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)
## (optional) ''[[Mod API Reference:RectangleVM|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails|TerritoryDetails]] object. (added in version 5.34.1)
# 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 information 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]]

Mod API Reference:Custom Cards

2025-11-23T14:08:22Z

JustADutchman:

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
# ''integer'': The duration, in turns, that the card should remain in effect. Pass -1, nil, or omit this argument to indicate that the card should not have a duration.
# ''[[Mod API Reference:ActiveCardExpireBehaviorOptions|ActiveCardExpireBehaviorOptions]]'': If a duration is specified, this controls whether the card expires at the beginning or end of the turn. Pass nil or omit this argument for cards where a duration is not passed. If omitted or nil is passed for a card with duration, it will default to EndOfTurn. (Added in version 5.34.1)

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 the following arguments:
## The text to appear in the orders list next to the play-card order
## a string that will be stored with the order in a field called ModData
## (optional) the [[Mod API Reference:TurnPhase|turn phase]] in which the card should be played. Custom turn phases cannot be used.
## (optional) ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryAnnotation|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)
## (optional) ''[[Mod API Reference:RectangleVM|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails|TerritoryDetails]] object. (added in version 5.34.1)
# 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]]

API

2025-06-05T21:45:57Z

JustADutchman: /* APIs */

Warzone has several '''<abbr title="Application Programming Interface">API</abbr>s''' that allow software engineers to write applications that interact with game. Currently, all of the APIs (except the [[Set map details API]]) are restricted to Warzone [[Membership|members]].
== APIs ==
* [[Clan Wars API]]
* [[Create game API]]
* [[Delete game API]]
* [[Game ID feed API]]
* [[Get API Token API]]
* [[Get mod performance API]]
* [[Query game API]]
* [[Set map details API]]
* [[Update Mod API]]
* [[Validate invite token API]]

[[Category:API|!]]

Query game API

2025-06-05T20:28:54Z

JustADutchman: /* JSON Definition */

Warzone can provide programmatic access to the details about multi-player Warzone games. This allows for the more technical users to write a program that can analyze information about games. This data is only available for ladder games, tournament games, games created by the [[Create game API]], or games that you played in.

There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.

The primary goals of this API is to enable tools that do statistical analysis of finished games and to enable custom ladders or custom tournaments to check on the winners of the game after it's over.

==Usage==

To access the data, use a URL like this: https://www.warzone.com/API/GameFeed?GameID=1212978

This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime, templateID, players) about the game.

If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game assuming it's finished.

If you want to get a game's settings, add an additional querystring parameter '''GetSettings=true'''. Adding this will cause the API to return you details about the settings of the game.

If you want to get a game's public chat message, add an additional querystring parameter '''GetChat=true'''.

==JSON Definition==

* A '''standing''' is the state of the board at any given point in time. This contains one entry per territory that contains the number of armies on that territory, who controls it, and the fog level.
* A '''turn''' is just a collection of orders. This includes all the orders each player submitted, mixed together in the sequence they played out.
* An '''order''' is obviously one order that a player submitted. But it can also include other things, such notifications when a player gets eliminated, or when cards are received, etc. Essentially, this represents what you see in the '''Orders''' panel on the right side of a game when viewing history.
In the JSON, you'll find:
* The players in the game (their names, color, their state, etc.)
* All of the details of the map (it's name, all of its territories, what they connect to and their x/y coordinates, all of its bonuses and what territories are in each bonus)
* The '''distribution standing''': This is what the map looked like when it was time to pick the territories you started with. This is only present for manual distribution games.
* The picks: This tells you which territories each player picked, and in what order. Like the distribution standing, this is only present for manual distribution games.
* Standing 0: This tells you what the map looked like at the beginning of the game.
* Turn 0: This is all of the orders that played out on the first turn of the game.
* Standing x/turn x: Standings and turns then alternate for each turn of the game, all the way until the final standing.

== Game State ==

This API returns a "state" attribute on the game. This will be one of the following values:
* WaitingForPlayers: This game is in the lobby and has not yet begun.
* DistributingTerritories: This game is waiting for players to make their territory selections. This state will not exist for games with automatic distribution.
* Playing: The game is in progress.
* Finished: The game has finished.

== Player States ==

This API returns a "players" collection which contains information about each player in the game. Each player will have a "state" attribute with one of the following values:
* Invited: The game is waiting on this player to accept or decline the game. This state will only ever be present for games still in the lobby.
* Playing: This player is in the game, and still alive. This state will never be present in a game that has finished.
* Eliminated: This player has been eliminated from the game.
* SurrenderAccepted: This player has surrendered and is no longer in the game.
* Booted: This player was booted from the game.
* Won: This player has won the game. This state will only be present in games that have finished.
* EndedByVote: This player, along with the other remaining players in the game, have voted to end the game. This state will only ever be present for games that are finished by voting-to-end.
* Declined: This player declined the game and did not play.
* RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players.

==Getting a list of Game IDs==

In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical Warzone client by opening up the Settings panel and examining the "Link to Game" field. At the end of this field, you'll see GameID= followed by a number.

To find game IDs programmatically, you can use the [[Game ID feed API]].

==See Also==

* [[Game ID feed API]]

[[Category:API]]

Mod API Reference:GameOrderEvent

2025-05-06T08:24:14Z

JustADutchman:

'''GameOrderEvent''': Subclass of [[Mod API Reference:GameOrder|GameOrder]]. This is a generic event that can present a message or modify territories. It can also control which players can see it. It was added for use by [[Mods]] and is not used by any built-in game mechanics, except for the "Received Gold" order in [[Commerce]] games.
* '''Message''' ''string'':
* '''TerritoryModifications''' ''Array<[[Mod API Reference:TerritoryModification|TerritoryModification]]>'': Optionally, can modify territories, such as changing ownership or armies.
* '''VisibleToOpt''' ''[[Mod API Reference:HashSet|HashSet]]<[[Mod API Reference:PlayerID|PlayerID]]>'': Defines who this event is visible to. Note that the player this event is assigned to can '''always''' see it, and any player who can see the effects of a territory modification can always see it as well. Set this to nil to mean that it should be visible to everyone (public). Set this to an empty list to indicate that the event should not be visible to anyone, except those that can see it by a previously mentioned rule.
* '''SetResourceOpt''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>>'': Sets the resource value of a player, such as their [[gold]], to a specific value.
* '''IncomeMods''' ''Array<[[Mod API Reference:IncomeMod|IncomeMod]]>'':
* '''AddResourceOpt''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>>'': Adds (or subtracts with negative numbers) to the resources of a player, such as their [[gold]]. When adding or subtracting a fixed number, this is preferred over SetResourceOpt. Added in version 5.20.0.
* '''AddCardPiecesOpt''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Table<[[Mod API Reference:CardID|CardID]],integer>>'': Provides a way to add (or remove with negative numbers) pieces of a card to a player. This can also add whole cards -- if the player's total cards exceeds the number of peices that make up that card as defined in the game settings, they will automatically be turned into whole cards and be given to the player. This cannot remove whole cards. For that, use RemoveWholeCardsOpt.
* '''RemoveWholeCardsOpt''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],[[Mod API Reference:CardInstanceID|CardInstanceID]]>'': Removes whole cards from a player.
* '''JumpToActionSpotOpt''' ''[[Mod API Reference:RectangleVM|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails|TerritoryDetails]] object.
* '''ModID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:ModID|ModID]]>'':
* '''FogModsOpt''' ''Array<[[Mod API Reference:FogMod|FogMod]]>'': Adds [[Mod API Reference:FogMod|FogMods]] for modifying fog.
* '''RemoveFogModsOpt''' ''Array<[[Mod API Reference:Guid|Guid]]>'': Removes [[Mod API Reference:FogMod|FogMods]]
* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID|TerritoryID]],[[Mod API Reference:TerritoryAnnotation|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)

== Functions ==

* '''WL.GameOrderEvent.Create'''('''playerID''' ''[[Mod API Reference:PlayerID|PlayerID]]'', '''message''' ''string'', '''visibleToOpt''' ''[[Mod API Reference:HashSet|HashSet]]<[[Mod API Reference:PlayerID|PlayerID]]>'', '''terrModsOpt''' ''Array<[[Mod API Reference:TerritoryModification|TerritoryModification]]>'', '''setResourcesOpt''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>>'', '''incomeModsOpt''' ''Array<[[Mod API Reference:IncomeMod|IncomeMod]]>'') (static) returns [[Mod API Reference:GameOrderEvent|GameOrderEvent]]:
** playerID: Pass the ID of a player that this event pertains to. This is one of the few players where WL.PlayerID.Neutral is an allowed value. An event assigned to Neutral is suitable for events that weren't initiated by a player.
[[Category:Mod API Reference]]

Mod Hooks

2025-04-09T19:03:24Z

JustADutchman: /* Client Hooks */ Added some additional newlines

Warzone will call into a [[Mods|mod's]] lua code using what are called '''hooks'''.

For example, it will call a hook named Server_StartGame when a game is beginning and give your mod an opportunity to change things about how the map is set up.

If you provide a function with the name listed here, and in a file with the name listed here, it will be called as explained. Note that both the function name and the file name are case-sensitive.

== Server Hooks ==
* Server_Created (Server_Created.lua)
** Called in every game when the game is first created. In multi-player, this means it's called before players even accept or join the request for the game. This is the only place that game settings can be changed.
** Return value: None.
** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# [[Mod API Reference:GameSettings|GameSettings]]: (writable) Allows your mod to change the game's settings.

* Server_StartDistribution (Server_StartDistribution.lua)
** Called in any game set to manual territory distribution before players select their picks. This hook is not called in any game configured to automatic territory distribution. This is called after the standing has been built (wastelands and pickable territories have already been placed and initial cards have already been given out.)
** Return value: None.
** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# [[Mod API Reference:GameStanding|Standing]]: (writable) Allows your mod to change the standing before players see it. For example, a mod could change the number of armies on any territory, control which territories are pickable, or define what cards each player starts with.

* Server_StartGame (Server_StartGame.lua)
** Called when the game starts the first turn. In a manual territory distribution game, this is called after all players have entered their picks. In an automatic territory distribution game, this is called when the game starts. This is called after the standing has been built (picks have been given out)
** Return value: None.
** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# [[Mod API Reference:GameStanding|Standing]]: (writable) Allows your mod to change the the standing before players see it. For example, a mod could change the number of armies on any territory, control which players control which territories, or define what cards each player starts with.

* Server_AdvanceTurn_Start (Server_AdvanceTurn.lua)
** Called whenever the server begins processing a normal turn (not territory picking). This gives mods an opportunity to insert orders at the start of a turn, before any player's orders are added. All of the Server_AdvanceTurn_* hooks share global state within a single turn, so global variables can be read and written reliably by mods.
** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the start of the turn. You may call this function multiple times if you wish to add multiple orders. Pass a single GameOrder as the first argument to this function.

* Server_AdvanceTurn_Order (Server_AdvanceTurn.lua)
** Called whenever the server processes a player's order during a normal turn (not territory picking). This gives mods an opportunity to skip the order, modify it, or let it process normally.

This hook is called after the results of the order have been computed, but before it has been applied to the [[Mod API Reference:GameStanding|standing]]. For example, when looking at an [[Mod API Reference:GameOrderAttackTransfer|Attack/Transfer order]] that represents a territory being captured, the standing will still show the territory as uncaptured.

All of the Server_AdvanceTurn_* turns share global state within a single turn, so global variables can be read and written reliably by mods.

** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# [[Mod API Reference:GameOrder|GameOrder]]: The order being processed. (read-only)
# [[Mod API Reference:GameOrderResult|GameOrderResult]]: The result of the order being processed. This is writable, so mods can change the result. Currently, only [[Mod API Reference:GameOrderAttackTransferResult|GameOrderAttackTransferResult]] has writable fields.
# skipThisOrder: A function that you can call to indicate that this order should be skipped. This should be called with one of three values, listed below. If it is called multiple times, the last call overrides the previous calls.
## WL.ModOrderControl.Keep: Indicates this order should be processed normally. This is the default value, and all orders will default to Keep if skipThisOrder is not called.
## WL.ModOrderControl.Skip: Indicates this order should be skipped. It won't appear in the orders list at all and it will be as if the order never existed. A [[Mod API Reference:GameOrderEvent|GameOrderEvent]] will be written into the orders list to tell the player who entered this order that their order was skipped.
## WL.ModOrderControl.SkipAndSupressSkippedMessage: Same as Skip, except that the GameOrderEvent is not written. This should be used with care, as players will want to know why their order didn't appear in the orders list. This should only be used if you use some other mechanism to explain to the player why their order was not present, or if this is an order that your mod inserted and therefore no players were expecting it.
# addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the start of the turn. You may call this function multiple times if you wish to add multiple orders. Pass a single GameOrder as the first argument to this function. Optionally, you can also pass "true" as a second argument to this function to make your new order get skipped if the order this hook was called on gets skipped, either by your mod or another mod. This second argument was added in [[Mod_API_Reference:IsVersionOrHigher|5.17.0]].

* Server_AdvanceTurn_End (Server_AdvanceTurn.lua)
** Called whenever the server finishes processing a normal turn (not territory picking). This gives mods an opportunity to insert orders at the end of a turn, after all player's orders are added. All of the Server_AdvanceTurn_* turns share global state within a single turn, so global variables can be read and written reliably by mods.
** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the start of the turn. You may call this function multiple times if you wish to add multiple orders. Pass a single GameOrder as the first argument to this function.

* Server_GameCustomMessage (Server_GameCustomMessage.lua)
** Called whenever your mod calls [[Mod API Reference:ClientGame|ClientGame]].SendGameCustomMessage. This gives mods a way to communicate between the client and server outside of a turn advancing. Note that if a mod changes Mod.PublicGameData or Mod.PlayerGameData, the clients that can see those changes and have the game open will automatically receive a refresh event with the updated data, so this message can also be used to push data from the server to clients.
** [[Mod_Security|Mod security]] should be applied when working with this Hook
** Arguments:
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game.
# [[Mod API Reference:PlayerID|PlayerID]]: The ID of the player who invoked this call.
# payload: The data passed as the ''payload'' parameter to SendGameCustomMessage. Must be a lua table.
# setReturn: Optionally, a function that sets what data will be returned back to the client. If you wish to return data, pass a table as the sole argument to this function. Not calling this function will result in an empty table being returned.

== Client Hooks ==
* Client_PresentConfigureUI (Client_PresentConfigureUI.lua)
** Called when a player checks your mod on the Create Game page. If your mod has any configurable settings, you should create UI controls on the screen to allow players to configure them using the [[Mod API Reference:UI|UI API]]. Mods should also check the <code>[[Mod Game Data Storage|Mod.Settings]]</code> global to see if any settings are already defined, and if they are, default their UI state to match that.
** Arguments:
# rootParent: Pass this as an argument to the top-level UI element your mod creates. See the [[Mod API Reference:UI|UI API]] for details.

* Client_SaveConfigureUI (Client_SaveConfigureUI.lua)
** Called when a player submits the Create Game Mod page with your mod checked. If your mod presented any UI in Client_PresentConfigureUI, your mod should persist any settings into the <code>Mod.Settings</code> global during this hook. This is the only place that <code>Mod.Settings</code> should ever be written to.
** Arguments:
# alert: A function callback that takes a string. If the user has configured anything wrong with your UI, you can call this to notify them of their mistake. Calling this function will also abort the save.
# addCard: A function callback used by [[Mod API Reference:Custom Cards|Custom Cards]]

* Client_CreateGame (Client_CreateGame.lua)
** Called when a player attempts to create a game with your mod included. If your mod wishes to check that the game settings are valid before the game is created, you can do so here. Note that you should do as much validation as possible in Client_SaveConfigureUI, however Client_CreateGame can be used to do additional validation that isn't possible in Client_SaveConfigureUI, such as if the player changed settings after leaving the mod configuration page.
** Arguments:
# settings: [[Mod API Reference:GameSettings|GameSettings]]
# alert: A function callback that takes a string. If the user has configured anything wrong with your UI, you can call this to notify them of their mistake. Calling this function will also abort the game creation.

* Client_PresentSettingsUI (Client_PresentSettingsUI.lua)
** Called when a player opens the Game Settings panel of a game that has your mod included. If your mod has any configurable settings, you should read them out of the global <code>Mod.Settings</code> and show them to the player here using the [[Mod API Reference:UI|UI API]].
** Arguments:
# rootParent: Pass this as an argument to the top-level UI element your mod creates. See the [[Mod API Reference:UI|UI API]] for details.

* Client_PresentMenuUI (Client_PresentMenuUI.lua)
** If present, games with this mod enabled will have a new button on the menu. When the player clicks that button, this mod hook is invoked and the resulting UI will be shown to the player in a dialog. See [[Mod API Reference:UI|UI API]].
** Arguments:
# rootParent: Pass this as an argument to the top-level UI element your mod creates. See the [[Mod API Reference:UI|UI API]] for details.
# setMaxSize: Function mods can call to set the maximum size of the dialog. Pass two numbers: the width and the height. Note that screen sizes can vary a lot, so you can never be sure you'll get the size you request, so plan on making your UI work in all sizes.
# setScrollable: Function mods can call to set whether the dialog is scrollable horizontally or vertically. Pass two booleans: the first determines if it's horizontally scrollable, and the second determines if it's vertically scrollable. The default is false, true.
# [[Mod API Reference:ClientGame|ClientGame]]: Information about the game.
# close: Function that, when called, will close the current dialog. Takes no arguments and returns nothing.

* Client_GameOrderCreated (Client_GameOrderCreated.lua)
** If present, whenever a player creates an order in the client, this function will be called. For example, whenever they deploy armies, issue an attack, play a card, etc.
** Arguments:
# [[Mod API Reference:ClientGame|ClientGame]]: Information about the game.
# [[Mod API Reference:GameOrder|GameOrder]]: Read-only information about the order that was just created.
# skipOrder: Function that, when called, will cause the order to not be inserted into the player's order list. If you call this, you should also ensure the player understands why the order was skipped, such as by popping up an alert, otherwise players could become confused about why their orders aren't being recorded. Note that if you use this for skipping invalid orders, you must still take care to ensure invalid orders are skipped on the server as well, as a clever player could hack their client to prevent Client_GameOrderCreated from being called at all.

* Client_GameCommit (Client_GameCommit.lua)
** If present, whenever a player clicks the Commit button in the client, this function will be called.
** Arguments:
# [[Mod API Reference:ClientGame|ClientGame]]: Information about the game.
# skipCommit: Function that, when called, will cause the commit request to be cancelled. If you call this, you should also ensure the player understands why they aren't being allowed to commit, such as by popping up an alert, otherwise players could become confused about why it isn't working. Note that if you use this for validating orders are correct, you must still take care to ensure invalid orders are checked on the server as well, as a clever player could hack their client to prevent Client_GameCommit from being called at all.

* Client_GameRefresh (Client_GameRefresh.lua)
** Invoked whenever the client gets data about this game from the server. This can be used to check for updated Mod.PublicGameData or Mod.PlayerGameData, documented at [[Mod Game Data Storage]]. The client refresh timing is different between single-player and multi-player, and in multi-player can also vary depending on the user's internet connection (such as whether they're connected by websocket, long polling socket, or normal polling). Therefore, a mod should never write code that breaks if Client_GameRefresh is called at unexpected times.
** Arguments:
# [[Mod API Reference:ClientGame|ClientGame]]: Information about the game.

* Client_PresentCommercePurchaseUI (Client_PresentCommercePurchaseUI.lua)
** Invoked whenever the player clicks the "Build" button in a commerce game. This can be used to present UI to allow the player to spend their gold on things.
** Arguments:
# rootParent: Pass this as an argument to the top-level UI element your mod creates. See the [[Mod API Reference:UI|UI API]] for details.
# [[Mod API Reference:ClientGame|ClientGame]]: Information about the game.
# close: Function that, when called, will close the current dialog. Takes no arguments and returns nothing.

* Client_PresentPlayCardUI (Client_PresentPlayCardUI.lua)
** See [[Mod_API_Reference:Custom_Cards|Custom Cards]]

== Notes ==
Any hooks that start with <code>Server_</code> are run on the server in multi-player games, and on the client in single-player games.

No hooks have return values. Meaning, it doesn't matter if you return any values from your hook functions. Instead, the mod framework gives you callbacks to call to affect things. This is preferred over return values for a few reasons. First, it allows mods to call the callbacks early on or late on in their function, which can be easier than a return statement which must come at the end. Second, it allows mods to simply not call the callback, which can signal to Warzone that the mod doesn't care about the result of this. This can be important in some cases where multiple mods that define the same hook. Sometimes the mods instructions can conflict and Warzone must decide which to obey.

== See also ==
* [[Mod Developers Guide]]
* [[Mod Game Data Storage]]

[[Category:Mod Developers Guide]]

Mod API Reference:Custom Cards

2025-03-10T22:07:50Z

JustADutchman:

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.

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

Mod API Reference:Custom Cards

2025-01-21T00:12:17Z

JustADutchman: /* Playing the Card */

Meteor Strike 2

2025-01-18T22:36:57Z

JustADutchman: Updated wiki: Aliens spawn again

{{stub}}

{{Mod infobox
|creatorToken=42131172405
|creatorName=Just_A_Dutchman_
|madePublicOnYear=2024
|madePublicOnMonth=02
|madePublicOnDay=14

|tags={{modtag|Silly}}<br>{{modtag|Strategic}}
|appversion=5.24.2
|source=https://github.com/JustMe003/WarzoneMods/tree/main/Meteor%20Strike%20Plus
}}

This [[mod]] is similar to [[Meteor Strike]], except it is more configurable, introduces the <strong>Alien</strong> [[special unit]], and contains an "Easter egg". There are <strong>normal storms</strong> and <strong>doomsday storms</strong>, which are like the other mod's standard meteor strikes and DoomsDay Mode, but multiple groups of them can be made.

== Settings ==
=== Mod Settings ===
Game creators can customize [[#General%20Settings|general settings]], [[#Normal%20Storms|normal storm settings]] and [[#Doomsday Storms|doomsday storm settings]]. Initially, no storms of any type are created. Note that higher an lower values for all number inputs can be entered rather than using the number slider.

==== General Settings ====
General settings:
* If meteors can hit the same territory multiple times (defaults to disabled).
* If meteors that deal 0 damage remove all armies any special units on the territory they hit as well as set the owner of the territory to neutral (defaults to disabled).
* If an "Easter egg" is allowed to occur (defaults to enabled).
* If "Presenter of weather forecast is game creator".
* The "Additional weather forecast message".

==== Storm Settings ====
Both storm types have common settings:
* Number of meteors (defaults to 3, min 1, max 20).
* Random number of meteors (defaults to 0, min 1, max 10).
* Meteor damage (defaults to 5, min 1, max 50).
* Meteor random damage (defaults to 0, min 0, max 10).
* If Aliens can be spawned (defaults to disabled).
** Alien spawn chance (defaults to 20, min 0.1, max 100).
** Alien default health (defaults to 10, min 1, max 20).
** Alien random health (defaults to 3, min 0, max 10).
* Storm name.
* If the storm repeats itself (defaults to disabled).
** If enabled - the storm will happen on a random turn number between a lower and upper limit plus the turn the storm ended on:
*** The minimum amount of turns until meteor storm is repeated (defaults to 10, min 0, max 50).
*** The maximum amount of turns until meteor storm is repeated (defaults to 20, min 0, max 50).

===== Normal Storms =====
Normal storm settings:
* [[#Storm%20Settings|Common storm settings]].
* Chance of meteors falling (defaults to 100, min 0.1, max 100).
* If meteors only fall between set turns (defaults to disabled).
** If enabled:
*** Number of turns after the meteors can fall (defaults to 5, min 1, max 20).
*** Number of turns after meteors stop falling (defaults to 20, min 1, max 50).
** If disabled: meteors fall every turn.

===== Doomsday Storms =====
Doomsday storm settings:
* [[#Storm%20Settings|Common storm settings]].
* If the storm happens on a random or fixed turn (defaults to disabled i.e. fixed turn).
** If enabled - a random turn between bounds is used:
*** Minimum turn bound (defaults to 10, min 5, max 20).
*** Maximum turn bound (defaults to 30, min 10, max 50).
** If disabled:
*** Which turn the storm happens on (defaults to 20, min 5, max 20).

== Alien ==

<table>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top; width: 100%;">

{{Special Unit infobox
|img=https://raw.githubusercontent.com/JustMe003/WarzoneMods/main/Meteor%20Strike%20Plus/SpecialUnitImages/Alien.png
|namePrefix=An
|name=Alien
|CombatOrder=477
|Health=Customizable
|AttackPower=Same as Health
|DefensePower=Same as Health
|CanBeAirliftedToSelf=No 
|CanBeAirliftedToTeammate=No
|CanBeGiftedWithGiftCard=No
|CanBeTransferredToTeammate=No
}}
</td>
</tr>
</table>

== Easter Egg ==
<table>
<tr>
<td style="vertical-align: top;">
If the "Easter egg" is enabled in settings, <strong>Alien UFO</strong> [[special unit]]s have a 1% chance of being created when an Alien would otherwise normally be created.
</td>
<td style="vertical-align: top;">
{{Special Unit infobox
|img=https://raw.githubusercontent.com/JustMe003/WarzoneMods/main/Meteor%20Strike%20Plus/SpecialUnitImages/UFO.png
|namePrefix=An
|name=Alien UFO
|CombatOrder=478
|Health=Alien Starting health * 2
|AttackPower=Same as Health
|DefensePower=Same as Health
|CanBeAirliftedToSelf=No
|CanBeAirliftedToTeammate=No
|CanBeGiftedWithGiftCard=No
|CanBeTransferredToTeammate=No
}}
</td>
</tr>
</table>

== See also ==
* [[Meteor Strike]]

Mod API Reference:TurnPhase

2024-12-04T22:33:35Z

JustADutchman: Added link to the page where Turn Phases are shown in order

'''TurnPhase''' ''(Byte)'':
* '''Airlift''':
* '''Attacks''':
* '''BlockadeCards''':
* '''BombCards''':
* '''CardsWearOff''':
* '''Deploys''':
* '''DiplomacyCards''':
* '''Discards''':
* '''EmergencyBlockadeCards''':
* '''Gift''':
* '''OrderPriorityCards''':
* '''Purchase''':
* '''ReceiveCards''':
* '''ReinforcementCards''':
* '''SanctionCards''':
* '''SpyingCards''':

These are the turn phases in alphabetical order. If you want to know in which order they are processed, see [[Turn phases]]
[[Category:Mod API Reference]]

Special units are Medics

2022-02-23T13:31:37Z

JustADutchman:

== Mod description ==
This Mod allows special units to revive 100% of the lost armies in the territories connected to the special units. The effect won't work if they are killed by a bomb card or if a special unit is involved in any way in the attack (including if the attack comes from a territoy with a special unit.)

== How does it work ==
This mod is relatively simple and allows you to do some crazy stuff, things like generating armies while you’re expanding or defend twice with armies while defending. But when you want to use these methods you do need to know when your armies get revived. There are 2 scenarios where the mod will revive your lost armies back:
* You defend against a player / AI while both defending and attacking territory don’t contain a special unit
* You attack anyone (neutral, AI, a player) and (one of) your special unit(s) is next to the defending territory, but not on the attacking territory.

== Examples ==
If these scenarios above are a bit difficult to understand, just know that whenever a special unit is involved in the attack your armies won’t get revived. Note that so far of all the special units only the commander is available for use, the four bosses can be made available for Warzone multiplayer and custom single player games but there is yet a mod to be made for it.

If it is still not clear how this mod works, this [https://docs.google.com/document/d/1qbUxFYOrLL-ZN-yzUpEqNfQjePixV675zwZwXhfhhFU/edit?usp=sharing#heading=h.oov58nw6v7cd link] will take you to some examples with images.

== How to set up ==
There are no options on this mod, but to make the mod actually do something you’ll need to include special units in your game. So far the only special unit is the commander, the four bosses are available for mods but are not yet included in any.

== Compatibility ==
This mod used to have an exploit but this was fixed when Warzone was updated to 5.17. Now at this date the mod is compatible with every setting and mod

== More information ==
*[https://docs.google.com/document/d/1qbUxFYOrLL-ZN-yzUpEqNfQjePixV675zwZwXhfhhFU/edit?usp=sharing#heading=h.5c6ts6j5clwa Mod manual]
*[[Mods]]
[[category:Mods]]

Special units are Medics

2022-02-23T13:31:21Z

JustADutchman:

Special units are Medics

2022-02-23T13:30:12Z

JustADutchman: Created page with "== Mod description == This Mod allows special units to revive 100% of the lost armies in the territories connected to the special units. The effect won't work if they are kill..."

King of the Hill

2022-02-23T13:18:06Z

JustADutchman: Created page with "== Mod description == This mod adds one new rule: If you hold all hills at the end of a turn, you win. The number and size of hills can be altered. The hills are indicated wit..."

== Mod description ==
This mod adds one new rule: If you hold all hills at the end of a turn, you win. The number and size of hills can be altered. The hills are indicated with Mines and can be found by clicking 'Game' on the bottom left and then 'Mod: King Of The Hill'. In team games, the game ends when a team holds all the hills.

== How does it work ==
This mod adds a new feature to the game, an extra method / strategy to win a game. The mod chooses a few random territories on the map which will work like ‘hills’ (the number of territories is configurable) which are indicated by mines. These ‘hills’ don’t do anything except for when you control all the hills in the game at the end of a turn. Your opponents will automatically lose all their territories and thus are eliminated, leaving only you in the game which makes you the winner. This even works with teams, if a team holds all the ‘hills’ at the end of a turn all the other teams will get eliminated. In this case it doesn’t matter if one player holds all the ‘hills’ or multiple do.

== How to set up ==
There are 2 configurable options. The number of hills and the number of armies the hills will have at the start of the game.

Due to how the mod configuration is set up, I wouldn’t recommend setting up a game with it on mobile since the text is barely readable.

== Compatibility ==
This mod is compatible with every other mod at this date, but beware that you don't combine it with other mods that add mines too

== Other pages ==
*[[Mods]]
[[category:Mods]]

Press This Button

2022-02-23T13:08:00Z

JustADutchman: Created page with "== Mod description == This mod adds a button that will reduce the next turn's income of a player by X% if they do not press the button in their current turn. AI's will not be ..."

== Mod description ==
This mod adds a button that will reduce the next turn's income of a player by X% if they do not press the button in their current turn. AI's will not be affected by this mod. Once the game started, you can find the button under Game > Press This Button

== How to use ==
This mod adds something like a dead man’s button to the game, with a punishment if the player does not push the button in time for the next turn. If you succeed in pushing the button, nothing will happen. If you fail to push the button, then your income will get adjusted downwards by a certain percentage. The button can be found in the mod menu. It's big, red and hard to miss :)

== How to set up ==
There are 2 configurable options. The first option is the percentage of income the player will lose when the player fails to hit the button in time. This number can be anywhere between 1 and 100 percent.

The second option is to allow the mod to warn the player when they have failed to push the button the previous turn. Unchecking this checkbox won’t send out an alert to the player when they fail to push the button.

== Other pages ==
*[[Mods]]
[[category:Mods]]

Hybrid Distribution

2022-02-23T13:03:16Z

JustADutchman:

== Mod description ==
Allows for some territories to be auto-distributed and some to be manual-distributed (picked).

== How does it work? ==
Normally you would have either an automatic distribution (get random territories) or a manual distribution where you could specify an order of picks to allow you to set yourself up. This mod combines the two, resulting in a ‘hybrid’ distribution.

The game creator can specify how many territories everyone gets before the distribution phase. You will have at least one territory on the map and everyone can see this. You can also see everyone else their auto-distributed territories so you can use this information in the distribution phase.

== How to set up ==
This mod only has one setting, the number of auto-distributed territories. There are a few notes though.
*You have to set the game to manual distribution yourself, the mod doesn’t overwrite this setting and the mod will do nothing if the game uses automatic distribution
The mod will auto distribute territories from neutrals, leaving the pickable
*The mod will auto distribute territories from neutrals, leaving the pickable territories. Note that playing with full distribution and no wastelands the mod will not auto-distribute territories and note that when playing with full distribution and wastelands enabled the mod will only auto-distribute wastelands.
*The mod will not overwrite the number of armies on the territories, so this would be equal to the number of armies in neutrals not in the distribution. Note that when playing with wastelands these army numbers don’t change. Players can end up with a wasteland, keeping the amount of armies.

If you’re looking to avoid one of these, you should use [[Hybrid Distribution 2]]

== Compatibility ==
This mod is compatible with every setting and mod in warzone at this date, it can even be used in combination with [[Hybrid Distribution 2]]

== Other pages ==
*[[Initial Territory Distribution]]
*[[Hybrid Distribution 2]]
*[[Mods]]
[[category:Mods]]

Hybrid Distribution 2

2022-02-23T13:02:01Z

JustADutchman:

== Mod description ==
Allows for some territories to be auto-distributed and some to be manual-distributed (picked) with more options.
*Choose if territories in the distribution or neutrals are auto-distributed
*Choose if auto-distributed territories have the same amount of armies as manual-distributed territories or as neutrals not in the distribution
*This mod overwrites wastelands, [[Hybrid Distribution]] does not. This can lead to players having wastelands and thus more or less armies than their opponent
*Forces the game to be manual distribution since the mod does nothing with auto distribution

== How does it work ==
The Hybrid Distribution 2 mod does the same thing as [[Hybrid Distribution]] but has more options and better compatibility.

Normally you would have either an automatic distribution (get random territories) or a manual distribution where you could specify an order of picks to allow you to set yourself up. This mod combines the two, resulting in a ‘hybrid’ distribution.

The game creator can specify how many territories everyone gets before the distribution phase. You will have at least one territory on the map and everyone can see this. You can also see everyone else their auto-distributed territories so you can use this information in the distribution phase.

== How to set up ==
The mod has 3 options, with one being similar to [[Hybrid Distribution]]. You’ll have to specify how many territories each player gets auto-distributed before the distribution phase. The other 2 options let you control which territories are auto-distributed and how many armies should be on those territories.

The second setting is a checkbox, which lets you control if the territories in the distribution are auto-distributed or neutrals (including wastelands, they get overwritten). The third option is also a checkbox and lets you specify what the amount of armies on the auto-distributed territories should be. Leaving this option checked will result in those territories having the same amount of armies as manual-distributed territories, unchecking this option will result in the same behavior as [[Hybrid Distribution]] except for the fact this mod does override wastelands.

== Compatibility ==
This mod is compatible with every setting and mod at this date, it can even be used incombination with [[Hybrid Distribution]]

== Other pages ==
*[[Initial Territory Distribution]]
*[[Hybrid Distribution]]
*[[Mods]]
[[category:Mods]]

Hybrid Distribution 2

2022-02-23T13:01:48Z

JustADutchman:

Hybrid Distribution 2

2022-02-23T13:01:24Z

JustADutchman: Created page with "== Mod description == Allows for some territories to be auto-distributed and some to be manual-distributed (picked) with more options. *Choose if territories in the distributi..."

Hybrid Distribution

2022-02-23T12:55:59Z

JustADutchman:

Hybrid Distribution

2022-02-23T12:54:44Z

JustADutchman:

== Mod description ==
Allows for some territories to be auto-distributed and some to be manual-distributed (picked).

== How does it work? ==
Normally you would have either an automatic distribution (get random territories) or a manual distribution where you could specify an order of picks to allow you to set yourself up. This mod combines the two, resulting in a ‘hybrid’ distribution.

The game creator can specify how many territories everyone gets before the distribution phase. You will have at least one territory on the map and everyone can see this. You can also see everyone else their auto-distributed territories so you can use this information in the distribution phase.

== How to set up ==
This mod only has one setting, the number of auto-distributed territories. There are a few notes though.
*You have to set the game to manual distribution yourself, the mod doesn’t overwrite this setting and the mod will do nothing if the game uses automatic distribution
The mod will auto distribute territories from neutrals, leaving the pickable
*The mod will auto distribute territories from neutrals, leaving the pickable territories. Note that playing with full distribution and no wastelands the mod will not auto-distribute territories and note that when playing with full distribution and wastelands enabled the mod will only auto-distribute wastelands.
*The mod will not overwrite the number of armies on the territories, so this would be equal to the number of armies in neutrals not in the distribution. Note that when playing with wastelands these army numbers don’t change. Players can end up with a wasteland, keeping the amount of armies.

If you’re looking to avoid one of these, you should use [[Hybrid Distribution 2]]

== Compatibility ==
This mod is compatible with every setting and mod in warzone at this date, it can even be used in combination with [[Hybrid Distribution 2]]

== Other pages ==
*[[Distribution]]
*[[Hybrid Distribution 2]]
[[category:Mods]]

Hybrid Distribution

2022-02-23T12:53:05Z

JustADutchman: Created page with "== Mod description == Allows for some territories to be auto-distributed and some to be manual-distributed (picked). == How does it work? == Normally you would have either an..."

== Mod description ==
Allows for some territories to be auto-distributed and some to be manual-distributed (picked).

== How does it work? ==
Normally you would have either an automatic distribution (get random territories) or a manual distribution where you could specify an order of picks to allow you to set yourself up. This mod combines the two, resulting in a ‘hybrid’ distribution.

The game creator can specify how many territories everyone gets before the distribution phase. You will have at least one territory on the map and everyone can see this. You can also see everyone else their auto-distributed territories so you can use this information in the distribution phase.

== How to set up ==
This mod only has one setting, the number of auto-distributed territories. There are a few notes though.
*You have to set the game to manual distribution yourself, the mod doesn’t overwrite this setting and the mod will do nothing if the game uses automatic distribution
The mod will auto distribute territories from neutrals, leaving the pickable
*The mod will auto distribute territories from neutrals, leaving the pickable territories. Note that playing with full distribution and no wastelands the mod will not auto-distribute territories and note that when playing with full distribution and wastelands enabled the mod will only auto-distribute wastelands.
*The mod will not overwrite the number of armies on the territories, so this would be equal to the number of armies in neutrals not in the distribution. Note that when playing with wastelands these army numbers don’t change. Players can end up with a wasteland, keeping the amount of armies.

If you’re looking to avoid one of these, you should use [[Hybrid Distribution 2]]

== compatibility ==
This mod is compatible with every setting and mod in warzone at this date, it can even be used in combination with [[Hybrid Distribution 2]]

Limited Multiattacks

2022-02-22T14:39:48Z

JustADutchman: Created page with "== Mod description == This mod allows you to limit the attack range of multiattack. Furthermore, you can bind it to cards == How to use == <div style="float:right"> https://i..."

== Mod description ==
This mod allows you to limit the attack range of multiattack. Furthermore, you can bind it to cards

== How to use ==
<div style="float:right">
https://i.ibb.co/jWsJjmY/multi-attack-chain.png

an attack chain
</div>
It is quite important to check up on the mod settings when a game uses this mod. There are 2 settings you have to know to use multi attack properly:
#Is multi attack bound to a card or multiple cards?
#What is the limit of a multi attack chain?

When multi attack is bound to a card or multiple cards the effect of multi attack is only enabled when you’ve played one of those cards. If multi attack is bound to the reinforcement card you’ll only be able to use multi attack if you played the reinforcement card. If it is bound to multiple cards (say spy card and gift card) you’ll only have to play 1 of (either) those cards, not both to enable multi attack. Note that multi attack is only enabled for you if you played the card, if other players want to have multi attack too they too have to play a card that enables it.

If you enable multi attack (or when it is always enabled) you still have to watch out for the limit of multi attacks. The mod keeps track of how many attacks armies have made so when they reach the limit the attacks are canceled, most of the time breaking your normal multi attack chain (an attack gets skipped, and all other attacks in the chain won’t go through since you don’t own the attacking territory) and leads to confusion for most players.

When the limit of multi attacks is not set to 0 attacks after the limit reached will be canceled. If the limit is set to 5, you’re able to make 1 attack as you normally do in every warzone game and pre-route 4 other attacks using the same armies. If you make one more pre-routed attack it will get canceled, leading that (if there are even more) attacks after the canceled attack won’t happen as you would imagine since you don’t own the attacking territory at the time the order is happening.

Note that when armies make a transfer they are completely stuck for the rest of the turn. This is the case in every Warzone game. it is not (yet) possible to cancel this, even in normal multi attack games.

== How to set up ==
*You don’t need to enable multi attack yourself, the mod will override this setting.
*You can specify what the limit of multi attacks will be (see bugs for an ongoing issue). This value can be set to any number between 0 and 100.000.
*To make the multi attacks behave like a normal Warzone game with multi attack you should keep the option on. If you keep the option off every failed attack will freeze the remaining armies on the territory the attack was from, canceling all attacks / transfers from this territory.
*The remaining checkboxes are for binding multi attack to a card or cards. Check the boxes of the corresponding cards you want, if you want multi attack to be bound to a card or cards. If you don’t want multi attack to be bound to a card or cards, leave all the checkboxes unchecked.

== Bugs ==
*(bugfix in review) Currently it is not yet possible to set the limit of multi attack to 0, although the UI does tell you it is. Trying to do this results in an alert telling you it is not possible, and even if the value goes through it gets overwritten to 1. If you want to have unlimited multi attacks (most usable in combination with enabling it with cards) you can set it to 100.000, which is technically infinite multi attacks
*(Bug solved) When transferring to a territory all attack / transfer orders from the receiving territory gets canceled.

== Compatibility ==
This mod is compatible with every settings and mod as far as we know

Advanced Diplo Mod

2022-02-22T14:06:43Z

JustADutchman:

The Advanced Diplomacy [[Mod]] was created by user [https://www.warzone.com/Profile?p=5852007897 dabo1]

Report any crashes to dabo1.

Every player starts at peace with each other. There are 3 levels of diplomacy status between players:
*allied (to attack an ally, you have to cancel the alliance, wait a turn, then cancel the peace treaty(declare war), and wait another turn)
*at peace (to attack someone you are at peace with, you have to declare war). This will take effect in 1 turn.
*at war (the default status of Warzone)

Unlike regular [[diplo]] games, attacks while allied/at peace DO NOT count as war declarations, since they simply do not happen

==Basic features==

*Prevent AIs from attacking
*Declare war (if allied or at peace). Will take 1 turn.
*Offer peace. This is effectively a cease-fire unless turned into an alliance. If the peace offer is accepted the same turn, and you had committed attacks, your attacks will be canceled by the mod.
*Offer alliance (if at peace). Can be accepted the same turn.
*Cancel the alliance (if allied). Will take effect the next turn.
*Pending requests: see a list of requests from other players. This list will pop up at the beginning of your turn. You can decline the request if you do not wish to see
*Mod history: see a list of alliances and war declarations and peace offers.
*Alliances:
**You can see all the territories your ally sees(depends on settings). This only works if spy cards are in the game.
**Can be public or private (depends on settings)
*Trading
**It is advised to use gift cards for trading since you can not attack without war

==Example games==
*https://www.warzone.com/MultiPlayer?GameID=13922952 (uses commerce)
*https://www.warzone.com/MultiPlayer?GameID=13901792

==Frequently Asked Questions:==
click [https://docs.google.com/document/d/1qbUxFYOrLL-ZN-yzUpEqNfQjePixV675zwZwXhfhhFU/edit?usp=sharing#heading=h.eumtsl9q2ho6 this] for an more in-depth manual for this mod

Q: How do I declare war?
Note: Attacks do NOT count as war declarations.
A: To declare war, click
Game
Mod: Advanced Diplo V4
Declare War
Select Player...
(Select the player from the list)
Declare

Q: Does gifting a territory count as a card piece?
A: No

Q: How do I accept a peace request? A: To accept peace, click
Game
Mod: Advanced Diplo V4
Pending Requests
and then search the offer and click accept

Q: Is the bomb/sanction card an act of war?
The [[Sanction card]] and all other cards that require war can not be played if they require war and you are not at war, but they do not declare war.
You cannot [[bomb]] unless you're at war (
This can be overwritten in the mod settings at game creation)

Q: What if I bomb/sanction someone I'm allied with?
Check the game mod settings. The game creator can allow bomb/sanction to be used on allies and players you are in peace with, but this is disabled by default.

==Mod limitations:==
Do not use in conjunction with other mods that use a pop-up notification system

In order to have the feature "See ally territories" working you need to have spy cards included in the game

Report any crashes to dabo1.

==See also==
*[[Diplomacy Gametype]]
*[[Mods]]
*[https://github.com/dabo123148/WarlightMod source code]
[[Category:Mods]]

Advanced Diplo Mod

2022-02-22T14:06:06Z

JustADutchman:

The Advanced Diplomacy [[Mod]] was created by user [https://www.warzone.com/Profile?p=5852007897 dabo1]

Report any crashes to dabo1.

Every player starts at peace with each other. There are 3 levels of diplomacy status between players:
*allied (to attack an ally, you have to cancel the alliance, wait a turn, then cancel the peace treaty(declare war), and wait another turn)
*at peace (to attack someone you are at peace with, you have to declare war). This will take effect in 1 turn.
*at war (the default status of Warzone)

Unlike regular [[diplo]] games, attacks while allied/at peace DO NOT count as war declarations, since they simply do not happen

==Basic features==

*Prevent AIs from attacking
*Declare war (if allied or at peace). Will take 1 turn.
*Offer peace. This is effectively a cease-fire unless turned into an alliance. If the peace offer is accepted the same turn, and you had committed attacks, your attacks will be canceled by the mod.
*Offer alliance (if at peace). Can be accepted the same turn.
*Cancel the alliance (if allied). Will take effect the next turn.
*Pending requests: see a list of requests from other players. This list will pop up at the beginning of your turn. You can decline the request if you do not wish to see
*Mod history: see a list of alliances and war declarations and peace offers.
*Alliances:
**You can see all the territories your ally sees(depends on settings). This only works if spy cards are in the game.
**Can be public or private (depends on settings)
*Trading
**It is advised to use gift cards for trading since you can not attack without war

==Example games==
*https://www.warzone.com/MultiPlayer?GameID=13922952 (uses commerce)
*https://www.warzone.com/MultiPlayer?GameID=13901792

==Frequently Asked Questions:==
click [https://docs.google.com/document/d/1qbUxFYOrLL-ZN-yzUpEqNfQjePixV675zwZwXhfhhFU/edit?usp=sharing this] for an more in-depth manual for this mod

Q: How do I declare war?
Note: Attacks do NOT count as war declarations.
A: To declare war, click
Game
Mod: Advanced Diplo V4
Declare War
Select Player...
(Select the player from the list)
Declare

Q: Does gifting a territory count as a card piece?
A: No

Q: How do I accept a peace request? A: To accept peace, click
Game
Mod: Advanced Diplo V4
Pending Requests
and then search the offer and click accept

Q: Is the bomb/sanction card an act of war?
The [[Sanction card]] and all other cards that require war can not be played if they require war and you are not at war, but they do not declare war.
You cannot [[bomb]] unless you're at war (
This can be overwritten in the mod settings at game creation)

Q: What if I bomb/sanction someone I'm allied with?
Check the game mod settings. The game creator can allow bomb/sanction to be used on allies and players you are in peace with, but this is disabled by default.

==Mod limitations:==
Do not use in conjunction with other mods that use a pop-up notification system

In order to have the feature "See ally territories" working you need to have spy cards included in the game

Report any crashes to dabo1.

==See also==
*[[Diplomacy Gametype]]
*[[Mods]]
*[https://github.com/dabo123148/WarlightMod source code]
[[Category:Mods]]

Advanced Diplo Mod

2022-02-22T14:05:28Z

JustADutchman:

The Advanced Diplomacy [[Mod]] was created by user [https://www.warzone.com/Profile?p=5852007897 dabo1]

Report any crashes to dabo1.

Every player starts at peace with each other. There are 3 levels of diplomacy status between players:
*allied (to attack an ally, you have to cancel the alliance, wait a turn, then cancel the peace treaty(declare war), and wait another turn)
*at peace (to attack someone you are at peace with, you have to declare war). This will take effect in 1 turn.
*at war (the default status of Warzone)

Unlike regular [[diplo]] games, attacks while allied/at peace DO NOT count as war declarations, since they simply do not happen

==Basic features==

*Prevent AIs from attacking
*Declare war (if allied or at peace). Will take 1 turn.
*Offer peace. This is effectively a cease-fire unless turned into an alliance. If the peace offer is accepted the same turn, and you had committed attacks, your attacks will be canceled by the mod.
*Offer alliance (if at peace). Can be accepted the same turn.
*Cancel the alliance (if allied). Will take effect the next turn.
*Pending requests: see a list of requests from other players. This list will pop up at the beginning of your turn. You can decline the request if you do not wish to see
*Mod history: see a list of alliances and war declarations and peace offers.
*Alliances:
**You can see all the territories your ally sees(depends on settings). This only works if spy cards are in the game.
**Can be public or private (depends on settings)
*Trading
**It is advised to use gift cards for trading since you can not attack without war

==Example games==
*https://www.warzone.com/MultiPlayer?GameID=13922952 (uses commerce)
*https://www.warzone.com/MultiPlayer?GameID=13901792

==Frequently Asked Questions:==
click this link for an more in-depth manual for this mod
[https://docs.google.com/document/d/1qbUxFYOrLL-ZN-yzUpEqNfQjePixV675zwZwXhfhhFU/edit?usp=sharing manual]

Q: How do I declare war?
Note: Attacks do NOT count as war declarations.
A: To declare war, click
Game
Mod: Advanced Diplo V4
Declare War
Select Player...
(Select the player from the list)
Declare

Q: Does gifting a territory count as a card piece?
A: No

Q: How do I accept a peace request? A: To accept peace, click
Game
Mod: Advanced Diplo V4
Pending Requests
and then search the offer and click accept

Q: Is the bomb/sanction card an act of war?
The [[Sanction card]] and all other cards that require war can not be played if they require war and you are not at war, but they do not declare war.
You cannot [[bomb]] unless you're at war (
This can be overwritten in the mod settings at game creation)

Q: What if I bomb/sanction someone I'm allied with?
Check the game mod settings. The game creator can allow bomb/sanction to be used on allies and players you are in peace with, but this is disabled by default.

==Mod limitations:==
Do not use in conjunction with other mods that use a pop-up notification system

In order to have the feature "See ally territories" working you need to have spy cards included in the game

Report any crashes to dabo1.

==See also==
*[[Diplomacy Gametype]]
*[[Mods]]
*[https://github.com/dabo123148/WarlightMod source code]
[[Category:Mods]]

Advanced Diplo Mod

2022-02-22T14:04:52Z

JustADutchman:

The Advanced Diplomacy [[Mod]] was created by user [https://www.warzone.com/Profile?p=5852007897 dabo1]

Report any crashes to dabo1.

Every player starts at peace with each other. There are 3 levels of diplomacy status between players:
*allied (to attack an ally, you have to cancel the alliance, wait a turn, then cancel the peace treaty(declare war), and wait another turn)
*at peace (to attack someone you are at peace with, you have to declare war). This will take effect in 1 turn.
*at war (the default status of Warzone)

Unlike regular [[diplo]] games, attacks while allied/at peace DO NOT count as war declarations, since they simply do not happen

==Basic features==

*Prevent AIs from attacking
*Declare war (if allied or at peace). Will take 1 turn.
*Offer peace. This is effectively a cease-fire unless turned into an alliance. If the peace offer is accepted the same turn, and you had committed attacks, your attacks will be canceled by the mod.
*Offer alliance (if at peace). Can be accepted the same turn.
*Cancel the alliance (if allied). Will take effect the next turn.
*Pending requests: see a list of requests from other players. This list will pop up at the beginning of your turn. You can decline the request if you do not wish to see
*Mod history: see a list of alliances and war declarations and peace offers.
*Alliances:
**You can see all the territories your ally sees(depends on settings). This only works if spy cards are in the game.
**Can be public or private (depends on settings)
*Trading
**It is advised to use gift cards for trading since you can not attack without war

==Example games==
*https://www.warzone.com/MultiPlayer?GameID=13922952 (uses commerce)
*https://www.warzone.com/MultiPlayer?GameID=13901792

==Frequently Asked Questions:==
click this link for an more in-depth manual for this mod
[https://docs.google.com/document/d/1qbUxFYOrLL-ZN-yzUpEqNfQjePixV675zwZwXhfhhFU/edit?usp=sharing]
Q: How do I declare war?
Note: Attacks do NOT count as war declarations.
A: To declare war, click
Game
Mod: Advanced Diplo V4
Declare War
Select Player...
(Select the player from the list)
Declare

Q: Does gifting a territory count as a card piece?
A: No

Q: How do I accept a peace request? A: To accept peace, click
Game
Mod: Advanced Diplo V4
Pending Requests
and then search the offer and click accept

Q: Is the bomb/sanction card an act of war?
The [[Sanction card]] and all other cards that require war can not be played if they require war and you are not at war, but they do not declare war.
You cannot [[bomb]] unless you're at war (
This can be overwritten in the mod settings at game creation)

Q: What if I bomb/sanction someone I'm allied with?
Check the game mod settings. The game creator can allow bomb/sanction to be used on allies and players you are in peace with, but this is disabled by default.

==Mod limitations:==
Do not use in conjunction with other mods that use a pop-up notification system

In order to have the feature "See ally territories" working you need to have spy cards included in the game

Report any crashes to dabo1.

==See also==
*[[Diplomacy Gametype]]
*[[Mods]]
*[https://github.com/dabo123148/WarlightMod source code]
[[Category:Mods]]

AI's don't play cards: How to set up

2022-02-22T14:00:03Z

JustADutchman: Blanked the page

AI's don't play cards

2022-02-22T13:59:34Z

JustADutchman:

== Mod description ==
Prevents AI's from playing cards, configurable for all (except reinforcement) cards AI's play. Note that checking a checkbox allows an AI to play that card

== How does it work ==
This mod prevents AI from playing cards. It simply checks every order in the order list when a turn gets processed. When the mod finds a card being played by an AI, it checks if the AI is allowed to play the card (configurable in the mod configuration) and cancels the order if the AI is not allowed to play it. If a player gets booted but returns it will find (unless the AI decided to discard some cards) all his cards untouched.

== How to set up ==
When adding the mod to the game you’ll get the mod configuration. Here you’re able to specify for each AI playable card if AIs are allowed to play the card or not. Note that when adding the mod all the settings are on their default False value, when you want AIs to play a certain card (eg. the blockade card) you should tick the corresponding checkbox which will allow the AIs to play that card.

These 5 cards AIs play can be configured:
*[[Blockade card]]
*[[Emergency Blockade Card]]
*[[Sanction card]]
*[[Diplomacy card]]
*[[Bomb card]]

Note that AIs always play reinforcement cards, but canceling this is way more difficult due to the way warzone handles these cards. For a better explanation see [[AI's don't play cards: How does it work]]

== Other pages ==
*[[cards]]
*[[mods]]
[[category:mods]]

AI's don't play cards

2022-02-22T13:58:51Z

JustADutchman:

AI's don't play cards: How does it work

2022-02-22T13:58:15Z

JustADutchman: Blanked the page

AI's don't play cards: How to set up

2022-02-21T17:21:20Z

JustADutchman:

When adding the mod to the game you’ll get the mod configuration. Here you’re able to specify for each AI playable card if AIs are allowed to play the card or not. Note that when adding the mod all the settings are on their default False value, when you want AIs to play a certain card (eg. the blockade card) you should tick the corresponding checkbox which will allow the AIs to play that card.

These 5 cards AIs play can be configured:
*[[Blockade card]]
*[[Emergency Blockade Card]]
*[[Sanction card]]
*[[Diplomacy card]]
*[[Bomb card]]

Note that AIs always play reinforcement cards, but canceling this is way more difficult due to the way warzone handles these cards. For a better explanation see [[AI's don't play cards: How does it work]]

== other pages ==
*[[AI's don't play cards]]
*[[mods]]
[[category:mods]]

AI's don't play cards: How to set up

2022-02-21T17:20:50Z

JustADutchman: Created page with "When adding the mod to the game you’ll get the mod configuration. Here you’re able to specify for each AI playable card if AIs are allowed to play the card or not. Note th..."

When adding the mod to the game you’ll get the mod configuration. Here you’re able to specify for each AI playable card if AIs are allowed to play the card or not. Note that when adding the mod all the settings are on their default False value, when you want AIs to play a certain card (eg. the blockade card) you should tick the corresponding checkbox which will allow the AIs to play that card.

These 5 cards AIs play can be configured:
*[[Blockade card]]
*[[Emergency blockade card]]
*[[Sanction card]]
*[[Diplomacy card]]
*[[Bomb card]]

Note that AIs always play reinforcement cards, but canceling this is way more difficult due to the way warzone handles these cards. For a better explanation see [[AI's don't play cards: How does it work]]

== other pages ==
*[[AI's don't play cards]]
*[[mods]]
[[category:mods]]

AI's don't play cards: How does it work

2022-02-21T17:16:46Z

JustADutchman: Created page with "This mod prevents AI from playing cards. It simply checks every order in the order list when a turn gets processed. When the mod finds a card being played by an AI, it checks ..."

This mod prevents AI from playing cards. It simply checks every order in the order list when a turn gets processed. When the mod finds a card being played by an AI, it checks if the AI is allowed to play the card (configurable in the mod configuration) and cancels the order if the AI is not allowed to play it. If a player gets booted but returns it will find (unless the AI decided to discard some cards) all his cards untouched.

AI's don't play cards

2022-02-21T17:16:19Z

JustADutchman: Created page with "== Mod description == Prevents AI's from playing cards, configurable for all (except reinforcement) cards AI's play. Note that checking a checkbox allows an AI to play that ca..."

== Mod description ==
Prevents AI's from playing cards, configurable for all (except reinforcement) cards AI's play. Note that checking a checkbox allows an AI to play that card

== Other pages ==
*[[AI's don't play cards: How does it work]]
*[[AI's don't play cards: How to set up]]
*[[cards]]
*[[mods]]
[[category:mods]]

Buy Neutral: Compatibility

2022-02-21T17:04:36Z

JustADutchman: Created page with "This mod is compatible with every setting, but does need the game to be a commerce game to allow the mod to be actually used. Nevertheless this mod lacks some useful features ..."

This mod is compatible with every setting, but does need the game to be a commerce game to allow the mod to be actually used. Nevertheless this mod lacks some useful features and really needs an update or revamp.

Buy Neutral: Bugs

2022-02-21T17:04:21Z

JustADutchman: Created page with "There are currently no bugs with this mod"

There are currently no bugs with this mod

Buy Neutral: How to set up

2022-02-21T17:04:02Z

JustADutchman: Created page with "When you add this mod you have to make sure you enable commerce, otherwise the mod won’t do anything and players won’t be able to create purchase orders at all. Also be ..."

When you add this mod you have to make sure you enable commerce, otherwise the mod won’t do anything and players won’t be able to create purchase orders at all.

Also be careful with the multiplier. When you set the multiplier to high, buying neutrals will get extremely inefficiënt but setting it to low, it becomes extremely efficiënt. The bare minimum in my opinion is 1, although it is possible to set it to 0. But by doing so you will give players the possibility to buy every territory they can fully see for free, resulting in a massive auction where the players who know what is listed above (how to use) will get a massive advantage.

Buy Neutral: How to use

2022-02-21T17:03:27Z

JustADutchman: Created page with "This mod allows players to buy neutral territories with gold, the price of the territory is determined by the amount of armies and the multiplier configured by the game creato..."

This mod allows players to buy neutral territories with gold, the price of the territory is determined by the amount of armies and the multiplier configured by the game creator.

There are some things you should know before you start asking questions. The most notable thing you should know is that only territories you can fully see are purchasable. When playing with light or dense (also heavy) fog you will be able to see who owns the territory, but not the army count and which special units. The mod sees this as ‘not fully’ visible’ and these territories are not purchasable. To buy a territory in light, dense or heavy fog that is not fully visible, you should play a reconnaissance, surveillance or spy (only if you’re able to spy on neutral) card.

Second, when you add the order to buy a territory does not mean you will buy the territory for sure. When the turn advances, the mod will look at every purchase order and check if the territory is still neutral. If the territory is not neutral anymore at the time your purchase order gets processed, nothing will happen. Note that the purchase order type is GameOrderCustom, you can put these orders wherever you want in your order list. You can even put them before your deployment orders where they will get processed before any deployment orders, even those of your opponents.

Third, the amount of armies on the neutral territory can differ at the time your purchase order gets processed then when you added the order in your order list. If the amount of armies on the territory is more than you originally paid for your purchase will get canceled. If the amount of armies is less than you originally paid for and the territory is still neutral, you will buy the territory but won’t get any compensation for paying too much.

At last, when playing on a big map, with a lot of neutral territories and no fog, the list where you can choose the territories from will be really, really big. Creating the list will take a while and searching for a precise territory is a task which requires a lot of patience. In this case I strongly recommend using the browser version to submit your turn. You can use [ctrl] + [F] to search for the name of the territory in the list which is way easier and faster than looking at every possible territory in the list. Note you cannot add these orders in the browser and finish creating your orders on mobile or in the app since the purchase orders will not be stored on the browser. The other way around is possible though.

Buy Neutral

2022-02-21T17:02:36Z

JustADutchman:

== Mod description ==
Allows players to purchase neutral territories with gold rather than conquering them by force. Requires that the game is a [[commerce]] game, and will do nothing otherwise.
The game creator can configure how expensive territories are to purchase, based on how many armies are on the neutral territory. To initiate a purchase, click the button for the mod on the menu, select the territory, and a purchase order will be inserted into your orders list. The purchase will complete when the turn advances.

==See also==
*[[Buy Neutral: How to use]]
*[[Buy Neutral: How to set up]]
*[[Buy Neutral: Bugs]]
*[[Buy Neutral: Compatibility]]
*[[Commerce]]
*[[Mods]]
[[Category:Mods]]

Advanced Diplomacy Mod V4

2022-02-21T16:55:41Z

JustADutchman: Redirected page to Advanced Diplomacy Mod

#REDIRECT [[Advanced Diplomacy Mod]]

Advanced Diplomacy Mod V4

2022-02-21T16:55:22Z

JustADutchman: Created page with "#REDIRECT Advanced Diplomacy Mod"

#REDIRECT Advanced Diplomacy Mod

Mods

2022-02-21T16:16:31Z

JustADutchman: updated the mod list

'''Mods''' are a way of modifying/expanding the Warzone core gameplay beyond what is possible using the built-in configuration options. Modded games can be created only by [[Membership|members]].

Mods are easy to use! When joining a game with mods, Warzone automatically downloads the mod. No installation is required. Simply join or create a game that has mods enabled.

Since no installation is required, mods are fully supported on Android and iOS! The only platform that does not support mods is the legacy Flash client.

== Create your own Mod ==
See the [[Mod Developers Guide]] for details on how to get started making your own mod.

== List of published mods (not exhaustive) ==
Please note some of these mods might have bugs. Contact the mod developer to report a bug.
=== Promoted mods ===
* [[Buy Neutral]]
* [[Diplomacy]]
* [[Gift Armies]]
* [[Gift Gold]]
* [[Picks Swap]]
* [[Randomized Bonuses]]
* [[Randomized Wastelands]]
=== Standard Mods ===
* [[Advanced Diplomacy Mod V4]]
* [[AIs don't deploy]]
* [[Buy Cards]]
* [[Commerce Plus]]
* [[Custom Card Package]]
* [[Diplomacy 2]]
* [[Late Airlifts]]
* [[Limited Attacks]]
* [[Limited Multiattacks]]
* [[Neutral Moves]]
* [[Safe Start]]
* [[Swap Territories]]
* [[Take Turns]]
=== Experimental Mods ===
* [[BetterCities and group chat]]
* [[AI's don't play cards]]
* [[Better don't fail an attack]]
* [[Bonus Airlift]]
* [[BonusValue QuickOverrider]]
* [[Connected Commanders]]
* [[Deployment Limit]]
* [[Don't lose a territory]]
* [[Essentials]]
* [[Extended Randomized Bonuses]]
* [[Extended Winning conditions]]
* [[Forts]]
* [[Gift Armies 2]]
* [[Hybrid Distribution]]
* [[Hybrid Distribution 2]]
* [[Informations for spectators]]
* [[King Of The Hills]]
* [[Local Deployment Helper]]
* [[Lotto Mod Istant Random Winner]]
* [[More_Distributions]]
* [[One Way Connections]]
* [[Portals]]
* [[Press This Button]]
* [[Random Starting Cities]]
* [[Runtime Wastelands]]
* [[Spawnbarriers]]
* [[Special units are Medics]]
* [[Stack Limit]]
* [[Transport Only Airlift]]

== Restrictions ==

Single-player modded games are always free for members. Likewise, multi-player games where all players are members are also free. Members can create a modded game for non-members by using the special "Allow non-members to join" check-box on the mods page. Using this special checkbox is free once per week to members, (restarts Monday), but after that it will cost a small fee (2 coins per player, member or not, in the game). This fee exists since mods can run on the server, and modded games are significantly more CPU-intensive for the Warzone server to run than non-modded games.
[[Category:Game Settings]][[Category:Mods]]