Lua:inputQuery - Revision history

Leunsel at 00:55, 25 June 2026

2026-06-25T00:55:04Z

Leunsel: Minor edit. Added Version Notice Template.

2025-12-04T19:04:52Z

Minor edit. Added Version Notice Template.

Leunsel: Created page with "Category:Lua '''function''' inputQuery(''Caption'', ''Prompt'', ''InitialString'') ''':''' String or nil Displays a dialog box that prompts the user to input a string...."

2025-07-10T23:55:35Z

Created page with "Category:Lua '''function''' inputQuery(''Caption'', ''Prompt'', ''InitialString'') ''':''' String or nil Displays a dialog box that prompts the user to input a string...."

New page

[[Category:Lua]]
'''function''' inputQuery(''Caption'', ''Prompt'', ''InitialString'') ''':''' String or nil

Displays a dialog box that prompts the user to input a string.
Returns the entered string, or nil if the user cancels the dialog.

===Function Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|Caption
|String
|The title of the input dialog window.
|-
|Prompt
|String
|The prompt or question to display to the user.
|-
|InitialString
|String
|The default value shown in the input field.
|}

===Examples===
<pre>
-- Ask the user for their name
local name = inputQuery("User Name", "Please enter your name:", "")
if name then
showMessage("Hello, " .. name .. "!")
else
showMessage("You cancelled the input.")
end
</pre>

<pre>
-- Prompt for a file name with a default value
local filename = inputQuery("Save File", "Enter the file name to save:", "myfile.txt")
if filename then
print("Saving to: " .. filename)
end
</pre>

<pre>
-- Use inputQuery for a password (not masked)
local password = inputQuery("Authentication", "Enter your password:", "")
if password then
print("Password entered.")
end
</pre>

== See also ==
* [[showMessage]]
* [[Lua]]

← Older revision		Revision as of 19:04, 4 December 2025
Line 1:		Line 1:
	[[Category:Lua]]		[[Category:Lua]]
		+	{{VersionNotice\|6.4+}}
	'''function''' inputQuery(''Caption'', ''Prompt'', ''InitialString'') ''':''' String or nil		'''function''' inputQuery(''Caption'', ''Prompt'', ''InitialString'') ''':''' String or nil

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
 {{VersionNotice|6.4+}}
-'''function''' inputQuery(''Caption'', ''Prompt'', ''InitialString'') ''':''' String or nil
+{{CodeBox|'''function''' inputQuery(''caption'', ''prompt'', ''initialstring'') ''':''' string}}
-Displays a dialog box that prompts the user to input a string.
+Shows a dialog where the user can input a string.
-Returns the entered string, or nil if the user cancels the dialog.
 ===Function Parameters===
@@ Line 12: / Line 13: @@
 !style="width: 80%;background-color:white;" align="left"|Description
 |-
-|Caption
+|caption
 |String
-|The title of the input dialog window.
+|The caption of the input dialog.
 |-
-|Prompt
+|prompt
 |String
-|The prompt or question to display to the user.
+|The prompt text shown to the user.
 |-
-|InitialString
+|initialstring
 |String
-|The default value shown in the input field.
+|The initial text shown in the input field.
 |}
 ===Examples===
 <pre>
--- Ask the user for their name
+local result = inputQuery("Name", "Enter your name:", "")
-local name = inputQuery("User Name", "Please enter your name:", "")
-if name then
+if result ~= nil then
-   showMessage("Hello, " .. name .. "!")
+   print("Entered name: " .. result)
 else
-   showMessage("You cancelled the input.")
+   print("Input cancelled")
 end
 </pre>
 <pre>
--- Prompt for a file name with a default value
+local value = inputQuery("Health", "Enter new health value:", "100")
-local filename = inputQuery("Save File", "Enter the file name to save:", "myfile.txt")
-if filename then
+if value ~= nil then
-   print("Saving to: " .. filename)
+   local numberValue = tonumber(value)
 end
 </pre>
 <pre>
--- Use inputQuery for a password (not masked)
+local address = inputQuery("Address", "Enter an address or symbol:", "player.health")
-local password = inputQuery("Authentication", "Enter your password:", "")
-if password then
+if address ~= nil then
-   print("Password entered.")
+   local resolvedAddress = getAddressSafe(address)
 end
 </pre>
-== See also ==
+{{LuaSeeAlso}}