Adventuring: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>RacboCricc
mNo edit summary
Ikzann (talk | contribs)
 
(83 intermediate revisions by 33 users not shown)
Line 1: Line 1:
[http://wiadomo.apodoses.info/ wiadomo] [http://dect311cordless.apodoses.info/ dect 311 cordless] [http://joncena.unrust.info/ jon cena] [http://nightgilda.overhit.info/ night gilda] [http://episomes.info/articles/louvreremix.html louvre remix] [http://epsonstylus.unrust.info/ epson stylus 5000] [http://governmentgrants.unrust.info/ government grants] [http://everybodychaing.overhit.info/ everybody chaing] [http://gpstomtomgo.overhit.info/ gps tom tom go 300] [http://dragonballzporno.overhit.info/ dragonball z porno] [http://des1008d.anywhy.info/ des 1008d] [http://forswear.info/blog/cybershotdscs90.html cyber shot dsc s90] [http://works.overhit.info/ works] [http://episomes.info/articles/nuevaesparta.html nueva esparta] [http://missmark.info/topic/avl109.html avl 109] [http://baywath.anywhy.info/ baywath] [http://zdnet.anywhy.info/ zdnet] [http://forswear.info/blog/omniviewsoho.html omniview soho] [http://nokia6680blue.overhit.info/ nokia 6680 blue] [http://dhoomdhoom.apodoses.info/ dhoom dhoom] [http://jacinthe.info/html/dfg.html dfg] [http://step.overhit.info/ step] [http://nuovafaor.overhit.info/ nuova faor] [http://forswear.info/blog/grandprix.html grand prix] [http://jacinthe.info/html/schramberg.html schramberg] [http://anywhy.info/index7_1000.html page] [http://thaeter.anywhy.info/ thaeter] [http://episomes.info/articles/minerva.html minerva] [http://nece228.overhit.info/ nec e228] [http://sonydsct3s.unrust.info/ sony dsc t3 s] [http://jbc.apodoses.info/ jbc] [http://missmark.info/ missmark.info] [http://galbusera.overhit.info/ galbusera] [http://throughtherain.anywhy.info/ through the rain] [http://dasy.apodoses.info/ dasy] [http://jacinthe.info/html/hengchun.html hengchun] [http://episomes.info/articles/sonylcs.html sony lcs] [http://anywhy.info/index6_1000.html url] [http://missmark.info/topic/alberghiragusa.html alberghi ragusa] [http://lindseylohan.geratic.info/ lindsey lohan] [http://jacinthe.info/html/neonjohnmayer.html neon john mayer] [http://tagetes.unrust.info/ tagetes] [http://missmark.info/topic/dondesem.html don desem] [http://olympusc310.geratic.info/ olympus c 310] [http://nuovaalpesrl.overhit.info/ nuova alpe srl] [http://species2.geratic.info/ species 2] [http://anywhy.info/ anywhy.info] [http://barbeq.anywhy.info/ barbeq] [http://palmas.anywhy.info/ palmas] [http://chuckie.apodoses.info/ chuckie] [http://geratic.info/index3_250.html map] [http://m40x243.overhit.info/ m40x 243] [http://forswear.info/blog/asusgprs.html asus gprs] [http://ladysoul.anywhy.info/ lady soul] [http://benidorm.overhit.info/ benidorm] [http://hexfiles.apodoses.info/ hexfiles] [http://jacinthe.info/html/benqduallayer.html benq dual layer] [http://poema.anywhy.info/ poema] [http://episomes.info/articles/v535blue.html v535 blue] [http://jacinthe.info/html/ilve.html ilve] [http://wwwstupidvideos.apodoses.info/ www stupidvideos com] [http://kiplang.unrust.info/ kip lang] [http://technomixtheclubs.overhit.info/ techno mix the clubs] [http://sennheisercuffie.geratic.info/ sennheiser cuffie] [http://tepic.anywhy.info/ tepic] [http://sophiemarceau.anywhy.info/ sophie marceau nuda] [http://forswear.info/blog/tubogomma.html tubo gomma] [http://apodoses.info/ apodoses.info] [http://missmark.info/topic/globoeasyfax.html globo easy fax] [http://gunsnrose.anywhy.info/ guns n rose] [http://episomes.info/articles/fauno.html fauno] [http://forswear.info/blog/importexportprofumi.html import export profumi] [http://episomes.info/articles/charlot.html charlot] [http://lincubo.anywhy.info/ lincubo] [http://tonyhawkunderground.apodoses.info/ tony hawk underground 2] [http://tpssat.geratic.info/ tps sat] [http://episomes.info/articles/barmix.html barmix] [http://temadroga.geratic.info/ tema droga] [http://cartransport.unrust.info/ car transport] [http://wwfarcade.overhit.info/ wwf arcade] [http://rextoncar.overhit.info/ rexton car] [http://jacinthe.info/html/klister.html klister] [http://forswear.info/blog/visualfoxpro.html visual foxpro 6 0] [http://forswear.info/blog/pst.html pst] [http://overhit.info/ overhit.info] [http://missmark.info/topic/trustwireless.html trust wireless] [http://nokia2300grey.geratic.info/ nokia 2300 grey] [http://forswear.info/blog/steppenwolf.html steppenwolf] [http://jacinthe.info/html/mauropalmas.html mauro palmas] [http://hamina.unrust.info/ hamina] [http://tda.overhit.info/ tda] [http://tuvuoidamequalcosa.geratic.info/ tu vuoi da me qualcosa] [http://bipowerauto.apodoses.info/ bipower auto] [http://jacinthe.info/html/googoodollsiris.html goo goo dolls iris mp3] [http://eippcbjrc.overhit.info/ eippcb jrc] [http://missmark.info/ missmark.info] [http://rampc800.geratic.info/ ram pc800] [http://epsons020010.geratic.info/ epson s020010] [http://xeroxpe120.overhit.info/ xerox pe120] [http://episomes.info/articles/globalexpres.html global expres]
{{TOCright}}
== Part 5 - Adventuring ==
==General Adventuring==
<p><em>Go get &#8216;em, tiger!</em></p>
{{Flink|boolean| adventure|int|location|desc=Visits the desired location the the desired number of times.}}
{{Flink|boolean| adventure|int|location|string|desc=Visits the desired location a specified number of times, using a combat filter function defined elsewhere in your script.}}
{{Flink|boolean| adv1|location|int|string|desc=Adventure exactly once in the specified location (even if it uses no turns). Chained choice adventures '''are''' followed. Int overrides default settings, and string is a filter, same as in [[adventure|adventure()]]}}
{{FunctionEmbed|visit_url|format=signature|desc=yes}}
{{Flink|string|get_counters|string|int|int|desc=Determine if a counter will expire in a specified
period of time.}}
{{Flink|void|council|desc=Visits the Council of Loathing.}}
{{Flink|item|guardians|desc=Climbs the Naughty Sorceress' Tower and passes the challenges it can, returning the first item needed to pass a failed stage.}}
{{Flink|int|tavern|desc=Attempt to complete the tavern, and returns the number of squares visited}}
{{Flink|boolean|entryway}}
{{Flink|boolean|hedgemaze}}
{{Flink|boolean|chamber|desc=These three functions attempt to perform the associated tasks. The return value indicates the success.}}
{{Flink|location|my_location|desc=Returns the location where you last adventured.}}
{{Flink|void|set_location|location|desc=Changes the value returned by my_location().}}
{{Flink|void|refresh_status|desc=Refreshes the side-pane character info (health, effects, etc.).}}
{{Flink|buffer|run_combat|desc=Uses the current KoLmafia settings to run a combat (for use with [[visit_url|visit_url()]]).}}
{{Flink|buffer|run_choice|desc=Chooses an option in the current choice adventure.}}
{{Flink|buffer|run_turn|desc=Works as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.}}
{{Flink|boolean|change_mcd|int|desc=Tries to set your +ML device to a specified setting and reports on success.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items.}}
==Goals and Conditions==
{{FunctionEmbed|add_item_condition|format=signature|desc=yes}}
{{Flink|string [int]|get_goals|desc=Lists all current goals.}}
{{Flink|boolean| is_goal|item|desc=Checks if a given item is a goal.}}
{{Flink|boolean|goal_exists|string|desc=Checks if there is currently a given type of goal.}}
{{Flink|void| remove_item_condition|int|item|desc=Removes adventuring conditions.}}
==About Monsters==
For all of the below functions that accept an optional monster parameter, the default value is your most recently-encountered monster (that means your current monster if you're in combat).


<p><strong>boolean adventure( int visits, [[%28ASHRM%29_Datatype_Constants#.24location.5Bconstant.5D|location place]] )</strong><br />
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
Visits the desired place the number of times that you wish.<br />
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}|desc=Returns the chance of successfully getting the jump against the monster or in the location.}}
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]</p>
{{Flink|monster|last_monster|desc=Returns last monster encountered.}}
{{Flink|monster [int]|get_monsters|location|desc=Returns a map of potential monsters at a given location.}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}|desc=Returns a map of the expected frequency of each monster at the specified location.}}
{{Flink|int|monster_attack|{{opt|monster}}|desc=Returns the starting/current attack value of the specified monster.}}
{{Flink|int|monster_defense|{{opt|monster}}|desc=Returns the starting/current defense value of the specified monster.}}
{{Flink|int|monster_hp|{{opt|monster}}|desc=Returns the starting/current HP of the specified monster.}}
{{Flink|int|monster_initiative|{{opt|monster}}|desc=Returns the starting/current initiative of the specified monster.}}
{{Flink|phylum|monster_phylum|{{opt|monster}}|desc=Returns the phylum of the specified monster.}}
{{Flink|int|expected_damage|{{opt|monster}}|desc=Returns the amount of damage you are expected to take each round from the specified monster.}}
{{Flink|element|monster_element|{{opt|monster}}|desc=Returns the elemental alignment of the specified monster.}}
{{Flink|monster|image_to_monster|string|desc=Looks up monster by image name.}}
{{Flink|boolean|is_banished|monster|desc=Returns true if the specified monster is banished}}


<p><strong>void add_item_condition( int quantity, [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
==Choice Adventures==
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 />
{{FunctionEmbed|available_choice_options|format=signature|desc=yes}}
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for additional condition programming.</p>
{{flink|boolean|choice_follows_fight|desc=Returns <code>true</code> if the last finished combat is about to lead into a choice adventure.}}
{{flink|boolean|handling_choice|desc=Returns <code>true</code> if you are currently in a choice.}}
{{flink|int|last_choice|desc=Returns the ID of the current (or last) choice adventure you encountered.}}
{{FunctionEmbed|run_choice|format=signature|desc=yes}}


<p><strong>void council()</strong><br />
==Misc.==
Visits the Council of Loathing.</p>
{{Flink|int|get_auto_attack|desc=Returns your current auto-attack setting.}}
 
{{Flink|void|set_auto_attack|int|desc=Sets your auto-attack setting.}}
<p><strong>item guardians()</strong><br />
{{Flink|boolean|set_ccs|string|desc=Sets your custom combat script.}}
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>
{{Flink|buffer|read_ccs|string|desc=Reads the text of your custom combat script.}}
 
{{Flink|boolean|write_ccs|buffer|string|desc=Writes the text of your custom combat script.}}
<p><strong>boolean guild()<br />
[[Category:Scripting]]
boolean gourd()<br />
int 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.<br />
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]</p>
 
<p><strong>boolean train_familiar( int nGoal, string sGoal )</strong><br />
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>
 
<p><strong>location my_location()</strong><br />
Returns the location where you last adventured.  </p>
 
<p><strong>void refresh_status()</strong><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.</p>
 
<p><strong>monster [int] get_monsters( [[%28ASHRM%29_Datatype_Constants#.24location.5Bconstant.5D|location place]] )</strong><br />
returns an integer indexed map of potential monsters in the given location.</p>
 
<p><strong>int monster_base_attack( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] )<br />
int monster_base_defense( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] )<br />
int monster_base_hp( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] )</strong><br />
Returns the stats for the given monster.  </p>
 
<p>spiceloop is a verified kolmafia ash function however the parameters and return type are speculation. This needs verified.<br />
<strong>void spiceloop( int count )</strong><br />
Executes kolmafia&#8217;s internal spiceloop for the specified number of adventures.</p>
 
<strong>element monster_attack_element( monster )</strong><br />
<strong>element monster_defense_element( monster )</strong><br />
Returns the given monsters attack element and element which it can defend against.

Latest revision as of 00:02, 9 January 2023

General Adventuring

boolean  adventure( int, location )

Visits the desired location the the desired number of times.

boolean  adventure( int, location, string )

Visits the desired location a specified number of times, using a combat filter function defined elsewhere in your script.

boolean  adv1( location, int, string )

Adventure exactly once in the specified location (even if it uses no turns). Chained choice adventures are followed. Int overrides default settings, and string is a filter, same as in adventure()

buffer visit_url()

Returns the original HTML source of the page being overridden inside a relay override script.

buffer visit_urlstring, boolean?, boolean? )

Visits a web page and returns its HTML source.

string get_counters( string, int, int )

Determine if a counter will expire in a specified period of time.

void council()

Visits the Council of Loathing.

item guardians()

Climbs the Naughty Sorceress' Tower and passes the challenges it can, returning the first item needed to pass a failed stage.

int tavern()

Attempt to complete the tavern, and returns the number of squares visited

boolean entryway()

boolean hedgemaze()

boolean chamber()

These three functions attempt to perform the associated tasks. The return value indicates the success.

location my_location()

Returns the location where you last adventured.

void set_location( location )

Changes the value returned by my_location().

void refresh_status()

Refreshes the side-pane character info (health, effects, etc.).

buffer run_combat()

Uses the current KoLmafia settings to run a combat (for use with visit_url()).

buffer run_choice()

Chooses an option in the current choice adventure.

buffer run_turn()

Works as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

boolean change_mcd( int )

Tries to set your +ML device to a specified setting and reports on success.

boolean hermit( int, item )

Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items.

Goals and Conditions

void add_item_conditionint, item )

void add_item_conditionitem, int )

Adds a number of the given item to the current auto-adventuring conditions.

string [int] get_goals()

Lists all current goals.

boolean  is_goal( item )

Checks if a given item is a goal.

boolean goal_exists( string )

Checks if there is currently a given type of goal.

void  remove_item_condition( int, item )

Removes adventuring conditions.

About Monsters

For all of the below functions that accept an optional monster parameter, the default value is your most recently-encountered monster (that means your current monster if you're in combat).

int jump_chance( [monster], [int], [int] )

int jump_chance( location, [int], [int] )

Returns the chance of successfully getting the jump against the monster or in the location.

monster last_monster()

Returns last monster encountered.

monster [int] get_monsters( location )

Returns a map of potential monsters at a given location.

float [monster] appearance_rates( location, [boolean] )

Returns a map of the expected frequency of each monster at the specified location.

int monster_attack( [monster] )

Returns the starting/current attack value of the specified monster.

int monster_defense( [monster] )

Returns the starting/current defense value of the specified monster.

int monster_hp( [monster] )

Returns the starting/current HP of the specified monster.

int monster_initiative( [monster] )

Returns the starting/current initiative of the specified monster.

phylum monster_phylum( [monster] )

Returns the phylum of the specified monster.

int expected_damage( [monster] )

Returns the amount of damage you are expected to take each round from the specified monster.

element monster_element( [monster] )

Returns the elemental alignment of the specified monster.

monster image_to_monster( string )

Looks up monster by image name.

boolean is_banished( monster )

Returns true if the specified monster is banished


Choice Adventures

string [int] available_choice_optionsboolean? )

Returns all available choice options in the current (or last) choice adventure the player encountered.

boolean choice_follows_fight()

Returns true if the last finished combat is about to lead into a choice adventure.

boolean handling_choice()

Returns true if you are currently in a choice.

int last_choice()

Returns the ID of the current (or last) choice adventure you encountered.

buffer run_choiceint, boolean?, string? )

Run the current choice adventure by selecting a choice number, optionally choosing to automate any resulting fight, and possibly specifying additional URL parameters.

buffer run_choiceint, string )

Run the current choice adventure by selecting a choice number and specifying additional URL parameters.

Misc.

int get_auto_attack()

Returns your current auto-attack setting.

void set_auto_attack( int )

Sets your auto-attack setting.

boolean set_ccs( string )

Sets your custom combat script.

buffer read_ccs( string )

Reads the text of your custom combat script.

boolean write_ccs( buffer, string )

Writes the text of your custom combat script.