DirectActionsWML - Revision history

Lhybrideur: Precise [gold] filter

2026-07-05T04:39:32Z

Precise [gold] filter

Octalot: /* [terrain] */ terrain="location_id base^overlay" is silently treated as terrain="base^overlay"

2026-07-04T15:10:03Z

‎[terrain]: terrain="location_id base^overlay" is silently treated as terrain="base^overlay"

Octalot: /* [terrain] */ location_id= is a StandardLocationFilter, the documentation here made it sound like it set a new value

2026-07-04T14:35:41Z

‎[terrain]: location_id= is a StandardLocationFilter, the documentation here made it sound like it set a new value

Soliton: /* [move_unit] */

2025-05-05T09:54:11Z

‎[move_unit]

Laela: /* [gold] */ side is not used anymore

2025-04-02T17:55:47Z

‎[gold]: side is not used anymore

Laela: /* [modify_unit] */ type and experience

2025-01-13T19:57:56Z

‎[modify_unit]: type and experience

Celtic Minstrel: /* [modify_unit] */ Replace Markdown markup with wiki markup

2024-12-07T16:38:44Z

‎[modify_unit]: Replace Markdown markup with wiki markup

White haired uncle: /* [modify_unit] */ - correct description of hitpoints example

2024-11-13T20:44:16Z

‎[modify_unit]: - correct description of hitpoints example

Jarom: Add information about $teleport_unit in [tunnel]

2024-09-04T18:47:40Z

Add information about $teleport_unit in [tunnel]

Laela: /* [cancel_action] */

2024-07-28T18:06:01Z

‎[cancel_action]

@@ Line 94: / Line 94: @@
 Gives sides gold.
 * '''amount''': the amount of gold to give.
-* [[StandardSideFilter]] sides to give the gold to. Default is all sides.
+* [[StandardSideFilter]] sides to give the gold to. Do not use a [filter_side] tag. Default is all sides.
 === [unstore_unit] ===

← Older revision		Revision as of 15:10, 4 July 2026
Line 88:		Line 88:

	<b>Note:</b> When a hex changes from a village terrain to a non-village terrain, and a team owned that village it loses that village. When a hex changes from a non-village terrain to a village terrain and there is a unit on that hex it does not automatically capture the village. The reason for not capturing villages is that there are too many choices to make; should a unit lose its movement points, should capture events be fired. It is easier to do this as wanted by the author in WML.		<b>Note:</b> When a hex changes from a village terrain to a non-village terrain, and a team owned that village it loses that village. When a hex changes from a non-village terrain to a village terrain and there is a unit on that hex it does not automatically capture the village. The reason for not capturing villages is that there are too many choices to make; should a unit lose its movement points, should capture events be fired. It is easier to do this as wanted by the author in WML.
		+
		+	<b>Note:</b> This tag does not support setting starting locations. '''location_id=''' is interpreted as a filter, and using [[TerrainCodesWML#Terrain_codes_in_map_data\|the map data prefix syntax]] will silently ignore the location id prefix.

	=== [gold] ===		=== [gold] ===

@@ Line 82: / Line 82: @@
 * '''layer''': (overlay|base|both, default=both) only change the specified layer.
 * '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.
 If you want to remove the overlays from a terrain and leave only the base, use:

@@ Line 221: / Line 221: @@
 === [move_unit] ===
-Moves a unit along a path on the map. The path can be specified exactly, or as a series of waypoints that the unit will pass through.
+Moves a unit along a path on the map. The path can be specified exactly, or as a series of waypoints that the unit will pass through. If the target location is occupied, the nearest free location is chosen.
-* [[StandardUnitFilter]] as argument; do not use a [filter] tag. All units matching the filter are moved. If the target location is occupied, the nearest free location is chosen.
+* [[StandardUnitFilter]] inline; do not use a [filter] tag. All units matching the filter are moved.
 * '''to_x''' (unsigned integer): The units are moved to this x coordinate. Can be a comma-separated list, in which case the unit follows this given path during the move.
 * '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.

@@ Line 93: / Line 93: @@
 Gives sides gold.
 * '''amount''': the amount of gold to give.
-* '''side''': (default=1) the number of the side to give the gold to. Can be a comma-separated list of sides. note: Default side=1 for empty side= is deprecated.
+* [[StandardSideFilter]] sides to give the gold to. Default is all sides.
 === [unstore_unit] ===

@@ Line 263: / Line 263: @@
 The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = "$($this_unit.hitpoints / 2)" to set the hitpoints of all units to half of their current value. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).
-Modifying a unit ''may'' trigger an advancement event if the experience is set higher than the max_experience. However, this behaviour should not be relied upon to happen under all circumstances; if it's desired, the event should be triggered separately, for example with '''[transform_unit]'''.
+Modifying a unit ''may'' trigger an advancement event if the experience is set higher than the max_experience. However, this behaviour should not be relied upon to happen under all circumstances; if it's desired, the event should be triggered separately, for example with '''[transform_unit]'''. Setting value, including empty string, of ''type'' acts as shortcut of ''experience="$this_unit.max_experience"''.
 '''Note:''' Some some properties of the units are reset sometimes (for example when the unit advances or when [remove_object] is called), so it's usually better to change them with [object] ([object] inside [modify_unit]) than to change those properties directly via [modify_unit]. The following properties are ''not'' reset in [remove_object] and are thus safe to use directly in [modify_unit]:

@@ Line 261: / Line 261: @@
 </syntaxhighlight>
-The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = "$($this_unit.hitpoints / 2)" to set the hitpoints of all units to half of their particular maxima. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).
+The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = "$($this_unit.hitpoints / 2)" to set the hitpoints of all units to half of their current value. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).
 Modifying a unit ''may'' trigger an advancement event if the experience is set higher than the max_experience. However, this behaviour should not be relied upon to happen under all circumstances; if it's desired, the event should be triggered separately, for example with '''[transform_unit]'''.

@@ Line 560: / Line 560: @@
 * '''[filter]''': (required) [[StandardUnitFilter]] the units which can use the tunnel. Leave empty for "all units".
-* '''[source]''': (required) [[StandardLocationFilter]] the source hex(es).
+* '''[source]''': (required) [[StandardLocationFilter]] the source hex(es). Use $teleport_unit to filter on unit being teleported.
-* '''[target]''': (required) [[StandardLocationFilter]] the target hex(es).
+* '''[target]''': (required) [[StandardLocationFilter]] the target hex(es). Use $teleport_unit to filter on unit being teleported.
 * '''id''': (optional) identifier for the tunnel, to allow removing.
 * '''remove''': (boolean, default: no)  If yes, removes all defined tunnels with the same ID (then only id= is necessary).

@@ Line 447: / Line 447: @@
 {{DevFeature1.13|11}}
 In an '''enter_hex'''/'''exit_hex''' [event], interrupt the movement, leaving the unit where it is. This is intended to be used with an event that gives the player new information, to let the player choose whether to change their plans. For example, if the player has commanded a unit to move from (1,1) to (3,3) and attack a unit on (4,4); then a [cancel_action] inside an '''enter_hex''' [event] on (2,2) would make the unit stop on (2,2). A [cancel_action] inside an enter_hex [event] on (3,3) would let the player choose whether to attack.
 === [heal_unit] ===