User confirm: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
m Formatting nonsense for consistency.
imported>Bale
mNo edit summary
Line 4: Line 4:
{{FunctionPage|
{{FunctionPage|
name={{#var:name}}|
name={{#var:name}}|
function_category=Miscellaneous|


function1={{Function|
function1={{Function|
Line 30: Line 29:


}}
}}
[[Category:Miscellaneous Functions]]

Revision as of 05:35, 22 May 2010



Function Syntax

boolean user_confirm(string message )

  • message is the text to display in the confirmation pop-up

Presents the user with a pop-up dialog box with the text in message (can use escaped characters, such as "\n" for a newline); returns true if the user selects "Yes" and false if the user selects "No."

Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.

Code Sample

A check to see if the user truly wants to execute a script.

if (!user_confirm("Are you sure you want to proceed with executing this script?") )
{
   abort("Script execution canceled by user.");
}