Wesnoth Formula Language - Revision history

Celtic Minstrel: /* Action Functions */ Add missing header

2026-01-25T06:59:30Z

‎Action Functions: Add missing header

Celtic Minstrel: Document the two action functions.

2026-01-25T06:58:44Z

Document the two action functions.

Celtic Minstrel: /* Maps */ Document empty map literal

2026-01-07T19:48:56Z

‎Maps: Document empty map literal

Vultraz: /* Files */

2025-07-21T06:46:31Z

‎Files

Vultraz: /* Files */

2025-07-21T06:15:17Z

‎Files

Vultraz: /* Game State Functions */

2025-07-21T06:08:07Z

‎Game State Functions

Vultraz: /* nearest_loc */

2025-07-19T20:08:02Z

‎nearest_loc

Celtic Minstrel: /* Location Functions */ Missed a bit

2025-07-19T13:27:58Z

‎Location Functions: Missed a bit

Celtic Minstrel: /* Location Functions */ Put nearest_loc in correct sorted location

2025-07-19T13:27:20Z

‎Location Functions: Put nearest_loc in correct sorted location

Vultraz: Add nearest_loc

2025-07-18T09:58:39Z

Add nearest_loc

← Older revision		Revision as of 06:59, 25 January 2026
Line 1,294:		Line 1,294:

	The result of this function is an object that has '''name''' and '''value''' keys with the passed-in values.		The result of this function is an object that has '''name''' and '''value''' keys with the passed-in values.
		+
		+	==== safe_call ====

	* safe_call(''main'', ''backup'')		* safe_call(''main'', ''backup'')

← Older revision		Revision as of 06:58, 25 January 2026
Line 1,280:		Line 1,280:

	Calculates the vision cost for the unit to see through the given location or terrain.		Calculates the vision cost for the unit to see through the given location or terrain.
		+
		+	=== Action Functions ===
		+
		+	These are special functions that represent an action to be executed. They don't actually execute the action, merely describe it – the action will be executed only after the formula has been fully evaluated.
		+
		+	Action functions can currently only be used in GUI2, in the '''actions''' key. This key must always evaluate to either an action or a list of actions.
		+
		+	==== set_var ====
		+
		+	* set_var(''name'', ''value'')
		+
		+	Sets a variable in the current '''self''' context to the specified value.
		+
		+	The result of this function is an object that has '''name''' and '''value''' keys with the passed-in values.
		+
		+	* safe_call(''main'', ''backup'')
		+
		+	Tries to execute the ''main'' action first. If that fails, the ''backup'' action is executed instead.
		+
		+	The ''backup'' formula can access a special '''error''' object, which in turn contains two values:
		+
		+	* '''status''': A status code representing the type of error. Currently, the only possible status is 5001, which means the current context is immutable.
		+	* '''object''': The action that failed to execute – in other words, the result of evaluating the ''main'' formula.
		+
		+	The result of this function is an object that has a '''main''' key that contains the result of evaluating the main formula.

← Older revision		Revision as of 19:48, 7 January 2026
Line 120:		Line 120:

	Note that the selection indexing that lists use is ''not'' valid for maps - a list can be used as a key, after all.		Note that the selection indexing that lists use is ''not'' valid for maps - a list can be used as a key, after all.
		+
		+	Though it's rarely needed, it's possible to define an empty map with <code>[ -> ]</code>

	=== Objects ===		=== Objects ===

@@ Line 283: / Line 283: @@
 The matching <code>wflend</code> is required.
-'''Note:''' This functionality was available prior to 1.13.5 using keywords <code>fai</code> and <code>faiend</code>. {{DevFeature1.19|14}} Support for the <code>fai</code> and <code>faiend</code> keywords has been removed.
+'''Note:''' This functionality was available prior to 1.13.5 using keywords <code>fai</code> and <code>faiend</code>. {{DevFeature1.19|14}} As of 1.19.14, support for the <code>fai</code> and <code>faiend</code> keywords has been removed.
 These directives have no effect on the formula code itself. They only change how error messages are reported if something goes wrong. Files using these directives are usually included using the WML preprocessor, though they could also be loaded in Lua with [[LuaAPI/filesystem#filesystem.read_file|filesystem.read_file]].

@@ Line 283: / Line 283: @@
 The matching <code>wflend</code> is required.
-'''Note:''' This functionality was available prior to 1.13.5 using keywords <code>fai</code> and <code>faiend</code>. These keywords are now deprecated, but still work.
+'''Note:''' This functionality was available prior to 1.13.5 using keywords <code>fai</code> and <code>faiend</code>. {{DevFeature1.19|14}} Support for the <code>fai</code> and <code>faiend</code> keywords has been removed.
 These directives have no effect on the formula code itself. They only change how error messages are reported if something goes wrong. Files using these directives are usually included using the WML preprocessor, though they could also be loaded in Lua with [[LuaAPI/filesystem#filesystem.read_file|filesystem.read_file]].

@@ Line 1,220: / Line 1,220: @@
 Calculates the jamming cost for the unit to block vision on the given location terrain.
 ==== movement_cost ====
@@ Line 1,246: / Line 1,262: @@
 Returns the unit on the given location, or null if there is no unit there.
 ==== vision_cost ====

@@ Line 1,017: / Line 1,017: @@
 * nearest_loc(''origin'', ''locations'')
-Returns the closest location in the given list closest to ''origin'' All arguments must be location objects such as those created by <code>loc()</code>.
+Returns the location in the given list closest to ''origin''. All arguments must be location objects such as those created by <code>loc()</code>.
 '''Note:''' This function was already available in FormulaAI prior to 1.19.14; however, from 1.19.14 onward it is available to all formulas.

@@ Line 995: / Line 995: @@
 '''Note:''' This function was already available in FormulaAI prior to 1.13.5; however, from 1.13.5 onward it is available to all formulas.
 ==== loc ====
@@ Line 1,020: / Line 1,018: @@
 Returns the closest location in the given list closest to ''origin'' All arguments must be location objects such as those created by <code>loc()</code>.
 ==== relative_dir ====

← Older revision		Revision as of 09:58, 18 July 2025
Line 995:		Line 995:

	'''Note:''' This function was already available in FormulaAI prior to 1.13.5; however, from 1.13.5 onward it is available to all formulas.		'''Note:''' This function was already available in FormulaAI prior to 1.13.5; however, from 1.13.5 onward it is available to all formulas.
		+
		+	==== nearest_loc ====
		+
		+	{{DevFeature1.19\|14}}
		+
		+	* nearest_loc(''origin'', ''locations'')
		+
		+	Returns the closest location in the given list closest to ''origin'' All arguments must be location objects such as those created by <code>loc()</code>.
		+
		+	'''Note:''' This function was already available in FormulaAI prior to 1.19.14; however, from 1.19.14 onward it is available to all formulas.

	==== loc ====		==== loc ====