Testing WML actions more often without reloading cache

[Ravana]

WML development feedback loop is quite slow - you need to use F5, build new cache, start scenario again. When only looking to test one specific event or tag there is faster way.

Many WML tags are implemented in Lua now, and because of that Lua has all the tools needed to read and run WML. Note that macros or in general preprocessing of any kind is not supported with this way.

To make use of it create cfg file somewhere in your addon files. Fill it with for example

Code: Select all

[message]
	message="message loaded during runtime"
[/message]

Then enable debug with :debug and either in Lua console run wesnoth.require("wml-utils").handle_event_commands(wml.load("~add-ons/EventLoader/action.cfg")) or run it as :lua wesnoth.require("wml-utils").handle_event_commands(wml.load("~add-ons/EventLoader/action.cfg")) after updating path to refer to your file. You can also set it as alias: :alias e=lua wesnoth.require("wml-utils").handle_event_commands(wml.load("~add-ons/EventLoader/event.cfg")) to then run it as :e

You can also test events. When testing event it is useful to remove previous version of event before loading new version.

Code: Select all

[remove_event]
	id=Rav_EventLoader_Event_1
[/remove_event]
[event]
	name=side_turn
	first_time_only=no
	# id is needed to not load multiple versions of event at once and to be able to remove it
	id=Rav_EventLoader_Event_1
	[lua]
		code=<<
wesnoth.message("event 2 loaded")
>>
	[/lua]
[/event]

I hope you find this design useful.
Tags: hotpatching, wml injection, eventloader

[lea]

... ... ...
Many WML tags are implemented in Lua now, and because of that Lua has all the tools needed to read and run WML.
... ... ...

is it limited to WML tags which are already (re/)implemented in lua?

if so then will it ignore tags which are not implemented in lua? will these tags cause runtime error when running in this way or some other visible result?

also in which version of Wesnoth this was added?

[Ravana]

This post was created with 1.16.0. It might work with earlier. I expect all ActionWML tags work. It does not matter if they are implemented in Lua or not.

But for example you cant load full [scenario] with this way.

[Celtic_Minstrel]

is it limited to WML tags which are already (re/)implemented in lua?

No. It's limited to ActionWML tags, but it doesn't matter whether they are implemented in Lua.

if so then will it ignore tags which are not implemented in lua?

No.

will these tags cause runtime error when running in this way or some other visible result?

No, they'll function normally.

[Ravana]

It might be useful to wrap wml.load in wml.tovconfig if there is interest to use $ variables.

:alias e=lua wesnoth.require("wml-utils").handle_event_commands(wml.tovconfig(wml.load("~add-ons/EventLoader/event.cfg")))