Difference between revisions of "StandardUnitFilter"
Latest revision as of 03:57, 11 June 2021
From FilterWML, this is the standard way of filtering units.
When a unit filter is applied to a map, first it applies to all units on the field, based on their coordinates. Next it applies to units in the recall list. This is important to remember as it means, for example, that the tag [kill] can be used to kill units in the recall list.
You can access the filtered unit within the filter as the $this_unit variable, see SingleUnitWML for the possible content of these variables
The term StandardUnitFilter means that the set of such keys and tags (see below) can appear at that point. Often a StandardUnitFilter needs to be included in a [filter] tag. But many tags take the StandardUnitFilter directly as an argument, like [kill] and [have_unit]. See Special:WhatLinksHere/StandardUnitFilter for tags which can contain a StandardUnitFilter.
The following attributes and sub-tags are allowed:
- id: unit matches the given id. This is the same as id in the [unit] tag. Note that it is independent of a unit's user-visible name, which can be internationalized independent of this (see SingleUnitWML). id= can be a comma-separated list, every unit with one of these ids matches.
- speaker: alias for id (no comma-separated list supported)
- type: matches the unit's type name (can be a list of types)
- type_adv_tree: (Version 1.13.7 and later only) matches the type name of the unit and all its advancements (can be a list)
- race: the race of the unit type. This can be a comma-separated list; the unit's race must match one of the given races.
Mainline races are listed in data/core/units.cfg
- variation: the unit type variation id (can be a list of variation ids)
- has_variation: matches if the unit type for the unit defines at least one of the variation ids provided as a comma-separated list
- upkeep: (Version 1.15.3 and later only) The upkeep of the unit. Can be either a non-negative number or one of the special values loyal, free, full. Note that while loyal and free are synonymous with an upkeep of 0, the value full is not synonymous with any single numeric value – it is equivalent to `$this_unit.level`.
- ability: unit has an ability with the given id; see AbilitiesWML
- ability_type: (Version 1.13.7 and later only) unit has an ability with the given type (tag name) - eg, ability_type=heals will match a unit with any healing ability.
- ability_type_active: (Version 1.13.8 and later only) unit has an active ability with the given type (tag name).
- trait: (Version 1.13.8 and later only) This can be a comma-separated list. The unit must have at least one of the specified traits.
- status: (Version 1.13.0 and later only) matches if the unit has the specified status active. This can be a comma-separated list, in which case the unit will match as long as it has one of the listed statuses active (note: possible statuses are listed on the SingleUnitWML page).
- side: the unit is on the given side (can be a list)
- has_weapon: the unit has a weapon with the given name (Version 1.13.5 and later only) Now deprecated
- [has_attack]: (Version 1.13.5 and later only) the unit has a weapon matching the StandardWeaponFilter. If this is present, has_weapon is ignored.
- canrecruit: yes if the unit can recruit (i.e. is a leader)
- gender: female if the unit is female rather than the default of male
- role: the unit has been assigned the given role; see [role], InternalActionsWML
- level: the level of the unit (this can be a comma-separated list).
- defense: current defense of the unit on current tile (chance to hit %, like in movement type definitions)
- movement_cost: current movement cost of the unit on current tile
- x,y: the position of the unit. Note: there is a special case for units on the recall list such that x,y="recall,recall"
- find_in: name of an array or container variable; if present, the unit will not match unless it is also found stored in the variable
- [filter_vision]: this tests whether or not the unit is currently visible
- visible: yes or no, default yes. When "yes", this matches units that are not obscured by fog or shroud, and that are not hiding (via the [hides] ability). When "no", this matches units that are obscured by fog or shroud, or that are hiding.
- StandardSideFilter tags and keys. Filter for who may be able to see (or not see) the unit. If there is *at least one* matching side which can see the unit then the filter matches, and otherwise it fails to match.
- [filter_wml]: Converts the unit to WML (as if by [store_unit]) and tests it against a WML filter. For a list of things in the WML that could be filtered on, see SingleUnitWML or open a saved game in a text editor. Note that this is slower than other methods, so if possible it's better to use other filter keys and tags; however, if the WML filter contains only a child [variables], then the unit is not converted to WML and the filter is matched only against the unit's variables (which are already WML).
- [and]: an extra unit filter. Unless the unit also matches the [and] filter, then it will not count as a match. Note: [and],[or], and [not] filters are considered after the containing filter; they are then processed in the order encountered.
- [or]: an extra unit filter. If a unit matches the [or] filter, then it will count as a match regardless of conditions in previous filters or the containing filter.
- [not]: an extra unit filter. If a unit matches the [not] filter, then that unit will not be considered a match by the containing filter.
- [filter_adjacent] with a StandardUnitFilter as argument; do not use a [filter] tag. If present the correct number of adjacent units must match this filter.
- StandardUnitFilter tags and keys
- count: a number, range, or comma separated range; default "1-6"
- adjacent: a comma separated list of directions; default "n,ne,se,s,sw,nw" (see notes)
- is_enemy: a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)
- $other_unit: (Version 1.13.2 and later only) Within [filter_adjacent], the special variable $other_unit refers to the filtered unit from the enclosing filter, while $this_unit refers (as with all StandardUnitFilters) to the unit being filtered on.
- [filter_location]: StandardLocationFilter - the tile that the unit is standing on matches the location filter.
- [filter_side]: The currently filtered unit's side must match this StandardSideFilter for the unit to match.
- StandardSideFilter tags and keys
- formula: A formula using Wesnoth Formula Language. The self variable is set to the current $this_unit, and the formula should return a boolean. If it returns 0, the filter does not match. Otherwise, the filter does match. (Version 1.13.5 and later only) If the filter has a secondary unit, the formula can access it using the
othervariable. Both the unit and the secondary unit are a unit object, with keys documented below. Do not surround the formula in
$(...), since that will erase the self variable.
- lua_function: the name of a Lua function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. (Version 1.13.5 and later only) Non-global functions can now be used here by building a dot-separated "path". Note that this is not actually interpreted as Lua code even though it superficially resembles it, so using a Lua keyword in the path will work, for example "my_filter_functions.goto" will correctly use the function which in actual Lua code would need to be referenced as
Wesnoth Formula Language
When using the formula key, the self and (if present) other objects support the following keys:
- x, y, loc - the latter is a location object such as what would be returned from loc().
- canrecruit, leader
- undead - true if the unit has the not_living status
- attacks - a list of weapon objects
- abilities - a list of the ability IDs the unit possesses
- hitpoints, max_hitpoints
- experience, max_experience
- moves, max_moves
- attacks_left, max_attacks
- level, full - full refers to the unit's level to support the formula
upkeep = full
- traits - a list of the trait IDs
- status - a list of active statuses
- loyal - a constant 0 to support the formula
upkeep = loyal
- petrified - true if the unit has the petrified status
- resistance, movement_cost, vision_cost, jamming_cost, defense - (Version 1.15.3 and later only) Maps containing the basic movetype data. The defense and resistance maps contain the actual defense and resistance values, rather than the values specified in the WML, so you do not need to subtract them from 100.
- flying (Version 1.15.3 and later only)
- vars - WFL variables owned by the unit, which can be set and used by FormulaAI
- wml_vars - the WML variables stored in the unit
- n, s, ne, se, nw, sw, lawful, chaotic, neutral, liminal, male, female - these are all defined to be the equivalent string so that, for example, you can write a formula like
alignment = liminal and gender = femalewithout needing to quote the alignment and gender strings.
A Note about Re-Using the Same Attribute
You are limited to having each attribute, such as id, appear once or less in a StandardUnitFilter. However, this can be worked around. If you have several specific units you want excepted from matching, use a separate [or] subfilters for each one. Also you can use [not] subfilters. For example to kill ([kill] uses the standard unit filter) all units except Gwiti Ha'atel and Tanar you can do the following:
[kill] [not] id=Gwiti Ha'atel [/not] [not] id=Tanar [/not] [/kill]
And similarly if you wanted to kill both Gwiti Ha'atel and Tanar, but no one else you could do the following:
[kill] id=Gwiti Ha'atel [or] id=Tanar [/or] [/kill]