LuaAPI/wesnoth/sync - Revision history

Laela at 17:53, 18 April 2024

2024-04-18T17:53:27Z

Celtic Minstrel: Missing period

2023-03-23T17:46:03Z

Missing period

Celtic Minstrel: Delete underscores in link

2023-03-23T17:45:52Z

Delete underscores in link

Gfgtdf at 04:59, 23 March 2023

2023-03-23T04:59:11Z

Octalot: Note about only calling from a synced event

2021-07-07T02:49:44Z

Note about only calling from a synced event

Octalot: It's not only multiplayer

2021-07-05T13:00:49Z

It's not only multiplayer

Celtic Minstrel: Add context specifiers to each entry

2021-07-04T23:37:39Z

Add context specifiers to each entry

Celtic Minstrel: Document wesnoth.sync.invoke_command

2021-07-01T06:12:24Z

Document wesnoth.sync.invoke_command

Celtic Minstrel: /* wesnoth.sync.evaluate_multiple */ Fix the inline code highlighting

2021-06-30T02:31:34Z

‎wesnoth.sync.evaluate_multiple: Fix the inline code highlighting

Celtic Minstrel: Categorize

2021-06-30T02:30:19Z

Categorize

← Older revision		Revision as of 17:53, 18 April 2024
Line 3:		Line 3:

	For more information about multiplayer and replay safety see also [[OOS (Out of Sync)]].		For more information about multiplayer and replay safety see also [[OOS (Out of Sync)]].
		+
		+	== Functions ==

	=== wesnoth.sync.evaluate_single ===		=== wesnoth.sync.evaluate_single ===

@@ Line 2: / Line 2: @@
 The <tt>wesnoth.sync</tt> module contains functions to synchronize data between players. This isn't only for multiplayer - single-player replays will break unless choices are synchronized between the player and the viewer.
-For more information about multiplayer and replay safety see also [[OOS (Out of Sync)]]
+For more information about multiplayer and replay safety see also [[OOS (Out of Sync)]].
 === wesnoth.sync.evaluate_single ===

@@ Line 2: / Line 2: @@
 The <tt>wesnoth.sync</tt> module contains functions to synchronize data between players. This isn't only for multiplayer - single-player replays will break unless choices are synchronized between the player and the viewer.
-For more information about multiplayer and replay safety see also [[OOS_(Out_of_Sync)]]
+For more information about multiplayer and replay safety see also [[OOS (Out of Sync)]]
 === wesnoth.sync.evaluate_single ===

← Older revision		Revision as of 04:59, 23 March 2023
Line 1:		Line 1:

	The <tt>wesnoth.sync</tt> module contains functions to synchronize data between players. This isn't only for multiplayer - single-player replays will break unless choices are synchronized between the player and the viewer.		The <tt>wesnoth.sync</tt> module contains functions to synchronize data between players. This isn't only for multiplayer - single-player replays will break unless choices are synchronized between the player and the viewer.
		+
		+	For more information about multiplayer and replay safety see also [[OOS_(Out_of_Sync)]]

	=== wesnoth.sync.evaluate_single ===		=== wesnoth.sync.evaluate_single ===

@@ Line 28: / Line 28: @@
 '''Note:''' The return value must be a valid WML table - the same kind of thing you could store to a WML variable, and not, for instance, a proxy unit, anything else that uses metatables, or a lua table with another table as the value of a string attribute. Unlike other lua functions, '''wesnoth.sync.evaluate_single''' will ''not'' throw an error if the table is invalid, but will silently strip out the contents of any invalid subtag.
 When wesnoth is running in debug mode (e.g. --debug flag on command line) '''evaluate_single''' will chat a "Lua Warning" if it finds that the table returned was partially invalid.
@@ Line 44: / Line 46: @@
 *  An optional function for evaluating the choice in case this side was null controlled. If this function is called, it is called on all clients (unlike the first passed function) defaults to a function returning an empty table.
 *  An array of integers specifying on which sides this function should be evaluated. The function is evaluated on all passed sides, and each side may only appear once in this array. All specified sides execute the function simultaneously.
 This function returns a table with integer as keys and WML tables as values. The keys are the sides where that action was evaluated, and the values are the values computed by the passed function on each side.

← Older revision		Revision as of 13:00, 5 July 2021
Line 1:		Line 1:

−	The <tt>wesnoth.sync</tt> module contains functions to synchronize data ~~in a~~ multiplayer ~~scenario~~.	+	The <tt>wesnoth.sync</tt> module contains functions to synchronize data between players. This isn't only for multiplayer - single-player replays will break unless choices are synchronized between the player and the viewer.

	=== wesnoth.sync.evaluate_single ===		=== wesnoth.sync.evaluate_single ===

@@ Line 4: / Line 4: @@
 === wesnoth.sync.evaluate_single ===
-* '''wesnoth.sync.evaluate_single'''([''description''], ''function'', [''ai_function''], [''for_side'']) &rarr; ''result''
+* {{LuaGameOnly}} '''wesnoth.sync.evaluate_single'''([''description''], ''function'', [''ai_function''], [''for_side'']) &rarr; ''result''
 Recovers a WML table that was computed on one client only or was stored in a replay. The actual computation is performed by the function passed as the first function argument, assuming that the client is the side currently playing. For all the other clients, the function will not be called. An optional second function can be passed; if present, it will be used instead of the first one when the client happens to be an AI (hence not enable to interact with a user interface).
@@ Line 37: / Line 37: @@
 === wesnoth.sync.evaluate_multiple ===
-* '''wesnoth.sync.evaluate_multiple'''([''description''], ''function'', [''default_function''], [''for_sides'']) &rarr; ''result map''
+* {{LuaGameOnly}} '''wesnoth.sync.evaluate_multiple'''([''description''], ''function'', [''default_function''], [''for_sides'']) &rarr; ''result map''
 Similar to the singular form above, this function takes a function parameter and evaluates it on the specified sides. It takes the following arguments:
@@ Line 61: / Line 61: @@
 === wesnoth.sync.run_unsynced ===
-* '''wesnoth.sync.run_unsynced'''(''func'')
+* {{LuaGameOnly}} '''wesnoth.sync.run_unsynced'''(''func'')
 Calls the given function in a unsynced context. In particular, while executing that function, random results will not be synced in mp. The function is called with no arguments, and any return values are ignored.
@@ Line 67: / Line 67: @@
 === wesnoth.sync.invoke_command ===
-* '''wesnoth.sync.invoke_command'''(''command_name'', ''cfg'')
+* {{LuaGameOnly}} '''wesnoth.sync.invoke_command'''(''command_name'', ''cfg'')
 Invoke a custom synced command, which is registered in the [[LuaAPI/wesnoth#wesnoth.custom_synced_commands|wesnoth.custom_synced_commands]] table. You can pass an arbitrary WML table as arguments.
 [[Category:Lua Reference]]

← Older revision		Revision as of 06:12, 1 July 2021
Line 64:		Line 64:

	Calls the given function in a unsynced context. In particular, while executing that function, random results will not be synced in mp. The function is called with no arguments, and any return values are ignored.		Calls the given function in a unsynced context. In particular, while executing that function, random results will not be synced in mp. The function is called with no arguments, and any return values are ignored.
		+
		+	=== wesnoth.sync.invoke_command ===
		+
		+	* '''wesnoth.sync.invoke_command'''(''command_name'', ''cfg'')
		+
		+	Invoke a custom synced command, which is registered in the [[LuaAPI/wesnoth#wesnoth.custom_synced_commands\|wesnoth.custom_synced_commands]] table. You can pass an arbitrary WML table as arguments.

	[[Category:Lua Reference]]		[[Category:Lua Reference]]

@@ Line 41: / Line 41: @@
 Similar to the singular form above, this function takes a function parameter and evaluates it on the specified sides. It takes the following arguments:
 *  An optional translatable string describing the type of the user input. This is displayed to the other clients while the specified clients execute the passed function. Defaults to "input"
-*  A function that evaluates the choice, returning a WML table. Unlike above, this function is called for AI and human sides (use if <syntaxhighlight lange=lua inline>controller == "ai"</syntaxhighlight> for checking if it is an AI side)
+*  A function that evaluates the choice, returning a WML table. Unlike above, this function is called for AI and human sides (use if <syntaxhighlight lang=lua inline>controller == "ai"</syntaxhighlight> for checking if it is an AI side)
 *  An optional function for evaluating the choice in case this side was null controlled. If this function is called, it is called on all clients (unlike the first passed function) defaults to a function returning an empty table.
 *  An array of integers specifying on which sides this function should be evaluated. The function is evaluated on all passed sides, and each side may only appear once in this array. All specified sides execute the function simultaneously.

← Older revision		Revision as of 02:30, 30 June 2021
Line 64:		Line 64:

	Calls the given function in a unsynced context. In particular, while executing that function, random results will not be synced in mp. The function is called with no arguments, and any return values are ignored.		Calls the given function in a unsynced context. In particular, while executing that function, random results will not be synced in mp. The function is called with no arguments, and any return values are ignored.
		+
		+	[[Category:Lua Reference]]