Adventuring: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Efilnikufecin
No edit summary
 
imported>Raeith
Copy/Paste with HTML formatting. Links to old wiki pages removed.
Line 1: Line 1:
== Part 5 - Adventuring ==
<p><em>Go get &#8216;em, tiger!</em></p>


Part 5 - Adventuring
<p><strong>boolean adventure( int visits, location place )</strong><br />
Visits the desired place the number of times that you wish.</p>


Go get ‘em, tiger!
<p><strong>void add_item_condition( int quantity, item it )</strong><br />
Specifies adventuring conditions.  With conditions in place, adventure(&#8230;) will successfully complete before using all the specified adventures if the conditions are all met.<br />
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for additional condition programming.</p>


boolean adventure( int visits, location place )
<p><strong>void council()</strong><br />
Visits the desired place the number of times that you wish.
Visits the Council of Loathing.</p>
Sample:Hedging


void add_item_condition( int quantity, item it )
<p><strong>item guardians()</strong><br />
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 CLI manual for additional condition programming.
Climbs the Naughty Sorceress&#8217; 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.</p>


void council()
<p><strong>boolean guild()<br />
Visits the Council of Loathing.
boolean gourd()<br />
boolean tavern()<br />
boolean nemesis()<br />
boolean entryway()<br />
boolean hedgemaze()<br />
boolean chamber()</strong><br />
Attempts to perform the associated tasks. The return value indicates the success.<br />
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details.</p>


item guardians()
<p><strong>boolean train_familiar( int nGoal, string sGoal )</strong><br />
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.
Trains your currently-equipped familiar.  sGoal can be either &#8220;base&#8221;, &#8220;buffed&#8221;, or &#8220;turns&#8221;, and nGoal is either the target weight or desired number of battles.</p>


boolean guild()
<p><strong>location my_location()</strong><br />
boolean gourd()
Returns the location where you last adventured. </p>
boolean tavern()
boolean nemesis()
boolean entryway()
boolean hedgemaze()
boolean chamber()
Attempts to perform the associated tasks. The return value indicates the success. See the CLI manual for more details.
Sample:Hedging


boolean train_familiar( int nGoal, string sGoal )
<p><strong>void refresh_status()</strong><br />
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.
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.</p>


location my_location()
<p><strong>monster [int] get_monsters( location loc )</strong><br />
Returns the location where you last adventured.
returns an integer indexed map of potential monsters in the given location.</p>


void refresh_status()
<p><strong>int monster_base_attack( monster eek )<br />
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.
int monster_base_defense( monster eek )<br />
int monster_base_hp( monster eek )</strong><br />
Returns the stats for the given monster. </p>


monster [int] get_monsters( location loc )
<p>spiceloop is a verified kolmafia ash function however the parameters and return type are speculation. This needs verified.<br />
returns an integer indexed map of potential monsters in the given location.
<strong>void spiceloop( int count )</strong><br />
 
Executes kolmafia&#8217;s internal spiceloop for the specified number of adventures.</p>
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.

Revision as of 03:58, 9 January 2007

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