LuaWML/Variables - Revision history

Celtic Minstrel: Add move notice

2021-02-12T13:26:08Z

Add move notice

Edward Chernenko: set_wml_tag_metatable is deprecated

2018-12-29T16:36:44Z

set_wml_tag_metatable is deprecated

Edward Chernenko: typo (missing ")

2018-12-12T21:55:33Z

typo (missing ")

Celtic Minstrel: Syntax highlighting, plus some spelling and grammar fixes

2018-03-18T05:48:15Z

Syntax highlighting, plus some spelling and grammar fixes

Show changes

Celtic Minstrel: Document wml_matches_filter

2018-03-18T05:41:51Z

Document wml_matches_filter

Celtic Minstrel: Fixup formatting

2017-05-14T03:08:02Z

Fixup formatting

Celtic Minstrel: Add new argument for set_variable_array and get_variable_array

2017-05-14T03:07:28Z

Add new argument for set_variable_array and get_variable_array

Pentarctagon: /* helper.set_variable_array */

2017-04-30T03:01:30Z

‎helper.set_variable_array

Vultraz: Vultraz moved page LuaWML:Variables to LuaWML/Variables

2016-03-11T03:40:25Z

Vultraz moved page LuaWML:Variables to LuaWML/Variables

Dorn: /* helper.get_nth_child */ fixed function syntax

2016-02-19T19:00:22Z

‎helper.get_nth_child: fixed function syntax

← Older revision		Revision as of 13:26, 12 February 2021
Line 1:		Line 1:
		+	{{Template:LuaMove}}
		+
	This page describes the [[LuaWML]] functions and helpers for handling WML variables and containers.		This page describes the [[LuaWML]] functions and helpers for handling WML variables and containers.

← Older revision		Revision as of 16:36, 29 December 2018
Line 50:		Line 50:

	Test if a config matches a WML filter (as <tt>[filter_wml]</tt>).		Test if a config matches a WML filter (as <tt>[filter_wml]</tt>).
−
−	~~==== helper.set_wml_var_metatable ====~~
−
−	* '''helper.set_wml_var_metatable{}'''
−
−	Sets the metatable of a table so that it can be used to access WML variables. Returns the table. The fields of the tables are then proxies to the WML objects with the same names; reading/writing to them will directly access the WML variables.
−
−	~~<syntaxhighlight lang=lua>~~
−	~~helper.set_wml_var_metatable(_G)~~
−	~~my_persistent_variable = 42~~
−	~~</syntaxhighlight>~~
−
−	~~It's not recommended to use helper.set_wml_var_metatable(_G) because that limits possible global variables to valid wml attributes or tables. This can have some surprising effects:~~
−
−	~~<syntaxhighlight lang=lua>~~
−	~~c = { a= 9}~~
−	~~d = c~~
−	~~c.a = 8~~
−	~~wesnoth.message(d.a) -- normally prints 8 but prints 9 with helper.set_wml_var_metatable(_G)~~
−
−	~~local lla = { {"a", {}}}~~
−	~~lla[1][2] = lla~~
−	~~la = lla -- crashes wesnoth with helper.set_wml_var_metatable(_G)~~
−
−	~~helper = wesnoth.require("lua/helper.lua")~~
−	~~helper.set_wml_var_metatable(_G)~~
−	~~-- some code later (maybe in another addon)~~
−	~~H = wesnoth.require("lua/helper.lua") -- fails because wesnoth.require("lua/helper.lua") doesn' return a valid wmltable..~~
−
−	~~helper = wesnoth.require("lua/helper.lua")~~
−	~~helper.set_wml_var_metatable(_G)~~
−	~~-- some code later (maybe in another addon)~~
−	~~T = helper.set_wml_tag_metatable {} -- doesn't work~~
−	~~V = helper.set_wml_var_metatable({}) -- doesn't work~~
−	~~</syntaxhighlight>~~
−
−	Even if you don't use such code in your addon, it's still bad because other code of modifications or eras to be used with your addon might. And you'll mess up their code. This is also true for SP campaigns because it might interfere with ai code and we plan to enable modifications in SP too.
−	~~Instead you should use set_wml_var_metatable with another table ('V' in this example):~~
−
−	~~<syntaxhighlight lang=lua>~~
−	~~V = helper.set_wml_var_metatable({})~~
−	~~V.my_persistent_variable = 42~~
−	~~</syntaxhighlight>~~

	==== helper.get_child ====		==== helper.get_child ====

@@ Line 154: / Line 154: @@
 <syntaxhighlight lang=lua>
 function get_recall_list(side)
-     wesnoth.fire("store_unit", { x = "recall", variable = "LUA_recall_list })
+     wesnoth.fire("store_unit", { x = "recall", variable = "LUA_recall_list" })
      local l = get_variable_array "LUA_recall_list"
      wesnoth.set_variable "LUA_recall_list"

@@ Line 38: / Line 38: @@
       end
   end
 ==== helper.set_wml_var_metatable ====

@@ Line 127: / Line 127: @@
 * '''helper.get_variable_array(''var_name'')'''
-* {{DevFeature1.13|8} '''helper.get_variable_array(''var_name'' [, ''context''])'''
+* {{DevFeature1.13|8}} '''helper.get_variable_array(''var_name'' [, ''context''])'''
 Fetches all the WML container variables with given name and returns a table containing them (starting at index 1). The context specifies where to get variables from. You can pass either a unit or a side as the context in order to get an array from the unit variables or side variables, respectively.

@@ Line 149: / Line 149: @@
 Creates WML container variables with given name from given table.
-  helper.set_variable_array("target", { t1, t2, t3 })
+  helper.set_variable_array("target", { {t=t1}, {t=t2}, {t=t3} })
-  -- target[0] <- t1; target[1] <- t2; target[2] <- t3
+  -- target[0].t <- t1; target[1].t <- t2; target[2].t <- t3
 [[Category: Lua Reference]]

← Older revision	Revision as of 03:40, 11 March 2016
(No difference)

@@ Line 93: / Line 93: @@
 {{DevFeature1.13|2}}
-* '''helper.get_child(''config'', ''child_tag_name'', ''n'')'''
+* '''helper.get_nth_child(''config'', ''child_tag_name'', ''n'')'''
 Returns the ''n''th sub-tag of a WML object with the given name.