VariablesWML

Variables in WML are used to store data for later retrieval. Each variable is identified by its name. Once created, a variable persists until the end of a campaign unless explicitly cleared. Variable names should contain only alphanumerics and underscores, and the first character of the name should not be an underscore.

The three basic manipulations of WML variables are assigning a value, querying the value, and clearing the variable.

• Assigning to a variable: stores a value in the variable. This is done with tags like [set_variable] or with macros like {VARIABLE}.
• Querying a variable: returns the last value stored in the variable (or the empty string, if no value was). This is done by prefixing the variable name with a dollar sign, as in $variable, and sometimes ending the variable name with a pipe character, as in $variable|.
• Clearing a variable: makes the WML engine forget about that variable. This is useful for reducing overhead, since all used variables are stored in saved games. This is done with [clear_variable] or the {CLEAR_VARIABLE} macro.

Kinds of Variables

Scalar

A scalar variable can store a single string, number, or boolean value.

[set_variable]
    name=my_variable
    value="sample value"
    boolean_value=yes
[/set_variable]

The full name of a scalar variable is its given name, in this case my_variable. Note that the value of the variable can be translatable or even a formula expression (Special Attribute Values).

Array

An array variable is a numbered sequence of container variables. There are some specific tags that assign array information, for example [store_unit] and [store_locations]. One could create an array using [set_variable] like this:

[set_variable]
    name=my_awesome_array[0].x
    value=10
[/set_variable]
[set_variable]
    name=my_awesome_array[1].x
    value=12
[/set_variable]
[set_variable]
    name=my_awesome_array[2].x
    value=14
[/set_variable]

However, when working with arrays, it is usually easier to make use of [set_variables]. This would be written as follows:

[set_variables]
    name=my_awesome_array
    [value]
        x=10
    [/value]
    [value]
        x=12
    [/value]
    [value]
        x=14
    [/value]
[/set_variables]

Arrays are indexed from 0, which means that if foo is the name of an array, foo[0] is the full name of its first container variable, foo[1] the full name of its second, and so on. foo.length is the special variable that always stores the number of containers in the array foo. Hence, if the value stored in foo.length is 18, the last container in the array would be foo[17]. If you try to query an array as if it were a container, then it will simply use the first index[0]. Thus $foo.bar would be the same as $foo[0].bar

Note: Do not attempt to store a scalar value to the explicit index of an array, which is a container of scalar variables. Hence referring to a variable named foo[3] as if it were a scalar one is illegal; instead, you would use foo[3].value to store a scalar value. (While it may appear to work to an extent if you ignore this rule, it may also cause undefined behavior. For example, loading a text save of a game that contains such variables will fail with a WML error.)

Container

A container variable can store any number of scalar and/or array variables. There are tags to assign specific information, for instance [store_side]. To refer to a variable bar stored in a container foo you would write foo.bar. An explicit index inside an array is also considered a container.

Conditionals

Variables may be compared by using [variable] within an [if] or [while] tag. For more information, please refer to ConditionalActionsWML.

Variable Substitution

When writing scenario events (EventWML) and filters, a scalar variable can generally be substituted in the right-hand side of any key=value assignment. To do this, enclose the full variable name to be queried between a dollar sign ($) and a pipe (|). The variable name should be the entire dot-separated path, where each component is an identifier (consisting of English letters, Arabic digits, and underscores) optionally followed by a pair of square brackets containing either a number or another substitution. The number represents the array index. When such a substitution appears in the text, the content which has previously been put into this variable name is used instead of the name of the variable.

In certain situations, the | that marks the end of the variable name to be queried can be omitted. The exact rule is: if there is no |, variable names span identifier characters (as defined in the preceding paragraph), balanced square brackets and some periods. Doubled periods, final periods (followed by a non-identifier character), and some periods that would result in an illegal variable name will not be included. If the variable name ends up being empty (e.g. when using $|), then it will be replaced by just $, giving you an easy way to include a dollar sign in an interpolated string.

(Version 1.13.2 and later only) If you want to substitute a default value when the variable is uninitialized or empty, add a question mark (?) followed by the default value after the variable name, eg $varname?default text|. In this case, the pipe (|) is required. The default text can be anything at all, as long as it doesn't contain a pipe. (There exists no mechanism to escape a pipe so it can be included in the default text.)

A dollar sign at the end of a string or followed by a character that's not an identifier will be left alone. If it's followed by a pipe, the pipe will be removed.

Variable substitutions (and also formula substitutions, see above for more details) in a string are processed one at a time from right to left. That is, the engine finds the last dollar sign, substitutes that variable in, and then moves on to the next one in the resulting string. This means that the result of one variable substitution can affect the next one.

For example, consider the substitution $house_$colour|.title. First the "colour" variable is substituted in. If it contains "blue", the result is $house_blue.title, so the game will then look for a container variable called "house_blue" and substituted in its "title" key. On the other hand, if the "colour" variable contains "red", the result of the first substitution is $house_red.title, so the engine will instead look for a container variable called "house_red" and substitute in its "title" key.

The most common use-case for this is using a scalar variable to index an array variable, for example $houses[$n].title. In cases where substitution will occur more than once, such as a nested event, it can also be used to delay substitution to the second phase by simply adding a pipe directly after the dollar sign. The first round of substitution will remove the pipe and stop there (moving on to the next substitution left of it, if any), and then the second round of substitution will detect the variable and replace it.

Here's a more complete example:

[event]
    name=turn 1
    [set_variable]
        name=my_variable
        value= _ "Konrad"
    [/set_variable]
    [message]
        speaker=Delfador
        message= _ "Hello, $my_variable|... How are you?"
    [/message]
[/event]

The WML code above will cause Delfador to say "Hello, Konrad... How are you?" on turn 1.

Literal Mode

There are a few places where the substitution mode is literal. In these places, attribute value are used exactly as provided, nothing is substituted, and the $ will not have special significance. The following places use the literal mode:

• The value of literal= inside [set_variable]
• The contents of [literal] inside [set_variables]
• The special [variables] tag, used to give initial values to many variables upon scenario start
• In general, anything that's not nested inside [event], [command], [tunnel], [story], or a filter. For example, the [unit_type] tag cannot use variable substitution (except in filters).

Automatically Stored Variables

• side_number: the number of the current player's side (may be empty during start or prestart events)
• turn_number: the number of the current turn (may be empty during start or prestart events)
• x1: this is the x-coordinate of the location where the most recent event was triggered
• y1: this is the y-coordinate of the location where the most recent event was triggered
• x2: this is the x-coordinate of the location that assisted in triggering the most recent event
• y2: this is the y-coordinate of the location that assisted in triggering the most recent event
• unit: inside an event, this is the unit at $x1,$y1
• second_unit: inside an event, this is the unit at $x2,$y2
• this_unit: inside a standard unit filter, this is the unit currently being considered for a possible match
• other_unit: inside some standard unit filters, this is an adjacent unit relevant to the match
• damage_inflicted: inside attacker_hits and defender_hits events, this is the amount of damage that was inflicted
• weapon: inside attack, attack_end, attacker_hits, attacker_misses, defender_hits, defender_misses, die and last_breath events, this is some information about the weapon that is/was being used by the unit at $x1,$y1. It contains the attributes from [attack], see UnitTypeWML.
• second_weapon: inside attack, attack_end, attacker_hits, attacker_misses, defender_hits, defender_misses, die and last_breath events, this is some information about the weapon that is/was being used by the unit at $x2,$y2. It contains the attributes from [attack], see UnitTypeWML.
• owner_side: inside a capture event, this contains the number of the previous owner (0 if previously unowned)
• teleport_unit: inside the [tunnel] tag used by a teleport ability, this is the unit with that ability

Note: Automatically stored container and array variables are only stored once one of their attributes is accessed for the first time. This means that one can sometimes get incorrect results, for instance by killing the unit at $x1,$y1 as first action in a moveto event and then accessing $unit.something. This can be worked around by previously making a dummy access, such as adding 0 to hitpoints.

The [variables] tag

The [variables] tag is used in saved games to describe the current value of each variable, and in scenario files for assigning initial values to variables at scenario start.

A scalar variable is assigned using an attribute, where the attribute's key is the variable's given name, and the attribute's value is the value to be stored in the variable.

A container variable with given name foo is assigned using a [foo] tag that contains the definitions for the contained variables.

An array variable with given name foo is assigned using several [foo] tags, where the first tag describes foo[0], the second foo[1], ...

Storing variables inside units

Sometimes it is useful to store a custom WML variable inside a unit. Units stored with the [store_unit] command have a unit.variables sub-container where custom variables related to that unit may be saved. (Remember to [unstore_unit] for the changes to be kept.) One benefit of this approach is that the unit may then be filtered based on the value, for example:

[filter]
  [filter_wml]
    [variables]
      my_variable="test"
    [/variables]
  [/filter_wml]
[/filter]

Variable Usage Examples

Consider a saved game with the following [variables] tag (or a freshly started scenario with that tag)

[variables]
    attitude_of_elves=hate
    attitude_of_dwarves=love
    attitude_of_humans=like
    current_opponent=elves
[/variables]

Then,

[message]
   message="Oh, I see $current_opponent|! They surely $attitude_of_$current_opponent|| us!"
[/message]

displays the message

Oh, I see elves! They surely hate us!

Consider another game with variables

[variables]
    our_side=1
    their_side=2
[/variables]

where side 1 has 75 gold, and side 2 50 gold. Then,

[store_side]
    side=$our_side
    variable=we
[/store_side]
[store_side]
    side=$their_side
    variable=they
[/store_side]
[message]
    message=We have $we.gold gold, they have $they.gold gold.
[/message]
[if]
    [variable]
        name=we.gold
        greater_than=$they.gold
    [/variable]
    [then]
        [message]
            message=This should be easy!
        [/message]
    [/then]
    [else]
        [message]
            message=This will not be easy!
        [/message]
    [/else]
[/if]
[clear_variable]
    name=we
[/clear_variable]
[clear_variable]
    name=they
[/clear_variable]

displays the messages

We have 75 gold, they have 50 gold.
This should be easy!

If side 2 had 100 gold instead, the same code would display the messages

We have 75 gold, they have 100 gold.
This will not be easy!

The code

[store_unit]
    [filter]
        canrecruit=yes
        side=1
    [/filter]
    variable=leader
[/store_unit]
[message]
    message=Our leader's first attack does $leader[0].attack[0].damage damage per hit.
[/message]
[clear_variable]
    name=leader
[/clear_variable]

always displays a true sentence.

You may find more complicated examples of variable use in the UsefulWMLFragments section.

Tutorial

• How to use variables