StandardSideFilter - Revision history

Celtic Minstrel: Add some anchors that can be linked to

2024-02-25T01:13:37Z

Add some anchors that can be linked to

Celtic Minstrel: /* Wesnoth Formula Language */ Replace deprecated side key with side_number

2022-01-08T19:13:45Z

‎Wesnoth Formula Language: Replace deprecated side key with side_number

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

2021-06-11T03:58:57Z

Clarify not to use $(...)

Celtic Minstrel: /* Wesnoth formula language */ Fix case of heading

2019-11-24T16:20:16Z

‎Wesnoth formula language: Fix case of heading

Celtic Minstrel: Document the WFL side object

2019-11-24T16:04:38Z

Document the WFL side object

EliDupree at 19:18, 23 June 2018

2018-06-23T19:18:51Z

Celtic Minstrel: Add formula key

2016-07-15T20:44:56Z

Add formula key

Vultraz: Remove DevFeature1.11

2015-03-01T08:26:59Z

Remove DevFeature1.11

Iceiceice at 20:12, 12 July 2014

2014-07-12T20:12:10Z

Iceiceice at 20:11, 12 July 2014

2014-07-12T20:11:34Z

@@ 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). This key also accepts ranges (i.e. "1,3-4,6")
-* '''[has_unit]''':
+* {{anchor|has_unit|'''[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
@@ Line 12: / Line 12: @@
 * '''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.)
-* '''[enemy_of]''': The currently filtered side must be an enemy of all of the sides matching this StandardSideFilter for it to match. If this inner StandardSideFilter matches no sides, the outer filter also doesn't. Note that a side is not an enemy of itself.
+* {{anchor|enemy_of|'''[enemy_of]'''}}: The currently filtered side must be an enemy of all of the sides matching this StandardSideFilter for it to match. If this inner StandardSideFilter matches no sides, the outer filter also doesn't. Note that a side is not an enemy of itself.
 **StandardSideFilter tags and keys
-* '''[allied_with]''': The currently filtered side must be allied with all of the sides matching this StandardSideFilter for it to match. If this inner StandardSideFilter matches no sides, the outer filter also doesn't. Note that a side is allied with itself.
+* {{anchor|allied_with|'''[allied_with]'''}}: The currently filtered side must be allied with all of the sides matching this StandardSideFilter for it to match. If this inner StandardSideFilter matches no sides, the outer filter also doesn't. Note that a side is allied with itself.
 **StandardSideFilter tags and keys
-* '''[has_enemy]''': The currently filtered side must have at least one enemy matching this StandardSideFilter for it to match. (Note that a side is not an enemy of itself.)
+* {{anchor|has_enemy|'''[has_enemy]'''}}: The currently filtered side must have at least one enemy matching this StandardSideFilter for it to match. (Note that a side is not an enemy of itself.)
 **StandardSideFilter tags and keys.
-* '''[has_ally]''': The currently filtered side must have at least one ally matching this StandardSideFilter for it to match. (Note that a side is allied with itself.)
+* {{anchor|has_ally|'''[has_ally]'''}}: The currently filtered side must have at least one ally matching this StandardSideFilter for it to match. (Note that a side is allied with itself.)
 **StandardSideFilter tags and keys.

@@ Line 34: / Line 34: @@
 When using the '''formula''' key, the context object is a '''side object''' which supports the following keys:
-* '''side'''
+* '''side_number'''
 * '''id'''
 * '''save_id'''

@@ Line 26: / Line 26: @@
 * '''controller''': The currently filtered side matches only if it has this controller string. Sensible values are ai, human, and null. This key is disabled for networked multiplayer, since there the controller value of a side may differ between the clients. Thus using this key would inevitably lead to OOS errors.
-* '''formula''': {{DevFeature1.13|5}} A formula using [[Wesnoth Formula Language]]
+* '''formula''': {{DevFeature1.13|5}} A formula using [[Wesnoth Formula Language]]. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.
 Also, [and], [or], and [not] subfilters are supported.

@@ Line 30: / Line 30: @@
 Also, [and], [or], and [not] subfilters are supported.
-== Wesnoth formula language ==
+== Wesnoth Formula Language ==
 When using the '''formula''' key, the context object is a '''side object''' which supports the following keys:

← Older revision		Revision as of 16:04, 24 November 2019
Line 30:		Line 30:
	Also, [and], [or], and [not] subfilters are supported.		Also, [and], [or], and [not] subfilters are supported.

		+	== Wesnoth formula language ==
		+
		+	When using the '''formula''' key, the context object is a '''side object''' which supports the following keys:
		+
		+	* '''side'''
		+	* '''id'''
		+	* '''save_id'''
		+	* '''gold'''
		+	* '''start_gold'''
		+	* '''base_income'''
		+	* '''total_income'''
		+	* '''village_gold'''
		+	* '''village_support'''
		+	* '''recall_cost'''
		+	* '''name'''
		+	* '''is_human'''
		+	* '''is_ai'''
		+	* '''is_network'''
		+	* '''fog''' - true if the side has fog enabled
		+	* '''shroud''' - true if the side has shroud enabled
		+	* '''hidden'''
		+	* '''flag'''
		+	* '''flag_icon'''
		+	* '''team_name'''
		+	* '''color'''
		+	* '''share_vision'''
		+	* '''carryover_bonus'''
		+	* '''carryover_percentage'''
		+	* '''carryover_add'''
		+	* '''recruit''' - a list of possible recruits
		+	* '''wml_vars''' - the WML variables stored with the side
		+
		+	== Interaction with inline side key ==

	Interaction of SSF and side= in tags like [remove_shroud] :		Interaction of SSF and side= in tags like [remove_shroud] :

← Older revision		Revision as of 20:44, 15 July 2016
Line 26:		Line 26:
	* '''controller''': The currently filtered side matches only if it has this controller string. Sensible values are ai, human, human_ai (:droided human side) and null. This key is disabled for networked multiplayer, since there the controller value of a side differs between the clients. Thus using this key would inevitably lead to OOS errors.		* '''controller''': The currently filtered side matches only if it has this controller string. Sensible values are ai, human, human_ai (:droided human side) and null. This key is disabled for networked multiplayer, since there the controller value of a side differs between the clients. Thus using this key would inevitably lead to OOS errors.

		+	* '''formula''': {{DevFeature1.13\|5}} A formula using [[Wesnoth Formula Language]]

	Also, [and], [or], and [not] subfilters are supported.		Also, [and], [or], and [not] subfilters are supported.

@@ Line 19: / Line 19: @@
 **StandardSideFilter tags and keys
-* '''[has_enemy]''': {{DevFeature1.11|16}} The currently filtered side must have at least one enemy matching this StandardSideFilter for it to match. (Note that a side is allied with itself.)
+* '''[has_enemy]''': {{DevFeature1.11|16}} The currently filtered side must have at least one enemy matching this StandardSideFilter for it to match. (Note that a side is not an enemy of itself.)
 **StandardSideFilter tags and keys.
-* '''[has_enemy]''': {{DevFeature1.11|16}} The currently filtered side must have at least one ally matching this StandardSideFilter for it to match. (Note that a side is not an enemy of itself.)
+* '''[has_ally]''': {{DevFeature1.11|16}} The currently filtered side must have at least one ally matching this StandardSideFilter for it to match. (Note that a side is allied with itself.)
 **StandardSideFilter tags and keys.