InternalActionsWML - Revision history

Soliton: /* [set_variables] */

2026-03-21T11:25:49Z

‎[set_variables]

Celtic Minstrel: /* [set_variables] */ Document how an explicit index changes the behaviour of replace and merge modes

2025-11-26T19:37:36Z

‎[set_variables]: Document how an explicit index changes the behaviour of replace and merge modes

Celtic Minstrel: /* [remove_event] */ Try to clarify that nested events aren't permanently linked to their parent.

2025-07-22T12:12:12Z

‎[remove_event]: Try to clarify that nested events aren't permanently linked to their parent.

Laela: /* [fire_event] */ [data] as $data

2025-01-24T21:04:04Z

‎[fire_event]: [data] as $data

Soliton: /* [store_locations] */

2024-10-29T17:55:13Z

‎[store_locations]

Pentarctagon: /* [set_variables] */

2024-06-12T18:44:09Z

‎[set_variables]

Celtic Minstrel: /* [role] */ Add an anchor that can be linked to

2024-02-27T05:49:47Z

‎[role]: Add an anchor that can be linked to

Celtic Minstrel: /* [set_variables] */ Add anchors that can be linked to

2024-02-27T05:40:55Z

‎[set_variables]: Add anchors that can be linked to

Celtic Minstrel: /* [set_variable] */ Add an anchor that can be linked to

2024-02-26T15:09:20Z

‎[set_variable]: Add an anchor that can be linked to

Celtic Minstrel: Delete [insert_tag], as it was moved to VariablesWML

2024-02-23T14:35:47Z

Delete [insert_tag], as it was moved to VariablesWML

@@ Line 71: / Line 71: @@
 ** ''replace'': will clear the variable '''name''' and replace it with given data. This is the default value. If given an explicit index, such as name=my_array[1], only that single element of the array is replaced, and the new data is inserted into that slot, potentially pushing other elements up. If ''not'' given an explicit index, the entire array is replaced.
 ** ''append'': will append given data to the current array. An explicit index is ignored if given.
-** ''merge'': will merge in the given data into '''name'''. Attributes in '''[value]''' will overwrite any existing already in '''name'''. Tags in '''[value]''' modify the corresponding tag of the original value of '''name''', so for example the first '''[attack]''' tag in '''[value]''' would modify the first '''[attack]''' tag of '''name''' rather than appending a new '''[attack]''' tag. If given an explicit index, all the '''[value]''' and '''[literal]''' tags will be merged together into a single tag (as if with mode=append), and this resulting container will then be merged into the container at the specified element. A few special syntaxes are supported:
+** ''merge'': will merge in the given data into '''name'''. Attributes in '''[value]''' will overwrite any existing already in '''name'''. Tags in '''[value]''' modify the corresponding tag of the original value of '''name''', so for example the first '''[attack]''' tag in '''[value]''' would modify the first '''[attack]''' tag of '''name''' rather than appending a new '''[attack]''' tag. If given an explicit index, all the '''[value]''' and '''[literal]''' tags will be joined together into a single tag, and this resulting container will then be merged into the container at the specified element. A few special syntaxes are supported:
 *** ''__remove=yes'': When used in a subtag, causes the corresponding subtag in '''name''' to be deleted rather than merged. Deletion happens after any other subtags have been merged.
 *** ''add_to_xxx'': Adds its integer value to the integer value of '''xxx''' in '''name''', and sets '''xxx''' in '''name''' to the result. {{DevFeature1.13|8}} Now adds as real numbers rather than integers.

@@ Line 69: / Line 69: @@
 * '''mode''': one of the following values:
-** ''replace'': will clear the array '''name''' and replace it with given data. This is the default value.
+** ''replace'': will clear the variable '''name''' and replace it with given data. This is the default value. If given an explicit index, such as name=my_array[1], only that single element of the array is replaced, and the new data is inserted into that slot, potentially pushing other elements up. If ''not'' given an explicit index, the entire array is replaced.
-** ''append'': will append given data to the current array
+** ''append'': will append given data to the current array. An explicit index is ignored if given.
-** ''merge'': will merge in the given data into '''name'''. Attributes in '''[value]''' will overwrite any existing already in '''name'''. Tags in '''[value]''' modify the corresponding tag of the original value of '''name''', so for example the first '''[attack]''' tag in '''[value]''' would modify the first '''[attack]''' tag of '''name''' rather than appending a new '''[attack]''' tag. A few special syntaxes are supported:
+** ''merge'': will merge in the given data into '''name'''. Attributes in '''[value]''' will overwrite any existing already in '''name'''. Tags in '''[value]''' modify the corresponding tag of the original value of '''name''', so for example the first '''[attack]''' tag in '''[value]''' would modify the first '''[attack]''' tag of '''name''' rather than appending a new '''[attack]''' tag. If given an explicit index, all the '''[value]''' and '''[literal]''' tags will be merged together into a single tag (as if with mode=append), and this resulting container will then be merged into the container at the specified element. A few special syntaxes are supported:
 *** ''__remove=yes'': When used in a subtag, causes the corresponding subtag in '''name''' to be deleted rather than merged. Deletion happens after any other subtags have been merged.
 *** ''add_to_xxx'': Adds its integer value to the integer value of '''xxx''' in '''name''', and sets '''xxx''' in '''name''' to the result. {{DevFeature1.13|8}} Now adds as real numbers rather than integers.
 *** ''concat_to_xxx'': {{DevFeature1.13|8}} Similar to '''add_to_xxx''', but does string concatenation instead of numerical addition.
-** ''insert'': will insert the given data at the index specified in the '''name''' attribute, such as name=my_array[1]. The default index is zero, which will insert to the front of the array. '''Note:''' if an invalid index is used, empty containers will be created before the insertion is performed. In other words, do not attempt to insert at an index greater than (or equal to) the array's current length. This limitation may be removed in future versions.
+** ''insert'': will insert the given data at the index specified in the '''name''' attribute, such as name=my_array[1]. The default index is zero, which will insert to the front of the array. Otherwise, it is inserted so as to become the element at the specified index, meaning that the element previously at that index and all later elements are pushed up by one. '''Note:''' if an invalid index is used, empty containers will be created before the insertion is performed. In other words, do not attempt to insert at an index greater than (or equal to) the array's current length. This limitation may be removed in future versions.
 * '''to_variable''': set the array or container to the value of the given variable

← Older revision		Revision as of 12:12, 22 July 2025
Line 386:		Line 386:

	* '''id''': the id of the event to remove. May be a comma separated list.		* '''id''': the id of the event to remove. May be a comma separated list.
		+
		+	'''Note''': Only events whose IDs are explicitly specified will be removed. For example, this will ''not'' automatically remove events nested within the events with those IDs.

	=== [role] ===		=== [role] ===

@@ Line 380: / Line 380: @@
 * '''[secondary_attack]''': Information passed to the second attack filter and $second_weapon variable on the new event.
-* {{DevFeature1.17|6}} '''[data]''': Additional arbitrary data to pass to the event. In addition to passing custom data, this can be used to set the '''damage_inflicted''' in an attack event or the '''owner_side''' in a village capture event. Values can only be used by Lua.
+* {{DevFeature1.17|6}} '''[data]''': Additional arbitrary data to pass to the event. In addition to passing custom data, this can be used to set the '''damage_inflicted''' in an attack event or the '''owner_side''' in a village capture event. Values can be used by Lua. {{DevFeature1.19|9}} Values can be accessed as $data.
 === [remove_event] ===

@@ Line 108: / Line 108: @@
 * [[StandardLocationFilter]]: a location or location range which specifies the locations to store. By default, all locations on the map are stored.
-* '''variable''': the name of the variable (array) into which to store the locations.
+* '''variable''': the name of the variable (array) into which to store the locations. Defaults to '''location'''.
 * '''mode''': {{DevFeature1.13|0}} defaults to ''always_clear'', which clears the variable, whether or not a match is found. If mode is set to ''replace'', the variable will not be cleared, and locations which match the filter will overwrite existing elements at the start of the array, leaving any additional elements intact if the original array contained more elements than there are locations matching the filter. If mode is set to ''append'', the variable will not be cleared, and locations which match the filter will be added to the array after the existing elements.

@@ Line 401: / Line 401: @@
 * '''[else]''' {{DevFeature1.13|5}} ActionWML to execute if the game is unable to find a unit to assign the role to. For example, this could be used to create a new unit satisfying the role.
-* '''[auto_recall]''' {{DevFeature1.13|6}} If present, and the role is assigned to a unit on the recall list, then that unit is recalled. Supports all unique keys of [[DirectActionsWML#.5Brecall.5D|&#x5b;recall&#x5d;]], but no [[StandardUnitFilter]].
+* {{anchor|auto_recall|'''[auto_recall]'''}}: {{DevFeature1.13|6}} If present, and the role is assigned to a unit on the recall list, then that unit is recalled. Supports all unique keys of [[DirectActionsWML#.5Brecall.5D|&#x5b;recall&#x5d;]], but no [[StandardUnitFilter]].
 * [[StandardUnitFilter]], do not use a [filter] sub-tag. SUF's role= and type= keys are not used: if you want to use them, use a nested SUF wrapped inside a [and] tag.

@@ Line 79: / Line 79: @@
 * '''to_variable''': set the array or container to the value of the given variable
-* '''[value]''': the WML inside the [value] tags will be stored in data, variables will be interpolated directly, use $| in order to escape the $ sign, you can store arrays of WML by supplying multiple [value] tags. ([[#Using_.5Bset_variables.5D_to_Create_Arrays_of_WML|See Example]])
+* {{anchor|set_variables-value|'''[value]'''}}: the WML inside the [value] tags will be stored in data, variables will be interpolated directly, use $| in order to escape the $ sign, you can store arrays of WML by supplying multiple [value] tags. ([[#Using_.5Bset_variables.5D_to_Create_Arrays_of_WML|See Example]])
-* '''[literal]''': same as '''[value]''', but variables will not be substituted, '''[literal]''' and '''[value]''' can not be used in the same [set_variables] tag, i.e. you can not create arrays by piling a mix of '''[value]''' and '''[literal]''' tags
+* {{anchor|set_variables-literal|'''[literal]'''}}: same as '''[value]''', but variables will not be substituted, '''[literal]''' and '''[value]''' can not be used in the same [set_variables] tag, i.e. you can not create arrays by piling a mix of '''[value]''' and '''[literal]''' tags
-*'''[split]''' splits a textual list into an array which will then be set to data
+*{{anchor|set_variables-split|'''[split]'''}}: splits a textual list into an array which will then be set to data
 ** '''list''': textual list to split
 ** '''key''': the key of each array element(array[$i].foo) in which the strings are stored; defaults to ''value'' if omitted.

@@ Line 41: / Line 41: @@
 * '''string_length''': Retrieves the length in characters of the string passed as this attribute's value; such string is parsed and variable substitution applied automatically (see [[VariablesWML]] for details).
-* '''[join]''' joins an array of strings to create a textual list
+* {{anchor|join|'''[join]'''}} joins an array of strings to create a textual list
 ** '''variable''': name of the array
 ** '''key''': the key of each array element(array[$i].foo) in which the strings are stored

@@ Line 386: / Line 386: @@
 * '''id''': the id of the event to remove. May be a comma separated list.
 === [role] ===
@@ Line 510: / Line 500: @@
 This will produce two output messages, first one saying '''bar''' and next one saying '''more'''.
 == See Also ==