Abort - Revision history

Philmasterplus: Convert to Template:Function2 format

2020-12-23T13:34:43Z

Convert to Template:Function2 format

← Older revision		Revision as of 13:34, 23 December 2020
Line 1:		Line 1:
	{{		<onlyinclude>{{{{{format\|Function2}}}
	~~#vardefine:name\|abort}}~~{{		\|name=abort
	~~#vardefine:return_type~~\|~~void~~}}{{		\|function1.return_type=void
			\|function1.description=Immediately halts the current script and all queued functions.
	~~FunctionPage~~\|		\|function1.param1=message
	name=~~{{#var:name}}~~\|		\|function1.param1.type=string
			\|function1.param1.optional=yes
	function1=~~{{Function\|~~		\|function1.param1.default="Script aborted."
	~~name={{#var:name}}~~\|		\|function1.param1.description=(optional) abort message to show in the gCLI
	~~aggregate~~=~~{{#var:aggregate}}\|~~		\|description=This function is often used for basic error handling.
	~~return_type={{#var:return_type}}~~\|		\|code1={{CodeSample
	~~return_also~~=~~{{#var:return_also}}\|~~		\|title=Code Samples
	}}\|		\|description=This code will abort the script if run by the "wrong" character.
			\|code=
	~~function2~~=~~{{Function\|~~		<syntaxhighlight lang="d">
	~~name={{#var:name}}~~\|		if ( my_name() != "MrPicky" )
	~~aggregate~~=~~{{#var:aggregate}}\|~~		{
	~~return_type={{#var:return_type}}~~\|		abort( "I don't want you to run this script, mister!" );
	~~return_also~~=~~{{#var:return_also}}\|~~
	~~parameter1={{Param~~\|~~string\|message}}\|~~
	~~p1desc~~=~~{{Pspan\|message}} is the~~ (optional) abort message (in ~~place of "KoLmafia declares world peace.")\|~~
	}}\|

	~~function_description~~=~~Halts all queued functions and the entire script it~~ is ~~called from. Often~~ used for error-handling.\|

	code1={{CodeSample\|
	title=Code Samples\|
	description=This code will abort the script if run by the "wrong" character.\|
	code=
	<syntaxhighlight>
	if (my_name() != "MrPicky") {
	abort("I don't want you to run this script, mister!");
	}		}
	</syntaxhighlight>}}		</syntaxhighlight>
	{{CodeSample\|		}}
	description=An example of '''abort()''' used for error-handling.\|		\|code2={{CodeSample
	code=		\|description=An example of '''abort()''' used for error-handling.
	<syntaxhighlight>		\|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 )
	abort("Error: Division by zero requested.");		{
	} else {		abort( "Error: Division by zero requested." );
	density = mass / volume;		}
			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).~~
	}}		}}
			\|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]]		[[Category:Miscellaneous Functions]]

Fewyn: Reverted edits by Fewyn (Talk) to last revision by Bale

2010-05-30T22:43:56Z

Reverted edits by Fewyn (Talk) to last revision by Bale

← Older revision		Revision as of 22:43, 30 May 2010
Line 1:		Line 1:
	~~{{#customtitle:My header\|My Title}}~~
	{{		{{
	#vardefine:name\|abort}}{{		#vardefine:name\|abort}}{{

Fewyn at 22:43, 30 May 2010

2010-05-30T22:43:44Z

← Older revision		Revision as of 22:43, 30 May 2010
Line 1:		Line 1:
			{{#customtitle:My header\|My Title}}
	{{		{{
	#vardefine:name\|abort}}{{		#vardefine:name\|abort}}{{

Fewyn: Reverted edits by Fewyn (Talk) to last revision by Bale

2010-05-30T22:31:49Z

Reverted edits by Fewyn (Talk) to last revision by Bale

← Older revision		Revision as of 22:31, 30 May 2010
Line 50:		Line 50:

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

	~~Testing~~

Fewyn at 22:31, 30 May 2010

2010-05-30T22:31:40Z

← Older revision		Revision as of 22:31, 30 May 2010
Line 50:		Line 50:

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

			Testing

Bale at 05:28, 22 May 2010

2010-05-22T05:28:39Z

← Older revision		Revision as of 05:28, 22 May 2010
Line 49:		Line 49:
	}}		}}

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

Bale at 05:27, 22 May 2010

2010-05-22T05:27:45Z

← Older revision		Revision as of 05:27, 22 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Miscellaneous\|~~

	function1={{Function\|		function1={{Function\|
Line 49:		Line 48:
	cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).		cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).
	}}		}}

			[[Category:Miscellaneous]]

Heeheehee: Format-fixing.

2010-03-27T13:54:18Z

Format-fixing.

← Older revision		Revision as of 13:54, 27 March 2010
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\|
	~~code2=~~{{CodeSample\|
	description=An example of '''abort()''' used for error-handling.\|		description=An example of '''abort()''' used for error-handling.\|
	code=		code=

StDoodle at 21:36, 8 March 2010

2010-03-08T21:36:00Z

← Older revision		Revision as of 21:36, 8 March 2010
Line 1:		Line 1:
	{{FunctionPage \|		{{
	~~page_name~~=~~abort~~\|		#vardefine:name\|abort}}{{
			#vardefine:return_type\|void}}{{

			FunctionPage\|
			name={{#var:name}}\|
	function_category=Miscellaneous\|		function_category=Miscellaneous\|
	~~function1_return_type~~=~~void~~\|
	~~function2_return_type~~=~~void~~\|		function1={{Function\|
	~~function2_parameter1~~={{Param\|string\|message}} \|		name={{#var:name}}\|
	~~function2_parameter1_desc~~=~~Where ''~~message'' is optional ~~text to display~~ in place of "KoLmafia declares world peace." ~~(Also displays in red.~~)\|		aggregate={{#var:aggregate}}\|
			return_type={{#var:return_type}}\|
			return_also={{#var:return_also}}\|
			}}\|

			function2={{Function\|
			name={{#var:name}}\|
			aggregate={{#var:aggregate}}\|
			return_type={{#var:return_type}}\|
			return_also={{#var:return_also}}\|
			parameter1={{Param\|string\|message}}\|
			p1desc={{Pspan\|message}} is the (optional) abort message (in place of "KoLmafia declares world peace.")\|
			}}\|

	function_description=Halts all queued functions and the entire script it is called from. Often used for error-handling.\|		function_description=Halts all queued functions and the entire script it is called from. Often used for error-handling.\|
	code1={{CodeSample \|
	title=Code ~~Sample~~\|		code1={{CodeSample\|
			title=Code Samples\|
	description=This code will abort the script if run by the "wrong" character.\|		description=This code will abort the script if run by the "wrong" character.\|
	code=		code=
	<syntaxhighlight ~~lang="c"~~>		<syntaxhighlight>
	if (my_name() != "MrPicky") {		if (my_name() != "MrPicky") {
	abort("I don't want you to run this script, mister!");		abort("I don't want you to run this script, mister!");
	}		}
	</syntaxhighlight>}} \|		</syntaxhighlight>}}\|
	code2={{CodeSample \|
			code2={{CodeSample\|
	description=An example of '''abort()''' used for error-handling.\|		description=An example of '''abort()''' used for error-handling.\|
	code=		code=
	<syntaxhighlight ~~lang="c"~~>		<syntaxhighlight>
	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
Line 31:		Line 50:
	cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).		cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).
	}}		}}
	~~{{Format}}~~

StDoodle at 21:30, 8 March 2010

2010-03-08T21:30:29Z

← Older revision		Revision as of 21:30, 8 March 2010
Line 31:		Line 31:
	cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).		cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).
	}}		}}
			{{Format}}

← Older revision		Revision as of 21:36, 8 March 2010
Line 1:		Line 1:
	{{FunctionPage \|		{{
	~~page_name~~=~~abort~~\|		#vardefine:name\|abort}}{{
			#vardefine:return_type\|void}}{{

			FunctionPage\|
			name={{#var:name}}\|
	function_category=Miscellaneous\|		function_category=Miscellaneous\|
	~~function1_return_type~~=~~void~~\|
	~~function2_return_type~~=~~void~~\|		function1={{Function\|
	~~function2_parameter1~~={{Param\|string\|message}} \|		name={{#var:name}}\|
	~~function2_parameter1_desc~~=~~Where ''~~message'' is optional ~~text to display~~ in place of "KoLmafia declares world peace." ~~(Also displays in red.~~)\|		aggregate={{#var:aggregate}}\|
			return_type={{#var:return_type}}\|
			return_also={{#var:return_also}}\|
			}}\|

			function2={{Function\|
			name={{#var:name}}\|
			aggregate={{#var:aggregate}}\|
			return_type={{#var:return_type}}\|
			return_also={{#var:return_also}}\|
			parameter1={{Param\|string\|message}}\|
			p1desc={{Pspan\|message}} is the (optional) abort message (in place of "KoLmafia declares world peace.")\|
			}}\|

	function_description=Halts all queued functions and the entire script it is called from. Often used for error-handling.\|		function_description=Halts all queued functions and the entire script it is called from. Often used for error-handling.\|
	code1={{CodeSample \|
	title=Code ~~Sample~~\|		code1={{CodeSample\|
			title=Code Samples\|
	description=This code will abort the script if run by the "wrong" character.\|		description=This code will abort the script if run by the "wrong" character.\|
	code=		code=
	<syntaxhighlight ~~lang="c"~~>		<syntaxhighlight>
	if (my_name() != "MrPicky") {		if (my_name() != "MrPicky") {
	abort("I don't want you to run this script, mister!");		abort("I don't want you to run this script, mister!");
	}		}
	</syntaxhighlight>}} \|		</syntaxhighlight>}}\|
	code2={{CodeSample \|
			code2={{CodeSample\|
	description=An example of '''abort()''' used for error-handling.\|		description=An example of '''abort()''' used for error-handling.\|
	code=		code=
	<syntaxhighlight ~~lang="c"~~>		<syntaxhighlight>
	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
Line 31:		Line 50:
	cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).		cli_equiv=Also available as the CLI command "abort," which will not be queued (similarly stops execution of all remaining commands when parsed).
	}}		}}
	~~{{Format}}~~