Luaapi/wml - Revision history

Laela at 21:09, 20 March 2026

2026-03-20T21:09:25Z

2025-08-31T18:02:02Z

‎wml.matches_filter: Linkify

2024-08-22T05:26:33Z

‎wml.load: Add a bit more information on schemas

2024-06-17T13:22:24Z

‎wml.merge: add missing bracket

2024-04-18T17:56:18Z

2024-04-12T07:16:14Z

‎wml.eval_conditional

2023-12-25T18:44:32Z

Undo revision 71940 by Vasya (talk)

2023-12-25T16:49:09Z

Add a migration note from set_wml_tag_metatable to wml.tag

2023-07-23T02:04:54Z

‎wml.fire: Correct dev-tag positioning

2023-07-21T13:14:25Z

‎wml.fire

← Older revision		Revision as of 21:09, 20 March 2026
Line 115:		Line 115:

	Tests whether the passed table represents a valid WML table. It will also return true if passed a vconfig.		Tests whether the passed table represents a valid WML table. It will also return true if passed a vconfig.
		+
		+	=== wml.valid_var ===
		+
		+	{{DevFeature1.19\|19}}
		+
		+	* '''wml.valid_var'''(''string'') → ''true or false''
		+
		+	Returns true if input looks like WML variable path for [set_variables].

	=== wml.matches_filter ===		=== wml.matches_filter ===

@@ Line 120: / Line 120: @@
 * '''wml.matches_filter'''(''WML table'', ''filter'')''' &rarr; ''boolean''
-Test if a config matches a WML filter (as <tt>[filter_wml]</tt>).
+Test if a config matches a WML filter (as [[FilterWML#Filtering_on_WML_data|<tt>[filter_wml]</tt>]]).
 === wml.load ===

@@ Line 128: / Line 128: @@
 * '''wml.load'''(''file'', [''defines'', [''schema'']]) &rarr; ''config''
-Loads WML from a file and optionally validates it against a schema. The file and schema (if present) must both be a valid WML path. The second parameter can either be a boolean specifying whether or not to preprocess the file (defaults to true), or an array of macros to be defined in the preprocessor (which of course implies the file will be preprocessed). The second form only allows specifying names to be defined. It does not allow setting a value or anything more complex.
+Loads WML from a file and optionally validates it against a schema. The file and schema (if present) must both be a valid WML path, and the schema must point to a [[SchemaWML]] file. All built-in schema files can be found directly in the "schema" folder – for example, "schema/game_config.cfg" is the schema for an add-on's (and core's) _main.cfg.
 === wml.parse ===

@@ Line 142: / Line 142: @@
 {{DevFeature1.15|3}}
-* '''wml.merge'''(''base table'', ''merge data'', ''mode'']) &rarr; ''merged config''
+* '''wml.merge'''(''base table'', ''merge data'', [''mode'']) &rarr; ''merged config''
 Merges two WML tables recursively, using the specified mode. Possible modes are '''merge''', '''replace''', and '''append'''. The modes work the same as in [[InternalActionsWML#.5Bset_variables.5D|[set_variables]]]. The mode only affects how child tags are merged; merging of attributes is always done the same way. The default mode is '''merge'''.

← Older revision		Revision as of 17:56, 18 April 2024
Line 4:		Line 4:

	A WML table is a specially-formatted Lua table representing WML tags and values. For more detail on the format of WML tables, see [[LuaWML#Encoding_WML_objects_into_Lua_tables\|LuaWML]].		A WML table is a specially-formatted Lua table representing WML tags and values. For more detail on the format of WML tables, see [[LuaWML#Encoding_WML_objects_into_Lua_tables\|LuaWML]].
		+
		+	== Functions ==

	=== wml.attribute_count ===		=== wml.attribute_count ===

@@ Line 357: / Line 357: @@
 <syntaxhighlight lang=lua>
 local result = wml.eval_conditional {
-   wml.have_unit { id = "hero" },
+   wml.tag.have_unit { id = "hero" },
-   wml.variable { name = "counter", numerical_equals = "$old_counter" }
+   wml.tag.variable { name = "counter", numerical_equals = "$old_counter" }
+}
 </syntaxhighlight>

@@ Line 89: / Line 89: @@
 wesnoth.wml_actions.event { name = "new turn", wml.tag.message { speaker = "narrator", message = "?" } }
 </syntaxhighlight>
 === wml.clone ===

@@ Line 367: / Line 367: @@
 * {{LuaGameOnly}} '''wml.fire'''(''tag'', ''parameters'')
-* {{LuaGameOnly}} '''wml.fire'''.''tag''(''parameters'') {{DevFeature1.17|17}}
+* {{DevFeature1.17|17}} {{LuaGameOnly}} '''wml.fire'''.''tag''(''parameters'')
 Fire a WML action tag. Note: WML variables are substituted into the parameters table.