Kolmafia - User contributions [en]

Miscellaneous Functions

2007-11-15T08:41:17Z

124.110.162.113: Removed spam

== 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 [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|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 [[%28ASHRM%29_KoLMafia_Properties|properties]] page contains details on many of the keys that are available for access. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|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

Adventuring

2007-11-15T08:40:06Z

124.110.162.113: Removed spam, restored data erased by spambot

== Part 5 - Adventuring ==
Go get ‘em, tiger!

boolean adventure( int visits, [[%28ASHRM%29_Datatype_Constants#.24location.5Bconstant.5D|location place]] ) 
Visits the desired place the number of times that you wish. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

void add_item_condition( int quantity, [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Specifies adventuring conditions. With conditions in place, adventure(…) will successfully complete before using all the specified adventures if the conditions are all met. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for additional condition programming.

void council() 
Visits the Council of Loathing.

item guardians() 
Climbs the Naughty Sorceress’ Tower and passes the challenges that it can. If it completes the challenge, it returns $item[none]. Otherwise, it returns the item that is needed to pass the next stage.

boolean guild() 
boolean gourd() 
int tavern() 
boolean nemesis() 
boolean entryway() 
boolean hedgemaze() 
boolean chamber() 
Attempts to perform the associated tasks. The return value indicates the success. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

boolean train_familiar( int nGoal, string sGoal ) 
Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target weight or desired number of battles.

location my_location() 
Returns the location where you last adventured. 

void refresh_status() 
Grabs a fresh copy of your sidebar, so that information on your health, effects, and such will be guaranteed accurate. In theory, this is not necessary unless you are attempting to script your own custom combat function.

monster [int] get_monsters( [[%28ASHRM%29_Datatype_Constants#.24location.5Bconstant.5D|location place]] ) 
returns an integer indexed map of potential monsters in the given location.

int monster_base_attack( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
int monster_base_defense( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
int monster_base_hp( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
Returns the stats for the given monster. 

spiceloop is a verified kolmafia ash function however the parameters and return type are speculation. This needs verified. 
void spiceloop( int count ) 
Executes kolmafia’s internal spiceloop for the specified number of adventures.

element monster_attack_element( monster ) 
element monster_defense_element( monster ) 
Returns the given monsters attack element and element which it can defend against.

Miscellaneous Functions

2007-11-12T11:41:10Z

124.110.162.113: Removed spam, restored data erased by spambot

In-combat Consulting

2007-11-12T11:39:30Z

124.110.162.113: Removed spam

== Part 6 - In-combat functions for consulting scripting ==
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.

string attack() 
string runaway() 
string use_skill( skill touse ) 
string throw_item( item tothrow ) 
string throw_items( item tothrow1, item tothrow2 ) 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

boolean use_skill( int count, skill touse ) 
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. 
See [[Skills and Effects]] 

element monster_attack_element() 
element monster_defense_element() 
returns the element that the monster attacks with, or defends against accordingly.

int monster_attack() 
int monster_defense() 
int monster_hp() 
returns the (current?) attack, defense, and hp of the monster.

boolean will_usually_miss() 
boolean will_usually_dodge() 
returns if you will normally miss, or will usually be missed in battle.

Adventuring

2007-11-12T11:38:40Z

124.110.162.113: Removed spam