LuaWML/Misc - Revision history

Soliton: /* wesnoth.format */

2021-05-07T10:01:43Z

‎wesnoth.format

2021-02-12T13:35:25Z

Add move notice

2020-02-19T21:41:24Z

typo

2019-01-02T00:33:03Z

‎helper.set_wml_tag_metatable: this is deprecated. Replaced with wml.tag

2018-12-16T19:26:57Z

typo

2018-11-11T04:20:35Z

‎wesnoth.game_config: added wesnoth.game_config.combat_experience

2018-08-02T18:38:46Z

‎helper.rand

2018-08-02T18:33:36Z

‎wesnoth.random

2018-03-18T05:36:53Z

Fix function name

2018-03-18T05:34:06Z

Document the text formatting functions

@@ Line 264: / Line 264: @@
 * '''wesnoth.format(''format_string'', ''values'')'''
-Similar to '''string.format''' but using Wesnoth's variable substitution syntax, and also supporting translatable strings. Any valid config can be passed as the values, though typically you will only need key-value pairs. You could also substitute WML variables into a string by passing '''wesnoth.get_all_vars()''' as the second parameter.
+Similar to '''string.format''' but using Wesnoth's variable substitution syntax, and also supporting translatable strings. Any valid WML table can be passed as the values, though typically you will only need key-value pairs. You could also substitute WML variables into a string by passing '''wesnoth.get_all_vars()''' as the second parameter.
 This function preserves the translatability of the input format string.

← Older revision		Revision as of 13:35, 12 February 2021
Line 1:		Line 1:
		+	{{LuaMove}}
		+
	This page describes miscellaneous [[LuaWML]] objects and helpers.		This page describes miscellaneous [[LuaWML]] objects and helpers.

@@ Line 81: / Line 81: @@
 * '''side''': integer (read only)
 * '''turn''': integer (read only)
-* '''event_context''': WML table with attributes ''name'', ''x1'', ''y1'', ''x2'', ''y2'', and children ''weapon'', ''second_weapon'', describing the trigger for the current event. {{DevFeature1.13|2}} ''unit_x'', ''unit_y'' contain the location of the primary unit involved in the event. Currently the only case where this cam be different from ''x1'' and ''y1'' are enter_hex and exit_hex events.
+* '''event_context''': WML table with attributes ''name'', ''x1'', ''y1'', ''x2'', ''y2'', and children ''weapon'', ''second_weapon'', describing the trigger for the current event. {{DevFeature1.13|2}} ''unit_x'', ''unit_y'' contain the location of the primary unit involved in the event. Currently the only case where this can be different from ''x1'' and ''y1'' are enter_hex and exit_hex events.
 * '''synced_state''' {{DevFeature1.13|0}} whether the current code runs in a synced contex, this returns a string, the possible values are:
 ** '''synced''' the current code runs on all mp clients, this is the normal context, in which all gamestatechaning actions should take place.

@@ Line 278: / Line 278: @@
 Formats a list of usually-translatable strings into a localized list string of the form "A, B, or C".
-==== helper.set_wml_tag_metatable ====
+==== wml.tag ====
-* '''helper.set_wml_tag_metatable{}'''
+* '''wml.tag.something'''
-Sets the metable of a table so that it can be used to create subtags with less brackets. Returns the table. The fields of the table are simple wrappers around table constructors.
+Can be used to create subtags with less brackets, for example:
+  W.event { name = "new turn", wml.tag.message { speaker = "narrator", message = "?" } }
 ==== helper.modify_unit ====

@@ Line 126: / Line 126: @@
 {{DevFeature1.13|2}}
 This function takes now takes these arguments:
-* An optional translatable string descibing the type of the user input. This is displayed to the other clients while one client executes the passeed function. Defaults to "input".
+* An optional translatable string describing the type of the user input. This is displayed to the other clients while one client executes the passed function. Defaults to "input".
 * A function: (as before).
 * An optional function: for ai sides (as before).

@@ Line 11: / Line 11: @@
 * '''rest_heal_amount''': integer (read/write)
 * '''recall_cost''': integer (read/write)
 * '''kill_experience''': integer (read/write)
 * '''last_turn''': integer (read/write) turn limit, maximum number of turns

@@ Line 312: / Line 312: @@
 create a random unit at (1, 1) on side=1 :
   wesnoth.put_unit(1, 1, { type = helper.rand("Dwarvish Fighter,Dwarvish Thunderer,Dwarvish Scout") })
 ==== helper.round ====

← Older revision		Revision as of 18:33, 2 August 2018
Line 223:		Line 223:

	In map generation scripts, the values returned by this function depend on the seed the map author has input (if any).		In map generation scripts, the values returned by this function depend on the seed the map author has input (if any).
		+
		+	Be careful as '''random''' is not safe in certain events, see [[EventWML#Multiplayer_safety\|Multiplayer_safety]].

	==== wesnoth.unsynced ====		==== wesnoth.unsynced ====

@@ Line 254: / Line 254: @@
 ** The max_length places a cap on the total length of the name. The default value is 12 characters.
 * '''Context-free grammar''': A [[context-free grammar]] is a way of specifying how strings can be constructed. The definition may be specified as a multi-line string, just as described in the preceding link, or it can be formatted as a table where the keys are non-terminals and the values are what they expand to. The expansion of each non-terminal can be formatted either as a |-separated list as described in the preceding link, or as an array-like table. (Mixing the two forms is permissible too.) The context-free generator has no additional parameters.
 ==== helper.set_wml_tag_metatable ====