LuaAPI/gui - Revision history

Bssarkar: /* gui.show_recall_dialog */ document return value

2025-06-07T03:13:42Z

gui.show_recall_dialog: document return value

← Older revision		Revision as of 03:13, 7 June 2025
Line 215:		Line 215:
	{{DevFeature1.19\|8}}		{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options'']) → ''unit''		* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options'']) → [''unit'']

	Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:
Line 224:		Line 224:
	* ''help_topic'': the help topic that is to be opened when the '?' button is clicked.		* ''help_topic'': the help topic that is to be opened when the '?' button is clicked.
	* ''show_headers'': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.		* ''show_headers'': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.

			If an unit is selected and the OK button pressed, will return the selected unit object, nothing otherwise.

	=== gui.show_story ===		=== gui.show_story ===

Bssarkar: /* gui.show_recruit_dialog */ document return value

2025-06-07T03:13:06Z

gui.show_recruit_dialog: document return value

← Older revision		Revision as of 03:13, 7 June 2025
Line 199:		Line 199:
	{{DevFeature1.19\|8}}		{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options'']) → ''unit_type''		* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options'']) → [''unit_type'']

	Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:
Line 208:		Line 208:
	* ''help_topic'': the help topic that is to be opened when the '?' button is clicked.		* ''help_topic'': the help topic that is to be opened when the '?' button is clicked.
	* ''show_headers'': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.		* ''show_headers'': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.

			If an unit type is selected and the OK button pressed, will return the selected unit type object, nothing otherwise.

	=== gui.show_recall_dialog ===		=== gui.show_recall_dialog ===

Shiki: change formatting

2025-06-02T10:07:54Z

change formatting

← Older revision		Revision as of 10:07, 2 June 2025
Line 203:		Line 203:
	Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

	* '''title''': the title of the dialog.		* ''title'': the title of the dialog.
	* '''ok_label''': caption of the button with id "ok".		* ''ok_label'': caption of the button with id "ok".
	* '''cancel_label''': caption of the button with id "cancel".		* ''cancel_label'': caption of the button with id "cancel".
	* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.		* ''help_topic'': the help topic that is to be opened when the '?' button is clicked.
	* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.		* ''show_headers'': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.

	=== gui.show_recall_dialog ===		=== gui.show_recall_dialog ===
Line 217:		Line 217:
	Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

	* '''title''': the title of the dialog.		* ''title'': the title of the dialog.
	* '''ok_label''': caption of the button with id "ok".		* ''ok_label'': caption of the button with id "ok".
	* '''cancel_label''': caption of the button with id "cancel".		* ''cancel_label'': caption of the button with id "cancel".
	* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.		* ''help_topic'': the help topic that is to be opened when the '?' button is clicked.
	* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.		* ''show_headers'': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.

	=== gui.show_story ===		=== gui.show_story ===

Shiki: /* gui.show_recall_dialog */

2025-06-02T10:05:27Z

gui.show_recall_dialog

← Older revision		Revision as of 10:05, 2 June 2025
Line 213:		Line 213:
	{{DevFeature1.19\|8}}		{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options'']) → ''~~unit_type~~''		* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options'']) → ''unit''

	Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

Shiki: show return value

2025-06-02T10:04:37Z

show return value

← Older revision		Revision as of 10:04, 2 June 2025
Line 199:		Line 199:
	{{DevFeature1.19\|8}}		{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])		* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options'']) → ''unit_type''

	Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:
Line 213:		Line 213:
	{{DevFeature1.19\|8}}		{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])		* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options'']) → ''unit_type''

	Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

Shadowm: gui.show_recruit/recall_dialog are dev-only, fix template position in gui.switch_theme

2025-02-27T22:07:15Z

gui.show_recruit/recall_dialog are dev-only, fix template position in gui.switch_theme

← Older revision		Revision as of 22:07, 27 February 2025
Line 196:		Line 196:

	=== gui.show_recruit_dialog ===		=== gui.show_recruit_dialog ===

			{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])		* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])
Line 208:		Line 210:

	=== gui.show_recall_dialog ===		=== gui.show_recall_dialog ===

			{{DevFeature1.19\|8}}

	* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])		* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])
Line 226:		Line 230:

	=== gui.switch_theme ===		=== gui.switch_theme ===

			{{DevFeature1.19\|4}}

	* '''gui.switch_theme'''(''theme_id'')		* '''gui.switch_theme'''(''theme_id'')

	~~{{DevFeature1.19\|4}}~~

	Switch to the GUI2 theme with id ''theme_id''. Can only be used inside a scenario and does not replace the UI Theme selected by Preferences. The UI reverts to the theme selected in Preferences after exiting the in-game window, for example, by using the menu or by winning or losing a campaign.		Switch to the GUI2 theme with id ''theme_id''. Can only be used inside a scenario and does not replace the UI Theme selected by Preferences. The UI reverts to the theme selected in Preferences after exiting the in-game window, for example, by using the menu or by winning or losing a campaign.

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

Shadowm: /* gui.switch_theme */ Dev-only feature

2025-02-27T22:01:23Z

gui.switch_theme: Dev-only feature

← Older revision		Revision as of 22:01, 27 February 2025
Line 228:		Line 228:

	* '''gui.switch_theme'''(''theme_id'')		* '''gui.switch_theme'''(''theme_id'')

			{{DevFeature1.19\|4}}

	Switch to the GUI2 theme with id ''theme_id''. Can only be used inside a scenario and does not replace the UI Theme selected by Preferences. The UI reverts to the theme selected in Preferences after exiting the in-game window, for example, by using the menu or by winning or losing a campaign.		Switch to the GUI2 theme with id ''theme_id''. Can only be used inside a scenario and does not replace the UI Theme selected by Preferences. The UI reverts to the theme selected in Preferences after exiting the in-game window, for example, by using the menu or by winning or losing a campaign.

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

Celtic Minstrel: Add the game-only indicator to the new functions

2024-12-30T15:48:16Z

Add the game-only indicator to the new functions

Bssarkar: Add more info and mark functions that are only available in-game

2024-12-30T10:54:58Z

Add more info and mark functions that are only available in-game

← Older revision		Revision as of 10:54, 30 December 2024
Line 87:		Line 87:
	* {{LuaGameOnly}} '''gui.show_inspector'''()		* {{LuaGameOnly}} '''gui.show_inspector'''()

	Show the gamestate inspector.		Show the gamestate inspector. Only available in-game.

	=== gui.show_lua_console ===		=== gui.show_lua_console ===
Line 199:		Line 199:
	* '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])		* '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])

	The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recruit dialog with the given list of unit types and options. Only available in-game. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

	* '''title''': the title of the dialog.		* '''title''': the title of the dialog.
Line 211:		Line 211:
	* '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])		* '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])

	The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recall dialog with the given list of units and options. Only available in-game. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

	* '''title''': the title of the dialog.		* '''title''': the title of the dialog.

Bssarkar: /* gui.show_prompt */ Add documentation for gui.show_recruit_dialog and gui.show_recall_dialog

2024-12-30T10:42:14Z

gui.show_prompt: Add documentation for gui.show_recruit_dialog and gui.show_recall_dialog

← Older revision		Revision as of 10:42, 30 December 2024
Line 194:		Line 194:

	The alert and confirm functions are simpler wrappers for this function, using a single OK button and a pair of Yes/No buttons, respectively. Both confirm and show_prompt return false if No or Cancel was clicked, and true otherwise. The alert function returns nothing.		The alert and confirm functions are simpler wrappers for this function, using a single OK button and a pair of Yes/No buttons, respectively. Both confirm and show_prompt return false if No or Cancel was clicked, and true otherwise. The alert function returns nothing.

			=== gui.show_recruit_dialog ===

			* '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])

			The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

			* '''title''': the title of the dialog.
			* '''ok_label''': caption of the button with id "ok".
			* '''cancel_label''': caption of the button with id "cancel".
			* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.
			* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.

			=== gui.show_recall_dialog ===

			* '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])

			The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

			* '''title''': the title of the dialog.
			* '''ok_label''': caption of the button with id "ok".
			* '''cancel_label''': caption of the button with id "cancel".
			* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.
			* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.

	=== gui.show_story ===		=== gui.show_story ===

← Older revision		Revision as of 15:48, 30 December 2024
Line 87:		Line 87:
	* {{LuaGameOnly}} '''gui.show_inspector'''()		* {{LuaGameOnly}} '''gui.show_inspector'''()

	Show the gamestate inspector~~. Only available in-game~~.		Show the gamestate inspector.

	=== gui.show_lua_console ===		=== gui.show_lua_console ===
Line 197:		Line 197:
	=== gui.show_recruit_dialog ===		=== gui.show_recruit_dialog ===

	* '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])		* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])

	Shows the recruit dialog with the given list of unit types and options~~. Only available in-game~~. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type\|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

	* '''title''': the title of the dialog.		* '''title''': the title of the dialog.
Line 209:		Line 209:
	=== gui.show_recall_dialog ===		=== gui.show_recall_dialog ===

	* '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])		* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])

	Shows the recall dialog with the given list of units and options~~. Only available in-game~~. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:		Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit\|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

	* '''title''': the title of the dialog.		* '''title''': the title of the dialog.