Difference between revisions of "LuaWML"

Revision as of 03:15, 19 November 2019

The [lua] tag

This tag is a part of ActionWML, thus can be used inside [event] and at other places where ActionWML can be used. It makes it possible to write actions with the Lua 5.3 language.

It is also possible to put this tag inside a [scenario] ScenarioWML, those tags will be executed immediately when the lua engine loads which is even before the scenario preload event is fired.

[lua] is now also allowed in [era], [modification] and [resource], those [lua] tags are then copied into the [scenario]/[multiplayer] when it is played just like [event]s inside [era] or [modification]

The tag supports only the code key, which is a string containing the Lua scripts. Since Lua makes usage of the quotes and the { and } symbols, it is certainly wise to enclose the script between stronger quotes, as they prevent the preprocessor from performing macro expansion and tokenization.

 [lua]
     code = << wesnoth.message "Hello World!" >>
 [/lua]

The Lua kernel can also be accessed from the command mode:

:lua local u = wesnoth.get_units({ id = "Konrad" })[1]; u.moves = 5

The [args] sub-tag can be used to pass a WML object to the script via its variadic local variable "...".

 [lua]
     code = << local t = ...; wesnoth.message(tostring(t.text)) >>
     [args]
         text = _ "Hello world!"
     [/args]
 [/lua]

Global environment

All the Lua scripts of a scenario share the same global environment (aka Lua state). Unlike other parts of the configurable gamestate the Lua state is not stored in savefiles, thus [lua] tags in [scenario] are executed not only before the scenario starts but also each time the game is loaded. Funtions defined in [lua] tags in [scenario] can be used in all [lua] tags in [event]s.

 [scenario]
     [lua]
         code = <<
             function narrator(t)
                 -- Behave like the [message] tag.
                 wesnoth.fire("message",
                   { speaker = "narrator", message = t.sentence })
             end
         >>
     [/lua]
     [event]
         name = turn 1
         [lua]
             code = << narrator(...) >>
             [args]
                 sentence = _ "Hello world!"
             [/args]
         [/lua]
         [lua]
             code = << narrator(...) >>
             [args]
                 sentence = _ "How are you today?"
             [/args]
         [/lua]
     [/event]
     ...
 [/scenario]

In the example above, the redundant structure could be hidden behind macros. But it may be better to simply define a new WML tag.

 [scenario]
     [lua]
         code = <<
             -- The function is now placed in the wesnoth.wml_actions table
             -- The tag is [narrator], same as the function name
             function wesnoth.wml_actions.narrator(t)
                 -- Behave like the [message] tag.
                 wesnoth.fire("message",
                   { speaker = "narrator", message = t.sentence })
             end
         >>
     [/lua]
 
     [event]
         name = turn 1
         [narrator]
             sentence = _ "Hello world!"
         [/narrator]
         [narrator]
             sentence = _ "How are you today?"
         [/narrator]
     [/event]
 [/scenario]

The global environment is not preserved over save/load cycles. Therefore, storing values in the global environment is generally a bad idea. The only time assigning global variables (including function definitions) makes sense is in a [lua] block directly in [scenario] or during a preload event, as this event is always run. Therefore, helper functions defined at that time will be available to all the later scripts.

The global environment initially contains the following modules: basic (no name), string, table, and math. A wesnoth module is also available, it provides access to the C++ engine. Additionally, the functions clock, date, time and difftime from the os library (keep in mind that they aren't multiplayer- and replay-safe), as well as traceback from the debug library are also available.

At the start of a script, the variadic local variable ... (three dots) is a proxy table representing WML data. This table is the content of the [args] sub-tag of the [lua] tag, if any.

Examples

The following WML event is taken from Wesnoth' tutorial. It will serve as an example to present how Lua scripts are embedded into Wesnoth. The event is fired whenever a unit from side 1 (that is, the hero controlled by the user) moves to a tile that is not the one set in the WML variable target_hex.

 # General catch for them moving to the wrong place.
 [event]
     name=moveto
     first_time_only=no
     [allow_undo][/allow_undo]
     [filter]
         side=1
     [/filter]
 
     [if]
         [variable]
             name=target_hex.is_set
             equals=yes
         [/variable]
         [then]
             [if]
                 [variable]
                     name=x1
                     equals=$target_hex.x
                 [/variable]
                 [variable]
                     name=y1
                     equals=$target_hex.y
                 [/variable]
                 [then]
                 [/then]
                 [else]
                     [redraw][/redraw]
                     [message]
                         speaker=narrator
                         message=_ "*Oops!
 You moved to the wrong place! After this message, you can press 'u' to undo, then try again." +
                         _ "
 *Left click or press spacebar to continue..."
                     [/message]
                 [/else]
             [/if]
         [/then]
     [/if]
 [/event]

A Lua script that performs the same action is presented below.

 [event]
     name=moveto
     first_time_only=no
     [allow_undo][/allow_undo]
     [filter]
         side=1
     [/filter]
 
     [lua]
         code = <<

             local event_data = wesnoth.current.event_context
             if wml.variables["target_hex.is_set"] and
                (event_data.x1 ~= wml.variables["target_hex.x"] or event_data.y1 ~= wml.variables["target_hex.y"])
             then
                 W.redraw()
                 narrator_says(_ "*Oops!\nYou moved to the wrong place! After this message, you can press 'u' to undo, then try again.")
             end
         >>
     [/lua]
 [/event]

Here is a more detailed explanation of the Lua code. Its first line

local event_data = wesnoth.current.event_context

puts the event data into the event_data local variable. Since it is a moveto event, the event_data table contains the destination of the unit in the x1 and y1 fields.

The next two lines then test

if wml.variables["target_hex.is_set"] and
    (event_data.x1 ~= wml.variables["target_hex.x"] or event_data.y1 ~= wml.variables["target_hex.y"])

whether the variable wml.variables["target_hex"] matches the event parameters. Since wml.variables is not a local variable, it is taken from the global environment. Usually, variables from the global environment are not persistent but the wesnoth engine maps the variable wml.variables to the storage of WML variables.

Without using wml.variables, the conditional would have been written

if wesnoth.get_variable("target_hex.is_set") and
    (event_data.x1 ~= wesnoth.get_variable("target_hex.x") or event_data.y1 ~= wesnoth.get_variable("target_hex.y")

The body of the conditional then performs the [redraw] action.

W.redraw()

This short syntax is made possible by a line of the prelude that makes W a proxy for performing WML actions.

 [scenario]
     [lua]
         code = <<
             H = wesnoth.require "lua/helper.lua"
             W = H.set_wml_action_metatable {}
         >>
     [/lua]
     ...
 [/scenario]

Without this shortcut, the first statement would have been written

wesnoth.fire("redraw")

or

wesnoth.wml_actions.redraw {}

Finally the script displays a message by

narrator_says(_ "*Oops!\nYou moved to the wrong place! After this message, you can press 'u' to undo, then try again.")

The narrator_says function is defined in the prelude too, since the construct behind it occurs several times in the tutorial. In plain WML, macros would have been used instead. The definition of the function is

function narrator_says(m)
    W.message { speaker="narrator",
                message = m .. _ "\n*Left click or press spacebar to continue..." }
end

The function fires a [message] action and passes a WML object containing the usual two fields to it. The second field is initialized by concatenating the function argument with another string. Both strings are prefixed by the _ symbol to mark them as translatable. (Note that _ is just a unary function, not a keyword.) Again, this is made possible by a specific line of the prelude:

_ = wesnoth.textdomain "wesnoth-tutorial"

A longer translation of the tutorial is available at [1].

Interface to the engine and helper functions

This section is in the process of being moved. The information here remains accurate as of 1.14.0, but for 1.15.0 and later, LuaAPI is planned to be the definitive source.

Functionalities of the game engine are available through the functions contained in the wesnoth global table. Some of these functions return proxy tables. Writes to fields marked "read-only" are ignored. The __cfg fields return plain tables; in particular, writes do not modify the original object, and reads return the values from the time the dump was performed.

Some helper functions are provided by the lua/helper.lua library. They are stored inside a table that is returned when loading the library with wesnoth.require.

helper = wesnoth.require "lua/helper.lua"

WML variables

Events and WML actions

User interface

Map and terrains

Time of day schedule

Units

Sides

Pathfinder

Lua files

Location sets

Miscellaneous

Functions that should not be used

If you take a look at Wesnoth's own lua files, you might find some undocumented functions use in the implementations of WML tags. Where possible, you should avoid using them, as they might be changed or removed with no compatibility for further releases. Instead, use the corresponding wml tags (in lua you can use wesnoth.wml_actions.tag_name(cfg), though keep in mind that this won't substitute variables in the config).

If uncertain whether an undocumented feature is safe to use, ask on the forums, Discord, or IRC. It may turn out that someone simply forgot to add it to the wiki.

wesnoth.redraw
wesnoth.set_menu_item
wesnoth.clear_menu_item
wesnoth.modify_ai
wesnoth.print
wesnoth.end_level

Encoding WML objects into Lua tables

Function wesnoth.fire expects a table representing a WML object as its second argument (if needed). Function wesnoth.set_variable allows to modify whole WML objects, again by passing it a table. Function wesnoth.get_variable transforms a WML object into a table, if its second argument is not set to true. All these tables have the same format.

Scalar fields are transformed into WML attributes. For instance, the following Lua table

{
    a_bool = true,
    an_int = 42,
    a_float = 1.25,
    a_string = "scout",
    a_translation = _ "Hello World!"
}

is equivalent to the content of the following WML object

[dummy]
    a_bool = "yes"
    an_int = 42
    a_float = 1.25
    a_string = "scout"
    a_translation = _ "Hello World!"
[/dummy]

WML child objects are not stored as Lua named fields, since several of them can have the same tag. Moreover, their tags can conflict with the attribute keys. So child objects are stored as pairs string + table in the unnamed fields in definition order. This means that for every subtag appearing in the wml code there is an additional table "layer" in the corresponding WML table of the form {[1] = "tag_name", [2] = {}} which is equivalent to {"tag_name", {}}. [1] etc are the unnamed fields (as opposed to wml attributes). The table under [2] in this subtable then holds the wml attributes from inside the wml subtag. So every subtag other than the toplevel tag corresponds to two nested tables each. For instance, the following Lua table

{
    foo = 42,
    { "bar", { v = 1, w = 2 } },
    { "foo", { x = false } },
    { "bar", { y = "foo" } },
    { "foobar", { z = 5, { "barfoo", {} } } }
}

is equivalent to the content of the following WML object

[dummy]
    foo = 42
    [bar]
        v = 1
        w = 2
    [/bar]
    [foo]
        x = no
    [/foo]
    [bar]
        y = foo
    [bar]
    [foobar]
        z = 5
        [barfoo]
        [/barfoo]
    [/foobar]
[/dummy]

Both tables above are also equivalent to this WML table, where all unnamed fields are displayed:

{
    foo = 42,
    [1] = { [1] = "bar", [2] = { v = 1, w = 2 } },
    [2] = { [1] = "foo", [2] = { x = false } },
    [3] = { [1] = "bar", [2] = { y = "foo" } },
    [4] = { [1] = "foobar", [2] = { z = 5, [1] = { [1] = "barfoo", [2] = {} } } }
}

So assuming cfg contains the above WML object, the following accesses are possible:

a_int = cfg.foo        -- "dummy.foo", 42
a_string = cfg[3][2].y -- "dummy.bar[1].y", "foo"
a_table = cfg[4][2]    -- "dummy.foobar", { z = 5, { "barfoo", {} } }

For creating valid wml table in lua it is usully easier to use T = helper.set_wml_tag_metatable {} asuming you did that you can create the above wml document with

{
    foo = 42,
    T.bar {
         v = 1,
         w = 1,
    },
    T.foo {
        x = false,
    },
    T.bar {
         y = "foo",
    },
    T.foobar {
         z = 5,
         T.barfoo {
         },
    },
}

Consider using the wml.get_child and wml.child_range helper functions to ease the access to subtags.

(Version 1.13.5 and later only) As a convenience, attributes with array values (tables with only integer keys) are concatenated into a string when converting a Lua table into WML. For example, the following Lua code:

{
    x = {1, 2, 3, 4},
    y = {7, 8, 9, 10}
}

produces the following WML table:

[dummy]
    x=1,2,3,4
    y=7,8,9,10
[/dummy]

Functions registered in wesnoth.wml_actions and other similar tables that provide hooks that the engine calls will receive their data either in lua tables encoding a WML object or as a WML vconfig userdata, which has the same structure but is read-only. Accessing fields or children on a vconfig performs variable substitution on the fly. Its __parsed and __literal fields provide translations to plain, writable tables. __literal returns the original text of the data (including dollar symbols in attributes and [insert_tag] children), while __parsed performs a full variable substitution.

For instance, if you cannot stand any longer the fact that first_time_only is set to yes by default for the [event] tag, you can redefine it. But we have to be careful not to cause variable substitution, since the engine would perform a second variable substitution afterwards.

local old_event_handler = wesnoth.wml_actions.event
function wesnoth.wml_actions.event(cfg)
    -- Get the plain text from the user.
    local new_cfg = helper.literal(cfg)
    -- The expression below is equivalent to cfg.__parsed.first_time_only,
    -- only faster. It is needed, since the first_time_only attribute may
    -- reference variables.
    local first = cfg.first_time_only
    -- Modify the default behavior of first_time_only.
    if first == nil then first = false end
    new_cfg.first_time_only = first
    -- Call the engine handler.
    old_event_handler(new_cfg)
end

(Note: The above example will only affect nested events. Toplevel events will still default to first_time_only=yes.) (Note2: You should not do that since it will break other addons that rely on the first_time_only=no default value.)

pairs and ipairs also work on vconfig objects (contrary to the above statement). However, pairs works a little differently than on plain configs (tables) - it returns only string keys (attributes in WML terms) and not integer keys (tags in WML terms).

Another approach for handling userdata and tables in the same way, would be to convert the former into the latter beforehand. The wml.parsed and wml.literal helpers take care of this for you.

The vconfig userdata provides two other special fields: __shallow_parsed and __shallow_literal. They return a table corresponding to the WML userdata with variable substitution performed on the attributes (or not). [insert_tag] tags have also been parsed, so the number of children is faithful. But contrarily to __parsed and __literal, the process is not recursive: all the children are still WML userdata and variable substitution can still happen for them. These shallow translators are meant as optimized versions of the deep ones, when only the toplevel attributes need to be writable.

Skeleton of a lua tag

The following [lua] tag is a skeleton for a prelude enabling Lua in your WML events. It creates a table H containing the functions from helper.lua . It sets up a table T so be used for easier creation of valid WML tables. It also sets up a table V so that any access to it is redirected to the persistent WML storage. Finally, it loads a textdomain to be accessed through the _ variable.

[scenario]
    [lua]
        code = <<
            H = wesnoth.require "lua/helper.lua"
            T = wml.tag
            V = wml.variables
            local _ = wesnoth.textdomain "my-campaign"

            -- Define your global constants here.
            -- ...


            -- Define your global functions here.
            -- ...
        >>
    [/lua]
    ... 
[/scenario]

It may be worth putting the whole Lua script above inside a separate file and having the [lua] tag load it:

[scenario]
    [lua]
        code = << wesnoth.dofile "~add-ons/Whatever/file.lua" >>
    [/lua]
    ...
[/scenario]

Remarks on Random Numbers

The math.random function is not safe for replays and multiplayer games, since the random values will be different each time and on all the clients. Instead, the Lua code should use the wesnoth.random function to synchronize random values. It has the same interface as math.random but is multiplayer-safe.

Also available is helper.rand(), which takes the same argument in the same format as [set_variable] rand=.

 local random_variable = helper.rand("1,2,3")

Random Lua table iteration

Table iteration order (pairs) is not strictly defined in Lua. If your code depends on the order of iteration, different clients may have different data in a multiplayer game. For example:

  local table = { ["Mage"] = true, ["Wose"] = true }
  local concat = ""
  local bad_usage = next(table) -- wrong, leads to OOS
  for k, _ in pairs(table) do -- wrong, leads to OOS
    concat = concat .. k
  end

To avoid the problem, sort the table keys before iterating. Or alternatively, use Lua "arrays" and the ipairs function, which have a strictly defined order and never lead to OOS. Example of correct code:

  local array = { "Mage", "Wose" }
  local good_usage = table[1] -- correct
  local concat = ""
  for _, v in ipairs(array) do -- correct
    concat = concat .. v
  end

@@ Line 535: / Line 535: @@
 [dummy]
      a_bool = "yes"
-     an_int = "42"
+     an_int = 42
-     a_float = "1.25"
+     a_float = 1.25
      a_string = "scout"
      a_translation = _ "Hello World!"
@@ Line 619: / Line 619: @@
 </syntaxhighlight>
-Consider using the [[LuaWML:Variables#helper.get_child|helper.get_child]] and [[LuaWML:Variables#helper.child_range|helper.child_range]] to ease the access to subtags.
+Consider using the [[LuaAPI/wml#wml.get_child|wml.get_child]] and [[LuaAPI/wml#wml.child_range|wml.child_range]] helper functions to ease the access to subtags.
 {{DevFeature1.13|5}} As a convenience, attributes with array values (tables with only integer keys) are concatenated into a string when converting a Lua table into WML. For example, the following Lua code:
@@ Line 639: / Line 639: @@
 </syntaxhighlight>
-Functions registered in [[LuaWML:Events#wesnoth.wml_actions|wesnoth.wml_actions]] receive their data either in lua tables encoding wmloject or as a userdata object which has the exact same structure as above. Those userdata objects are called vconfig. vconfig objects are read-only however. Accessing fields or children on vconfig performs variable substitution on the fly. Its '''__parsed''' and '''__literal''' fields provide translations to plain tables (therefore writable). '''__literal''' returns the original text of the data (including dollar symbols in attributes and [insert_tag] children), while '''__parsed''' performs a variable substitution.
+Functions registered in [[LuaWML:Events#wesnoth.wml_actions|wesnoth.wml_actions]] and other similar tables that provide hooks that the engine calls will receive their data either in lua tables encoding a WML object or as a [[LuaAPI/wml#wml.tovconfig|WML vconfig userdata]], which has the same structure but is read-only. Accessing fields or children on a vconfig performs variable substitution on the fly. Its '''__parsed''' and '''__literal''' fields provide translations to plain, writable tables. '''__literal''' returns the original text of the data (including dollar symbols in attributes and '''[insert_tag]''' children), while '''__parsed''' performs a full variable substitution.
 For instance, if you cannot stand any longer the fact that '''first_time_only''' is set to yes by default for the '''[event]''' tag, you can redefine it. But we have to be careful not to cause variable substitution, since the engine would perform a second variable substitution afterwards.
@@ Line 664: / Line 664: @@
 <!-- This should probably be replaced with a better example. -->
-'''pairs''' and '''ipairs''' now work on vconfig objects (contrary to the above statement). However, '''pairs''' works a little differently than on plain configs (tables) - it returns only string keys (attributes in WML terms) and not integer keys (tags in WML terms).
+'''pairs''' and '''ipairs''' also work on vconfig objects (contrary to the above statement). However, '''pairs''' works a little differently than on plain configs (tables) - it returns only string keys (attributes in WML terms) and not integer keys (tags in WML terms).
-Another approach for handling userdata and tables in the same way, would be to convert the former into the latter beforehand:
+Another approach for handling userdata and tables in the same way, would be to convert the former into the latter beforehand. The [[LuaAPI/wml#wml.parsed|wml.parsed]] and [[LuaAPI/wml#wml.literal|wml.literal]] helpers take care of this for you.
-<syntaxhighlight lang=lua>
+The vconfig userdata provides two other special fields: '''__shallow_parsed''' and '''__shallow_literal'''. They return a table corresponding to the WML userdata with variable substitution performed on the attributes (or not). [insert_tag] tags have also been parsed, so the number of children is faithful. But contrarily to '''__parsed''' and '''__literal''', the process is not recursive: all the children are still WML userdata and variable substitution can still happen for them. These shallow translators are meant as optimized versions of the deep ones, when only the toplevel attributes need to be writable.
-if getmetatable(cfg) == "wml object" then cfg = cfg.__parsed end
-</syntaxhighlight>
-The WML userdata provides two other special fields: '''__shallow_parsed''' and '''__shallow_literal'''. They return a table corresponding to the WML userdata with variable substitution performed on the attributes (or not). [insert_tag] tags have also been parsed, so the number of children is faithful. But contrarily to '''__parsed''' and '''__literal''', the process is not recursive: all the children are still WML userdata and variable substitution can still happen for them. These shallow translators are meant as optimized versions of the deep ones, when only the toplevel attributes need to be writable.
 == Skeleton of a lua tag ==