Kolmafia - User contributions [en]

Miscellaneous Functions

2007-10-28T18:33:28Z

Gxc:

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

In-combat Consulting

2007-10-28T18:32:20Z

Gxc:

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

Adventuring

2007-10-28T18:32:03Z

Gxc:

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

Main Page

2007-10-28T18:31:22Z

Gxc:

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/vb/showthread.php?t=88408 The KoLMafia thread on the KoL Forums]

KoL:

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

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