FilterWML - Revision history

Celtic Minstrel: /* Filtering Abilities */ New section

2026-02-05T00:32:02Z

‎Filtering Abilities: New section

Celtic Minstrel: /* Filtering on WML data */ Render the substituted parts in italics instead of bold

2025-08-31T18:00:11Z

‎Filtering on WML data: Render the substituted parts in italics instead of bold

Newfrenchy83: /* Filtering Weapons */

2024-11-03T17:00:51Z

‎Filtering Weapons

Laela: /* Filtering Weapons */

2024-09-04T19:15:59Z

‎Filtering Weapons

Laela: /* Filtering Weapons */

2024-09-04T19:13:49Z

‎Filtering Weapons

Laela: /* Filtering Weapons */

2024-09-04T19:13:21Z

‎Filtering Weapons

Celtic Minstrel: /* See Also */ Link to animation filtering

2024-08-01T13:54:45Z

‎See Also: Link to animation filtering

Soliton: /* Filtering on WML data */ clarify what is literal and what needs to be replaced with own data

2024-05-21T16:43:42Z

‎Filtering on WML data: clarify what is literal and what needs to be replaced with own data

Newfrenchy83: /* Filtering Weapons */

2023-11-11T10:39:13Z

‎Filtering Weapons

Pentarctagon: /* Filtering Weapons */

2023-11-08T04:31:34Z

‎Filtering Weapons

← Older revision		Revision as of 00:32, 5 February 2026
Line 39:		Line 39:

	See [[StandardSideFilter]] for details.		See [[StandardSideFilter]] for details.
		+
		+	== Filtering Abilities ==
		+	Occasionally, you need to filter for matching unit abilities or weapon specials. For this, an ability filter can be used.
		+	Ability filters are represented on this site by the phrase "standard ability filter".
		+
		+	See [[StandardAbilityFilter]] for details.

	== Filtering Weapons ==		== Filtering Weapons ==

@@ Line 105: / Line 105: @@
 Some places allow you to filter directly on WML data. WML filters are more free-form than other filters, allowing arbitrary WML data that is to be matched. Anything between '''<>''' needs to be replaced by the actual data to be filtered for. The following conventions are possible:
-* '''<key>=<value>''': Means that the key '''key''' must be present with the specified '''value'''.
+* ''<key>'''='''<value>'': Means that the key '''key''' must be present with the specified '''value'''.
-* '''glob_on_<key>=<glob>''': {{DevFeature1.15|0}} Means that the key '''key''' must be present with a value that matches the specified glob. In a glob, the '''*''' character matches any sequence of characters, while the '''?''' character matches any single character. In addition to the obvious, this is useful for matching the absence of a key - just place '''glob_on_<key>=*''' in a '''[not]''' tag.
+* '''glob_on_'''''<key>'''''='''''<glob>'': {{DevFeature1.15|0}} Means that the key '''key''' must be present with a value that matches the specified glob. In a glob, the '''*''' character matches any sequence of characters, while the '''?''' character matches any single character. In addition to the obvious, this is useful for matching the absence of a key - just place '''glob_on_'''''<key>'''''=*''' in a '''[not]''' tag.
-* '''[<some_tag>]''': In a WML filter, all tags contain further WML filter data as children. The presence of a tag in the filter means that the WML must have at least one tag '''some_tag''' present, and at least one of the '''some_tag''' tags must match the WML filter contained in '''[some_tag]'''.
+* '''['''''<some_tag>''''']''': In a WML filter, all tags contain further WML filter data as children. The presence of a tag in the filter means that the WML must have at least one tag '''some_tag''' present, and at least one of the '''some_tag''' tags must match the WML filter contained in '''[some_tag]'''.
 * '''[not]''': The WML filter contained in '''[not]''' ''must not'' match the WML.
 * '''[and]''': {{DevFeature1.15|0}} In addition to the main filter, the filter contained in '''[and]''' must also match the WML. In most cases this tag is not necessary (the two filters can simply be merged), but in some unusual cases (particularly when globs are involved) it might be needed to get the desired result.

@@ Line 58: / Line 58: @@
 * '''special''': filter on the attack's special power, matches both id and tag name. {{DevFeature1.15|2}} Deprecated, see '''special_id''' and '''special_type''' instead.
 * '''special_active''': {{DevFeature1.13|8}} Like '''special''', but true if the special is active at the current location. {{DevFeature1.15|2}} Deprecated, see '''special_id''' and '''special_type''' instead.
 * '''number''': {{DevFeature1.13|5}} filter on number of strikes
 * '''parry''': {{DevFeature1.13|5}} filter on parry value

@@ Line 65: / Line 65: @@
 * '''min_range''': {{DevFeature1.19|4}} filter on attack's range (distance)
 * '''max_range''': {{DevFeature1.19|4}} filter on attack's range (distance)
-* '''formula''': {{DevFeature1.13|5}} filter using [[Wesnoth Formula Language]]. The context object for the formula is a '''weapon object''', which supports the following keys: '''name''', '''description''', '''type''', '''icon''', '''range''', '''damage''', '''number''', '''attack_weight''', '''defense_weight''', '''accuracy''', '''parry''', '''movement_used''', '''min_range''', '''max_range''', '''specials'''. The '''specials''' key is a list of all the special IDs the unit possesses. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable. {{DevFeature1.17|13}} The '''attacks_used''' key is also supported.
+* '''formula''': {{DevFeature1.13|5}} filter using [[Wesnoth Formula Language]]. The context object for the formula is a '''weapon object''', which supports the following keys: '''name''', '''description''', '''type''', '''icon''', '''range''', '''damage''', '''number''', '''attack_weight''', '''defense_weight''', '''accuracy''', '''parry''', '''movement_used''', '''specials'''. The '''specials''' key is a list of all the special IDs the unit possesses. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable. Keys supported after specific version: {{DevFeature1.17|13}} '''attacks_used'''. {{DevFeature1.19|4}} '''min_range''', '''max_range'''.
 '''[and]''', '''[or]''', and '''[not]''' subfilters are also supported.

@@ Line 65: / Line 65: @@
 * '''min_range''': {{DevFeature1.19|4}} filter on attack's range (distance)
 * '''max_range''': {{DevFeature1.19|4}} filter on attack's range (distance)
-* '''formula''': {{DevFeature1.13|5}} filter using [[Wesnoth Formula Language]]. The context object for the formula is a '''weapon object''', which supports the following keys: '''name''', '''description''', '''type''', '''icon''', '''range''', '''damage''', '''number''', '''attack_weight''', '''defense_weight''', '''accuracy''', '''parry''', '''movement_used''', '''specials'''. The '''specials''' key is a list of all the special IDs the unit possesses. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable. {{DevFeature1.17|13}} The '''attacks_used''' key is also supported.
+* '''formula''': {{DevFeature1.13|5}} filter using [[Wesnoth Formula Language]]. The context object for the formula is a '''weapon object''', which supports the following keys: '''name''', '''description''', '''type''', '''icon''', '''range''', '''damage''', '''number''', '''attack_weight''', '''defense_weight''', '''accuracy''', '''parry''', '''movement_used''', '''min_range''', '''max_range''', '''specials'''. The '''specials''' key is a list of all the special IDs the unit possesses. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable. {{DevFeature1.17|13}} The '''attacks_used''' key is also supported.
 '''[and]''', '''[or]''', and '''[not]''' subfilters are also supported.

@@ Line 63: / Line 63: @@
 * '''movement_used''': {{DevFeature1.13|5}} filter on attack's movement cost
 * '''attacks_used''': {{DevFeature1.17|13}} filter on attack's attack cost
 * '''formula''': {{DevFeature1.13|5}} filter using [[Wesnoth Formula Language]]. The context object for the formula is a '''weapon object''', which supports the following keys: '''name''', '''description''', '''type''', '''icon''', '''range''', '''damage''', '''number''', '''attack_weight''', '''defense_weight''', '''accuracy''', '''parry''', '''movement_used''', '''specials'''. The '''specials''' key is a list of all the special IDs the unit possesses. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable. {{DevFeature1.17|13}} The '''attacks_used''' key is also supported.

@@ Line 113: / Line 113: @@
 == See Also ==
 * [[UnitTypeWML]]
 * [[EventWML]]

@@ Line 50: / Line 50: @@
 ** '''ranged''': only ranged weapons pass
 * '''name''': filter on the attack's name. See <code>data/units/</code> to find the name of a particular unit's attack.
-* '''type''': filter on the attack's type. Values are 'blade', 'pierce', 'impact', 'fire', 'cold', and 'arcane' or customised type. {{DevFeature1.17|23}} [damage] can modify type of attack but cannot yet be filtered on.
+* '''type''': filter on the attack's type. Values are 'blade', 'pierce', 'impact', 'fire', 'cold', and 'arcane' or customised type. {{DevFeature1.17|23}} [damage_type] can change the type of damage inflicted, and this change can be detected in the filter except when it is applied from a [damage_type] which affects the filtered attack, in this case only the type before any modification by a any [damage_type] will be detectable.
 * '''damage''': filter on damage value. Can be a specific number or a list of ranges like 'damage=0-5,7-99'
 * '''special_id''': {{DevFeature1.15|2}} Filter on a weapon special by id, for example, <code>magical</code> in <code>[chance_to_hit] id=magical</code>. True if the unit has the special, whether or not it's currently active.