Cli execute - Revision history

Philmasterplus: Convert to Template:Function2 format, modernize code example

2020-12-23T14:41:17Z

Convert to Template:Function2 format, modernize code example

← Older revision		Revision as of 14:41, 23 December 2020
Line 1:		Line 1:
	{{		<onlyinclude>{{{{{format\|Function2}}}
	~~#vardefine:~~name\|~~cli_execute}}~~{{		\|name=cli_execute
	~~#vardefine:return_type~~\|~~boolean~~}}{{		\|function1.return_type=boolean
			\|function1.description=Executes a string as a gCLI command. Returns <code>true</code> on success, <code>false</code> on failure.
			\|function1.param1=command
			\|function1.param1.type=string
			\|function1.param1.description=gCLI command(s) to execute
			\|description=<p>This function passes the parameter {{pspan\|command}} to KoLmafia's gCLI, which will execute it as though it was typed in through the normal interface. This function will return <code>true</code> if the gCLI command executed properly, and <code>false</code> if it was unable to do so (for example, trying to execute an adventuring command while drunk).</p>

	~~FunctionPage\|~~		<p>Though it is considered a "best practice" to use built-in ASH functions whenever possible, there are some cases where no ASH function exists to handle a task (e.g. creating moods). This function provides an escape hatch for such tasks by using gCLI commands from within an ASH script.</p>
	~~name={{#var:name}}\|~~

	~~function1=~~{{~~Function~~\|		<p>{{f\|cli_execute}} is used most commonly for functions that do not have an ASH equivalent. More CLI commands can be found at the [[CLI Reference]], or by typing "help" into the gCLI window.</p>
	~~name={{#var:name}}\|~~		\|code1={{CodeSample
	~~aggregate={{#var:aggregate}}\|~~		\|title=Code Samples
	~~return_type={{#var:return_type}}\|~~		\|description=This example maximizes your meat drop percentage and spends all of your adventures in {{kolwiki\|The Castle in the Clouds in the Sky (Top Floor)}}.
	~~return_also={{#var:return_also}}\|~~		\|code=
	~~parameter1={{Param\|string\|command}}\|~~		<syntaxhighlight lang="d">
	~~p1desc={{Pspan\|command~~}} is ~~a cli command or~~ commands ~~to execute\|~~		cli_execute( "maximize meat, switch hobo monkey, -switch leprechaun" );
	~~}}\|~~		adventure( my_adventures(), $location[ The Castle in the Clouds in the Sky (Top Floor) ] );
			</syntaxhighlight>
	~~function_description=This function passes~~ the ~~parameter {{pspan\|command}} on to KoLmafia's~~ CLI, which will execute it as if it were typed in through the normal interface. This function will return true if the CLI command executed properly, and false if it was unable to do so (for example, trying to execute an adventuring command while drunk). Though it's considered a "~~best practice~~" to use built-in ASH functions when possible, there are some instances (such as "maximize") where no ASH function exists to handle what needs to be done, and this function allows access to such commands from within an ASH script.\|		\|moreinfo=
			}}
	~~code2~~={{CodeSample\|		\|code2={{CodeSample
			\|description=A basic leveling mood setup using CLI Execute as ASH does not have anything similar.
	description=~~<br>~~This example maximizes your meat drop percentage and spends all of your adventures in the ~~Castle~~\|		\|code=
	code=		<syntaxhighlight lang="d">
	<syntaxhighlight>		// Mood Name
	cli_execute("maximize meat, switch hobo monkey, -switch leprechaun");		cli_execute( "mood MoxieLeveling" );
	adventure( my_adventures(), $location[~~Giant's~~ Castle] );		cli_execute( "mood clear" );
	</syntaxhighlight>}}\|		// Remove Poisons
			cli_execute( "trigger gain_effect, somewhat poisoned, uneffect Somewhat Poisoned" );
			cli_execute( "trigger gain_effect, Hardly Poisoned at All, uneffect Hardly Poisoned at All" );
	~~code1~~={{CodeSample\|		cli_execute( "trigger gain_effect, A Little Bit Poisoned, uneffect A Little Bit Poisoned" );
	~~title=Code Samples~~\|		cli_execute( "trigger gain_effect, Really Quite Poisoned, uneffect Really Quite Poisoned" );
	description=A basic leveling mood setup using CLI Execute as ASH does not have anything similar.\|		cli_execute( "trigger gain_effect, Majorly Poisoned, uneffect Majorly Poisoned" );
	code=		cli_execute( "trigger gain_effect, Toad In The Hole, uneffect Toad In The Hole" );
	<syntaxhighlight>		cli_execute( "trigger gain_effect, just the best anapests, uneffect just the best anapests" );
	//Mood Name		// Store Buffs
	cli_execute("mood MoxieLeveling");		if ( my_meat() >= 500 )
	cli_execute("mood clear");		cli_execute( "trigger lose_effect, Butt-Rock Hair, use 10 hair spray" );
	//Remove Poisons		// Smiles
	cli_execute("trigger gain_effect, somewhat poisoned, uneffect Somewhat Poisoned");		if ( have_skill( $skill[ Knowing Smile ] ) && my_maxmp() >= 20 )
	cli_execute("trigger gain_effect, Hardly Poisoned at All, uneffect Hardly Poisoned at All");		cli_execute( "trigger lose_effect, Knowing Smile, cast 1 Knowing Smile" );
	cli_execute("trigger gain_effect, A Little Bit Poisoned, uneffect A Little Bit Poisoned");		else if ( have_skill( $skill[ disco smirk ] ) && my_maxmp() >= 20 )
	cli_execute("trigger gain_effect, Really Quite Poisoned, uneffect Really Quite Poisoned");		cli_execute( "trigger lose_effect, Disco Smirk, cast 1 Disco Smirk" );
	cli_execute("trigger gain_effect, Majorly Poisoned, uneffect Majorly Poisoned");		// DB Skills
	cli_execute("trigger gain_effect, Toad In The Hole, uneffect Toad In The Hole");		if ( have_skill( $skill[ Disco Aerobics ] ) )
	cli_execute("trigger gain_effect, just the best anapests, uneffect just the best anapests");		cli_execute( "trigger lose_effect, Disco State of Mind, cast 5 Disco Aerobics" );
	//Store Buffs		// AT Skills
	if (my_meat() >= 500)		if ( have_skill( $skill[ Moxie of the Mariachi ] ) )
	cli_execute("trigger lose_effect, Butt-Rock Hair, use 10 hair spray");		cli_execute( "trigger lose_effect, Mariachi Mood, cast 5 Moxie of the Mariachi" );
	//Smiles		// Songs
	if (have_skill($skill[Knowing Smile]) && my_maxmp() >= 20)		if ( have_skill( $skill[ The Moxious Madrigal ] ) && my_maxmp() >= 2 )
	cli_execute("trigger lose_effect, Knowing Smile, cast 1 Knowing Smile");		cli_execute( "trigger lose_effect, The Moxious Madrigal, cast 1 The Moxious Madrigal" );
	else if (have_skill($skill[disco smirk]) && my_maxmp() >= 20)		// Execute the mood
	cli_execute("trigger lose_effect, Disco Smirk, cast 1 Disco Smirk");		mood_execute(1);
	//DB Skills		</syntaxhighlight>
	if (have_skill($skill[Disco Aerobics]))		\|moreinfo=
	cli_execute("trigger lose_effect, Disco State of Mind, cast 5 Disco Aerobics");
	//At Skills
	if (have_skill($skill[Moxie of the Mariachi]))
	cli_execute("trigger lose_effect, Mariachi Mood, cast 5 Moxie of the Mariachi");
	//Songs
	if (have_skill($skill[The Moxious Madrigal]) && my_maxmp() >= 2)
	cli_execute("trigger lose_effect, The Moxious Madrigal, cast 1 The Moxious Madrigal");
	//Execute the mood
	~~cli_execute~~(~~"mood execute"~~);
	</syntaxhighlight>\|
	moreinfo=
	Cli_execute is used most commonly for functions that do not have an ASH equivalent. More CLI commands can be found [http://wiki.kolmafia.us/index.php?title=CLI_Reference here] or typing "help" into the CLI window.
	~~}}\|~~

	~~cli_equiv=The function cli_execute() equivalents you!\|~~
	}}		}}
			\|see_also={{SeeAlso/gCLI Functions}}
			\|cli_equiv=The function cli_execute() equivalents you!
			\|more_info=
			\|special=
			\|{{{1\|}}}
			}}</onlyinclude>
	[[Category:Miscellaneous Functions]]		[[Category:Miscellaneous Functions]]

Eliteofdelete at 05:06, 12 January 2015

2015-01-12T05:06:59Z

← Older revision		Revision as of 05:06, 12 January 2015
Line 33:		Line 33:
	<syntaxhighlight>		<syntaxhighlight>
	//Mood Name		//Mood Name
	cli_execute("mood ~~MoxieLeveing~~");		cli_execute("mood MoxieLeveling");
	cli_execute("mood clear");		cli_execute("mood clear");
	//Remove Poisons		//Remove Poisons

Eliteofdelete at 08:41, 11 January 2015

2015-01-11T08:41:18Z

← Older revision		Revision as of 08:41, 11 January 2015
Line 17:		Line 17:
	function_description=This function passes the parameter {{pspan\|command}} on to KoLmafia's CLI, which will execute it as if it were typed in through the normal interface. This function will return true if the CLI command executed properly, and false if it was unable to do so (for example, trying to execute an adventuring command while drunk). Though it's considered a "best practice" to use built-in ASH functions when possible, there are some instances (such as "maximize") where no ASH function exists to handle what needs to be done, and this function allows access to such commands from within an ASH script.\|		function_description=This function passes the parameter {{pspan\|command}} on to KoLmafia's CLI, which will execute it as if it were typed in through the normal interface. This function will return true if the CLI command executed properly, and false if it was unable to do so (for example, trying to execute an adventuring command while drunk). Though it's considered a "best practice" to use built-in ASH functions when possible, there are some instances (such as "maximize") where no ASH function exists to handle what needs to be done, and this function allows access to such commands from within an ASH script.\|

	~~code1~~={{CodeSample\|		code2={{CodeSample\|
	~~title=Code Samples\|~~
	description=This example maximizes your meat drop percentage and spends all of your adventures in the Castle\|		description=<br>This example maximizes your meat drop percentage and spends all of your adventures in the Castle\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
Line 26:		Line 26:
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

	~~code2~~={{CodeSample\|
	description=~~<br>~~A basic leveling mood setup using CLI Execute as ASH does not have anything similar.\|		code1={{CodeSample\|
			title=Code Samples\|
			description=A basic leveling mood setup using CLI Execute as ASH does not have anything similar.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
Line 62:		Line 64:
	</syntaxhighlight>\|		</syntaxhighlight>\|
	moreinfo=		moreinfo=
	Cli_execute is used most commonly for functions that do not have an ASH equivalent ~~like the above two examples~~. More CLI commands can be found ~~here (~~http://wiki.kolmafia.us/index.php?title=CLI_Reference) or typing "help" into the CLI window.		Cli_execute is used most commonly for functions that do not have an ASH equivalent. More CLI commands can be found [http://wiki.kolmafia.us/index.php?title=CLI_Reference here] or typing "help" into the CLI window.
	}}\|		}}\|

Eliteofdelete at 08:32, 11 January 2015

2015-01-11T08:32:59Z

← Older revision		Revision as of 08:32, 11 January 2015
Line 18:		Line 18:

	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code ~~Sample~~\|		title=Code Samples\|
	description=This example maximizes your meat drop percentage and spends all of your adventures in the Castle\|		description=This example maximizes your meat drop percentage and spends all of your adventures in the Castle\|
	code=		code=
Line 26:		Line 26:
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

	~~code1~~={{CodeSample\|		code2={{CodeSample\|
	~~title=Code Samples~~\|		description=<br>A basic leveling mood setup using CLI Execute as ASH does not have anything similar.\|
	description=A basic leveling mood setup using CLI Execute as ~~ash~~ does not have anything similar.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

Eliteofdelete at 08:26, 11 January 2015

2015-01-11T08:26:46Z

@@ Line 26: / Line 26: @@
 </syntaxhighlight>}}|
-improvecode=yes|
+code1={{CodeSample|
 cli_equiv=The function cli_execute() equivalents you!|

Bale at 05:30, 22 May 2010

2010-05-22T05:30:28Z

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

	function1={{Function\|		function1={{Function\|
Line 31:		Line 30:
	cli_equiv=The function cli_execute() equivalents you!\|		cli_equiv=The function cli_execute() equivalents you!\|
	}}		}}

			[[Category:Miscellaneous Functions]]

Heeheehee at 05:09, 9 April 2010

2010-04-09T05:09:06Z

← Older revision		Revision as of 05:09, 9 April 2010
Line 23:		Line 23:
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	cli_execute("maximize meat, switch ~~hobomonkey~~, -switch leprechaun");		cli_execute("maximize meat, switch hobo monkey, -switch leprechaun");
	adventure( my_adventures(), $location[Giant's Castle] );		adventure( my_adventures(), $location[Giant's Castle] );
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

	~~needscode~~=yes\|		improvecode=yes\|

	cli_equiv=The function cli_execute() equivalents you!\|		cli_equiv=The function cli_execute() equivalents you!\|
	}}		}}

Slyz: add code sample

2010-03-31T14:52:55Z

add code sample

← Older revision		Revision as of 14:52, 31 March 2010
Line 17:		Line 17:

	function_description=This function passes the parameter {{pspan\|command}} on to KoLmafia's CLI, which will execute it as if it were typed in through the normal interface. This function will return true if the CLI command executed properly, and false if it was unable to do so (for example, trying to execute an adventuring command while drunk). Though it's considered a "best practice" to use built-in ASH functions when possible, there are some instances (such as "maximize") where no ASH function exists to handle what needs to be done, and this function allows access to such commands from within an ASH script.\|		function_description=This function passes the parameter {{pspan\|command}} on to KoLmafia's CLI, which will execute it as if it were typed in through the normal interface. This function will return true if the CLI command executed properly, and false if it was unable to do so (for example, trying to execute an adventuring command while drunk). Though it's considered a "best practice" to use built-in ASH functions when possible, there are some instances (such as "maximize") where no ASH function exists to handle what needs to be done, and this function allows access to such commands from within an ASH script.\|

			code1={{CodeSample\|
			title=Code Sample\|
			description=This example maximizes your meat drop percentage and spends all of your adventures in the Castle\|
			code=
			<syntaxhighlight>
			cli_execute("maximize meat, switch hobomonkey, -switch leprechaun");
			adventure( my_adventures(), $location[Giant's Castle] );
			</syntaxhighlight>}}\|

	needscode=yes\|		needscode=yes\|

StDoodle at 23:37, 10 March 2010

2010-03-10T23:37:04Z

@@ Line 1: / Line 1: @@
-'''[[boolean]] cli_execute( [[string]] command )'''
+{{
-Executes the given command as a CLI command, rather than ASH.
+#vardefine:name|cli_execute}}{{
-<pre>
+FunctionPage|
-// snippet from my aftercore.ash script
+name={{#var:name}}|
-    cli_execute("outfit "+consumption_outfit);
+function_category=Miscellaneous|
-Note that you can speed things up (and possibly reduce the number of HTTP requests sent to KoL) by combining multiple requests in one command:
+function1={{Function|
-<pre>
+name={{#var:name}}|
-    # from bottom of above code...
+aggregate={{#var:aggregate}}|
-    if (switch_ode_polka)
+return_type={{#var:return_type}}|
+return_also={{#var:return_also}}|
-      cli_execute{
+parameter1={{Param|string|command}}|
-         uneffect ode to booze;
+p1desc={{Pspan|command}} is a cli command or commands to execute|
-         nuns;
+}}|
-</pre>
+function_description=This function passes the parameter {{pspan|command}} on to KoLmafia's CLI, which will execute it as if it were typed in through the normal interface. This function will return true if the CLI command executed properly, and false if it was unable to do so (for example, trying to execute an adventuring command while drunk). Though it's considered a "best practice" to use built-in ASH functions when possible, there are some instances (such as "maximize") where no ASH function exists to handle what needs to be done, and this function allows access to such commands from within an ASH script.|
-{{Format}}

StDoodle at 21:37, 8 March 2010

2010-03-08T21:37:10Z

← Older revision		Revision as of 21:37, 8 March 2010
Line 50:		Line 50:

	</pre>		</pre>
			{{Format}}