StandardLocationFilter - Revision history

Octalot: Remove the suggestion that the [terrain] tag can set location ids

2026-07-04T15:01:18Z

Remove the suggestion that the [terrain] tag can set location ids

← Older revision		Revision as of 15:01, 4 July 2026
Line 10:		Line 10:
	* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).		* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).
	* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])		* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])
	* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list~~. This key can be set in the map editor or with the [terrain] tag~~.		* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map data. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list.
	* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.		* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.
	* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.		* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.

Soliton: /* Attributes */

2025-06-17T09:23:12Z

Attributes

← Older revision		Revision as of 09:23, 17 June 2025
Line 14:		Line 14:
	* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.		* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.
	* '''[filter]''' with a [[StandardUnitFilter]] as argument; if present a unit must also be there		* '''[filter]''' with a [[StandardUnitFilter]] as argument; if present a unit must also be there
	* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ [[TerrainWML\|terrain_type]] ]gives_income= parameter was set to yes (which means a side can own that hex).		* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [[TerrainWML\|[terrain_type]]]<nowiki/>gives_income= parameter was set to yes (which means a side can own that hex).
	* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.		* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.
	* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the location is currently visible		* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the location is currently visible

Octalot: /* Attributes */ Clarify that find_in is looking for x,y= rather than location_id=

2024-05-22T21:57:59Z

Attributes: Clarify that find_in is looking for x,y= rather than location_id=

← Older revision		Revision as of 21:57, 22 May 2024
Line 22:		Line 22:
	* {{anchor\|filter_owner\|'''[filter_owner]'''}}: If present, inline owner_side= is ignored. Restricts stored locations to villages, each of which must belong to any of the matching sides. If no sides match, restricts to unowned villages (and only these).		* {{anchor\|filter_owner\|'''[filter_owner]'''}}: If present, inline owner_side= is ignored. Restricts stored locations to villages, each of which must belong to any of the matching sides. If no sides match, restricts to unowned villages (and only these).
	**'''[[StandardSideFilter]]''' tags and keys as arguments		**'''[[StandardSideFilter]]''' tags and keys as arguments
	* '''find_in''': name of an array or container variable; if present, the location will not match unless it is also found stored in the variable		* '''find_in''': name of an array or container variable; if present, the location will not match unless it is also found stored in the variable. Expects containers to contain '''x''','''y''' pairs, not '''location_id''' names.
	* '''radius''': matches if any location within the radius matches this filter ([[StandardLocationFilter#Notes_about_Radius_Usage\|notes]])		* '''radius''': matches if any location within the radius matches this filter ([[StandardLocationFilter#Notes_about_Radius_Usage\|notes]])
	* {{anchor\|filter_radius\|'''[filter_radius]'''}}: a standard location filter; normally the radius extends outwards from matching locations one step at a time without checking any additional information-- however, if this tag is present, the radius will be restricted so that it can only expand outwards in the directions where it passes the given location filter		* {{anchor\|filter_radius\|'''[filter_radius]'''}}: a standard location filter; normally the radius extends outwards from matching locations one step at a time without checking any additional information-- however, if this tag is present, the radius will be restricted so that it can only expand outwards in the directions where it passes the given location filter

Celtic Minstrel: /* Attributes */ Add anchors that can be linked to

2024-02-26T14:57:35Z

Attributes: Add anchors that can be linked to

Doofus-01 at 23:04, 28 May 2023

2023-05-28T23:04:09Z

← Older revision		Revision as of 23:04, 28 May 2023
Line 10:		Line 10:
	* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).		* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).
	* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])		* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])
	* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list.		* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list. This key can be set in the map editor or with the [terrain] tag.
	* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.		* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.
	* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.		* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.

Egallager: /* Tutorial */ link cleanup

2023-04-19T06:51:31Z

Tutorial: link cleanup

← Older revision		Revision as of 06:51, 19 April 2023
Line 193:		Line 193:

	== Tutorial ==		== Tutorial ==
	* [~~http://wiki.wesnoth.org/~~FilterWML/Examples_-_How_to_use_Filter How To Use Filter (with examples)]		* [[FilterWML/Examples_-_How_to_use_Filter\|How To Use Filter (with examples)]]

	== See Also ==		== See Also ==

Celtic Minstrel: /* Wesnoth Formula Language */ Replace owner (deprecated, 0-based) with owner_side (1-based)

2022-01-08T19:14:37Z

Wesnoth Formula Language: Replace owner (deprecated, 0-based) with owner_side (1-based)

← Older revision		Revision as of 19:14, 8 January 2022
Line 186:		Line 186:
	* '''keep'''		* '''keep'''
	* '''healing''': an integer containing the value of [terrain_type]heals=		* '''healing''': an integer containing the value of [terrain_type]heals=
	* '''~~owner~~'''		* '''owner_side'''

	For an up-to-date list, check the C++ function terrain_callable::get_value(const std::string& key) const.		For an up-to-date list, check the C++ function terrain_callable::get_value(const std::string& key) const.

Celtic Minstrel: /* Attributes */ Document gives_income

2021-06-19T20:25:49Z

Attributes: Document gives_income

← Older revision		Revision as of 20:25, 19 June 2021
Line 15:		Line 15:
	* '''[filter]''' with a [[StandardUnitFilter]] as argument; if present a unit must also be there		* '''[filter]''' with a [[StandardUnitFilter]] as argument; if present a unit must also be there
	* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ [[TerrainWML\|terrain_type]] ]gives_income= parameter was set to yes (which means a side can own that hex).		* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ [[TerrainWML\|terrain_type]] ]gives_income= parameter was set to yes (which means a side can own that hex).
			* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.
	* '''[filter_vision]''': this tests whether or not the location is currently visible		* '''[filter_vision]''': this tests whether or not the location is currently visible
	** '''visible''': yes or no, default yes. "yes" filters for visible locations, "no" filters for invisible locations.		** '''visible''': yes or no, default yes. "yes" filters for visible locations, "no" filters for invisible locations.

Celtic Minstrel: Clarify not to use $(...)

2021-06-11T03:58:40Z

Clarify not to use $(...)

← Older revision		Revision as of 03:58, 11 June 2021
Line 30:		Line 30:
	** '''count''': a number, range, or comma separated range; default "1-6"		** '''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 [[#Directions\|notes]])		** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[#Directions\|notes]])
	* '''formula''': {{DevFeature1.13\|5}} a [[Wesnoth Formula Language]] formula. Some terrain-specific variables, for example "light" and "castle", can be used in the filter [[#Wesnoth_Formula_Language\|(see list below)]].		* '''formula''': {{DevFeature1.13\|5}} a [[Wesnoth Formula Language]] formula. Some terrain-specific variables, for example "light" and "castle", can be used in the filter [[#Wesnoth_Formula_Language\|(see list below)]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.
	* '''lua_function''': {{DevFeature1.13\|5}} the name of a [[LuaWML\|Lua]] function in the global environment that takes arguments <code>x, y</code> and returns true if the given location matches the filter. 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 <code>my_filter_functions["goto"]</code>.		* '''lua_function''': {{DevFeature1.13\|5}} the name of a [[LuaWML\|Lua]] function in the global environment that takes arguments <code>x, y</code> and returns true if the given location matches the filter. 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 <code>my_filter_functions["goto"]</code>.

Soliton: /* Attributes */

2020-11-24T15:11:43Z

Attributes

← Older revision		Revision as of 15:11, 24 November 2020
Line 18:		Line 18:
	** '''visible''': yes or no, default yes. "yes" filters for visible locations, "no" filters for invisible locations.		** '''visible''': yes or no, default yes. "yes" filters for visible locations, "no" filters for invisible locations.
	** '''respect_fog''': yes or no, default yes. "yes" filters for locations that are clear of both fog and shroud, "no" filters for locations that are clear of shroud.		** '''respect_fog''': yes or no, default yes. "yes" filters for locations that are clear of both fog and shroud, "no" filters for locations that are clear of shroud.
	** [[StandardSideFilter]] tags and keys as arguments. If there is at least one matching side which can see the location then the filter matches, and otherwise it fails to match.		** [[StandardSideFilter]] tags and keys as arguments. If there is '''at least one''' matching side which can see the location then the filter matches, and otherwise it fails to match.
	*'''[filter_owner]''': If present, inline owner_side= is ignored. Restricts stored locations to villages, each of which must belong to any of the matching sides. If no sides match, restricts to unowned villages (and only these).		*'''[filter_owner]''': If present, inline owner_side= is ignored. Restricts stored locations to villages, each of which must belong to any of the matching sides. If no sides match, restricts to unowned villages (and only these).
	**'''[[StandardSideFilter]]''' tags and keys as arguments		**'''[[StandardSideFilter]]''' tags and keys as arguments

← Older revision		Revision as of 15:01, 4 July 2026
Line 10:		Line 10:
	* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).		* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).
	* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])		* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])
	* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list~~. This key can be set in the map editor or with the [terrain] tag~~.		* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map data. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list.
	* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.		* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.
	* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.		* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.

← Older revision		Revision as of 09:23, 17 June 2025
Line 14:		Line 14:
	* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.		* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.
	* '''[filter]''' with a [[StandardUnitFilter]] as argument; if present a unit must also be there		* '''[filter]''' with a [[StandardUnitFilter]] as argument; if present a unit must also be there
	* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ [[TerrainWML\|terrain_type]] ]gives_income= parameter was set to yes (which means a side can own that hex).		* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [[TerrainWML\|[terrain_type]]]<nowiki/>gives_income= parameter was set to yes (which means a side can own that hex).
	* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.		* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.
	* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the location is currently visible		* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the location is currently visible

← Older revision		Revision as of 23:04, 28 May 2023
Line 10:		Line 10:
	* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).		* '''terrain''': comma separated list of terrains. (See also: [[#Filtering_Terrains\|Filtering Terrains]]).
	* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])		* '''x,y''': the same as in the unit filter; supports any range ([[StandardLocationFilter#Notes_about_Coordinate_Usage\|notes]])
	* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list.		* '''location_id''': {{DevFeature1.13\|?}} Matches a special location set in the map. This can also be a side number to match that side's starting location. Note: this does not accept a comma separated list, one has to use [or] tags. {{DevFeature1.15\|0}} Accepts a comma separated list. This key can be set in the map editor or with the [terrain] tag.
	* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.		* '''area''': matches locations assigned to the [[DirectActionsWML#.5Btime_area.5D\|[time_area]]] with the given id.
	* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.		* '''include_borders''': {{DevFeature1.13\|0}} whether the SLF will include border hexes or not. Will override the default behavior of the tag this appears in.

← Older revision		Revision as of 14:57, 26 February 2024
Line 16:		Line 16:
	* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ [[TerrainWML\|terrain_type]] ]gives_income= parameter was set to yes (which means a side can own that hex).		* '''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ [[TerrainWML\|terrain_type]] ]gives_income= parameter was set to yes (which means a side can own that hex).
	* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.		* '''gives_income''': {{DevFeature1.15\|11}} Matches whether or not a hex gives income, based on its terrain_type settings.
	* '''[filter_vision]''': this tests whether or not the location is currently visible		* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the location is currently visible
	** '''visible''': yes or no, default yes. "yes" filters for visible locations, "no" filters for invisible locations.		** '''visible''': yes or no, default yes. "yes" filters for visible locations, "no" filters for invisible locations.
	** '''respect_fog''': yes or no, default yes. "yes" filters for locations that are clear of both fog and shroud, "no" filters for locations that are clear of shroud.		** '''respect_fog''': yes or no, default yes. "yes" filters for locations that are clear of both fog and shroud, "no" filters for locations that are clear of shroud.
	** [[StandardSideFilter]] tags and keys as arguments. If there is '''at least one''' matching side which can see the location then the filter matches, and otherwise it fails to match.		** [[StandardSideFilter]] tags and keys as arguments. If there is '''at least one''' matching side which can see the location then the filter matches, and otherwise it fails to match.
	*'''[filter_owner]''': If present, inline owner_side= is ignored. Restricts stored locations to villages, each of which must belong to any of the matching sides. If no sides match, restricts to unowned villages (and only these).		* {{anchor\|filter_owner\|'''[filter_owner]'''}}: If present, inline owner_side= is ignored. Restricts stored locations to villages, each of which must belong to any of the matching sides. If no sides match, restricts to unowned villages (and only these).
	**'''[[StandardSideFilter]]''' tags and keys as arguments		**'''[[StandardSideFilter]]''' tags and keys as arguments
	* '''find_in''': name of an array or container variable; if present, the location will not match unless it is also found stored in the variable		* '''find_in''': name of an array or container variable; if present, the location will not match unless it is also found stored in the variable
	* '''radius''': matches if any location within the radius matches this filter ([[StandardLocationFilter#Notes_about_Radius_Usage\|notes]])		* '''radius''': matches if any location within the radius matches this filter ([[StandardLocationFilter#Notes_about_Radius_Usage\|notes]])
	* '''[filter_radius]''': a standard location filter; normally the radius extends outwards from matching locations one step at a time without checking any additional information-- however, if this tag is present, the radius will be restricted so that it can only expand outwards in the directions where it passes the given location filter		* {{anchor\|filter_radius\|'''[filter_radius]'''}}: a standard location filter; normally the radius extends outwards from matching locations one step at a time without checking any additional information-- however, if this tag is present, the radius will be restricted so that it can only expand outwards in the directions where it passes the given location filter
	* '''[and]''': an extra location filter. Unless a location matches the [and] filter, then it will be excluded. ''Note: [and],[or],and [not] extra location filters are considered after everything else in the containing filter (except radius, which is considered last in 1.3.8 and greater); they are then processed in the order encountered.''		* '''[and]''': an extra location filter. Unless a location matches the [and] filter, then it will be excluded. ''Note: [and],[or],and [not] extra location filters are considered after everything else in the containing filter (except radius, which is considered last in 1.3.8 and greater); they are then processed in the order encountered.''
	* '''[or]''': an extra location filter. If a location matches the [or] filter, then it will count as a match regardless of conditions in previous filters or the containing filter.		* '''[or]''': an extra location filter. If a location matches the [or] filter, then it will count as a match regardless of conditions in previous filters or the containing filter.
	* '''[not]''': an extra location filter. If a location matches the [not] filter, then that location will be excluded.		* '''[not]''': an extra location filter. If a location matches the [not] filter, then that location will be excluded.
	* '''[filter_adjacent_location]''': a standard location filter; if present the correct number of adjacent locations must match this filter		* {{anchor\|filter_adjacent_location\|'''[filter_adjacent_location]'''}}: a standard location filter; if present the correct number of adjacent locations must match this filter
	** '''count''': a number, range, or comma separated range; default "1-6"		** '''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 [[#Directions\|notes]])		** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[#Directions\|notes]])