Kolmafia - User contributions [en]

My meat

2007-01-17T06:36:04Z

Raeith: My meat Temp moved to My meat

int my_meat() 
Returns the amount of meat you currently have in your inventory. This does not include meat you have in Your Colossal Closet or Hagnk's storage.
 
 
 
The following sample checks to see if you have enough meat to buy a hermit Permit and if you do, it will buy one.
<code>
int a = my_meat();
if(a <= 100)
{
buy(1, $item[hermit permit]);
}
</code>

The following code does the same, but places my_meat in the if statement rather than storing it in a variable first.
<code>
if(my_meat() <= 100)
{
buy(1, $item[hermit permit]);
}
</code>

<Center>
<table style="width:80%;margin-top:+.7em;background-color:#F4DF3B;border:2px solid #8663A8">
<tr>
<td class="box_tgen" style="text-align:center;color:#000;font-size:90%;border:none;margin: 0;padding:.1em;">
'''See Also:''' [[my_closetmeat]] || [[item_amount]]</td>
</tr>
</table>
</Center>

My meat

2007-01-17T06:35:47Z

Raeith: My meat moved to My meat Temp

Miscellaneous Functions

2007-01-09T11:51:01Z

Raeith: My bad, turns out THIS one had lots of dataype links >_<

== Part 6 - 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 [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|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 [[%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]]

string boolean_to_string( boolean flag ) 
string int_to_string( int number ) 
string float_to_string( float number ) 
string item_to_string( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
string zodiac_to_string( [[%28ASHRM%29_Dataype_Constants#.24zodiac.5Bconstant.5D|zodiac sign]] ) 
string location_to_string( [[%28ASHRM%29_Dataype_Constants#.24location.5Bconstant.5D|location place]] ) 
string familiar_to_string( [[%28ASHRM%29_Dataype_Constants#.24class.5Bconstant.5D|class cl]] ) 
string class_to_string( [[%28ASHRM%29_Dataype_Constants#.24class.5Bconstant.5D|class cl]] ) 
string stat_to_string( [[%28ASHRM%29_Dataype_Constants#.24stat.5Bconstant.5D|stat st]] ) 
string skill_to_string( [[%28ASHRM%29_Dataype_Constants#.24skill.5Bconstant.5D|skill sk]] ) 
string effect_to_string( [[%28ASHRM%29_Dataype_Constants#.24effect.5Bconstant.5D|effect ef]] ) 
string element_to_string( element el ) 
string slot_to_string( [[%28ASHRM%29_Dataype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
string monster_to_string( [[%28ASHRM%29_Dataype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties.

boolean string_to_boolean( string str ) 
int string_to_int( string str ) 
float string_to_float( string str ) 
item string_to_item( string str ) 
zodiac string_to_zodiac( string str ) 
location string_to_location( string str ) 
familiar string_to_familiar( string str ) 
class string_to_class( string str ) 
stat string_to_stat( string str ) 
skill string_to_skill( string str ) 
effect string_to_effect( string str ) 
slot string_to_slot( string str ) 
element string_to_element( string str ) 
monster string_to_monster( string str ) 
Converts strings to ASH variables. Useful for converting the result of a get_property() call intoa legitimate value.

int item_to_int( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
int skill_to_int ( [[%28ASHRM%29_Dataype_Constants#.24skill.5Bconstant.5D|skill sk]] ) 
int effect_to_int ( [[%28ASHRM%29_Dataype_Constants#.24effect.5Bconstant.5D|effect ef]]f ) 
int familiar_to_int ( [[%28ASHRM%29_Dataype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
int slot_to_int ( [[%28ASHRM%29_Dataype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
int element_to_int ( element el ) 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you’re building raw URLs from time to time.

item int_to_item( int nItem ) 
skill int_to_skill ( int nSkill ) 
effect int_to_effect ( int nEffect ) 
familiar int_to_familiar ( int nFamiliar ) 
slot int_to_slot ( int nSlot ) 
element int_to_element ( int nElement ) 
Converts the KoL-based number into an associated ASH object. These aren’t the commands you’re looking for. You can go about your business.

void file_to_map( string file_to_load, map map_to_fill ) 
void 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

Equipment

2007-01-09T11:42:16Z

Raeith: Sooo many datatype links >_<.

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean unequip( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Takes off one of the specified item.

boolean equip_slot( [[%28ASHRM%29_Dataype_Constants#.24slot.5Bconstant.5D|slot sl]], [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
boolean unequip_slot( [[%28ASHRM%29_Dataype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Equipment management that targets a specific slot.

slot item_to_slot( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Returns the natural slot for the item, if it is equippable.

item current_equipment( [[%28ASHRM%29_Dataype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Returns the item currently equipped in the given slot. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean have_equipped( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean ranged_weapon( [[%28ASHRM%29_Dataype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( [[%28ASHRM%29_Dataype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean equip_familiar( [[%28ASHRM%29_Dataype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( [[%28ASHRM%29_Dataype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check current_equipment( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

Adventuring

2007-01-09T11:36:08Z

Raeith: Linking the datatypes to the respective section on the datatype page.

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

boolean adventure( int visits, [[%28ASHRM%29_Dataype_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_Dataype_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() 
boolean 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_Dataype_Constants#.24location.5Bconstant.5D|location place]] ) 
returns an integer indexed map of potential monsters in the given location.

int monster_base_attack( [[%28ASHRM%29_Dataype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
int monster_base_defense( [[%28ASHRM%29_Dataype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
int monster_base_hp( [[%28ASHRM%29_Dataype_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.

Adventuring

2007-01-09T10:53:52Z

Raeith: Internal link fixing.

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

boolean adventure( int visits, 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, 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() 
boolean 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( location loc ) 
returns an integer indexed map of potential monsters in the given location.

int monster_base_attack( monster eek ) 
int monster_base_defense( monster eek ) 
int monster_base_hp( 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.

Equipment

2007-01-09T10:51:47Z

Raeith: /* Part 3 - Equipment */

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( item it ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean unequip( item it ) 
Takes off one of the specified item.

boolean equip_slot( slot sl, item it ) 
boolean unequip_slot( slot sl ) 
Equipment management that targets a specific slot.

slot item_to_slot( item it ) 
Returns the natural slot for the item, if it is equippable.

item current_equipment( slot sl ) 
Returns the item currently equipped in the given slot. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean have_equipped( item it ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( item it ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( item ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( item it ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean ranged_weapon( item it ) 
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( familiar pet ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean equip_familiar( familiar pet ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( familiar pet ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check current_equipment( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

Miscellaneous Functions

2007-01-09T10:38:11Z

Raeith: Changed internal linkage to proper wiki format.

== Part 6 - 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 [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|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 [[%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]]

string boolean_to_string( boolean flag ) 
string int_to_string( int number ) 
string float_to_string( float number ) 
string item_to_string( item it ) 
string zodiac_to_string( zodiac sign ) 
string location_to_string( location place ) 
string familiar_to_string( class cl ) 
string class_to_string( class cl ) 
string stat_to_string( stat st ) 
string skill_to_string( skill sk ) 
string effect_to_string( effect ef ) 
string element_to_string( element el ) 
string slot_to_string( slot sl ) 
string monster_to_string( monster eek ) 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties.

boolean string_to_boolean( string str ) 
int string_to_int( string str ) 
float string_to_float( string str ) 
item string_to_item( string str ) 
zodiac string_to_zodiac( string str ) 
location string_to_location( string str ) 
familiar string_to_familiar( string str ) 
class string_to_class( string str ) 
stat string_to_stat( string str ) 
skill string_to_skill( string str ) 
effect string_to_effect( string str ) 
slot string_to_slot( string str ) 
element string_to_element( string str ) 
monster string_to_monster( string str ) 
Converts strings to ASH variables. Useful for converting the result of a get_property() call intoa legitimate value.

int item_to_int( item it ) 
int skill_to_int ( skill sk ) 
int effect_to_int ( effect eff ) 
int familiar_to_int ( familiar pet ) 
int slot_to_int ( slot sl ) 
int element_to_int ( element el ) 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you’re building raw URLs from time to time.

item int_to_item( int nItem ) 
skill int_to_skill ( int nSkill ) 
effect int_to_effect ( int nEffect ) 
familiar int_to_familiar ( int nFamiliar ) 
slot int_to_slot ( int nSlot ) 
element int_to_element ( int nElement ) 
Converts the KoL-based number into an associated ASH object. These aren’t the commands you’re looking for. You can go about your business.

void file_to_map( string file_to_load, map map_to_fill ) 
void 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

In-combat Consulting

2007-01-09T10:17:46Z

Raeith:

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 [[%28ASHRM%29_Skills_and_Effects]]

Miscellaneous Functions

2007-01-09T04:48:35Z

Raeith: "Sample" linkys

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

string boolean_to_string( boolean flag ) 
string int_to_string( int number ) 
string float_to_string( float number ) 
string item_to_string( item it ) 
string zodiac_to_string( zodiac sign ) 
string location_to_string( location place ) 
string familiar_to_string( class cl ) 
string class_to_string( class cl ) 
string stat_to_string( stat st ) 
string skill_to_string( skill sk ) 
string effect_to_string( effect ef ) 
string element_to_string( element el ) 
string slot_to_string( slot sl ) 
string monster_to_string( monster eek ) 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties.

boolean string_to_boolean( string str ) 
int string_to_int( string str ) 
float string_to_float( string str ) 
item string_to_item( string str ) 
zodiac string_to_zodiac( string str ) 
location string_to_location( string str ) 
familiar string_to_familiar( string str ) 
class string_to_class( string str ) 
stat string_to_stat( string str ) 
skill string_to_skill( string str ) 
effect string_to_effect( string str ) 
slot string_to_slot( string str ) 
element string_to_element( string str ) 
monster string_to_monster( string str ) 
Converts strings to ASH variables. Useful for converting the result of a get_property() call intoa legitimate value.

int item_to_int( item it ) 
int skill_to_int ( skill sk ) 
int effect_to_int ( effect eff ) 
int familiar_to_int ( familiar pet ) 
int slot_to_int ( slot sl ) 
int element_to_int ( element el ) 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you’re building raw URLs from time to time.

item int_to_item( int nItem ) 
skill int_to_skill ( int nSkill ) 
effect int_to_effect ( int nEffect ) 
familiar int_to_familiar ( int nFamiliar ) 
slot int_to_slot ( int nSlot ) 
element int_to_element ( int nElement ) 
Converts the KoL-based number into an associated ASH object. These aren’t the commands you’re looking for. You can go about your business.

void file_to_map( string file_to_load, map map_to_fill ) 
void 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

Adventuring

2007-01-09T04:45:45Z

Raeith: More "sample" linking for you.

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

boolean adventure( int visits, location place ) 
Visits the desired place the number of times that you wish. 
Sample:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_4:_Hedging Hedging]

void add_item_condition( int quantity, 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() 
boolean 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:[http://www.wiki.kolmafia.us/index.php/%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( location loc ) 
returns an integer indexed map of potential monsters in the given location.

int monster_base_attack( monster eek ) 
int monster_base_defense( monster eek ) 
int monster_base_hp( 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.

Equipment

2007-01-09T04:39:15Z

Raeith: Gotta love Sample Links

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( item it ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean unequip( item it ) 
Takes off one of the specified item.

boolean equip_slot( slot sl, item it ) 
boolean unequip_slot( slot sl ) 
Equipment management that targets a specific slot.

slot item_to_slot( item it ) 
Returns the natural slot for the item, if it is equippable.

item current_equipment( slot sl ) 
Returns the item currently equipped in the given slot. 
Sample:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather Battlefield_gather]

boolean have_equipped( item it ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( item it ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( item ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( item it ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather Battlefield_gather]

boolean ranged_weapon( item it ) 
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( familiar pet ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean equip_familiar( familiar pet ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( familiar pet ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check current_equipment( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_1:_Seltzer Seltzer]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather Battlefield_gather]

Miscellaneous Functions

2007-01-09T04:06:29Z

Raeith:

== Part 6 - 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 [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details.

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 [http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_KoLMafia_Properties properties] page contains details on many of the keys that are available for access.

string boolean_to_string( boolean flag ) 
string int_to_string( int number ) 
string float_to_string( float number ) 
string item_to_string( item it ) 
string zodiac_to_string( zodiac sign ) 
string location_to_string( location place ) 
string familiar_to_string( class cl ) 
string class_to_string( class cl ) 
string stat_to_string( stat st ) 
string skill_to_string( skill sk ) 
string effect_to_string( effect ef ) 
string element_to_string( element el ) 
string slot_to_string( slot sl ) 
string monster_to_string( monster eek ) 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties.

boolean string_to_boolean( string str ) 
int string_to_int( string str ) 
float string_to_float( string str ) 
item string_to_item( string str ) 
zodiac string_to_zodiac( string str ) 
location string_to_location( string str ) 
familiar string_to_familiar( string str ) 
class string_to_class( string str ) 
stat string_to_stat( string str ) 
skill string_to_skill( string str ) 
effect string_to_effect( string str ) 
slot string_to_slot( string str ) 
element string_to_element( string str ) 
monster string_to_monster( string str ) 
Converts strings to ASH variables. Useful for converting the result of a get_property() call intoa legitimate value.

int item_to_int( item it ) 
int skill_to_int ( skill sk ) 
int effect_to_int ( effect eff ) 
int familiar_to_int ( familiar pet ) 
int slot_to_int ( slot sl ) 
int element_to_int ( element el ) 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you’re building raw URLs from time to time.

item int_to_item( int nItem ) 
skill int_to_skill ( int nSkill ) 
effect int_to_effect ( int nEffect ) 
familiar int_to_familiar ( int nFamiliar ) 
slot int_to_slot ( int nSlot ) 
element int_to_element ( int nElement ) 
Converts the KoL-based number into an associated ASH object. These aren’t the commands you’re looking for. You can go about your business.

void file_to_map( string file_to_load, map map_to_fill ) 
void 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

Adventuring

2007-01-09T03:58:34Z

Raeith: Copy/Paste with HTML formatting. Links to old wiki pages removed.

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

boolean adventure( int visits, location place ) 
Visits the desired place the number of times that you wish.

void add_item_condition( int quantity, 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() 
boolean 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.

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( location loc ) 
returns an integer indexed map of potential monsters in the given location.

int monster_base_attack( monster eek ) 
int monster_base_defense( monster eek ) 
int monster_base_hp( 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.

Equipment

2007-01-09T03:47:37Z

Raeith: Copy/Paste with HTML formatting. Links removed.

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( item it ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean unequip( item it ) 
Takes off one of the specified item.

boolean equip_slot( slot sl, item it ) 
boolean unequip_slot( slot sl ) 
Equipment management that targets a specific slot.

slot item_to_slot( item it ) 
Returns the natural slot for the item, if it is equippable.

item current_equipment( slot sl ) 
Returns the item currently equipped in the given slot.

boolean have_equipped( item it ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( item it ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( item ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( item it ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2.

boolean ranged_weapon( item it ) 
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( familiar pet ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean equip_familiar( familiar pet ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( familiar pet ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check current_equipment( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces.

boolean outfit( string outfit_name ) 
Wears the specified outfit.