StandardUnitFilter - Revision history

Octalot: Add anchor for [filter_ability], rename anchors for the experimental version

2026-10-02T20:35:14Z

Add anchor for [filter_ability], rename anchors for the experimental version

← Older revision		Revision as of 20:35, 2 October 2026
Line 61:		Line 61:
	* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.		* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.
	* '''lua_function''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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>.
	* {{anchor\|~~filter_ability~~\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''. {{DevFeature1.19\|5}} [experimental_filter_ability] deprecated, use [filter_ability] instead.		* {{anchor\|experimental_filter_ability\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''. {{DevFeature1.19\|5}} [experimental_filter_ability] deprecated, use [filter_ability] instead.
	* {{anchor\|~~filter_ability_active~~\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability]. {{DevFeature1.19\|5}} [experimental_filter_ability_active] deprecated, use [filter_ability] instead.		* {{anchor\|experimental_filter_ability_active\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability]. {{DevFeature1.19\|5}} [experimental_filter_ability_active] deprecated, use [filter_ability] instead.
	* '''[filter_ability]''': {{DevFeature1.19\|5}} [[StandardAbilityFilter]] matches if the unit has anability with the given properties - eg, ''[filter_ability]affect_adjacent=yes'' will match a unit with any ability with ''[affect_adjacent]''.		* {{anchor\|filter_ability\|'''[filter_ability]'''}}: {{DevFeature1.19\|5}} [[StandardAbilityFilter]] matches if the unit has anability with the given properties - eg, ''[filter_ability]affect_adjacent=yes'' will match a unit with any ability with ''[affect_adjacent]''.
	** '''active''': if active=yes, matches if the unit has an ''active'' ability with the given properties, if active=no, matches if the unit has an ability with the given properties regardless of 'active' or not. '''active''' is false by default.		** '''active''': if active=yes, matches if the unit has an ''active'' ability with the given properties, if active=no, matches if the unit has an ability with the given properties regardless of 'active' or not. '''active''' is false by default.

Soliton: Remove nonsensical radius mention

2026-04-10T09:42:25Z

Remove nonsensical radius mention

← Older revision		Revision as of 09:42, 10 April 2026
Line 51:		Line 51:
	* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter.		* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter.
	**'''StandardUnitFilter''' tags and keys		**'''StandardUnitFilter''' tags and keys
	** '''count''': a number, range, or comma separated range; default "1-6" {{DevFeature1.19\|13}} '''count''' no longer has a default value ~~since `filters adjacent` supports remote units thanks to '''radius'''~~.		** '''count''': a number, range, or comma separated range; default "1-6" {{DevFeature1.19\|13}} '''count''' no longer has a default value.
	** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[StandardLocationFilter#Directions\|notes]])		** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[StandardLocationFilter#Directions\|notes]])
	** '''is_enemy''': a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)		** '''is_enemy''': a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)

Newfrenchy83 at 10:24, 9 November 2025

2025-11-09T10:24:03Z

← Older revision		Revision as of 10:24, 9 November 2025
Line 51:		Line 51:
	* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter.		* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter.
	**'''StandardUnitFilter''' tags and keys		**'''StandardUnitFilter''' tags and keys
	** '''count''': a number, range, or comma separated range; default "1-6"		** '''count''': a number, range, or comma separated range; default "1-6" {{DevFeature1.19\|13}} '''count''' no longer has a default value since `filters adjacent` supports remote units thanks to '''radius'''.
	** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[StandardLocationFilter#Directions\|notes]])		** '''adjacent''': a comma separated list of directions; default "n,ne,se,s,sw,nw" (see [[StandardLocationFilter#Directions\|notes]])
	** '''is_enemy''': a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)		** '''is_enemy''': a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)

Newfrenchy83 at 09:14, 11 August 2025

2025-08-11T09:14:49Z

← Older revision		Revision as of 09:14, 11 August 2025
Line 55:		Line 55:
	** '''is_enemy''': a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)		** '''is_enemy''': a boolean specifying whether the adjacent unit must be an enemy or an ally (optional)
	** '''$other_unit''': {{DevFeature1.13\|2}} 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.		** '''$other_unit''': {{DevFeature1.13\|2}} 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.
			** '''radius''': {{DevFeature1.19\|13}} determines the distance of units that can be filtered and not just adjacent units, '''radius''' is set to 1 by default.
	* '''[filter_location]''': [[StandardLocationFilter]] - the tile that the unit is standing on matches the location filter.		* '''[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.		*'''[filter_side]''': The currently filtered unit's side must match this [[StandardSideFilter]] for the unit to match.

Laela at 18:48, 9 June 2025

2025-06-09T18:48:59Z

← Older revision		Revision as of 18:48, 9 June 2025
Line 49:		Line 49:
	* '''[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.		* '''[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.		* '''[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.
	* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter~~. {{DevFeature1.19\|10}} Inside abilities, can be used without [filter] tag~~.		* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter.
	**'''StandardUnitFilter''' tags and keys		**'''StandardUnitFilter''' tags and keys
	** '''count''': a number, range, or comma separated range; default "1-6"		** '''count''': a number, range, or comma separated range; default "1-6"

Newfrenchy83 at 18:16, 9 June 2025

2025-06-09T18:16:43Z

← Older revision		Revision as of 18:16, 9 June 2025
Line 49:		Line 49:
	* '''[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.		* '''[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.		* '''[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.
	* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument~~; use inside a [filter] tag~~. If present the correct number of adjacent units must match this filter. {{DevFeature1.19\|10}} Inside abilities, can be used without [filter] tag.		* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument. If present the correct number of adjacent units must match this filter. {{DevFeature1.19\|10}} Inside abilities, can be used without [filter] tag.
	**'''StandardUnitFilter''' tags and keys		**'''StandardUnitFilter''' tags and keys
	** '''count''': a number, range, or comma separated range; default "1-6"		** '''count''': a number, range, or comma separated range; default "1-6"

Newfrenchy83 at 13:43, 9 June 2025

2025-06-09T13:43:30Z

← Older revision		Revision as of 13:43, 9 June 2025
Line 49:		Line 49:
	* '''[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.		* '''[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.		* '''[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.
	* {{anchor\|filter_adjacent\|'''[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.		* {{anchor\|filter_adjacent\|'''[filter_adjacent]'''}} with a StandardUnitFilter as argument; use inside a [filter] tag. If present the correct number of adjacent units must match this filter. {{DevFeature1.19\|10}} Inside abilities, can be used without [filter] tag.
	**'''StandardUnitFilter''' tags and keys		**'''StandardUnitFilter''' tags and keys
	** '''count''': a number, range, or comma separated range; default "1-6"		** '''count''': a number, range, or comma separated range; default "1-6"

Newfrenchy83 at 17:12, 3 November 2024

2024-11-03T17:12:55Z

← Older revision		Revision as of 17:12, 3 November 2024
Line 60:		Line 60:
	* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.		* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.
	* '''lua_function''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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>.
	* {{anchor\|filter_ability\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''.		* {{anchor\|filter_ability\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''. {{DevFeature1.19\|5}} [experimental_filter_ability] deprecated, use [filter_ability] instead.
	* {{anchor\|filter_ability_active\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability].		* {{anchor\|filter_ability_active\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability]. {{DevFeature1.19\|5}} [experimental_filter_ability_active] deprecated, use [filter_ability] instead.
			* '''[filter_ability]''': {{DevFeature1.19\|5}} [[StandardAbilityFilter]] matches if the unit has anability with the given properties - eg, ''[filter_ability]affect_adjacent=yes'' will match a unit with any ability with ''[affect_adjacent]''.
			** '''active''': if active=yes, matches if the unit has an ''active'' ability with the given properties, if active=no, matches if the unit has an ability with the given properties regardless of 'active' or not. '''active''' is false by default.

	== [[Wesnoth Formula Language]] ==		== [[Wesnoth Formula Language]] ==

Celtic Minstrel: /* Wesnoth Formula Language */ Document health and fearless

2024-09-21T17:10:15Z

Wesnoth Formula Language: Document health and fearless

← Older revision		Revision as of 17:10, 21 September 2024
Line 106:		Line 106:
	* '''resistance''', '''movement_cost''', '''vision_cost''', '''jamming_cost''', '''defense''' - {{DevFeature1.15\|3}} 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.		* '''resistance''', '''movement_cost''', '''vision_cost''', '''jamming_cost''', '''defense''' - {{DevFeature1.15\|3}} 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''' {{DevFeature1.15\|3}}		* '''flying''' {{DevFeature1.15\|3}}
			* '''fearless''', '''healthy''' {{DevFeature1.19\|4}}
	* '''vars''' - WFL variables owned by the unit, which can be set and used by FormulaAI		* '''vars''' - WFL variables owned by the unit, which can be set and used by FormulaAI
	* '''wml_vars''' - the WML variables stored in the unit		* '''wml_vars''' - the WML variables stored in the unit

Egallager: link to the have_unit tag; clarify role of search_recall_list=yes key

2024-06-28T13:10:45Z

link to the have_unit tag; clarify role of search_recall_list=yes key

← Older revision		Revision as of 13:10, 28 June 2024
Line 11:		Line 11:
	You can access the filtered unit within the filter as the ''$this_unit'' variable, see [[SingleUnitWML]] for the possible content of these variables		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 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 [[DirectActionsWML#.5Bkill.5D\|[kill]]] and [[ConditionalActionsWML#.5Bhave_unit.5D\|[have_unit]]] (which each accept a few additional keys of their own). See [[Special:WhatLinksHere/StandardUnitFilter]] for tags which can contain a StandardUnitFilter.

	__TOC__		__TOC__
Line 40:		Line 40:
	* '''defense''': current defense of the unit on current tile (chance to hit %, like in movement type definitions)		* '''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. Can be a number, range, or comma separated range.		* '''movement_cost''': current movement cost of the unit on current tile. Can be a number, range, or comma separated range.
	* '''x,y''': the position of the unit. Note: As a special case '''x,y=recall,recall''' matches units on the recall list		* '''x,y''': the position of the unit. Note: As a special case '''x,y=recall,recall''' matches units on the recall list. Note that the similar '''search_recall_list=yes''' key is only available as part of the '''[have_unit]''' condition tag, and is not otherwise considered part of a StandardUnitFilter.
	* '''find_in''': name of an array or container variable; if present, the unit will not match unless a unit with the same '''id''' is already stored in the variable		* '''find_in''': name of an array or container variable; if present, the unit will not match unless a unit with the same '''id''' is already stored in the variable
	* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the unit is currently visible		* {{anchor\|filter_vision\|'''[filter_vision]'''}}: this tests whether or not the unit is currently visible

← Older revision		Revision as of 20:35, 2 October 2026
Line 61:		Line 61:
	* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.		* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.
	* '''lua_function''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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>.
	* {{anchor\|~~filter_ability~~\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''. {{DevFeature1.19\|5}} [experimental_filter_ability] deprecated, use [filter_ability] instead.		* {{anchor\|experimental_filter_ability\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''. {{DevFeature1.19\|5}} [experimental_filter_ability] deprecated, use [filter_ability] instead.
	* {{anchor\|~~filter_ability_active~~\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability]. {{DevFeature1.19\|5}} [experimental_filter_ability_active] deprecated, use [filter_ability] instead.		* {{anchor\|experimental_filter_ability_active\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability]. {{DevFeature1.19\|5}} [experimental_filter_ability_active] deprecated, use [filter_ability] instead.
	* '''[filter_ability]''': {{DevFeature1.19\|5}} [[StandardAbilityFilter]] matches if the unit has anability with the given properties - eg, ''[filter_ability]affect_adjacent=yes'' will match a unit with any ability with ''[affect_adjacent]''.		* {{anchor\|filter_ability\|'''[filter_ability]'''}}: {{DevFeature1.19\|5}} [[StandardAbilityFilter]] matches if the unit has anability with the given properties - eg, ''[filter_ability]affect_adjacent=yes'' will match a unit with any ability with ''[affect_adjacent]''.
	** '''active''': if active=yes, matches if the unit has an ''active'' ability with the given properties, if active=no, matches if the unit has an ability with the given properties regardless of 'active' or not. '''active''' is false by default.		** '''active''': if active=yes, matches if the unit has an ''active'' ability with the given properties, if active=no, matches if the unit has an ability with the given properties regardless of 'active' or not. '''active''' is false by default.

← Older revision		Revision as of 17:12, 3 November 2024
Line 60:		Line 60:
	* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.		* '''formula''': A formula using [[Wesnoth Formula Language]]. The <tt>self</tt> 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. {{DevFeature1.13\|5}} If the filter has a secondary unit, the formula can access it using the <code>other</code> variable. Both the unit and the secondary unit are a '''unit object''', with keys documented [[#Wesnoth_Formula_Language\|below]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.
	* '''lua_function''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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''': the name of a [[LuaWML\|Lua]] function in the global environment that takes a unit as an argument and returns true if the given unit matches the filter. {{DevFeature1.13\|5}} 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>.
	* {{anchor\|filter_ability\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''.		* {{anchor\|filter_ability\|'''[experimental_filter_ability]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ability with the given properties - eg, ''[experimental_filter_ability]affect_self=yes'' will match a unit with any ability with ''affect_self=yes''. {{DevFeature1.19\|5}} [experimental_filter_ability] deprecated, use [filter_ability] instead.
	* {{anchor\|filter_ability_active\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability].		* {{anchor\|filter_ability_active\|'''[experimental_filter_ability_active]'''}}: {{DevFeature1.17\|17}} [[StandardAbilityFilter]] matches if the unit has an ''active'' ability with the given properties - eg, ''[experimental_filter_ability_active]affect_adjacent=yes'' will match a unit with any ''active'' ability with ''[affect_adjacent]''. The attributes checked are the same as for [experimental_filter_ability]. {{DevFeature1.19\|5}} [experimental_filter_ability_active] deprecated, use [filter_ability] instead.
			* '''[filter_ability]''': {{DevFeature1.19\|5}} [[StandardAbilityFilter]] matches if the unit has anability with the given properties - eg, ''[filter_ability]affect_adjacent=yes'' will match a unit with any ability with ''[affect_adjacent]''.
			** '''active''': if active=yes, matches if the unit has an ''active'' ability with the given properties, if active=no, matches if the unit has an ability with the given properties regardless of 'active' or not. '''active''' is false by default.

	== [[Wesnoth Formula Language]] ==		== [[Wesnoth Formula Language]] ==