VariablesWML - Revision history

Celtic Minstrel: Undo revision 74848 by Sapient (talk) -- Who are we do prescribe what may be done?

2026-02-22T07:03:13Z

Undo revision 74848 by Sapient (talk) -- Who are we do prescribe what may be done?

Sapient: remove false "not possible" claim, improve language

2026-02-20T00:25:18Z

remove false "not possible" claim, improve language

Sapient: /* Global */

2026-02-20T00:06:54Z

‎Global

Sapient: Not "always"

2026-02-20T00:05:59Z

Not "always"

Sapient: irrelevant information... numeric variable names are inadvisable

2026-02-19T23:48:50Z

irrelevant information... numeric variable names are inadvisable

Sapient: there is no boolean_value key in set_variable

2026-02-13T17:46:14Z

there is no boolean_value key in set_variable

Soliton: /* The [variables] tag */ Looks like there is no proper place where [variables] is documented

2024-10-20T19:41:24Z

‎The [variables] tag: Looks like there is no proper place where [variables] is documented

Soliton: /* The [set_variables] tag */

2024-10-17T15:42:14Z

‎The [set_variables] tag

Soliton: /* The [set_variable] tag */

2024-10-17T15:41:16Z

‎The [set_variable] tag

Soliton: /* The [variables] tag */

2024-10-17T15:40:30Z

‎The [variables] tag

@@ Line 22: / Line 22: @@
 === Container ===
-A container variable can store any number of scalar variables, as well as nested containers. There are tags to assign specific information, for instance [store_side]. To refer to a variable <code>bar</code> stored in a container <code>foo</code> you would write <code>foo.bar</code>.
+A container variable can store any number of scalar variables, as well as nested containers. There are tags to assign specific information, for instance [store_side]. To refer to a variable <code>bar</code> stored in a container <code>foo</code> you would write <code>foo.bar</code>. This works even if one of the variable names is entirely numeric.
 === Array ===

@@ Line 71: / Line 71: @@
 === Unit ===
-Unit variables are stored on a specific unit. That means that, if desired, every unit could have a variable with the same name, and it doesn't conflict with a global variable of the same name. Note that they are not global only in the sense that they are "namespaced" and not in the sense that they cannot be accessed globally.
+Unit variables may be stored on a specific unit in a special '''variables''' child container. That means that, if desired, every unit could have a variable with the same name, and it wouldn't conflict with a global variable of the same name. Note that they are not global only in the sense that they are "namespaced" and not in the sense that they cannot be accessed globally.
-Unit variables can be created with '''[modify_unit]''', but there is currently no way to read them directly in WML. You can read them from [[Wesnoth Formula Language|formulas]] (eg in [[StandardUnitFilter]] or [[AbilitiesWML]]) and the '''[filter_wml][variables]''' tag in [[StandardUnitFilter]], or you can use '''[store_unit]''' to copy the unit along with all its variables into a global variable which can then be accessed normally – if you call the variable <code>my_unit</code>, then you could access the scalar unit variable <code>stamina</code> as <code>$my_unit.variables.stamina</code>.
+Unit variables can be read after storing a unit then can be created by setting data in the '''variables''' child container and unstoring the unit. A one-step way of creating unit variables is possible with '''[modify_unit]''', but to read the variables you still usually need to use '''[store_unit]'''. You can read them from [[Wesnoth Formula Language|formulas]] (eg in [[StandardUnitFilter]] or [[AbilitiesWML]]) and the '''[filter_wml][variables]''' tag in [[StandardUnitFilter]], or as mentioned you can use '''[store_unit]''' to copy the unit along with all its variables into a global variable which can then be accessed normally – for example with a unit stored to the variable <code>my_unit</code>, you could access the scalar unit variable <code>my_stamina</code> as <code>$my_unit.variables.my_stamina</code>.
-If modifying unit variables after storing the unit, remember to [[DirectActionsWML#.5Bunstore_unit.5D|[unstore_unit]]] for the changes to be kept.
+If modifying unit variables after storing the unit, always remember to [[DirectActionsWML#.5Bunstore_unit.5D|[unstore_unit]]] for the changes to be kept.
 An example of how you can filter on a unit variable in [[StandardUnitFilter]]:

@@ Line 67: / Line 67: @@
 === Global ===
-Most WML variables are global variables and unless they are explicitly cleared, they will continue to exist across all events and scenarios until a campaign ends. Variables created with '''[set_variable]''', '''[set_variables]''', or any of the [store_something] styled WML tags such as '''[store_unit]''' may all used to create or modify global variables. Likewise, [[#Variable Substitution|variable substitution]] and the '''[variable]''' conditional tag may be used to read global variables.
+Most WML variables are global variables, and unless they are explicitly cleared, they will continue to exist across all events and scenarios until a campaign ends. Variables created with '''[set_variable]''', '''[set_variables]''', or any of the [store_something] styled WML tags such as '''[store_unit]''' may all used to create or modify global variables. Likewise, [[#Variable Substitution|variable substitution]] and the '''[variable]''' conditional tag may be used to read global variables.
 === Unit ===

@@ Line 67: / Line 67: @@
 === Global ===
-Most variables are global variables – they exist in the global scope. Variables created with '''[set_variable]''', '''[set_variables]''', or any of the '''[store_something]''' styled WML tags are all global variables, and [[#Variable Substitution|variable substitution]] and the '''[variable]''' conditional tag only read global variables.
+Most WML variables are global variables and unless they are explicitly cleared, they will continue to exist across all events and scenarios until a campaign ends. Variables created with '''[set_variable]''', '''[set_variables]''', or any of the [store_something] styled WML tags such as '''[store_unit]''' may all used to create or modify global variables. Likewise, [[#Variable Substitution|variable substitution]] and the '''[variable]''' conditional tag may be used to read global variables.
 === Unit ===

@@ Line 22: / Line 22: @@
 === Container ===
-A container variable can store any number of scalar variables, as well as nested containers. There are tags to assign specific information, for instance [store_side]. To refer to a variable <code>bar</code> stored in a container <code>foo</code> you would write <code>foo.bar</code>. This works even if one of the variable names is entirely numeric.
+A container variable can store any number of scalar variables, as well as nested containers. There are tags to assign specific information, for instance [store_side]. To refer to a variable <code>bar</code> stored in a container <code>foo</code> you would write <code>foo.bar</code>.
 === Array ===

@@ Line 16: / Line 16: @@
      name=my_variable
      value="sample value"
 [/set_variable]
 </syntaxhighlight>

@@ Line 118: / Line 118: @@
 === The [variables] tag ===
-Unlike the others, the '''[[ConditionalActionsWML#.5Bvariable.5D|[variables]]]''' tag cannot be directly used as ActionWML. It can be used in a number of other places, however:
+Unlike the others, the '''[variables]''' tag cannot be directly used as ActionWML. It can be used in a number of other places, however:
 * Placed in a scenario tag to assign initial global variables at scenario start.

@@ Line 114: / Line 114: @@
 === The [set_variables] tag ===
-As of 1.18.0, the '''[set_variables]''' tag can only be used as ActionWML. Support for placing it in '''[modify_unit]''' and '''[modify_side]''' is planned. See the documentation of these tags for details.
+As of 1.18.0, the '''[[InternalActionsWML#.5Bset_variables.5D|[set_variables]]]''' tag can only be used as ActionWML. Support for placing it in '''[modify_unit]''' and '''[modify_side]''' is planned. See the documentation of these tags for details.
 === The [variables] tag ===

@@ Line 110: / Line 110: @@
 === The [set_variable] tag ===
-The '''[set_variable]''' tag can be directly used as ActionWML to work with global variables, or it can be placed in the '''[modify_unit]''' or '''[modify_side]''' ActionWML tags to work with unit or side variables, respectively. See the documentation of these tags for details.
+The '''[[InternalActionsWML#.5Bset_variable.5D|[set_variable]]]''' tag can be directly used as ActionWML to work with global variables, or it can be placed in the '''[modify_unit]''' or '''[modify_side]''' ActionWML tags to work with unit or side variables, respectively. See the documentation of these tags for details.
 === The [set_variables] tag ===