LuaWML/Display - Revision history

Pentarctagon at 16:24, 29 April 2024

2024-04-29T16:24:07Z

Celtic Minstrel: Formatting fix

2021-02-12T13:28:57Z

Formatting fix

Celtic Minstrel: Formatting fix

2021-02-12T13:28:33Z

Formatting fix

Celtic Minstrel: Add move notice

2021-02-12T13:28:01Z

Add move notice

Pentarctagon: /* wesnoth.show_dialog */

2021-01-22T07:29:58Z

‎wesnoth.show_dialog

Pentarctagon: /* wesnoth.show_dialog */

2021-01-22T07:16:42Z

‎wesnoth.show_dialog

Pentarctagon: /* wesnoth.show_dialog */

2021-01-22T07:13:32Z

‎wesnoth.show_dialog

Pentarctagon: /* wesnoth.show_dialog */

2021-01-22T07:11:10Z

‎wesnoth.show_dialog

Pentarctagon: /* wesnoth.show_dialog */

2021-01-22T07:10:36Z

‎wesnoth.show_dialog

Octalot: /* wesnoth.show_dialog */ issue 5334: synchronize even in single-player, otherwise the replay breaks

2020-12-03T16:45:47Z

‎wesnoth.show_dialog: issue 5334: synchronize even in single-player, otherwise the replay breaks

@@ Line 297: / Line 297: @@
 * if the dialog was closed with the escape key, -2.
-The dialog box is equivalent to the resolution section of a GUI window as described in [https://devdocs.wesnoth.org/GUIToolkitWML.html GUIToolkit] and must therefore contain at least the following children: '''[tooltip]''', '''[helptip]''', and '''[grid]'''. The [grid] must contain nested [row], [column] and [grid] tags which describe the layout of the window. (More information can be found in [https://devdocs.wesnoth.org/GUILayout.html Layout]; suffice to say that the basic structure is grid -> row -> column -> widget, where the widget is considered to be in a cell defined by the row and column of the grid. A list of widgets can be found at [https://devdocs.wesnoth.org/group__GUIWidgetWML.html Widgets].)
+The dialog box is equivalent to the resolution section of a GUI window as described in [[GUIToolkitWML]] and must therefore contain at least the following children: '''[tooltip]''', '''[helptip]''', and '''[grid]'''. The [grid] must contain nested [row], [column] and [grid] tags which describe the layout of the window. (More information can be found in [[GUILayout]]; suffice to say that the basic structure is grid -> row -> column -> widget, where the widget is considered to be in a cell defined by the row and column of the grid. A list of widgets can be found at [[GUIWidgetInstanceWML]] and [[GUIWidgetDefinitionWML]].)
 Two optional functions can be passed as second and third arguments; the first one is called once the dialog is created and before it is shown; the second one is called once the dialog is closed. These functions are helpful in setting the initial values of the fields and in recovering the final user values. These functions can call the [[#wesnoth.set_dialog_value]], [[#wesnoth.get_dialog_value]], and [[#wesnoth.set_dialog_callback]] functions for this purpose.

← Older revision		Revision as of 13:28, 12 February 2021
Line 1:		Line 1:
−	{{Template::LuaMove}}	+	{{Template:LuaMove}}

	<div class="tright"> __TOC__ </div>		<div class="tright"> __TOC__ </div>

← Older revision		Revision as of 13:28, 12 February 2021
Line 1:		Line 1:
		+	{{Template::LuaMove}}
		+
	<div class="tright"> __TOC__ </div>		<div class="tright"> __TOC__ </div>
−
−	~~{{Template:LuaMove}}~~

	This page describes the [[LuaWML]] functions and helpers for interfacing with the user.		This page describes the [[LuaWML]] functions and helpers for interfacing with the user.

← Older revision		Revision as of 13:28, 12 February 2021
Line 1:		Line 1:
	<div class="tright"> __TOC__ </div>		<div class="tright"> __TOC__ </div>
		+
		+	{{Template:LuaMove}}

	This page describes the [[LuaWML]] functions and helpers for interfacing with the user.		This page describes the [[LuaWML]] functions and helpers for interfacing with the user.

@@ Line 295: / Line 295: @@
 * if the dialog was closed with the escape key, -2.
-The dialog box is equivalent to the resolution section of a GUI window as described in [[GUIToolkitWML#Window_definition|GUIToolkitWML]] and must therefore contain at least the following children: '''[tooltip]''', '''[helptip]''', and '''[grid]'''. The [grid] must contain nested [row], [column] and [grid] tags which describe the layout of the window. (More information can be found in [https://devdocs.wesnoth.org/GUILayout.html Layout]; suffice to say that the basic structure is grid -> row -> column -> widget, where the widget is considered to be in a cell defined by the row and column of the grid. A list of widgets can be found at [https://devdocs.wesnoth.org/group__GUIWidgetWML.html Widgets].)
+The dialog box is equivalent to the resolution section of a GUI window as described in [https://devdocs.wesnoth.org/GUIToolkitWML.html GUIToolkit] and must therefore contain at least the following children: '''[tooltip]''', '''[helptip]''', and '''[grid]'''. The [grid] must contain nested [row], [column] and [grid] tags which describe the layout of the window. (More information can be found in [https://devdocs.wesnoth.org/GUILayout.html Layout]; suffice to say that the basic structure is grid -> row -> column -> widget, where the widget is considered to be in a cell defined by the row and column of the grid. A list of widgets can be found at [https://devdocs.wesnoth.org/group__GUIWidgetWML.html Widgets].)
 Two optional functions can be passed as second and third arguments; the first one is called once the dialog is created and before it is shown; the second one is called once the dialog is closed. These functions are helpful in setting the initial values of the fields and in recovering the final user values. These functions can call the [[#wesnoth.set_dialog_value]], [[#wesnoth.get_dialog_value]], and [[#wesnoth.set_dialog_callback]] functions for this purpose.

@@ Line 299: / Line 299: @@
 Two optional functions can be passed as second and third arguments; the first one is called once the dialog is created and before it is shown; the second one is called once the dialog is closed. These functions are helpful in setting the initial values of the fields and in recovering the final user values. These functions can call the [[#wesnoth.set_dialog_value]], [[#wesnoth.get_dialog_value]], and [[#wesnoth.set_dialog_callback]] functions for this purpose.
-This function should be called in conjunction with [[LuaWML:Misc#wesnoth.synchronize_choice|#wesnoth.synchronize_choice]], in order to ensure that only one client displays the dialog and that the other ones recover the same input values from this single client.
+This function should be called in conjunction with [[LuaWML:Misc#wesnoth.synchronize_choice|#wesnoth.synchronize_choice]], in order to ensure that only one client displays the dialog and that the other ones recover the same input values from this single client. Even in single-player campaigns, synchronization is necessary otherwise the replay will be broken.
 The example below defines a dialog with a list and two buttons on the left, and a big image on the right. The ''preshow'' function fills the list and defines a callback on it. This ''select'' callback changes the displayed image whenever a new list item is selected. The ''postshow'' function recovers the selected item before the dialog is destroyed.