Abort: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle mNo edit summary |
Convert to Template:Function2 format |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | <onlyinclude>{{{{{format|Function2}}} | ||
|name=abort | |||
|function1.return_type=void | |||
|function1.description=Immediately halts the current script and all queued functions. | |||
|function1.param1=message | |||
|function1.param1.type=string | |||
|function1.param1.optional=yes | |||
|function1.param1.default="Script aborted." | |||
code1={{CodeSample | | |function1.param1.description=(optional) abort message to show in the gCLI | ||
title=Code | |description=This function is often used for basic error handling. | ||
description=This code will abort the script if run by the "wrong" character.| | |code1={{CodeSample | ||
code= | |title=Code Samples | ||
<syntaxhighlight lang=" | |description=This code will abort the script if run by the "wrong" character. | ||
if (my_name() != "MrPicky") { | |code= | ||
<syntaxhighlight lang="d"> | |||
if ( my_name() != "MrPicky" ) | |||
{ | |||
abort( "I don't want you to run this script, mister!" ); | |||
} | } | ||
</syntaxhighlight>}} | | </syntaxhighlight> | ||
code2={{CodeSample | | }} | ||
description=An example of '''abort()''' used for error-handling.| | |code2={{CodeSample | ||
code= | |description=An example of '''abort()''' used for error-handling. | ||
<syntaxhighlight lang=" | |code= | ||
<syntaxhighlight lang="d"> | |||
float mass = 5.0; | float mass = 5.0; | ||
float volume = some_function(); //where some_function() may return 0.0 | float volume = some_function(); // where some_function() may return 0.0 | ||
float density; | float density; | ||
if (volume_cf == 0) { | if ( volume_cf == 0 ) | ||
{ | |||
} else { | abort( "Error: Division by zero requested." ); | ||
} | |||
else | |||
{ | |||
density = mass / volume; | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | }} | ||
|cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed). | |||
}}</onlyinclude> | |||
[[Category:Miscellaneous Functions]] | |||
Latest revision as of 13:34, 23 December 2020
Function Syntax
void abort( string? message = "Script aborted." )
- Immediately halts the current script and all queued functions.
- message: (optional) abort message to show in the gCLI
This function is often used for basic 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).