DirectActionsWML - Revision history

Octalot: /* [progress_achievement] */ Achievements can be completed via [progress_achievement]

2026-10-29T13:36:51Z

[progress_achievement]: Achievements can be completed via [progress_achievement]

← Older revision		Revision as of 13:36, 29 October 2026
Line 625:		Line 625:
	{{DevFeature1.17\|13}}		{{DevFeature1.17\|13}}

	Progress an achievement by the specified amount, with an optional limit for how far the achievement can be progressed.		Progress an achievement by the specified amount, with an optional limit for how far the achievement can be progressed. If this results in the current progress reaching the value of [achievement]max_progress, this will set the achievement as completed.

	* '''content_for''': The [[AchievementsWML#.5Bachievement_group.5D\|[achievement_group]]] that this achievement is part of.		* '''content_for''': The [[AchievementsWML#.5Bachievement_group.5D\|[achievement_group]]] that this achievement is part of.

Shiki: /* [tunnel] */ Add an example for delayed_variable_substitution

2026-10-27T00:04:40Z

[tunnel]: Add an example for delayed_variable_substitution

← Older revision		Revision as of 00:04, 27 October 2026
Line 570:		Line 570:
	* '''allow_vision''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, vision through a tunnel is not possible. Note that in that case the tunnel cannot be used if the tunnel exit is under shroud (which previously was ''always'' the case).		* '''allow_vision''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, vision through a tunnel is not possible. Note that in that case the tunnel cannot be used if the tunnel exit is under shroud (which previously was ''always'' the case).
	* '''pass_allied_units''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, allied (including own) units on the exit hex block a tunnel.		* '''pass_allied_units''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, allied (including own) units on the exit hex block a tunnel.
	* '''delayed_variable_substitution''' (boolean, default: yes): If yes, the WML block contained in this [tunnel] is not variable-substituted at execution time of the event where this [tunnel] is within. Instead, variables are substituted when the tunnel is used by a unit. See [[EventWML#Nested_Events]]		* '''delayed_variable_substitution''' (boolean, default: yes): If yes, the WML block contained in this [tunnel] is not variable-substituted at execution time of the event where this [tunnel] is within. Instead, variables are substituted when the tunnel is used by a unit. See [[EventWML#Nested_Events\|Nested_Events]]. For example, you should disable this, when this tag is used inside a [[ConditionalActionsWML#.5Bfor.5D\|for]] loop and you want to use the $i variable for the tunnel's coordinates.

	(Note: The tunnel tag can also be used inside the [[AbilitiesWML\|[teleport]]] ability, without remove= and id=).		(Note: The tunnel tag can also be used inside the [[AbilitiesWML\|[teleport]]] ability, without remove= and id=).

Shiki: /* [remove_trait] */ Can't remove must_have traits

2026-10-25T17:52:56Z

[remove_trait]: Can't remove must_have traits

← Older revision		Revision as of 17:52, 25 October 2026
Line 340:		Line 340:
	* [[StandardUnitFilter]]: All units on the map (but not the recall list) matching the filter have matching traits removed. Use no [filter] tag.		* [[StandardUnitFilter]]: All units on the map (but not the recall list) matching the filter have matching traits removed. Use no [filter] tag.
	* '''trait_id''': The id of the trait to be removed. See [[UnitsWML#.5Btrait.5D\|[trait]]].		* '''trait_id''': The id of the trait to be removed. See [[UnitsWML#.5Btrait.5D\|[trait]]].

			If the trait is a must_have trait for the unit_type, it will be re-added immediately at the end of the trait list.

	=== [remove_shroud] ===		=== [remove_shroud] ===

Lhybrideur: Precise [gold] filter

2026-07-05T04:39:32Z

Precise [gold] filter

← Older revision		Revision as of 04:39, 5 July 2026
Line 94:		Line 94:
	Gives sides gold.		Gives sides gold.
	* '''amount''': the amount of gold to give.		* '''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] ===		=== [unstore_unit] ===

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"

← 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] ===

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

← Older revision		Revision as of 14:35, 4 July 2026
Line 82:		Line 82:
	* '''layer''': (overlay\|base\|both, default=both) only change the specified layer.		* '''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.		* '''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.
	* '''location_id''': This key sets a string as a way to mark the hex or hexes for later reference. It is very similar to the leader starting position, and can also be set that way in the map editor.

	If you want to remove the overlays from a terrain and leave only the base, use:		If you want to remove the overlays from a terrain and leave only the base, use:

Soliton: /* [move_unit] */

2025-05-05T09:54:11Z

[move_unit]

← Older revision		Revision as of 09:54, 5 May 2025
Line 221:		Line 221:

	=== [move_unit] ===		=== [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_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.		* '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.

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

2025-04-02T17:55:47Z

[gold]: side is not used anymore

← Older revision		Revision as of 17:55, 2 April 2025
Line 93:		Line 93:
	Gives sides gold.		Gives sides gold.
	* '''amount''': the amount of gold to give.		* '''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.
	* [[StandardSideFilter]] tags and keys; default for empty side= is all sides~~, as usual in a SSF~~.

	=== [unstore_unit] ===		=== [unstore_unit] ===

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

2025-01-13T19:57:56Z

[modify_unit]: type and experience

← Older revision		Revision as of 19:57, 13 January 2025
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).		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]:		'''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]:

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

2024-12-07T16:38:44Z

[modify_unit]: Replace Markdown markup with wiki markup

← Older revision		Revision as of 16:38, 7 December 2024
Line 265:		Line 265:
	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]'''.

	'''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]:		'''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]:
	* '''side'''		* '''side'''
	* '''gender'''		* '''gender'''

← Older revision		Revision as of 00:04, 27 October 2026
Line 570:		Line 570:
	* '''allow_vision''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, vision through a tunnel is not possible. Note that in that case the tunnel cannot be used if the tunnel exit is under shroud (which previously was ''always'' the case).		* '''allow_vision''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, vision through a tunnel is not possible. Note that in that case the tunnel cannot be used if the tunnel exit is under shroud (which previously was ''always'' the case).
	* '''pass_allied_units''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, allied (including own) units on the exit hex block a tunnel.		* '''pass_allied_units''': (boolean, default: yes) {{DevFeature1.13\|6}} If no, allied (including own) units on the exit hex block a tunnel.
	* '''delayed_variable_substitution''' (boolean, default: yes): If yes, the WML block contained in this [tunnel] is not variable-substituted at execution time of the event where this [tunnel] is within. Instead, variables are substituted when the tunnel is used by a unit. See [[EventWML#Nested_Events]]		* '''delayed_variable_substitution''' (boolean, default: yes): If yes, the WML block contained in this [tunnel] is not variable-substituted at execution time of the event where this [tunnel] is within. Instead, variables are substituted when the tunnel is used by a unit. See [[EventWML#Nested_Events\|Nested_Events]]. For example, you should disable this, when this tag is used inside a [[ConditionalActionsWML#.5Bfor.5D\|for]] loop and you want to use the $i variable for the tunnel's coordinates.

	(Note: The tunnel tag can also be used inside the [[AbilitiesWML\|[teleport]]] ability, without remove= and id=).		(Note: The tunnel tag can also be used inside the [[AbilitiesWML\|[teleport]]] ability, without remove= and id=).