StandardLocationFilter - Revision history

Soliton: /* Attributes */

2025-06-17T09:23:12Z

‎Attributes

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=

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

Egallager: /* Tutorial */ link cleanup

2023-04-19T06:51:31Z

‎Tutorial: link cleanup

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)

Celtic Minstrel: /* Attributes */ Document gives_income

2021-06-19T20:25:49Z

‎Attributes: Document gives_income

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

2021-06-11T03:58:40Z

Clarify not to use $(...)

Soliton: /* Attributes */

2020-11-24T15:11:43Z

‎Attributes

Celtic Minstrel: /* Wesnoth Formula Language */ Mention the teleport_unit variable too

2019-11-24T16:09:05Z

‎Wesnoth Formula Language: Mention the teleport_unit variable too

@@ 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.
 * '''[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.
 * {{anchor|filter_vision|'''[filter_vision]'''}}: this tests whether or not the location is currently visible

@@ 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).
 **'''[[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]])
 * {{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

@@ 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).
 * '''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.
 ** '''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.
-*'''[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
 * '''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]])
-* '''[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.''
 * '''[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.
-* '''[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"
 ** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[#Directions|notes]])

@@ Line 10: / Line 10: @@
 * '''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]])
-* '''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.
 * '''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.

@@ Line 193: / Line 193: @@
 == 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 ==

@@ Line 186: / Line 186: @@
 * '''keep'''
 * '''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.

@@ Line 30: / Line 30: @@
 ** '''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]])
-* '''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>.

← Older revision		Revision as of 16:09, 24 November 2019
Line 188:		Line 188:

	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.
		+
		+	Some location formulas also have access to a '''teleport_unit''' variable, which is a '''[[StandardUnitFilter#Wesnoth_Formula_Language\|unit object]]'''.

	== Tutorial ==		== Tutorial ==