Difference between revisions of "Miscellaneous Functions"
Jump to navigation
Jump to search
(Removed spam, restored data erased by spambot) |
|||
| Line 1: | Line 1: | ||
| − | + | == Part 7 - Miscellaneous == | |
| − | |||
<p><em>Mostly internal stuff. Some good for everyone, some only for ASH wizards.</em></p> | <p><em>Mostly internal stuff. Some good for everyone, some only for ASH wizards.</em></p> | ||
| − | <p><strong>void print( string | + | <p><strong>void print( string output )</strong><br /> |
| − | Prints | + | <strong>void print( string output, string color )</strong><br /> |
| + | Prints <i>output</i> to the CLI buffer and displays it in the status line of the main Adventuring window. If <i>color</i> is specified any HTML in <i>output</i> is escaped and the string is wrapped in a font tag before being printed.</p> | ||
<p><strong>boolean cli_execute( string command )</strong><br /> | <p><strong>boolean cli_execute( string command )</strong><br /> | ||
| − | Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you | + | Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you’re careful and not an asshat, for raw URLs.<br /> |
| + | See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details.<br /> | ||
| + | <em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]</p> | ||
| + | |||
| + | <p><strong>void wait( int delay )</strong><br /> | ||
| + | Sleeps for <i>delay</i> seconds.</p> | ||
| + | |||
| + | <p><strong>string get_property( string key )<br /> | ||
| + | boolean set_property( string key, string value )</strong><br /> | ||
| + | Gets or sets a stored property from your character’s .kcs file.<br /> | ||
| + | The KoLmafia [[%28ASHRM%29_KoLMafia_Properties|properties]] page contains details on many of the keys that are available for access.<br /> | ||
| + | <em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]</p> | ||
| + | |||
| + | <p><strong>boolean file_to_map( string file_to_load, map map_to_fill )<br /> | ||
| + | boolean map_to_file( map map_to_save, string file_to_write )</strong><br /> | ||
| + | Loads and saves maps as tab-delimited text files.</p> | ||
| + | |||
| + | <p><strong>int random( int range )</strong><br /> | ||
| + | Generates a random integer between 0 and (range-1) inclusive.</p> | ||
| + | |||
| + | <p><strong>int round( float ratio )<br /> | ||
| + | int floor( float ratio )<br /> | ||
| + | int ceil( float ratio )<br /> | ||
| + | int truncate( float ratio )</strong><br /> | ||
| + | Returns an integer near the given real number. Respectively, it returns the nearest, next lowest, next highest, and decimal-stripped integer.</p> | ||
| + | |||
| + | <p><strong>int count( map )</strong><br /> | ||
| + | Returns the number of defined keys for the aggregate.</p> | ||
| + | |||
| + | <p><strong>void clear( map )</strong><br /> | ||
| + | Remove all keys from a map. </p> | ||
| + | |||
| + | <p><strong>void disable( string function_name )<br /> | ||
| + | void enable( string function_name )</strong><br /> | ||
| + | For debugging purposes disables or enables the indicated function</p> | ||
| + | |||
| + | <p><strong>float square_root( float value )</strong><br /> | ||
| + | returns the square root of the passed value</p> | ||
| + | |||
| + | <p><strong>string today_to_string()</strong><br /> | ||
| + | Returns today’s (real-world) date in the form yyyymmdd. It is based on your computer’s system date</p> | ||
Revision as of 11:41, 12 November 2007
Part 7 - Miscellaneous
Mostly internal stuff. Some good for everyone, some only for ASH wizards.
void print( string output )
void print( string output, string color )
Prints output to the CLI buffer and displays it in the status line of the main Adventuring window. If color is specified any HTML in output is escaped and the string is wrapped in a font tag before being printed.
boolean cli_execute( string command )
Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you’re careful and not an asshat, for raw URLs.
See the CLI manual for more details.
Sample:Hedging
void wait( int delay )
Sleeps for delay seconds.
string get_property( string key )
boolean set_property( string key, string value )
Gets or sets a stored property from your character’s .kcs file.
The KoLmafia properties page contains details on many of the keys that are available for access.
Sample:Battlefield_gather
boolean file_to_map( string file_to_load, map map_to_fill )
boolean map_to_file( map map_to_save, string file_to_write )
Loads and saves maps as tab-delimited text files.
int random( int range )
Generates a random integer between 0 and (range-1) inclusive.
int round( float ratio )
int floor( float ratio )
int ceil( float ratio )
int truncate( float ratio )
Returns an integer near the given real number. Respectively, it returns the nearest, next lowest, next highest, and decimal-stripped integer.
int count( map )
Returns the number of defined keys for the aggregate.
void clear( map )
Remove all keys from a map.
void disable( string function_name )
void enable( string function_name )
For debugging purposes disables or enables the indicated function
float square_root( float value )
returns the square root of the passed value
string today_to_string()
Returns today’s (real-world) date in the form yyyymmdd. It is based on your computer’s system date