KoLmafia Guide: Preface

Master list of all ASH functions. All functions as of r27333 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.) The CLI command "ashref" shows every implemented ash function for your mafia version. A guide to add new functions via a script can be found here.

a

void abort( string? )

boolean [monster] absorbed_monsters()

void add_item_condition( int, item )

void add_item_condition( item, int )

boolean adv1( location, [int], [string] )

int adv_cost( skill )

boolean adventure( int, location, [string] )

boolean adventure( location, int, [string] )

boolean [monster] all_monsters_with_id()

string [0] all_normal_outfits()

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

buffer append( buffer, string )

buffer append_replacement( matcher, buffer, string )

buffer append_tail( matcher, buffer )

buffer attack()

boolean autosell( int, item )

boolean autosell( item, int )

int autosell_price( item )

int available_amount( item )

string [int] available_choice_options( boolean? )

string[string, string] available_choice_select_inputs( int )

string [string] available_choice_text_inputs( int )

int available_pocket( effect )

int available_pocket( item )

int available_pocket( monster )

int available_pocket( stat )

b

boolean batch_close()

void batch_open()

boolean bjornify_familiar( familiar )

boolean black_market_available()

boolean boolean_modifier( effect, string )

boolean boolean_modifier( item, string )

boolean boolean_modifier( [string], string )

int buffed_hit_stat()

boolean buffer_to_file( buffer, string )

boolean buy( coinmaster, item )

boolean buy( item, [int], [int] )

boolean buy( [coinmaster], int, item )

int buy( int, item, int )

int buy_price( coinmaster, item )

boolean buy_using_storage( int, item )

boolean buy_using_storage( item, int )

boolean buy_using_storage( item )

int buy_using_storage( int, item, int )

int buy_using_storage( item, int, int )

boolean buys_item( coinmaster, item )

c

boolean can_adventure( location )

boolean can_drink()

boolean can_eat()

boolean can_equip( familiar, [item] )

boolean can_equip( item )

boolean can_faxbot( monster )

boolean can_interact()

boolean can_still_steal()

boolean canadia_available()

item [0] candy_for_tier( int, [int] )

int ceil( float )

boolean change_mcd( int )

string char_at( string, int )

void chat_clan( string, [string] )

void chat_macro( string )

void chat_notify( string, string )

void chat_private( string, string )

boolean chew( int, item )

boolean chew( item, [int] )

boolean choice_follows_fight()

class class_modifier( item, string )

class class_modifier( string, string )

void clear( aggregate )

void clear_booze_helper()

void clear_food_helper()

boolean cli_execute( string )

string cli_execute_output( string )

int closet_amount( item )

int combat_mana_cost_modifier()

float combat_rate_modifier()

boolean combat_skill_available( skill )

int concoction_price( item )

int concoction_price( vykea )

boolean contains_text( string, string )

void council()

int count( aggregate )

int craft( string, int, item, item )

string craft_type( item )

int creatable_amount( item )

int creatable_turns( item, [int], [boolean] )

boolean create( int, item )

boolean create( item, [int] )

matcher create_matcher( string, string )

stat current_hit_stat()

int current_mcd()

int [string] current_pvp_stances()

int current_rad_sickness()

int current_round()

d

element dad_sea_monkee_weakness( int )

item daily_special()

float damage_absorption_percent()

int damage_reduction()

int date_to_timestamp( string, string )

int daycount()

void debugprint( string )

buffer delete( buffer, int, int )

effect desc_to_effect( string )

item desc_to_item( string )

void disable( string )

boolean dispensary_available()

int display_amount( item )

boolean drink( item, int? )

boolean drink( int, item )

boolean drinksilent( int, item )

boolean drinksilent( item, [int] )

void dump( any, [string] )

e

boolean eat( item, int? )

boolean eat( int, item )

boolean eatsilent( int, item )

boolean eatsilent( item, [int] )

effect effect_modifier( item, string )

effect effect_modifier( string, string )

boolean [int] effect_pockets()

int eight_bit_points( location, string, float )

int eight_bit_points( location )

float elemental_resistance( monster )

float elemental_resistance( [element] )

boolean empty_closet()

void enable( string )

int end( matcher, [int] )

boolean ends_with( string, string )

boolean enthrone_familiar( familiar )

string entity_decode( string )

string entity_encode( string )

boolean equip( item, [slot] )

boolean equip( slot, item )

boolean equip_all_familiars()

int equipped_amount( item, boolean )

int equipped_amount( item )

item equipped_item( slot )

boolean eudora( string )

string eudora()

item eudora_item()

string every_card_name( strict_string )

item [string] expected_cold_medicine_cabinet()

int expected_damage( [monster] )

float experience_bonus()

float expression_eval( string )

int [item] extract_items( string )

int extract_meat( string )

f

item familiar_equipment( familiar )

item familiar_equipped_equipment( familiar )

int familiar_weight( familiar )

boolean [familiar] favorite_familiars()

boolean faxbot( monster, [string] )

boolean fight_follows_choice()

string [int] file_to_array( string )

buffer file_to_buffer( string )

boolean file_to_map( string, aggregate, [boolean] )

boolean find( matcher )

int floor( float )

boolean florist_available()

boolean flush_monster_manuel_cache()

string form_field( string )

string [string] form_fields()

string format_date_time( string, string, string )

boolean friars_available()

int fuel_cost( skill )

int fullness_limit()

g

int gameday_to_int()

string gameday_to_string()

int gametime_to_int()

boolean [string] get_all_properties( string, boolean )

int get_auto_attack()

location [0] get_autumnaton_locations()

int [item] get_campground()

string get_ccs_action( int )

int [item] get_chateau()

int get_clan_id()

int [item] get_clan_lounge()

string get_clan_name()

int [string] get_clan_rumpus()

int [item] get_closet()

int get_counter( string )

string get_counters( string, int, int )

string [0] get_custom_outfits()

int [item] get_display()

item get_dwelling()

location [string] get_fishing_locations()

string [location, 3] get_florist_plants()

int [item] get_free_pulls()

int get_fuel()

string [0] get_goals()

boolean get_ignore_zone_warnings()

int [item] get_ingredients( item )

int [item] get_inventory()

boolean [monster] get_location_monsters( location )

boolean [monster] get_locket_monsters()

monster [monster] get_monster_mapping( [string] )

monster [0] get_monsters( location )

string [0] get_moods()

string [0] get_outfits()

string get_path()

string get_path_full()

string get_path_variables()

boolean [skill] get_permed_skills()

string get_player_id( string )

string get_player_name( int )

int get_power( item )

string get_property( string, [boolean] )

int [item] get_related( item, string )

int get_revision()

int [item] get_shop()

string [0] get_shop_log()

string file( string, name, int, line [0], get_stack_trace )

int [item] get_stash()

int [item] get_storage()

string get_version()

item get_workshed()

item get_zap_wand()

boolean git_at_head( string )

boolean git_exists( string )

string [0] git_list()

boolean gnomads_available()

boolean goal_exists( string )

string group( matcher, string )

string group( matcher, [int] )

int group_count( matcher )

boolean [string] group_names( matcher )

string [int, int] group_string( string, string )

boolean guild_available()

boolean guild_store_available()

h

boolean handling_choice()

boolean have_bartender()

boolean have_chef()

boolean have_display()

int have_effect( effect )

boolean have_equipped( item )

boolean have_familiar( familiar )

boolean have_mushroom_plot()

boolean have_outfit( string )

boolean have_servant( servant )

boolean have_shop()

boolean have_skill( skill )

boolean hedge_maze( string )

boolean heist( int, item )

boolean heist( item )

item [monster, int] heist_targets()

boolean hermit( int, item )

boolean hermit( item, int )

boolean hidden_temple_unlocked()

boolean hippy_stone_broken()

boolean hippy_store_available()

float historical_age( item )

int historical_price( item )

string holiday()

int hp_cost( skill )

i

monster image_to_monster( strict_string )

boolean in_bad_moon()

boolean in_casual()

boolean in_hardcore()

boolean in_moxie_sign()

boolean in_multi_fight()

boolean in_muscle_sign()

boolean in_mysticality_sign()

boolean in_terrarium( familiar )

string inaccessible_reason( coinmaster )

int index_of( string, string, int? )

int inebriety_limit()

float initiative_modifier()

buffer insert( buffer, int, string )

boolean is_accessible( coinmaster )

boolean is_banished( monster )

boolean is_coinmaster_item( item )

boolean is_dark_mode()

boolean is_discardable( item )

boolean is_displayable( item )

boolean is_familiar_equipment_locked()

boolean is_giftable( item )

boolean is_goal( item )

boolean is_headless()

boolean is_integer( string )

boolean is_npc_item( item )

boolean is_online( string )

boolean is_tradeable( item )

boolean is_trendy( item/familiar/skill/string )

boolean is_unrestricted( item/familiar/skill/string )

boolean is_wearing_outfit( string )

int item_amount( item )

float item_drop_modifier()

int [item] item_drops( [monster] )

item int string [int] item_drops_array( [monster] )

boolean [int] item_pockets()

string item_type( item )

j

boolean [int] joke_pockets()

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

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

k

boolean knoll_available()

l

int last_choice()

int last_decision()

int last_index_of( string, string, int? )

string last_item_message()

monster last_monster()

string last_skill_message()

string leetify( string )

int length( string )

int lightning_cost( skill )

string limit_mode()

buffer load_html( string )

void lock_familiar_equipment( boolean )

float log_n( float, [float] )

void logprint( string )

m

string make_url( string, boolean, boolean )

int mall_price( item )

int mall_prices( string, string? )

int mall_prices( boolean [item] )

int mana_cost_modifier()

boolean map_to_file( aggregate, string, [boolean] )

float max( float, float )

int max( int, int )

boolean maximize( string, boolean )

boolean maximize( string, int, int, boolean )

string display( string, command, float, score, effect, effect, item )

int meat_drop( [monster] )

float meat_drop_modifier()

int [int] meat_pockets()

float min( float, float )

int min( int, int )

item minstrel_instrument()

int minstrel_level()

boolean minstrel_quest()

float modifier_eval( string )

boolean monkey_paw( effect )

boolean monkey_paw( item )

boolean monkey_paw( string )

int monster_attack( [monster] )

int monster_defense( [monster] )

element monster_element( [monster] )

float monster_eval( string )

int monster_factoids_available( monster, boolean )

int monster_hp( [monster] )

int monster_initiative( [monster] )

int monster_level_adjustment()

string monster_manuel_text( monster )

monster monster_modifier( effect, string )

phylum monster_phylum( [monster] )

boolean [int] monster_pockets()

void mood_execute( int )

string [0] mood_list()

int moon_light()

int moon_phase()

int mp_cost( skill )

int my_absorbs()

int my_adventures()

int my_ascensions()

int my_audience()

int my_basestat( stat )

familiar my_bjorned_familiar()

int my_buffedstat( stat )

class my_class()

int my_closet_meat()

string my_companion()

int my_daycount()

int my_discomomentum()

familiar my_effective_familiar()

int [effect] my_effects()

familiar my_enthroned_familiar()

familiar my_familiar()

int my_fullness()

int my_fury()

string my_garden_type()

string my_hash()

int my_hp()

string my_id()

int my_inebriety()

int my_level()

int my_lightning()

location my_location()

string my_mask()

int my_maxfury()

int my_maxhp()

int my_maxmp()

int my_maxpp()

int my_meat()

int my_mp()

string my_name()

path my_path()

int my_path_id()

familiar my_poke_fam( int )

int my_pp()

stat my_primestat()

int my_rain()

int my_robot_energy()

int my_robot_scraps()

servant my_servant()

int my_session_adv()

int [item] my_session_items()

int my_session_items( item )

int my_session_meat()

int [string] my_session_results()

string my_sign()

int my_soulsauce()

int my_spleen_use()

int my_storage_meat()

thrall my_thrall()

int my_thunder()

int my_turncount()

vykea my_vykea_companion()

int my_wildfire_water()

n

int now_to_int()

string now_to_string( string )

int npc_price( item )

string numberology_prize( int )

float numeric_modifier( effect, string )

float numeric_modifier( familiar, string, int, item )

float numeric_modifier( item, string )

float numeric_modifier( skill, string )

float numeric_modifier( [string], string )

o

boolean outfit( string )

item [0] outfit_pieces( string )

string outfit_tattoo( [string] )

float [item] outfit_treats( string )

boolean overdrink( int, item )

boolean overdrink( item, int? )

p

string path_id_to_name( int )

int path_name_to_id( string )

boolean pick_pocket( int )

boolean pick_pocket( monster )

int [effect] pick_pocket( effect )

int [item] pick_pocket( item )

int [stat] pick_pocket( stat )

boolean [int] picked_pockets()

boolean [int] picked_scraps()

int [effect] pocket_effects( int )

int [item] pocket_items( int )

string pocket_joke( int )

string [int] pocket_meat( int )

monster pocket_monster( int )

string [int] pocket_poem( int )

string [int] pocket_scrap( int )

int [stat] pocket_stats( int )

int [int] poem_pockets()

int [int] potential_pockets( effect/item/monster/stat )

boolean pre_validate_adventure( location )

boolean prepare_for_adventure( location )

void print( [string], [string] )

void print_html( string, boolean )

void print_html( string )

string property_default_value( string )

boolean property_exists( string, boolean? )

boolean property_has_default( string )

int pulls_remaining()

boolean put_closet( int, [item] )

boolean put_closet( item, [int] )

boolean put_display( int, item )

boolean put_display( item, int )

boolean put_shop( int, int, [int], item )

boolean put_shop_using_storage( int, int, [int], item )

boolean put_stash( int, item )

boolean put_stash( item, int )

int pvp_attacks_left()

r

int rain_cost( skill )

int random( int )

int raw_damage_absorption()

buffer read_ccs( string )

void receive_fax()

boolean refresh_shop()

boolean refresh_stash()

boolean refresh_status()

void remove_item_condition( int, item )

void remove_item_condition( item, int )

string remove_property( string, boolean? )

boolean rename_property( string, string )

buffer replace( buffer, int, int, string )

string replace_all( matcher, string )

string replace_first( matcher, string )

buffer replace_string( buffer, string, string )

buffer replace_string( string, string, string )

boolean reprice_shop( int, [int], item )

matcher reset( matcher, [string] )

boolean [int] restoration_pockets()

boolean restore_hp( int )

boolean restore_mp( int )

boolean retrieve_item( int, item )

boolean retrieve_item( item, [int] )

int retrieve_price( int, item, boolean )

int retrieve_price( int, item )

int retrieve_price( item, int, boolean )

int retrieve_price( item, int )

int retrieve_price( item )

int [int] reverse_numberology( [int] )

int rollover()

int round( float )

buffer run_choice( int, boolean?, string? )

buffer run_choice( int, string )

buffer run_combat( [string] )

buffer run_turn()

buffer runaway()

s

int [int] scrap_pockets()

boolean sell( coinmaster, int, item )

int sell_price( coinmaster, item )

boolean sells_item( coinmaster, item )

void send_fax()

string [int] session_logs( [string], [string], int )

void set_auto_attack( int/string )

boolean set_ccs( string )

void set_length( buffer, int )

void set_location( location )

void set_property( string, string )

int shop_amount( item )

int shop_limit( item )

int shop_price( item )

skill skill_modifier( item, string )

skill skill_modifier( string, string )

int slash_count( item )

int soulsauce_cost( skill )

int spleen_limit()

string [int] split_string( string, [string] )

float square_root( float )

int start( matcher, [int] )

boolean starts_with( string, string )

int stash_amount( item )

stat stat_bonus_today()

stat stat_bonus_tomorrow()

stat stat_modifier( effect, string )

boolean [int] stats_pockets()

buffer steal()

int stills_available()

void stop_counter( string )

int storage_amount( item )

string string_modifier( [string], string )

skill stun_skill()

string substring( string, int, [int] )

boolean svn_at_head( string )

boolean svn_exists( string )

string [0] svn_list()

boolean sweet_synthesis( effect, [int] )

boolean sweet_synthesis( int, effect, [int] )

boolean sweet_synthesis( [int], item, item )

item [0] sweet_synthesis_pair( effect, [item], [int] )

item [0] sweet_synthesis_pairing( effect, item, int )

item [0] sweet_synthesis_pairing( effect, item )

effect sweet_synthesis_result( item, item )

t

boolean take_closet( int, [item] )

boolean take_closet( item, [int] )

boolean take_display( int, item )

boolean take_display( item, int )

boolean take_shop( [int], item )

boolean take_stash( int, item )

boolean take_stash( item, int )

boolean take_storage( int, item )

boolean take_storage( item, int )

int tavern( [string] )

buffer throw_item( item )

buffer throw_items( item, item )

int thunder_cost( skill )

string time_to_string()

string timestamp_to_date( int, string )

boolean to_boolean( any )

bounty to_bounty( strict_string )

class to_class( strict_string/int )

coinmaster to_coinmaster( strict_string )

effect to_effect( int/skill/strict_string )

element to_element( strict_string )

familiar to_familiar( int/strict_string )

float to_float( any )

int to_int( any )

item to_item( int/strict_string )

item to_item( string, int )

string to_json( aggregate )

location to_location( int/strict_string )

string to_lower_case( string )

monster to_monster( int/strict_string )

path to_path( int )

path to_path( strict_string )

phylum to_phylum( strict_string )

string to_plural( item )

servant to_servant( int/strict_string )

skill to_skill( effect/int )

skill to_skill( strict_string, [strict_string] )

slot to_slot( item/strict_string )

stat to_stat( strict_string )

string to_string( any )

thrall to_thrall( int/strict_string )

string to_upper_case( string )

string to_url( location )

vykea to_vykea( strict_string )

string to_wiki_url( effect )

string to_wiki_url( item )

string to_wiki_url( monster )

string to_wiki_url( skill )

string to_wiki_url( string )

string today_to_string()

int total_free_rests()

int total_turns_played()

boolean tower_door()

void traceprint( string )

int truncate( float )

int turns_per_cast( skill )

int turns_played()

buffer twiddle()

u

item unusual_construct_disc()

void update_candy_prices()

string url( int, revision, string, last_changed_author, int, last_changed_rev, string )

string url( string, branch, string, commit, string, last_changed_author, string )

string url_decode( string )

string url_encode( string )

boolean use( int, item )

boolean use( item, [int] )

boolean use_familiar( familiar )

boolean use_servant( servant )

boolean use_skill( int, skill, [string] )

boolean use_skill( skill, int, [string] )

buffer use_skill( skill )

boolean user_confirm( string, int, boolean )

boolean user_confirm( string )

void user_notify( string, boolean )

void user_notify( string )

string user_prompt( string, aggregate )

string user_prompt( string, int, string )

string user_prompt( string )

v

boolean visit( coinmaster )

buffer visit_url()

buffer visit_url( string, boolean?, boolean? )

boolean [string] voting_booth_initiatives( class, path, int )

boolean [string] voting_booth_initiatives( int, int, int )

w

void wait( int )

void waitq( int )

int weapon_hands( item )

stat weapon_type( item )

int weight_adjustment()

boolean well_stocked( string, int, int )

boolean white_citadel_available()

boolean [string] who_clan()

boolean will_usually_dodge()

boolean will_usually_miss()

void write( string )

boolean write_ccs( buffer, string )

void writeln( string )

x

string [0] xpath( string, string )

z

item zap( item )