AbilitiesWML - Revision history

Laela: /* The [specials] tag */ stun

2026-07-17T06:40:22Z

‎The [specials] tag: stun

Newfrenchy83: /* Common keys and tags for abilities with a value */

2026-06-28T08:31:27Z

‎Common keys and tags for abilities with a value

Newfrenchy83: /* Extra tags and keys used by weapon specials as abilities */

2026-06-28T08:26:38Z

‎Extra tags and keys used by weapon specials as abilities

Newfrenchy83: /* Extra tags and keys used by weapon specials as abilities */

2026-06-28T08:02:43Z

‎Extra tags and keys used by weapon specials as abilities

Shiki: /* See Also */ Link to WML_Abilities

2026-06-14T13:23:54Z

‎See Also: Link to WML_Abilities

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

@@ Line 198: / Line 198: @@
 * '''[slow]''': slows the target
 * '''[swarm]''': number of strikes decreases as the unit loses hitpoints
 Any other tag is valid, but will result in a special that does nothing but report it is there.

@@ Line 80: / Line 80: @@
 * '''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'''.
 ==== Common calculations ====

@@ Line 147: / Line 147: @@
 ** '''radius''': {{DevFeature1.19|13}} determines the distance of units that can be filtered and not just adjacent units, '''radius''' is set to 1 by default. {{DevFeature1.19|18}} '''[filter_adjacent_student]''' is removed because having multiple shorthands requires giving them specific names for abilities used as weapons, and it's even simpler to use the [[StandardUnitFilter]].
 * '''[filter_adjacent_student_location]''': {{DevFeature1.19|10}} like [filter_adjacent_student], but filters on locations instead of units. This is a shorthand for [filter_student][filter_location][filter_adjacent_location]. {{DevFeature1.19|18}} '''[filter_adjacent_student_location]''' is removed because having multiple shorthands requires giving them specific names for abilities used as weapons, and it's even simpler to use the [[StandardUnitFilter]].
-* '''overwrite_specials''': {{DevFeature1.15|13}} If present, allows a special abilities weapon with a numerical value to impose its value and ignore values of abilities or specials of the same type. If '''overwrite_specials=one_side''', the specials and abilities used by the opponent of the unit affected by the ability with this key and applied to it will not be affected. If '''overwrite_specials=both_sides''', all non-key-carrying abilities and all specials of the same type affecting the recipient unit will be affected, even if used by the opponent (used in the macro FORCE_CHANCE_TO_HIT).
+* '''overwrite_specials''': {{DevFeature1.15|13}} If present, allows a special abilities weapon with a numerical value to impose its value and ignore values of abilities or specials of the same type. If '''overwrite_specials=one_side''', the specials and abilities used by the opponent of the unit affected by the ability with this key and applied to it will not be affected. If '''overwrite_specials=both_sides''', all non-key-carrying abilities and all specials of the same type affecting the recipient unit will be affected, even if used by the opponent (used in the macro FORCE_CHANCE_TO_HIT). {{DevFeature1.19|25}} '''overwrite_specials''' is deprecated, use '''[overwrite_specials]''' instead.
 * {{anchor|overwrite|'''[overwrite]'''}}: {{DevFeature1.17|22}} Part of '''overwrite_specials'''. Allows more flexibility in determining which specials should take priority over other specials of the same type.
 ** '''priority''': A numeric value to use when determining which special should be used if multiple specials of the same type have the '''overwrite_specials''' attribute. Default is 0.
 ** {{anchor|filter_specials|'''[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]''' is deprecated, use '''[filter_specials]''' instead.
 ** {{anchor|filter_specials|'''[filter_specials]'''}}: {{DevFeature1.19|5}} [[StandardAbilityFilter]] Further attributes to filter specials by to determine if it should take priority over other specials. Accepts the same attributes as [filter_ability].
-** '''description_affected''': {{DevFeature1.17|13}} becomes the '''description''' of the weapon special, without changing the '''description''' of the ability
+* {{anchor|overwrite_specials|'''[overwrite_specials]'''}}: {{DevFeature1.19|25}} Replace '''overwrite_specials''' attribute. If present, allows a special or a special ability weapon with a numerical value to impose its value and ignore values of abilities or specials of the same type. Allows more flexibility in determining which specials should take priority over other specials of the same type.
-** '''name_affected''': {{DevFeature1.17|13}} becomes the '''name''' of the weapon special, without changing the '''name''' of the ability
+** '''priority''': A numeric value to use when determining which special should be used if multiple specials of the same type have the '''[overwrite_specials]''' tag. Default is 0.
 * Other keys and tags appropriate to the specific weapon special.

@@ Line 150: / Line 150: @@
 * {{anchor|overwrite|'''[overwrite]'''}}: {{DevFeature1.17|22}} Part of '''overwrite_specials'''. Allows more flexibility in determining which specials should take priority over other specials of the same type.
 ** '''priority''': A numeric value to use when determining which special should be used if multiple specials of the same type have the '''overwrite_specials''' attribute. Default is 0.
-** {{anchor|filter_specials|'''[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].
+** {{anchor|filter_specials|'''[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]''' is deprecated, use '''[filter_specials]''' instead.
 ** '''description_affected''': {{DevFeature1.17|13}} becomes the '''description''' of the weapon special, without changing the '''description''' of the ability
 ** '''name_affected''': {{DevFeature1.17|13}} becomes the '''name''' of the weapon special, without changing the '''name''' of the ability

@@ Line 303: / Line 303: @@
 * [[SingleUnitWML]]
 * [[ReferenceWML]]
 [[Category:WML Reference]]

@@ 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 ===

← 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.