UI (functions)/Choice Menu - Revision history

Imbion at 17:21, 18 January 2026

2026-01-18T17:21:45Z

← Older revision		Revision as of 17:21, 18 January 2026
Line 57:		Line 57:
	{{ArgHeader}}		{{ArgHeader}}
	{{ArgRow		{{ArgRow
	\|name=		\|name=msg
	\|type=		\|type=String
	\|techt=		\|techt=System.String
	\|purp=		\|purp=The question to ask the user.
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=		\|name=choices
	\|type=		\|type=LuaTable
	\|techt=		\|techt=NLua.LuaTable
	\|purp=		\|purp=A table of choices. Each choice can be either a string, or { string, bool } representing the text and enabled status.
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=		\|name=defaultChoice
	\|type=		\|type=Object
	\|techt=		\|techt=System.Object
	\|purp=		\|purp=The cursor starts on this choice
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=		\|name=cancelChoice
	\|type=		\|type=Object
	\|techt=		\|techt=System.Object
	\|purp=		\|purp=This choice is chosen if the player presses the cancel button.
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=		\|name=callbacks
	\|type=		\|type=LuaTable
	\|techt=		\|techt=NLua.LuaTable
	\|purp=		\|purp=The Lua table of callbacks for the textbox to call.
	}}		}}
	\|}		\|}
Line 102:		Line 102:
	{{ArgRow		{{ArgRow
	\|name=x		\|name=x
	\|type=		\|type=Integer
	\|techt=		\|techt=System.Int32
	\|purp=X position of the menu		\|purp=X position of the menu
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=y		\|name=y
	\|type=		\|type=Integer
	\|techt=		\|techt=System.Int32
	\|purp=Y position of the menu		\|purp=Y position of the menu
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=width		\|name=width
	\|type=		\|type=Integer
	\|techt=		\|techt=System.Int32
	\|purp=Width of the menu		\|purp=Width of the menu
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=title		\|name=title
	\|type=		\|type=String
	\|techt=		\|techt=System.String
	\|purp=Height of the menu		\|purp=Height of the menu
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=choices		\|name=choices
	\|type=		\|type=LuaTable
	\|techt=		\|techt=NLua.LuaTable
	\|purp=A table of choices. Each choice can be either a string, or { string, bool } representing the text and enabled status.		\|purp=A table of choices. Each choice can be either a string, or { string, bool } representing the text and enabled status.
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=linesPerPage		\|name=linesPerPage
	\|type=		\|type=Integer
	\|techt=		\|techt=System.Int32
	\|purp=Number of choices per page		\|purp=Number of choices per page
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=defaultChoice		\|name=defaultChoice
	\|type=		\|type=Object
	\|techt=		\|techt=System.Object
	\|purp=The cursor starts on this choice.		\|purp=The cursor starts on this choice.
	}}		}}
	{{ArgRow		{{ArgRow
	\|name=cancelChoice		\|name=cancelChoice
	\|type=		\|type=Object
	\|techt=		\|techt=System.Object
	\|purp=This choice is chosen if the player presses the cancel		\|purp=This choice is chosen if the player presses the cancel
	}}		}}

Imbion at 17:14, 18 January 2026

2026-01-18T17:14:56Z

← Older revision		Revision as of 17:14, 18 January 2026
Line 43:		Line 43:
	}}		}}
	\|}		\|}

			== BeginChoiceMenu ==

			Marks the start of a multi-choice menu.

			UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
			and for execution to suspend until the choice is returned.

			Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called. {{FuncUsage\|nmspace=UI\|nm=BeginChoiceMenu\|args=}}

			=== Arguments ===
			{\|class="wikitable"
			{{ArgHeader}}
			{{ArgRow
			\|name=
			\|type=
			\|techt=
			\|purp=
			}}
			{{ArgRow
			\|name=
			\|type=
			\|techt=
			\|purp=
			}}
			{{ArgRow
			\|name=
			\|type=
			\|techt=
			\|purp=
			}}
			{{ArgRow
			\|name=
			\|type=
			\|techt=
			\|purp=
			}}
			{{ArgRow
			\|name=
			\|type=
			\|techt=
			\|purp=
			}}
			\|}

			== BeginMultiPageMenu ==

			Marks the start of a multi-paged choice menu.

			UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
			and for execution to suspend until the choice is returned.

			Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called. {{FuncUsage\|nmspace=UI\|nm=\|args=}}

			=== Arguments ===
			{\|class="wikitable"
			{{ArgHeader}}
			{{ArgRow
			\|name=x
			\|type=
			\|techt=
			\|purp=X position of the menu
			}}
			{{ArgRow
			\|name=y
			\|type=
			\|techt=
			\|purp=Y position of the menu
			}}
			{{ArgRow
			\|name=width
			\|type=
			\|techt=
			\|purp=Width of the menu
			}}
			{{ArgRow
			\|name=title
			\|type=
			\|techt=
			\|purp=Height of the menu
			}}
			{{ArgRow
			\|name=choices
			\|type=
			\|techt=
			\|purp=A table of choices. Each choice can be either a string, or { string, bool } representing the text and enabled status.
			}}
			{{ArgRow
			\|name=linesPerPage
			\|type=
			\|techt=
			\|purp=Number of choices per page
			}}
			{{ArgRow
			\|name=defaultChoice
			\|type=
			\|techt=
			\|purp=The cursor starts on this choice.
			}}
			{{ArgRow
			\|name=cancelChoice
			\|type=
			\|techt=
			\|purp=This choice is chosen if the player presses the cancel
			}}
			\|}

			== ChoiceResult ==

			Get the result of the last choice menu

			=== Returns ===

			The result of the choice

			== GetChoiceAction ==
			undocumented

			== WaitForChoice ==

			Displays the currently set choice menu and waits for the player's selection to complete.

			=== Example ===

			<pre>

			WaitForChoice()

			</pre>

			== __WaitForChoice ==

			Wait for choice and then CLEAN UP m_curchoice

Imbion: /* Arguments */

2026-01-18T11:48:28Z

Arguments

← Older revision		Revision as of 11:48, 18 January 2026
Line 39:		Line 39:
	\|name=callbacks		\|name=callbacks
	\|type=Lua Table		\|type=Lua Table
	\|techt=NLua.LuaTable)		\|techt=NLua.LuaTable
	\|purp= The Lua table of callbacks for the textbox to call.		\|purp= The Lua table of callbacks for the textbox to call.
	}}		}}
	\|}		\|}

Imbion at 11:48, 18 January 2026

2026-01-18T11:48:16Z

← Older revision		Revision as of 11:48, 18 January 2026
Line 1:		Line 1:
	== ~~UI:~~SetChoiceLoc~~(System.Int32,System.Int32)~~ ==		== SetChoiceLoc ==


	Sets the position of the choices for a question dialog.		Sets the position of the choices for a question dialog.


	=== Arguments ===		=== Arguments ===

	* <code>x</code>: The X position		== ResetChoiceLoc ==
	* <code>y</code>: The Y position

	== ~~UI:~~ResetChoiceLoc ==


	Sets the position of the choices for a question dialog back to default.		Sets the position of the choices for a question dialog back to default.

			== ChoiceMenuYesNo ==
	== ~~UI:~~ChoiceMenuYesNo~~(System.String,System.Boolean,NLua.LuaTable)~~ ==


	Ask a question answered by yes or no via character dialogue to the player.		Ask a question answered by yes or no via character dialogue to the player.
	UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,		UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
	and for execution to suspend until the choice is returned.		and for execution to suspend until the choice is returned.

	Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.		Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.

	The Yes/No menu returns 1 for yes, and 0 for no.		The Yes/No menu returns 1 for yes, and 0 for no.

			{{FuncUsage\|nmspace=UI\|nm=ChoiceMenuYesNo\|args=message, defaultWhenNo, callbacks}}

	=== Arguments ===		=== Arguments ===
			{\|class="wikitable"
	* <code>message~~</code>:~~ Question to be asked to the user.		{{ArgHeader}}
	* <code>bdefaultstono</code>: Whether the cursor starts on no by default		{{ArgRow
	* <code>callbacks~~</code>:~~ The Lua table of callbacks for the textbox to call.		\|name=message
			\|type=String
			\|techt=System.String
			\|purp=Question to be asked to the user.
			}}
			{{ArgRow
			\|name=defaultWhenNo
			\|type=Boolean
			\|techt=System.Boolean
			\|purp=Whether the cursor starts on no by default
			}}
			{{ArgRow
			\|name=callbacks
			\|type=Lua Table
			\|techt=NLua.LuaTable)
			\|purp= The Lua table of callbacks for the textbox to call.
			}}
			\|}

Imbion: Created page with "== UI:SetChoiceLoc(System.Int32,System.Int32) == Sets the position of the choices for a question dialog. === Arguments === * `x`: The X position * `y`: The Y position == UI:ResetChoiceLoc == Sets the position of the choices for a question dialog back to default. == UI:ChoiceMenuYesNo(System.String,System.Boolean,NLua.LuaTable) == Ask a question answered by yes or no via character dialogue to the player. UI:WaitForChoice() must be called..."

2026-01-18T03:47:16Z

Created page with "== UI:SetChoiceLoc(System.Int32,System.Int32) == Sets the position of the choices for a question dialog. === Arguments === * <code>x</code>: The X position * <code>y</code>: The Y position == UI:ResetChoiceLoc == Sets the position of the choices for a question dialog back to default. == UI:ChoiceMenuYesNo(System.String,System.Boolean,NLua.LuaTable) == Ask a question answered by yes or no via character dialogue to the player. UI:WaitForChoice() must be called..."

New page

== UI:SetChoiceLoc(System.Int32,System.Int32) ==

Sets the position of the choices for a question dialog.

=== Arguments ===

* <code>x</code>: The X position
* <code>y</code>: The Y position

== UI:ResetChoiceLoc ==

Sets the position of the choices for a question dialog back to default.

== UI:ChoiceMenuYesNo(System.String,System.Boolean,NLua.LuaTable) ==

Ask a question answered by yes or no via character dialogue to the player.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.

The Yes/No menu returns 1 for yes, and 0 for no.

=== Arguments ===

* <code>message</code>: Question to be asked to the user.
* <code>bdefaultstono</code>: Whether the cursor starts on no by default
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.