Cli execute: Difference between revisions
imported>Heeheehee mNo edit summary |
imported>Bale mNo edit summary |
||
Line 5: | Line 5: | ||
FunctionPage| | FunctionPage| | ||
name={{#var:name}}| | name={{#var:name}}| | ||
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]] |
Revision as of 05:30, 22 May 2010
Function Syntax
boolean cli_execute(string command )
- command is a cli command or commands to execute
This function passes the parameter 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.
Code Sample
This example maximizes your meat drop percentage and spends all of your adventures in the Castle
cli_execute("maximize meat, switch hobo monkey, -switch leprechaun");
adventure( my_adventures(), $location[Giant's Castle] );
CLI Equivalent
The function cli_execute() equivalents you!