Difference between revisions of "StandardSideFilter"
From The Battle for Wesnoth Wiki
(document [has_unit]search_recall_list=) |
|||
Line 6: | Line 6: | ||
* '''side''': filter matches only if side number is contained in a comma-separated list. Note that as opposed to the usual inline side= key in wml action tags, which defaults to 1, the side= key in a SSF defaults to all sides (similarly, the id= key in SUFs defaults to all ids) | * '''side''': filter matches only if side number is contained in a comma-separated list. Note that as opposed to the usual inline side= key in wml action tags, which defaults to 1, the side= key in a SSF defaults to all sides (similarly, the id= key in SUFs defaults to all ids) | ||
− | * '''[has_unit]''': filter matches only if side controls a unit matched by this [[StandardUnitFilter]] | + | * '''[has_unit]''': |
+ | **'''[[StandardUnitFilter]]''': filter matches only if side controls a unit matched by it | ||
+ | **'''search_recall_list''': (boolean yes|no, default no) whether to include recall list units when trying to match this [[StandardUnitFilter]] against a unit | ||
+ | |||
* '''team_name''': The currently filtered side matches only if this passed team_name is contained in its (the filtered side's) team_name= string. Note that a side can be allied/on the same team like 2 (more...) other sides which can be enemies at the same time. (achieved by defining a side via [side]team_name=1,2 etc.) | * '''team_name''': The currently filtered side matches only if this passed team_name is contained in its (the filtered side's) team_name= string. Note that a side can be allied/on the same team like 2 (more...) other sides which can be enemies at the same time. (achieved by defining a side via [side]team_name=1,2 etc.) | ||
Revision as of 22:57, 19 May 2011
From FilterWML, this is the standard way of filtering on sides. Often a SSF needs to be included in a [filter_side] tag. There are however also many tags that take the SSF tags and keys directly as arguments.
The following attributes and sub-tags are permitted:
- side: filter matches only if side number is contained in a comma-separated list. Note that as opposed to the usual inline side= key in wml action tags, which defaults to 1, the side= key in a SSF defaults to all sides (similarly, the id= key in SUFs defaults to all ids)
- [has_unit]:
- StandardUnitFilter: filter matches only if side controls a unit matched by it
- search_recall_list: (boolean yes|no, default no) whether to include recall list units when trying to match this StandardUnitFilter against a unit
- team_name: The currently filtered side matches only if this passed team_name is contained in its (the filtered side's) team_name= string. Note that a side can be allied/on the same team like 2 (more...) other sides which can be enemies at the same time. (achieved by defining a side via [side]team_name=1,2 etc.)
Also, [and], [or], and [not] subfilters are supported.
Interaction of SSF and side= in tags like [remove_shroud] :
In case that inline side= and [filter_side] are given, inline side= is ignored and [filter_side]side= gets priority:
selects side 4 and 5:
[remove_shroud] side=2 [filter_side] side=4,5 [/filter_side] [remove_shroud]