SingleUnitWML - Revision history

Lea at 11:44, 25 February 2026

2026-02-25T11:44:08Z

Lea: could not find Template:DevFeature for Wesnoth 1.12

2026-02-25T11:43:23Z

could not find Template:DevFeature for Wesnoth 1.12

Lea at 11:33, 25 February 2026

2026-02-25T11:33:18Z

Celtic Minstrel: Remove formula AI documentation (but leave a link to the legacy page for posterity)

2025-07-24T01:08:31Z

Remove formula AI documentation (but leave a link to the legacy page for posterity)

Shadowm: /* Unit Data */ Rewrite some confusing wording surrounding [modifications] [advancement]

2025-03-27T10:25:23Z

‎Unit Data: Rewrite some confusing wording surrounding [modifications] [advancement]

Bssarkar: /* Unit Data */ Add dismissable and block_dismiss_message.

2025-03-05T16:35:46Z

‎Unit Data: Add dismissable and block_dismiss_message.

Soliton: /* Unit Data */

2024-07-25T16:04:15Z

‎Unit Data

Soliton: /* Unit Data */ document language_name

2024-07-25T15:59:38Z

‎Unit Data: document language_name

Celtic Minstrel: /* Unit State */ Clarify that unhealable doesn't block programmatic healing

2024-05-14T13:27:32Z

‎Unit State: Clarify that unhealable doesn't block programmatic healing

Celtic Minstrel: Bold tag names

2024-05-10T13:39:50Z

Bold tag names

@@ Line 60: / Line 60: @@
 * {{anchor|max_moves|'''max_moves'''}}: The maximum number of movement points the unit has. Default is the number of movement specified for the [unit_type] described by [[#type|'''type''']].
-* '''vision''': ''(Version 1.15.0 and later only)'' The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].
+* '''vision''': ''(Version 1.12.0 and later only)'' The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].
 * '''jamming''': {{DevFeature1.15|0}} The number of jamming points for the unit. Default is the number of jamming points specified for the [unit_type] described by [[#type|'''type''']].

@@ Line 60: / Line 60: @@
 * {{anchor|max_moves|'''max_moves'''}}: The maximum number of movement points the unit has. Default is the number of movement specified for the [unit_type] described by [[#type|'''type''']].
-* '''vision''': {{DevFeature1.12|0}} The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].
+* '''vision''': ''(Version 1.15.0 and later only)'' The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].
 * '''jamming''': {{DevFeature1.15|0}} The number of jamming points for the unit. Default is the number of jamming points specified for the [unit_type] described by [[#type|'''type''']].

@@ Line 60: / Line 60: @@
 * {{anchor|max_moves|'''max_moves'''}}: The maximum number of movement points the unit has. Default is the number of movement specified for the [unit_type] described by [[#type|'''type''']].
-* '''vision''': The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].
+* '''vision''': {{DevFeature1.12|0}} The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].
 * '''jamming''': {{DevFeature1.15|0}} The number of jamming points for the unit. Default is the number of jamming points specified for the [unit_type] described by [[#type|'''type''']].

@@ Line 111: / Line 111: @@
 ** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it). Does the same as '''[status] guardian = 'yes''''.
-* {{anchor|ai|'''[ai]'''}}: This affects how the computer will control this unit (currently only used by [[FormulaAI]]).
+* {{anchor|ai|'''[ai]'''}}: This affects how the computer will control this unit.
 ** {{DevFeature1.15|?}} '''[candidate_action]''': Add a candidate action that only applies to this unit; see [[Wesnoth_AI_Framework#The_.5Bcandidate_action.5D_Tag|here]] for details. The [filter_own] tag is not supported.
 *** '''stage''': If specified, the candidate action is added to the stage with the given ID, instead of the default stage (which is main_loop).
 ** {{DevFeature1.15|?}} '''[micro_ai]''': Add a micro AI that only applies to this unit; see [[Micro AIs]] for details. This tag does not support side, action, or [filter].
 * '''traits_description''': the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

@@ Line 97: / Line 97: @@
 And since we used the mods subtable, [remove_object] will work properly for objects that give this effect.
-* {{anchor|modifications|'''[modifications]'''}}: changes that have been made to the unit.
+* {{anchor|modifications|'''[modifications]'''}}: a collection of tags describing changes that have been made to the unit. Any number and combination of tags of each type may be specified.
-** '''[trait]''' a trait the unit has. Same format as [[UnitsWML#.5Btrait.5D|[trait], UnitsWML]].
+** '''[trait]''': a trait the unit has. Same format as [[UnitsWML#.5Btrait.5D|[trait], UnitsWML]].
-** '''[object]''' an object the unit has. Same format as [[DirectActionsWML#.5Bobject.5D|[object], DirectActionsWML]].
+** '''[object]''': an object the unit has. Same format as [[DirectActionsWML#.5Bobject.5D|[object], DirectActionsWML]].
-** '''[advance]''' an advancement that has already been applied to the unit. Same format as [[UnitTypeWML#After max level advancement (AMLA)|AMLA [advancement], UnitTypeWML]]. These are automatically added as the unit has AMLA advancements applied to it, but can also be specified manually to indicate that the unit already has a particular advancement applied, or to disable certain advancements (by ID). {{DevFeature1.13|2}} In 1.13.2 and later this has been renamed to [advancement], to match the UnitTypeWML tag of the same name.
+** '''[advancement]''': an advancement (AMLA) that has been applied to the unit. Same format as [[UnitTypeWML#After max level advancement (AMLA)|[advancement], UnitTypeWML]]. These are automatically added when the player confirms an AMLA in the Advance Unit dialog, but they can also be specified manually to indicate that the unit already has a particular advancement applied; by providing only an advancement ID with no effects, it is even possible to disable a future advancement. {{DevFeature1.13|2}} In versions prior to 1.13.2, this tag was named [advance].
 * '''[event]''' The event is copied from this unit's WML description into the scenario. The event is carried along with the unit (even during advancement) and inserted into a scenario whenever this unit is first included. A [unit][event] requires a non-empty id= attribute.

← Older revision		Revision as of 16:35, 5 March 2025
Line 75:		Line 75:

	* '''role''': used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).		* '''role''': used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).
		+
		+	* '''dismissable''': {{DevFeature1.19\|9}} If 'no', unit cannot be dismissed from the recall list using the ''Dismiss'' button in Unit Recall dialog. Default: 'yes'.
		+
		+	* '''block_dismiss_message''': {{DevFeature1.19\|9}} Sets the message to be shown when ''dismissable'' is ''no'' and the user presses the ''Dismiss'' button in Unit Recall dialog. If not set, a default message will be shown instead.

	* {{anchor\|variables\|'''[variables]'''}}: a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable '''unit'''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]). The subnode '''mods''' is special as it is deleted on every unit rebuild (for example when the unit advances or when an [object] is removed). This makes it possible to implement [effect]s that change variables, as those will also be reapplied whenever the unit is reset. (so in particular if your effect changes the variables mods.<whatever> [remove_object] will work properly for those objects.) For example the following code will define a apply_to=moves_on_recruits effect that gives units with that effect full movement when recruited		* {{anchor\|variables\|'''[variables]'''}}: a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable '''unit'''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]). The subnode '''mods''' is special as it is deleted on every unit rebuild (for example when the unit advances or when an [object] is removed). This makes it possible to implement [effect]s that change variables, as those will also be reapplied whenever the unit is reset. (so in particular if your effect changes the variables mods.<whatever> [remove_object] will work properly for those objects.) For example the following code will define a apply_to=moves_on_recruits effect that gives units with that effect full movement when recruited

@@ Line 9: / Line 9: @@
 == Unit Data ==
 The following keys and tags describe the unit itself, and will persist with the unit (though some may change automatically when the unit advances):
-* <span id="type">'''type'''</span>: the ID of the unit's unit type. This key is mandatory. See [[UnitTypeWML]].
+* {{anchor|type|'''type'''}}: the ID of the unit's unit type. This key is mandatory. See [[UnitTypeWML]].
-* <span id="language_name">'''language_name'''<span>: the name of the unit's unit type. See [[UnitTypeWML]].
+* {{anchor|language_name|'''language_name'''}}: the name of the unit's unit type. See [[UnitTypeWML]].
 * '''variation''': the [variation] of the [unit_type] as which the unit will appear.

@@ Line 160: / Line 160: @@
 ** '''uncovered''': if 'yes', the unit has performed an action (e.g. attacking) that causes it to no longer be hidden until the next turn. For cutscenes, it may be useful to set this manually.
 ** '''guardian''': if 'yes', the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it). Does the same as '''ai_special = "guardian"'''.
-** '''unhealable''': if set to 'yes', the unit cannot be healed. This includes the healing by resting.
+** '''unhealable''': if set to 'yes', the unit cannot be healed through normal game mechanics. This includes the healing by resting. It does ''not'' prevent the unit from being healed by WML or Lua code.
 ** '''unpoisonable''':  if set to 'yes', the unit cannot be poisoned.
 ** '''undrainable''':  if set to 'yes', the attacker can't gain health with drain ability attacking this unit.

@@ Line 1: / Line 1: @@
 {{WML Tags}}
 The '''[unit]''' tag describes a single unit on the map or in memory, for example Konrad.
-It is different from the [unit_type] in [units], which describes a class of units. However it takes many of the same keys and thus can generally override the inherited properties from the associated [unit_type].
+It is different from the '''[unit_type]''' in '''[units]''', which describes a class of units. However it takes many of the same keys and thus can generally override the inherited properties from the associated '''[unit_type]'''.
-[unit] can be used inside [side] ([[SideWML]]) for units present at start of the scenario, or as [[DirectActionsWML]] for units created during the game. (It is also used in save-files.)
+'''[unit]''' can be used inside '''[side]''' ([[SideWML]]) for units present at start of the scenario, or as [[DirectActionsWML]] for units created during the game. (It is also used in save-files.)
 This contains keys and tags which describe the unit's [[#Unit Data|persistent data]], as well as certain [[#Unit State|state variables]] which will also persist with the unit but will change frequently as gameplay progresses. Finally, there are some keys to set certain [[#Creation Options|one-time options]] for how the unit will be initially created, which will ''not'' persist beyond initial creation.