View source for SyntaxWML

{{Translations}}
{{WML Tags}}

The '''Wesnoth Markup Language''' ('''WML''') is used to code almost everything in Wesnoth, including scenarios, units, savefiles, and the user interface layout. WML files are simple, human-readable text files, usually with the .cfg extension, with similarities to INI files and XML.
For guidelines on keeping these files easily human-readable, see [[ConventionsWML#Indentation|ConventionsWML]].

== Tag and Attribute Structures ==

WML has a syntax containing two basic elements: ''tags'' and ''attributes''. Furthermore, ''attributes'' consist of ''keys'' and ''values''. For example:
<syntaxhighlight lang="wml">
[tag]
    key=value
[/tag]
</syntaxhighlight>

''Tags'' are used to partition information, while the data is contained in the ''attributes''. ''Keys'' identify the type of data to be stored and ''values'' are the actual data stored. When WML is processed, the tag identifies some unit of information, such as an action to perform or even an entire campaign. This gives a context for the attributes within the tag. For each <code>key=value</code> line within a tag, the attribute identified by <code>key</code> has its data set to <code>value</code>.
Also allowed inside a tag is another tag. The inner tag is considered the child of the outer tag, as in the following example.
<syntaxhighlight lang="wml">
[parent_tag]
    key1=value1
    [child_tag]
        key2=value2
    [/child_tag]
[/parent_tag]
</syntaxhighlight>

Every tag describes something different about the game; different tags work differently, with the allowed tags defined by context. There are several "[[ReferenceWML#WML_toplevel_tags|top-level tags]]" that are allowed when not inside any other tag, and each tag defines which child tags (and which keys) it recognizes. Unrecognized tags and keys, such as the result of typos, sometimes produce error messages, but at other times they are ignored. The [[SchemaWML|WML schema]] defines what is allowed and where. Although it's not designed to be read by humans, you can [[ValidationFAQ|use it to automatically detect]] if you've done something wrong even in contexts where unrecognized keys and tags would be ignored, though it still won't work in contexts where you're allowed to define the contents however you like.

''Keys should not be confused with variables!'' A common mistake among beginners is to make up undocumented key names. Instead, consult the WML Reference to find allowed key names for each tag. For a list of all tags with links to their documentation, see the "WML Tags" navigation box.

Also, tag and key names follow a special format. They will contain only alphanumeric characters and underscores; in particular, they cannot contain <code>+</code>, <code>-</code>, or whitespace. The values, however, may contain such characters when needed. A key or tag name beginning with a digit or even consisting of entirely digits is permitted.


=== Tag Amendment Syntax ===

Inserting a plus sign (<code>+</code>) before a tag name allows one to append to an earlier tag (the most recent with the same name) rather than starting a new tag. This allows attributes to be added or replaced.
<syntaxhighlight lang="wml">
[tag]
    key=value
[/tag]
[+tag]
    key=value
[/tag]
</syntaxhighlight>

* All keys in the ''+tag'' will be set to the given values. If the keys did not exist in the most recent [tag] then they are added to that [tag]; otherwise their values will replace the old values in the most recent [tag].

* Any child tags of the ''+tag'' will be appended to the children of the most recent [tag]. To be clear: none of those original child tags will be altered by this operation, since this is an "append" and not a "merge."

* It is even possible to make tag amendments to a child tag after the parent tag has already closed. Using [+tag] syntax multiple times in a row (first for the parent, then for the child) will allow you to amend the more inward scopes.

=== Multiple Assignment Syntax ===

It is possible to set multiple attributes on a single line. This is done by listing the associated keys, followed by an equal sign, followed by the desired values.
<syntaxhighlight lang="wml">
[tag]
    key1,key2,key3=value1,value2,value3
[/tag]
</syntaxhighlight>
would be the same as:
<syntaxhighlight lang="wml">
[tag]
    key1=value1
    key2=value2
    key3=value3
[/tag]
</syntaxhighlight>
* If there are extra keys, they will be set to an empty value. If there are extra values the last key will be set to the comma-separated list of all remaining values.
* It is recommended not to use this syntax with keys which normally interpret commas specially (such as x and y in a [[StandardLocationFilter]]), to avoid confusion on which key receives which value. However, using <code>x,y=12,10</code> for single coordinates is widely used and is an exception to the recommendation.

=== Special Attribute Values ===

Although an attribute's value can be just text corresponding to the function of its key, a value can also be encoded in many other ways, each with a specific purpose.
* '''key = "value"''': a ''quoted value'' is a value surrounded by quotes. This is often unnecessary as single-line values are typically interpreted as intended. However, quotes are required in order to specify multiple-line values (a line break without quotes would otherwise end the value). Quotes may also be required to cancel the special meaning of other characters, and they prevent spaces from being stripped &ndash; without quotes, all leading and trailing spaces would be removed, and internal runs of spaces would be replaced by a single space. It is never wrong to use quotes with correct WML.
* '''key = _"value"''': a ''[[translatable]] value'' is a value that is subject to translations, and should be used for all text intended to be shown to a player (most notably seen in [story], [message], and the name= key in unit definitions). A translatable value is surrounded by quotes and preceded by an underscore (_). In terms of WML syntax, it behaves very much like a quoted value, other than being unsuitable for [[ConditionalActionsWML#Condition_Tags|comparisons to other values]]. Translatable values are intended for display on the screen, not for internal data.  See [[TranslationsWML]] and [[GettextForWesnothDevelopers]] for more information.
* '''key = "value1" + "value2"''': ''string concatenation'' is performed with the plus sign (<code>+</code>). If a plus sign appears outside quotes in a value, it means that the string/value on its right will be appended to the string/value on its left.  To have an actual plus sign in a value, the string containing the <code>+</code> character must be surrounded by quotes (a quoted value or a translatable value). Quotes are not strictly necessary around the pre-concatenated values, but they are advisable so that it is easy to tell where the values begin and end and to spot some kinds of mistakes. If two non-quoted values are concatenated, they will have a space inserted between them, but if either value is quoted, no space will be inserted.
* '''key = "quoted ""double quoted value"" value"''': ''doubled quotes'' can be used to create quote marks within a quoted or translatable value. The doubled quote mark in the value produces one quote mark in the stored data and does not terminate the quoted value. (These do not necessarily need to be used in pairs.)
* '''key = $variable''': a ''variable substitution'' sets the key to the value of the indicated WML variable. This is indicated by the dollar sign (<code>$</code>) and is really just  a special case of general variable substitution, as variables can be substituted within other values. See [[#Variable_Substitution|below]] for more information on values based on WML variables. (Note that some keys require their data to be a variable name, not the variable's value; in that case there would be no dollar sign.) ''Variable substitution is supported in only a few contexts, such as in [[IntroWML]] and [[EventWML]].''
* '''key = "$(formula-expression)"''': a ''formula expression'' sets the key to the value of the processed formula. This is indicated by a dollar sign (<code>$</code>) followed by a parenthesized expression. See [[Wesnoth Formula Language]] for more information on formula basics, data types, and built-in functions. Quotes around the formula are not strictly necessary in all cases, but they are advisable, particularly since quotes are the only way to use a plus sign (<code>+</code>) within a formula (without quotes, the plus sign represents string concatenation). ''Formula expressions are only supported where variable substitution is supported.''
* '''key = <<value>>''': similar to a quoted value but stronger: the value is hidden from the [[PreprocessorRef|preprocessor]], which will see all text therein as literal. Useful with [[LuaWML]] or whenever a literal curly brace ("{", a US-ASCII 0x7B) is needed in any text string. This can also be combined with the translatable mark, in case curly braces are needed in translatable text.

== Variables ==

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 {{tag|InternalActionsWML|set_variable}} or with [[PreprocessorRef|macros]] like <tt>{VARIABLE}</tt>.
* '''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 <tt>$variable</tt>, and sometimes ending the variable name with a pipe character, as in <tt>$variable|</tt>.
* '''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 {{tag|InternalActionsWML|clear_variable}} or the <tt>{CLEAR_VARIABLE}</tt> [[PreprocessorRef|macro]].

=== Kinds of Variables ===
==== Scalar ====
A scalar variable can store a single string or number.

<syntaxhighlight lang="wml">
[set_variable]
    name=my_variable
    value="sample value"
[/set_variable]
</syntaxhighlight>

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 ([[SyntaxWML#Special_Attribute_Values|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:
<syntaxhighlight lang="wml">
[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]
</syntaxhighlight>

However, when working with arrays, it is usually easier to make use of [set_variables]. This would be written as follows:
<syntaxhighlight lang="wml">
[set_variables]
    name=my_awesome_array
    [value]
        x=10
    [/value]
    [value]
        x=12
    [/value]
    [value]
        x=14
    [/value]
[/set_variables]
</syntaxhighlight>

Arrays are indexed from 0, which means that if <tt>foo</tt> is the name of an array, <tt>foo[0]</tt> is the full name of its first container variable, <tt>foo[1]</tt> the full name of its second, and so on. <tt>foo.length</tt> is the special variable that always stores the number of containers in the array <tt>foo</tt>. Hence, if the value stored in <tt>foo.length</tt> is 18, the last container in the array would be <tt>foo[17]</tt>. 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 <tt>foo[3]</tt> as if it were a scalar one is illegal; instead, you would use <tt>foo[3].value</tt> 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 <tt>bar</tt> stored in a container <tt>foo</tt> you would write <tt>foo.bar</tt>. 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 (<code>$</code>) and a pipe (<code>|</code>). 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 <tt>|</tt> 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-alphanumeric 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.

{{DevFeature1.13|2}} If you want to substitute a default value when the variable is uninitialized or empty, add a question mark (<code>?</code>) followed by the default value after the variable name, eg <code>$varname?default text|</code>. In this case, the pipe (<code>|</code>) 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 below 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 <code>$house_$colour|.title</code>. First the "colour" variable is substituted in. If it contains "blue", the result is <code>$house_blue.title<code>, 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 <code>$house_red.title</code>, 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 <code>$houses[$n].title</code>. 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:

<syntaxhighlight lang="wml">
[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]
</syntaxhighlight>

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 <code>$</code> 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 [[SyntaxWML#The_.5Bvariables.5D_tag|[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 [[AbilitiesWML#Extra_tags_used_by_the_.5Bteleport.5D_ability|[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 [[InternalActionsWML#.5Bstore_unit.5D|[store_unit]]] command have a '''unit.variables''' sub-container where custom variables related to that unit may be saved. (Remember to [[DirectActionsWML#.5Bunstore_unit.5D|[unstore_unit]]] for the changes to be kept.) One benefit of this approach is that the unit may then be [[FilterWML|filtered]] based on the value, for example:
<syntaxhighlight lang="wml">
[filter]
  [filter_wml]
    [variables]
      my_variable="test"
    [/variables]
  [/filter_wml]
[/filter]
</syntaxhighlight>

=== Variable Usage Examples ===
Consider a saved game with the following [variables] tag (or a freshly started scenario with that tag)
<syntaxhighlight lang="wml">
[variables]
    attitude_of_elves=hate
    attitude_of_dwarves=love
    attitude_of_humans=like
    current_opponent=elves
[/variables]
</syntaxhighlight>

Then,
<syntaxhighlight lang="wml">
[message]
   message="Oh, I see $current_opponent|! They surely $attitude_of_$current_opponent|| us!"
[/message]
</syntaxhighlight>
displays the message
 Oh, I see elves! They surely hate us!

Consider another game with variables
<syntaxhighlight lang="wml">
[variables]
    our_side=1
    their_side=2
[/variables]
</syntaxhighlight>
where side 1 has 75 gold, and side 2 50 gold. Then, 
<syntaxhighlight lang="wml">
[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]
</syntaxhighlight>
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
<syntaxhighlight lang="wml">
[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]
</syntaxhighlight>
always displays a true sentence.

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

== Comments ==

Comments are indicated by a pound sign (<code>#</code>) unless in double quotes. Unless the line forms a valid [[PreprocessorRef#Preprocessor_directives|preprocessor directive]], all text after the pound sign will be ignored by the WML engine. Note that if the beginning of the line is a valid preprocessor directive, which is then followed by ''another'' pound sign, the second pound sign will still be interpreted as a comment character. For example, this works:
<syntaxhighlight lang="wml">
#ifdef FOO
#endif # FOO
</syntaxhighlight>
Whether or not doing so is a good idea is a stylistic choice.

It is a very good coding convention to always add a space immediately following a pound sign for every comment. Not only does it avoid accidentally calling a preprocessor directive (for example, a commented line that begins with the word “define”) but it also makes comments stand further apart from the code.

Specially-formatted comments are frequently used to give commands to the Wesnoth [[MaintenanceTools|maintenance tools]] to suppress false positives and enhance their coverage, as well as for adding explanatory comments for [[GettextForWesnothDevelopers#Marking_up_strings_in_WML|translatable strings]].

== Tutorial ==

* [[VariablesWML/How_to_use_variables|How to use variables]]

== See Also ==

* [[PreprocessorRef]]
* [[ConventionsWML]]
* [[SavefileWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]