Kolmafia - User contributions [en]

Equipment

2007-07-22T07:54:46Z

67.170.82.213: Corrected function name: was have_familiar(...) -> is actually use_familiar(...)

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

boolean equip( [[%28ASHRM%29_Datatype_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_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Takes off one of the specified item.

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

item current_equipment( [[%28ASHRM%29_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean use_familiar( [[%28ASHRM%29_Datatype_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_Datatype_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-07-22T07:33:49Z

67.170.82.213: Fixed multiple link typos: "Dataype" -> "Datatype"

== 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.

Equipment

2007-07-22T07:26:05Z

67.170.82.213: Fixed multiple link typos: "Dataype" -> "Datatype"

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

boolean equip( [[%28ASHRM%29_Datatype_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_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Takes off one of the specified item.

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

item current_equipment( [[%28ASHRM%29_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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_Datatype_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]]

Miscellaneous Functions

2007-07-22T02:31:17Z

67.170.82.213: revert

== 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]]

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

Main Page

2007-07-07T13:52:39Z

67.170.82.213: revert, removing spam

<center>
Welcome to the KoLmafia Wiki.

Please pardon our dust while we remodel. 
'''Progress level: [[Special:Statistics|{{NUMBEROFARTICLES}}]]'''

<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;">
'''Quick Links:''' [[Your Character]] || [[Item Management]] || [[Equipment]] || [[Skills and Effects]] || [[Adventuring]] || [[In-combat functions for consult scripting]] || [[Miscellaneous]] || [[String Handling Routines]] || [[Datatype Constants]] || [[Datatype Conversions]] || [[KoLmafia Properties]] || [[Code Samples]]</td>
</tr>
</table>

== Helpful Links ==

KoLMafia:

[http://kolmafia.sourceforge.net Download KoLMafia]

[http://kolmafia.sourceforge.net/manual.html KoLMafia Documentation]

[http://kolmafia.sourceforge.net/scripting.html CLI Scripting Manual]

[http://kolmafia.sourceforge.net/advanced.html ASH Scripting Manual]

[http://kolmafia.sourceforge.net/combat.html Custom Combat Scripting Manual]

[http://www.kolmafia.us The KoLMafia Script Repository]

[http://forums.kingdomofloathing.com/viewtopic.php?t=19779 The KoLMafia thread on the KoL Forums]

KoL:

[http://www.kingdomofloathing.com/ The Kingdom of Loathing]

[http://forums.kingdomofloathing.com/ KoL Forums]