Abort: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle No edit summary |
imported>Heeheehee m Format-fixing. |
||
Line 33: | Line 33: | ||
abort("I don't want you to run this script, mister!"); | abort("I don't want you to run this script, mister!"); | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
{{CodeSample| | |||
description=An example of '''abort()''' used for error-handling.| | description=An example of '''abort()''' used for error-handling.| | ||
code= | code= |
Revision as of 13:54, 27 March 2010
Function Syntax
void abort()
- message is the (optional) abort message (in place of "KoLmafia declares world peace.")
Halts all queued functions and the entire script it is called from. Often used for error-handling.
Code Samples
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!");
}
An example of abort() used for error-handling.
float mass = 5.0;
float volume = some_function(); //where some_function() may return 0.0
float density;
if (volume_cf == 0) {
abort("Error: Division by zero requested.");
} else {
density = mass / volume;
}
CLI Equivalent
Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).