Difference between revisions of "Abort"
Jump to navigation
Jump to search
imported>StDoodle |
imported>StDoodle m |
||
Line 1: | Line 1: | ||
− | + | {{FunctionPage | | |
− | + | page_name=abort| | |
− | + | function_category=Miscellaneous| | |
− | + | function1_return_type=void| | |
− | < | + | function2_return_type=void| |
− | + | function2_parameter1={{Param|string|message}} | | |
− | + | function2_parameter1_desc=Where ''message'' is optional text to display in place of "KoLmafia declares world peace." (Also displays in red.)| | |
− | + | function_description=Halts all queued functions and the entire script it is called from. Often used for error-handling.| | |
− | } | + | code1={{CodeSample | |
+ | title=Code Sample| | ||
+ | description=This code will abort the script if run by the "wrong" character.| | ||
+ | code= | ||
+ | <syntaxhighlight lang="c"> | ||
+ | if (my_name() != "MrPicky") { | ||
+ | abort("I don't want you to run this script, mister!"); | ||
+ | } | ||
+ | </syntaxhighlight>}} | | ||
+ | cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed). | ||
+ | }} |
Revision as of 13:20, 25 February 2010
Function Syntax
Halts all queued functions and the entire script it is called from. Often used for error-handling.
Code Sample
This code will abort the script if run by the "wrong" character.
if (my_name() != "MrPicky") {
abort("I don't want you to run this script, mister!");
}
CLI Equivalent
Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).