From Kolmafia
Jump to navigation Jump to search

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.


int get_auto_attack()

Returns your current auto-attack setting.

void set_auto_attack( int )

Sets your auto-attack setting.