AbilitiesWML - Revision history

Octalot: /* Common keys and tags for every ability */ [filter_adjacent] and [filter_adjacent_location] are deprecated and buggy

2026-09-20T18:19:47Z

Common keys and tags for every ability: [filter_adjacent] and [filter_adjacent_location] are deprecated and buggy

← Older revision		Revision as of 18:19, 20 September 2026
Line 61:		Line 61:
	** '''radius''': {{DevFeature1.19\|13}} set to 1 by default, it determines the range within which units can be affected beyond immediately adjacent units, if the value is equal to 'full-map', the area is the entire map.		** '''radius''': {{DevFeature1.19\|13}} set to 1 by default, it determines the range within which units can be affected beyond immediately adjacent units, if the value is equal to 'full-map', the area is the entire map.
	* '''[filter_self]''': if the owner of the ability does not match this filter, it will not receive the effects of the ability. [filter_self] takes a [[StandardUnitFilter]] as argument.		* '''[filter_self]''': if the owner of the ability does not match this filter, it will not receive the effects of the ability. [filter_self] takes a [[StandardUnitFilter]] as argument.
	* '''[filter_adjacent]''': if an adjacent unit does not match this filter, the ability will not be active and no-one will receive its affects. Takes extra keys ''adjacent'', ''count'', ''is_enemy'', ~~just like in a [[StandardUnitFilter]], with the one difference that~~, in the absence of a specified ''count'', all listed directions must match (so, with two ~~directiones~~ eg ''adjacent=n,s'', the default is ''count=2'')~~. In fact, it's really a shorthand for a [filter_adjacent] nested within [filter]. The variables $this_unit and {{DevFeature1.13\|2}} $other_unit both work as you'd expect~~. Multiple [filter_adjacent] can be provided, all of which must pass for the ability to activate. {{DevFeature1.19\|18}} '''~~filter_adjacent~~'~~'' is deprecated and will likely be removed in version 1.21~~, ~~since a version already exists in~~ the ~~[[StandardUnitFilter]]~~.		* '''[filter_adjacent]''': if an adjacent unit does not match this filter, the ability will not be active and no-one will receive its affects. Deprecated, please use [filter][filter_adjacent] instead, this filter behaves slightly differently. Takes extra keys ''adjacent'', ''count'', ''is_enemy'', however, in the absence of a specified ''count'', all listed directions must match (so, with two directions eg ''adjacent=n,s'', the default is ''count=2''). Multiple [filter_adjacent] can be provided, all of which must pass for the ability to activate.{{DevFeature1.13\|2}} Even in the presence of ''count'', the implementation was buggy and required all directions to match.
	* '''[filter_adjacent_location]''': like [filter_adjacent], but filters on locations instead of units. ~~This is a shorthand for~~ [filter][filter_location][filter_adjacent_location~~]. {{DevFeature1.19\|18}} '''filter_adjacent_location''' is deprecated and will likely be removed in version 1.21, since a version already exists in the [[StandardUnitFilter]~~].		* '''[filter_adjacent_location]''': like [filter_adjacent], including the bugs, but filters on locations instead of units. Similarly, it's deprecated in favor of [filter][filter_location][filter_adjacent_location].
	* {{anchor\|filter_base_value\|'''[filter_base_value]'''}}: filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', etc. If several keys are used all have to match.		* {{anchor\|filter_base_value\|'''[filter_base_value]'''}}: filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', etc. If several keys are used all have to match.
	* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} but leaks memory until {{DevFeature1.19\|28}} An [event] to be included into any scenario where a unit with this ability appears in. Note that such events get included when a unit with this ability 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].		* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} but leaks memory until {{DevFeature1.19\|28}} An [event] to be included into any scenario where a unit with this ability appears in. Note that such events get included when a unit with this ability 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].

Laela: /* Common keys and tags for every weapon special */

2026-09-13T16:54:59Z

Common keys and tags for every weapon special

← Older revision		Revision as of 16:54, 13 September 2026
Line 232:		Line 232:
	** '''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.		** '''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.
	** '''[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.		** '''[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].		* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} but leaks memory until {{DevFeature1.19\|28}} 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 [[#Extra_tags_and_keys_used_by_weapon_specials_as_abilities\|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]]).

Laela: /* Common keys and tags for every ability */

2026-09-13T16:53:48Z

Common keys and tags for every ability

← Older revision		Revision as of 16:53, 13 September 2026
Line 64:		Line 64:
	* '''[filter_adjacent_location]''': like [filter_adjacent], but filters on locations instead of units. This is a shorthand for [filter][filter_location][filter_adjacent_location]. {{DevFeature1.19\|18}} '''filter_adjacent_location''' is deprecated and will likely be removed in version 1.21, since a version already exists in the [[StandardUnitFilter]].		* '''[filter_adjacent_location]''': like [filter_adjacent], but filters on locations instead of units. This is a shorthand for [filter][filter_location][filter_adjacent_location]. {{DevFeature1.19\|18}} '''filter_adjacent_location''' is deprecated and will likely be removed in version 1.21, since a version already exists in the [[StandardUnitFilter]].
	* {{anchor\|filter_base_value\|'''[filter_base_value]'''}}: filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', etc. If several keys are used all have to match.		* {{anchor\|filter_base_value\|'''[filter_base_value]'''}}: filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', etc. If several keys are used all have to match.
	* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} An [event] to be included into any scenario where a unit with this ability appears in. Note that such events get included when a unit with this ability 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].		* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} but leaks memory until {{DevFeature1.19\|28}} An [event] to be included into any scenario where a unit with this ability appears in. Note that such events get included when a unit with this ability 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 abilities with a value ===		=== Common keys and tags for abilities with a value ===

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

2026-07-17T06:40:22Z

The [specials] tag: stun

← Older revision		Revision as of 06:40, 17 July 2026
Line 198:		Line 198:
	* '''[slow]''': slows the target		* '''[slow]''': slows the target
	* '''[swarm]''': number of strikes decreases as the unit loses hitpoints		* '''[swarm]''': number of strikes decreases as the unit loses hitpoints
			* '''[stun]''': reserved tag for mainline
	Any other tag is valid, but will result in a special that does nothing but report it is there.		Any other tag is valid, but will result in a special that does nothing but report it is there.

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

2026-06-28T08:31:27Z

Common keys and tags for abilities with a value

← Older revision		Revision as of 08:31, 28 June 2026
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.		* '''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'''.		* '''[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'''.
			* {{anchor\|overwrite_abilities\|'''[overwrite_abilities]'''}}: {{DevFeature1.19\|25}} If present, allows a ability with a numerical value to impose its value and ignore values of abilities of the same type.
			** '''priority''': A numeric value to use when determining which ability should be used if multiple abilities of the same type have the '''[overwrite_abilities]''' tag. Default is 0.
			** {{anchor\|filter_ability\|'''[filter_ability]'''}}: {{DevFeature1.19\|25}} [[StandardAbilityFilter]] Further attributes to filter abilities by to determine if it should take priority over other abilities. Accepts the same attributes as standard [filter_ability].

	==== Common calculations ====		==== Common calculations ====

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

← Older revision		Revision as of 08:26, 28 June 2026
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]].		** '''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]].		* '''[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.		* {{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.		** '''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\|'''[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].		** {{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.
			** '''affect''': A attribute for discriminate specials applied to self to specials applied to opponent, if '''affect=self''', specials used by opponent of unit affected will be ignored, if '''affect=opponent''', specials used by unit affected(same taught by teacher unit) will be ignored. This attribute work same if specials '''apply_to=attacker\|defender'''. '''both''' is value by default.
			** {{anchor\|filter_special\|'''[filter_special]'''}}: {{DevFeature1.19\|25}} [[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
			* '''name_affected''': {{DevFeature1.17\|13}} becomes the '''name''' of the weapon special, without changing the '''name''' of the ability
	* Other keys and tags appropriate to the specific weapon special.		* Other keys and tags appropriate to the specific weapon special.

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

← Older revision		Revision as of 08:02, 28 June 2026
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.		* {{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.		** '''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.
			** {{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		** '''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		** '''name_affected''': {{DevFeature1.17\|13}} becomes the '''name''' of the weapon special, without changing the '''name''' of the ability

Shiki: /* See Also */ Link to WML_Abilities

2026-06-14T13:23:54Z

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

← Older revision		Revision as of 05:35, 11 February 2026
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.		** '''[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].		* '''[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 ===		=== Common keys and tags for specials with a value ===

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

← Older revision		Revision as of 19:47, 7 February 2026
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.		** '''[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].		* '''[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).

	=== Common keys and tags for specials with a value ===		=== Common keys and tags for specials with a value ===

← Older revision		Revision as of 18:19, 20 September 2026
Line 61:		Line 61:
	** '''radius''': {{DevFeature1.19\|13}} set to 1 by default, it determines the range within which units can be affected beyond immediately adjacent units, if the value is equal to 'full-map', the area is the entire map.		** '''radius''': {{DevFeature1.19\|13}} set to 1 by default, it determines the range within which units can be affected beyond immediately adjacent units, if the value is equal to 'full-map', the area is the entire map.
	* '''[filter_self]''': if the owner of the ability does not match this filter, it will not receive the effects of the ability. [filter_self] takes a [[StandardUnitFilter]] as argument.		* '''[filter_self]''': if the owner of the ability does not match this filter, it will not receive the effects of the ability. [filter_self] takes a [[StandardUnitFilter]] as argument.
	* '''[filter_adjacent]''': if an adjacent unit does not match this filter, the ability will not be active and no-one will receive its affects. Takes extra keys ''adjacent'', ''count'', ''is_enemy'', ~~just like in a [[StandardUnitFilter]], with the one difference that~~, in the absence of a specified ''count'', all listed directions must match (so, with two ~~directiones~~ eg ''adjacent=n,s'', the default is ''count=2'')~~. In fact, it's really a shorthand for a [filter_adjacent] nested within [filter]. The variables $this_unit and {{DevFeature1.13\|2}} $other_unit both work as you'd expect~~. Multiple [filter_adjacent] can be provided, all of which must pass for the ability to activate. {{DevFeature1.19\|18}} '''~~filter_adjacent~~'~~'' is deprecated and will likely be removed in version 1.21~~, ~~since a version already exists in~~ the ~~[[StandardUnitFilter]]~~.		* '''[filter_adjacent]''': if an adjacent unit does not match this filter, the ability will not be active and no-one will receive its affects. Deprecated, please use [filter][filter_adjacent] instead, this filter behaves slightly differently. Takes extra keys ''adjacent'', ''count'', ''is_enemy'', however, in the absence of a specified ''count'', all listed directions must match (so, with two directions eg ''adjacent=n,s'', the default is ''count=2''). Multiple [filter_adjacent] can be provided, all of which must pass for the ability to activate.{{DevFeature1.13\|2}} Even in the presence of ''count'', the implementation was buggy and required all directions to match.
	* '''[filter_adjacent_location]''': like [filter_adjacent], but filters on locations instead of units. ~~This is a shorthand for~~ [filter][filter_location][filter_adjacent_location~~]. {{DevFeature1.19\|18}} '''filter_adjacent_location''' is deprecated and will likely be removed in version 1.21, since a version already exists in the [[StandardUnitFilter]~~].		* '''[filter_adjacent_location]''': like [filter_adjacent], including the bugs, but filters on locations instead of units. Similarly, it's deprecated in favor of [filter][filter_location][filter_adjacent_location].
	* {{anchor\|filter_base_value\|'''[filter_base_value]'''}}: filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', etc. If several keys are used all have to match.		* {{anchor\|filter_base_value\|'''[filter_base_value]'''}}: filters on the value before any modifications; uses the keys '''equals''', '''not_equals''', etc. If several keys are used all have to match.
	* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} but leaks memory until {{DevFeature1.19\|28}} An [event] to be included into any scenario where a unit with this ability appears in. Note that such events get included when a unit with this ability 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].		* '''[event]''': [[EventWML]]. {{DevFeature1.19\|4}} but leaks memory until {{DevFeature1.19\|28}} An [event] to be included into any scenario where a unit with this ability appears in. Note that such events get included when a unit with this ability 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].

← Older revision		Revision as of 08:26, 28 June 2026
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]].		** '''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]].		* '''[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.		* {{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.		** '''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\|'''[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].		** {{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.
			** '''affect''': A attribute for discriminate specials applied to self to specials applied to opponent, if '''affect=self''', specials used by opponent of unit affected will be ignored, if '''affect=opponent''', specials used by unit affected(same taught by teacher unit) will be ignored. This attribute work same if specials '''apply_to=attacker\|defender'''. '''both''' is value by default.
			** {{anchor\|filter_special\|'''[filter_special]'''}}: {{DevFeature1.19\|25}} [[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
			* '''name_affected''': {{DevFeature1.17\|13}} becomes the '''name''' of the weapon special, without changing the '''name''' of the ability
	* Other keys and tags appropriate to the specific weapon special.		* Other keys and tags appropriate to the specific weapon special.

← Older revision		Revision as of 08:02, 28 June 2026
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.		* {{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.		** '''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.
			** {{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		** '''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		** '''name_affected''': {{DevFeature1.17\|13}} becomes the '''name''' of the weapon special, without changing the '''name''' of the ability

← Older revision		Revision as of 13:23, 14 June 2026
Line 303:		Line 303:
	* [[SingleUnitWML]]		* [[SingleUnitWML]]
	* [[ReferenceWML]]		* [[ReferenceWML]]
			* [[WML_Abilities\|Ability Examples]]

	[[Category:WML Reference]]		[[Category:WML Reference]]