Adventuring: Difference between revisions
No edit summary |
|||
(82 intermediate revisions by 32 users not shown) | |||
Line 1: | Line 1: | ||
== | {{TOCright}} | ||
==General Adventuring== | |||
{{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). | |||
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}} | |||
{{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.}} | |||
{{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}} | |||
< | ==Choice Adventures== | ||
{{FunctionEmbed|available_choice_options|format=signature|desc=yes}} | |||
{{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}} | |||
==Misc.== | |||
{{Flink|int|get_auto_attack|desc=Returns your current auto-attack setting.}} | |||
{{Flink|void|set_auto_attack|int|desc=Sets your auto-attack setting.}} | |||
{{Flink|boolean|set_ccs|string|desc=Sets your custom combat script.}} | |||
{{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.}} | |||
[[Category:Scripting]] | |||
int | |||
Latest revision as of 00:02, 9 January 2023
General Adventuring
boolean adventure( int, location )
boolean adventure( int, location, string )
boolean adv1( location, int, string )
- Returns the original HTML source of the page being overridden inside a relay override script.
buffer visit_url( string, boolean?, boolean? )
- Visits a web page and returns its HTML source.
string get_counters( string, int, int )
void council()
item guardians()
int tavern()
boolean entryway()
boolean hedgemaze()
boolean chamber()
location my_location()
void refresh_status()
buffer run_combat()
buffer run_choice()
buffer run_turn()
boolean change_mcd( int )
boolean hermit( int, item )
Goals and Conditions
void add_item_condition( int, item )
void add_item_condition( item, int )
- Adds a number of the given item to the current auto-adventuring conditions.
string [int] get_goals()
boolean is_goal( item )
boolean goal_exists( string )
void remove_item_condition( int, item )
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] )
monster last_monster()
monster [int] get_monsters( location )
float [monster] appearance_rates( location, [boolean] )
int monster_attack( [monster] )
int monster_defense( [monster] )
int monster_initiative( [monster] )
phylum monster_phylum( [monster] )
int expected_damage( [monster] )
element monster_element( [monster] )
monster image_to_monster( string )
boolean is_banished( monster )
Choice Adventures
string [int] available_choice_options( boolean? )
- Returns all available choice options in the current (or last) choice adventure the player encountered.
boolean choice_follows_fight()
true
if the last finished combat is about to lead into a choice adventure.boolean handling_choice()
true
if you are currently in a choice.int last_choice()
buffer run_choice( int, 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_choice( int, string )
- Run the current choice adventure by selecting a choice number and specifying additional URL parameters.
Misc.
boolean set_ccs( string )
buffer read_ccs( string )
boolean write_ccs( buffer, string )