AbilitiesWML - Revision history

Celtic Minstrel: /* Common keys and tags for every weapon special */ Link to the section

2026-02-11T05:35:28Z

‎Common keys and tags for every weapon special: Link to the section

Jarom: Added a note about ability keys inside weapon specials used as abilities

2026-02-07T19:47:16Z

Added a note about ability keys inside weapon specials used as abilities

ZombieKnight: /* Extra keys used by the [regenerate] ability */

2026-02-05T21:05:02Z

‎Extra keys used by the [regenerate] ability

ZombieKnight: /* Extra keys used by the [heals] ability */

2026-02-05T21:04:53Z

‎Extra keys used by the [heals] ability

ZombieKnight: /* Extra keys used by the [regenerate] ability */

2026-01-29T09:42:48Z

‎Extra keys used by the [regenerate] ability

ZombieKnight: /* Extra keys used by the [heals] ability */

2026-01-29T09:42:34Z

‎Extra keys used by the [heals] ability

ZombieKnight: /* Extra keys used by the [heals] ability */

2026-01-29T09:41:47Z

‎Extra keys used by the [heals] ability

Octalot: /* Common keys and tags for abilities with a value */ Arbitrary values for priority commonly use -10

2026-01-04T11:39:41Z

‎Common keys and tags for abilities with a value: Arbitrary values for priority commonly use -10

Shiki: variable name

2025-12-16T02:21:36Z

variable name

Shiki: unique_id moved from 1.19.17 to 1.19.18

2025-12-15T21:45:17Z

unique_id moved from 1.19.17 to 1.19.18

@@ Line 224: / Line 224: @@
 ** '''[experimental_filter_specials]''': [[StandardAbilityFilter]] Further attributes to filter specials by to determine if it should take priority over other specials. Accepts the same attributes as [experimental_filter_ability], {{DevFeature1.19|5}} [experimental_filter_specials] deprecated, use [filter_specials] instead.
 * '''[event]''': [[EventWML]]. {{DevFeature1.19|4}} An [event] to be included into any scenario where a unit with this weapon special appears in. Note that such events get included when a unit with this weapon special first appears in the scenario, not automatically when the scenario begins (meaning that ''name=prestart'' events, for example, would usually never trigger). See [[WML_Abilities|WML Abilities]]. Shortcut of [unit_type][event].
-* {{DevFeature1.15|3}} When used inside '''[abilities]''' tag, relevant ability keys can also be used (see above).
+* {{DevFeature1.15|3}} When used inside '''[abilities]''' tag, relevant ability keys can also be used (see [[#Extra_tags_and_keys_used_by_weapon_specials_as_abilities|above]]).
 === Common keys and tags for specials with a value ===

@@ Line 224: / Line 224: @@
 ** '''[experimental_filter_specials]''': [[StandardAbilityFilter]] Further attributes to filter specials by to determine if it should take priority over other specials. Accepts the same attributes as [experimental_filter_ability], {{DevFeature1.19|5}} [experimental_filter_specials] deprecated, use [filter_specials] instead.
 * '''[event]''': [[EventWML]]. {{DevFeature1.19|4}} An [event] to be included into any scenario where a unit with this weapon special appears in. Note that such events get included when a unit with this weapon special first appears in the scenario, not automatically when the scenario begins (meaning that ''name=prestart'' events, for example, would usually never trigger). See [[WML_Abilities|WML Abilities]]. Shortcut of [unit_type][event].
 === Common keys and tags for specials with a value ===

← Older revision		Revision as of 21:05, 5 February 2026
Line 99:		Line 99:

	* Use common keys and tags for abilities with a value.		* Use common keys and tags for abilities with a value.
−
−	~~=== Extra keys used by the ''[regenerate]'' ability ===~~
−	* '''value''': the amount healed.
−	* '''poison''': {{DevFeature1.19\|?}} changes the behavior when the healed unit is poisoned. possible values are:
−	** ''cured'' - heals the poison instead of healing
−	** ''slowed'' - does prevent poison damage, but doesn't remove it and doesn't heal the unit
−	** ''left empty, or with any other value'' - does not prevent the poison damage and does not heal, when poison is present
−
−	* Use common keys and tags for abilities with a value

	=== Extra keys and tags used by the ''[resistance]'' ability ===		=== Extra keys and tags used by the ''[resistance]'' ability ===

@@ Line 92: / Line 92: @@
 * If '''add''' and '''sub''' are used in separate abilities with the same id, or with the default id that's used when no id is specified, then the order in which the abilities are encountered controls the calculation, which may change depending on units' positions on the map.
-=== Extra keys used by the ''[heals]'' ability ===
+=== Extra keys used by the ''[heals]'' and ''[regenerate]'' abilities ===
 * '''value''': the amount healed.
-* '''poison''': {{DevFeature1.19|?}} changes the behavior when the healed unit is poisoned. possible values are:
+* '''poison''': When the healed unit is poisoned, then unit takes usual poison damage instead. Interaction with poison can be changed with these values:
-** ''cured'' - heals the poison instead of healing
+** ''cured'' - stops poison damage and heals the poison instead of healing
-** ''slowed'' - does prevent poison damage, but doesn't remove it and doesn't heal the unit
+** ''slowed'' - stops poison damage instead of healing
 * Use common keys and tags for abilities with a value.

@@ Line 103: / Line 103: @@
 === Extra keys used by the ''[regenerate]'' ability ===
 * '''value''': the amount healed.
 * Use common keys and tags for abilities with a value

@@ Line 77: / Line 77: @@
 * '''max_value''': {{DevFeature1.19|2}}  maximum special value. Default: no limit. Available inside translatable strings as '''$max_value'''.
 * '''min_value''': {{DevFeature1.19|2}}  minimum special value. Default: no limit. Available inside translatable strings as '''$min_value'''.
-* '''priority''': {{DevFeature1.19|19}}  This attribute allows a higher-priority ability to use as its base the value returned by a lower-priority ability of the same type. Default: 0.
+* '''priority''': {{DevFeature1.19|19}}  This attribute allows a higher-priority ability to use as its base the value returned by a lower-priority ability of the same type; for example a negative priority will cause the value to be calculated before checking whether the mainline marksman ability should override it. The value is arbitrary, but generally -10 is chosen to allow for another (not yet known) ability to be placed in between the known ones. Default: 0.
-* '''cumulative''': if set to 'yes', the [leadership] value will be added to another [leadership] value= same if have same id=, for other abilities, the highest value between value= or base_value will be choosen.
+* '''cumulative''': if set to 'yes', the [leadership] value will be added to another [leadership] value= same if have same id=, for other abilities, the highest value between value= or base_value will be chosen.
 * '''[filter_base_value]''': filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', '''less_than''', '''greater_than''', '''less_than_equal_to''', '''greater_than_equal_to'''.

@@ Line 230: / Line 230: @@
 * '''value''': the value to be used. Available inside translatable strings as '''$value'''.
-* '''add''': the number to add to the base value. Note the interaction with '''sub''' in [[#Common_calculations]]. Available inside translatable strings as '''$value'''.
+* '''add''': the number to add to the base value. Note the interaction with '''sub''' in [[#Common_calculations]]. Available inside translatable strings as '''$add'''.
 * '''sub''': the number to subtract from the base value. Available inside translatable strings as '''$sub'''.
 * '''multiply''': this multiplies the base value. Available inside translatable strings as '''$multiply'''.

@@ Line 50: / Line 50: @@
 * '''affect_enemies''': if equal to 'yes' (default is 'no'), the ability will affect enemies in the specified adjacent hexes.
 * '''id''': this ability will not be cumulative with other abilities using this id. Must be present if cumulative is anything other than 'yes'.
-* '''unique_id''': {{DevFeature1.19|17}} A unique identifier for this ability, used for the registry under [[UnitsWML#.5Babilities.5D|[units][abilities]]]. If not defined, falls back to '''id'''. Used to add this ability via '''abilities_list''' key in '''[unit_type]''' or '''[effect]apply_to=new_ability'''.
+* '''unique_id''': {{DevFeature1.19|18}} A unique identifier for this ability, used for the registry under [[UnitsWML#.5Babilities.5D|[units][abilities]]]. If not defined, falls back to '''id'''. Used to add this ability via '''abilities_list''' key in '''[unit_type]''' or '''[effect]apply_to=new_ability'''.
 * '''halo_image''': {{DevFeature1.17|22}} if used, the halo specified showed on unit affected by ability.
 * '''overlay_image''': {{DevFeature1.17|22}} if used, the overlay specified showed on unit affected by ability.
@@ Line 202: / Line 202: @@
 * '''special_note''' {{DevFeature1.15|14}} Translatable string, which will be displayed in the unit’s help. See also [[UnitTypeWML#Special_Notes]].
 * '''id''': this ability will not be cumulative with other specials using this id.
-* '''unique_id''': {{DevFeature1.19|17}} A unique identifier for this weapon special, used for the registry under [[UnitsWML#.5Bweapon_specials.5D|[units][weapon_specials]]]. If not defined, falls back to '''id'''. Used to add this weapon special via '''[unit_type][attack]specials_list''', or via [[EffectWML]].
+* '''unique_id''': {{DevFeature1.19|18}} A unique identifier for this weapon special, used for the registry under [[UnitsWML#.5Bweapon_specials.5D|[units][weapon_specials]]]. If not defined, falls back to '''id'''. Used to add this weapon special via '''[unit_type][attack]specials_list''', or via [[EffectWML]].
 * '''active_on''': one of '''defense''' or '''offense'''; if left out, the special is active on both.
 * '''apply_to''': one of '''self''','''opponent''','''attacker''','''defender''','''both''' (default: ''self''). Determines who the effects of this special are applied to.