Difference between revisions of "Miscellaneous Functions"

From Kolmafia
Jump to navigation Jump to search
imported>ZammyWarrior
imported>ZammyWarrior
Line 1: Line 1:
−
== Part 6 - In-combat functions for consulting scripting ==
+
== Part 7 - Miscellaneous ==
−
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.
+
<p><em>Mostly internal stuff. Some good for everyone, some only for ASH wizards.</em></p>
  
−
<p><strong>string attack()</strong><br />
+
<p><strong>void print( string helloworld )</strong><br />
−
<strong>string runaway()</strong><br />
+
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window</p>
−
<strong>string use_skill(  skill touse )</strong><br />
 
−
<strong>string throw_item(  item tothrow )</strong><br />
 
−
<strong>string throw_items(  item tothrow1,  item tothrow2 )</strong><br />
 
−
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.</p>
 
  
−
<p><strong>boolean use_skill( int count, skill touse )</strong><br />
+
<p><strong>boolean cli_execute( string command )</strong><br />
−
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle.<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&#8217;re careful and not an asshat, for raw URLs.<br />
−
See [[Skills and Effects]]<br /></p>
+
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>element monster_attack_element()</strong><br />
+
<p><strong>void wait( int delay )</strong><br />
−
<strong>element monster_defense_element()</strong><br />
+
Does nothing for the desired number of seconds.</p>
−
Returns the element that the monster attacks with, or defends against accordingly.</p>
 
  
−
<p><strong>int monster_attack()</strong><br />
+
<p><strong>string get_property( string key )<br />
−
<strong>int monster_defense()</strong><br />
+
boolean set_property( string key, string value )</strong><br />
−
<strong>int monster_hp()</strong><br />
+
Gets or sets a stored property from your character&#8217;s .kcs file.<br />
−
returns the (current?) attack, defense, and hp of the monster.</p>
+
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 will_usually_miss()</strong><br />
+
<p><strong>boolean file_to_map( string file_to_load, map map_to_fill )<br />
−
<strong>boolean will_usually_dodge()</strong><br />
+
boolean map_to_file( map map_to_save, string file_to_write )</strong><br />
−
Returns if you will normally miss, or will usually be missed in battle.</p>
+
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&#8217;s (real-world) date in the form yyyymmdd. It is based on your computer&#8217;s system date</p>

Revision as of 20:49, 9 September 2007

Part 7 - Miscellaneous

Mostly internal stuff. Some good for everyone, some only for ASH wizards.

void print( string helloworld )
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window

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 )
Does nothing for the desired number of 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

Retrieved from "https://wiki.kolmafia.us/index.php?title=Miscellaneous_Functions&oldid=958"