https://wiki.kolmafia.us/api.php?action=feedcontributions&feedformat=atom&user=Eliteofdelete 2026-05-01T16:04:57Z User contributions MediaWiki 1.44.0 https://wiki.kolmafia.us/index.php?title=Reserved_Words&diff=9220 2023-05-01T00:54:35Z

<p>Eliteofdelete: /* Complex types */ Added new ones</p> <hr /> <div>{{TOCright}}<br /> Following is a list of words that are reserved for special usage by KoLmafia. They can not be used as variable or function names.<br /> <br /> They are listed by category for ease of reference; the category names are not reserved words, themselves (though using them as variables would be considered poor practice in most cases).<br /> <br /> ==Constants==<br /> *&quot;true&quot;<br /> *&quot;false&quot;<br /> <br /> ==Operators==<br /> *&quot;contains&quot;<br /> *&quot;remove&quot;<br /> *&quot;new&quot;<br /> <br /> ==Control flow==<br /> *&quot;if&quot;<br /> *&quot;else&quot;<br /> *&quot;foreach&quot;<br /> *&quot;in&quot;<br /> *&quot;for&quot;<br /> *&quot;from&quot;<br /> *&quot;upto&quot;<br /> *&quot;downto&quot;<br /> *&quot;by&quot;<br /> *&quot;while&quot;<br /> *&quot;repeat&quot;<br /> *&quot;until&quot;<br /> *&quot;break&quot;<br /> *&quot;continue&quot;<br /> *&quot;return&quot;<br /> *&quot;exit&quot;<br /> *&quot;switch&quot;<br /> *&quot;case&quot;<br /> *&quot;default&quot;<br /> *&quot;try&quot;<br /> *&quot;catch&quot;<br /> *&quot;finally&quot;<br /> *&quot;static&quot;<br /> <br /> ==Data types==<br /> ===Primitive types===<br /> *&quot;void&quot;<br /> *&quot;boolean&quot;<br /> *&quot;int&quot;<br /> *&quot;float&quot;<br /> *&quot;string&quot;<br /> *&quot;buffer&quot;<br /> *&quot;matcher&quot;<br /> *&quot;aggregate&quot;<br /> <br /> ===Complex types===<br /> *&quot;item&quot;<br /> *&quot;location&quot;<br /> *&quot;class&quot;<br /> *&quot;stat&quot;<br /> *&quot;skill&quot;<br /> *&quot;effect&quot;<br /> *&quot;familiar&quot;<br /> *&quot;slot&quot;<br /> *&quot;monster&quot;<br /> *&quot;element&quot;<br /> *&quot;coinmaster&quot;<br /> *&quot;phylum&quot;<br /> *&quot;thrall&quot;<br /> *&quot;bounty&quot;<br /> *&quot;servant&quot;<br /> *&quot;vykea&quot;<br /> *&quot;path&quot;<br /> <br /> === Miscellaneous ===<br /> *&quot;record&quot;<br /> *&quot;typedef&quot;<br /> <br /> ==More Information==<br /> The file [https://github.com/kolmafia/kolmafia/blob/main/src/net/sourceforge/kolmafia/textui/Parser.java &lt;code&gt;Parser.java&lt;/code&gt;] contains the most up-to-date version of this list.<br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Reserved_Words&diff=9219 2023-05-01T00:23:22Z

<p>Eliteofdelete: /* More Information */ fixed the link to point to the new git</p> <hr /> <div>{{TOCright}}<br /> Following is a list of words that are reserved for special usage by KoLmafia. They can not be used as variable or function names.<br /> <br /> They are listed by category for ease of reference; the category names are not reserved words, themselves (though using them as variables would be considered poor practice in most cases).<br /> <br /> ==Constants==<br /> *&quot;true&quot;<br /> *&quot;false&quot;<br /> <br /> ==Operators==<br /> *&quot;contains&quot;<br /> *&quot;remove&quot;<br /> *&quot;new&quot;<br /> <br /> ==Control flow==<br /> *&quot;if&quot;<br /> *&quot;else&quot;<br /> *&quot;foreach&quot;<br /> *&quot;in&quot;<br /> *&quot;for&quot;<br /> *&quot;from&quot;<br /> *&quot;upto&quot;<br /> *&quot;downto&quot;<br /> *&quot;by&quot;<br /> *&quot;while&quot;<br /> *&quot;repeat&quot;<br /> *&quot;until&quot;<br /> *&quot;break&quot;<br /> *&quot;continue&quot;<br /> *&quot;return&quot;<br /> *&quot;exit&quot;<br /> *&quot;switch&quot;<br /> *&quot;case&quot;<br /> *&quot;default&quot;<br /> *&quot;try&quot;<br /> *&quot;catch&quot;<br /> *&quot;finally&quot;<br /> *&quot;static&quot;<br /> <br /> ==Data types==<br /> ===Primitive types===<br /> *&quot;void&quot;<br /> *&quot;boolean&quot;<br /> *&quot;int&quot;<br /> *&quot;float&quot;<br /> *&quot;string&quot;<br /> *&quot;buffer&quot;<br /> *&quot;matcher&quot;<br /> *&quot;aggregate&quot;<br /> <br /> ===Complex types===<br /> *&quot;item&quot;<br /> *&quot;location&quot;<br /> *&quot;class&quot;<br /> *&quot;stat&quot;<br /> *&quot;skill&quot;<br /> *&quot;effect&quot;<br /> *&quot;familiar&quot;<br /> *&quot;slot&quot;<br /> *&quot;monster&quot;<br /> *&quot;element&quot;<br /> *&quot;coinmaster&quot;<br /> <br /> === Miscellaneous ===<br /> *&quot;record&quot;<br /> *&quot;typedef&quot;<br /> <br /> ==More Information==<br /> The file [https://github.com/kolmafia/kolmafia/blob/main/src/net/sourceforge/kolmafia/textui/Parser.java &lt;code&gt;Parser.java&lt;/code&gt;] contains the most up-to-date version of this list.<br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Ash_Functions&diff=9218 2023-04-29T04:46:59Z

<p>Eliteofdelete: </p> <hr /> <div>{{TOCright}}<br /> 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version. A guide to add new functions via a script can be found [https://wiki.kolmafia.us/index.php/NewFunctionsScript here.]<br /> <br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{Flink|boolean [monster]|absorbed_monsters}}<br /> {{FunctionEmbed|add_item_condition|format=signature}}<br /> {{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}<br /> {{Flink|int|adv_cost|skill}}<br /> {{Flink|boolean|adventure|int|location|{{opt|string}}}}<br /> {{Flink|boolean|adventure|location|int|{{opt|string}}}}<br /> {{FunctionEmbed|all_monsters_with_id|format=signature}}<br /> {{Flink|string [0]|all_normal_outfits}}<br /> {{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}<br /> {{Flink|buffer|append|buffer|string}}<br /> {{Flink|buffer|append_replacement|matcher|buffer|string}}<br /> {{Flink|buffer|append_tail|matcher|buffer}}<br /> {{Flink|buffer|attack}}<br /> {{Flink|boolean|autosell|int|item}}<br /> {{Flink|boolean|autosell|item|int}}<br /> {{Flink|int|autosell_price|item}}<br /> {{Flink|int|available_amount|item}}<br /> {{FunctionEmbed|available_choice_options}}<br /> {{FunctionEmbed|available_choice_select_inputs}}<br /> {{Flink|string [string]|available_choice_text_inputs|int}}<br /> {{Flink|int|available_pocket|effect}}<br /> {{Flink|int|available_pocket|item}}<br /> {{Flink|int|available_pocket|monster}}<br /> {{Flink|int|available_pocket|stat}}<br /> <br /> ===b===<br /> {{Flink|boolean|batch_close}}<br /> {{Flink|void|batch_open}}<br /> {{Flink|boolean|bjornify_familiar|familiar}}<br /> {{Flink|boolean|black_market_available}}<br /> {{Flink|boolean|boolean_modifier|effect|string}}<br /> {{Flink|boolean|boolean_modifier|item|string}}<br /> {{Flink|boolean|boolean_modifier|{{opt|string}}|string}}<br /> {{Flink|int|buffed_hit_stat}}<br /> {{FunctionEmbed|buffer_to_file|format=signature}}<br /> {{Flink|boolean|buy|coinmaster|item}}<br /> {{Flink|boolean|buy|item|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}<br /> {{Flink|int|buy|int|item|int}}<br /> {{Flink|int|buy_price|coinmaster|item}}<br /> {{Flink|boolean|buy_using_storage|int|item}}<br /> {{Flink|boolean|buy_using_storage|item|int}}<br /> {{Flink|boolean|buy_using_storage|item}}<br /> {{Flink|int|buy_using_storage|int|item|int}}<br /> {{Flink|int|buy_using_storage|item|int|int}}<br /> {{Flink|boolean|buys_item|coinmaster|item}}<br /> <br /> ===c===<br /> {{Flink|boolean|can_adventure|location}}<br /> {{Flink|boolean|can_drink}}<br /> {{Flink|boolean|can_eat}}<br /> {{Flink|boolean|can_equip|familiar|{{opt|item}}}}<br /> {{Flink|boolean|can_equip|item}}<br /> {{Flink|boolean|can_faxbot|monster}}<br /> {{Flink|boolean|can_interact}}<br /> {{Flink|boolean|can_still_steal}}<br /> {{Flink|boolean|canadia_available}}<br /> {{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}<br /> {{Flink|int|ceil|float}}<br /> {{Flink|boolean|change_mcd|int}}<br /> {{Flink|string|char_at|string|int}}<br /> {{Flink|void|chat_clan|string|{{opt|string}}}}<br /> {{Flink|void|chat_macro|string}}<br /> {{Flink|void|chat_notify|string|string}}<br /> {{Flink|void|chat_private|string|string}}<br /> {{Flink|boolean|chew|int|item}}<br /> {{Flink|boolean|chew|item|{{opt|int}}}}<br /> {{Flink|boolean|choice_follows_fight}}<br /> {{Flink|class|class_modifier|item|string}}<br /> {{Flink|class|class_modifier|string|string}}<br /> {{Flink|void|clear|aggregate}}<br /> {{FunctionEmbed|clear_booze_helper|format=signature}}<br /> {{FunctionEmbed|clear_food_helper|format=signature}}<br /> {{FunctionEmbed|cli_execute|format=signature}}<br /> {{FunctionEmbed|cli_execute_output|format=signature}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|combat_mana_cost_modifier}}<br /> {{Flink|float|combat_rate_modifier}}<br /> {{Flink|boolean|combat_skill_available|skill}}<br /> {{Flink|int|concoction_price|item}}<br /> {{Flink|int|concoction_price|vykea}}<br /> {{FunctionEmbed|contains_text|format=signature}}<br /> {{Flink|void|council}}<br /> {{Flink|int|count|aggregate}}<br /> {{Flink|int|craft|string|int|item|item}}<br /> {{Flink|string|craft_type|item}}<br /> {{Flink|int|creatable_amount|item}}<br /> {{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}<br /> {{Flink|boolean|create|int|item}}<br /> {{Flink|boolean|create|item|{{opt|int}}}}<br /> {{Flink|matcher|create_matcher|string|string}}<br /> {{Flink|stat|current_hit_stat}}<br /> {{Flink|int|current_mcd}}<br /> {{Flink|int [string]|current_pvp_stances}}<br /> {{Flink|int|current_rad_sickness}}<br /> {{Flink|int|current_round}}<br /> <br /> ===d===<br /> {{Flink|element|dad_sea_monkee_weakness|int}}<br /> {{Flink|item|daily_special}}<br /> {{Flink|float|damage_absorption_percent}}<br /> {{Flink|int|damage_reduction}}<br /> {{Flink|int|date_to_timestamp|string|string}}<br /> {{Flink|int|daycount}}<br /> {{Flink|void|debugprint|string}}<br /> {{Flink|buffer|delete|buffer|int|int}}<br /> {{Flink|effect|desc_to_effect|string}}<br /> {{Flink|item|desc_to_item|string}}<br /> {{Flink|void|disable|string}}<br /> {{Flink|boolean|dispensary_available}}<br /> {{Flink|int|display_amount|item}}<br /> {{FunctionEmbed|drink|format=signature}}<br /> {{Flink|boolean|drinksilent|int|item}}<br /> {{Flink|boolean|drinksilent|item|{{opt|int}}}}<br /> {{Flink|void|dump|any|{{opt|string}}}}<br /> <br /> ===e===<br /> {{FunctionEmbed|eat|format=signature}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eatsilent|item|{{opt|int}}}}<br /> {{Flink|effect|effect_modifier|item|string}}<br /> {{Flink|effect|effect_modifier|string|string}}<br /> {{Flink|boolean [int]|effect_pockets}}<br /> {{Flink|int|eight_bit_points|location|string|float}}<br /> {{Flink|int|eight_bit_points|location}}<br /> {{Flink|float|elemental_resistance|monster}}<br /> {{Flink|float|elemental_resistance|{{opt|element}}}}<br /> {{Flink|boolean|empty_closet}}<br /> {{Flink|void|enable|string}}<br /> {{Flink|int|end|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|ends_with|format=signature}}<br /> {{Flink|boolean|enthrone_familiar|familiar}}<br /> {{Flink|string|entity_decode|string}}<br /> {{Flink|string|entity_encode|string}}<br /> {{Flink|boolean|equip|item|{{opt|slot}}}}<br /> {{Flink|boolean|equip|slot|item}}<br /> {{Flink|boolean|equip_all_familiars}}<br /> {{Flink|int|equipped_amount|item|boolean}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|item|equipped_item|slot}}<br /> {{Flink|boolean|eudora|string}}<br /> {{Flink|string|eudora}}<br /> {{Flink|item|eudora_item}}<br /> {{Flink|string|every_card_name|strict_string}}<br /> {{Flink|item [string]|expected_cold_medicine_cabinet}}<br /> {{Flink|int|expected_damage|{{opt|monster}}}}<br /> {{Flink|float|experience_bonus}}<br /> {{Flink|float|expression_eval|string}}<br /> {{Flink|int [item]|extract_items|string}}<br /> {{Flink|int|extract_meat|string}}<br /> <br /> ===f===<br /> {{Flink|item|familiar_equipment|familiar}}<br /> {{Flink|item|familiar_equipped_equipment|familiar}}<br /> {{Flink|int|familiar_weight|familiar}}<br /> {{Flink|boolean [familiar]|favorite_familiars}}<br /> {{Flink|boolean|faxbot|monster|{{opt|string}}}}<br /> {{Flink|boolean|fight_follows_choice}}<br /> {{FunctionEmbed|file_to_array|format=signature}}<br /> {{FunctionEmbed|file_to_buffer|format=signature}}<br /> {{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}<br /> {{Flink|boolean|find|matcher}}<br /> {{Flink|int|floor|float}}<br /> {{Flink|boolean|florist_available}}<br /> {{Flink|boolean|flush_monster_manuel_cache}}<br /> {{Flink|string|form_field|string}}<br /> {{Flink|string [string]|form_fields}}<br /> {{Flink|string|format_date_time|string|string|string}}<br /> {{Flink|boolean|friars_available}}<br /> {{Flink|int|fuel_cost|skill}}<br /> {{Flink|int|fullness_limit}}<br /> <br /> ===g===<br /> {{Flink|int|gameday_to_int}}<br /> {{Flink|string|gameday_to_string}}<br /> {{Flink|int|gametime_to_int}}<br /> {{Flink|boolean [string]|get_all_properties|string|boolean}}<br /> {{Flink|int|get_auto_attack}}<br /> {{Flink|location [0]|get_autumnaton_locations}}<br /> {{Flink|int [item]|get_campground}}<br /> {{Flink|string|get_ccs_action|int}}<br /> {{Flink|int [item]|get_chateau}}<br /> {{Flink|int|get_clan_id}}<br /> {{Flink|int [item]|get_clan_lounge}}<br /> {{Flink|string|get_clan_name}}<br /> {{Flink|int [string]|get_clan_rumpus}}<br /> {{Flink|int [item]|get_closet}}<br /> {{Flink|int|get_counter|string}}<br /> {{Flink|string|get_counters|string|int|int}}<br /> {{Flink|string [0]|get_custom_outfits}}<br /> {{Flink|int [item]|get_display}}<br /> {{Flink|item|get_dwelling}}<br /> {{Flink|location [string]|get_fishing_locations}}<br /> {{Flink|string [location, 3]|get_florist_plants}}<br /> {{Flink|int [item]|get_free_pulls}}<br /> {{Flink|int|get_fuel}}<br /> {{Flink|string [0]|get_goals}}<br /> {{Flink|boolean|get_ignore_zone_warnings}}<br /> {{Flink|int [item]|get_ingredients|item}}<br /> {{Flink|int [item]|get_inventory}}<br /> {{Flink|boolean [monster]|get_location_monsters|location}}<br /> {{Flink|boolean [monster]|get_locket_monsters}}<br /> {{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}<br /> {{Flink|monster [0]|get_monsters|location}}<br /> {{Flink|string [0]|get_moods}}<br /> {{Flink|string [0]|get_outfits}}<br /> {{Flink|string|get_path}}<br /> {{Flink|string|get_path_full}}<br /> {{Flink|string|get_path_variables}}<br /> {{Flink|boolean [skill]|get_permed_skills}}<br /> {{Flink|string|get_player_id|string}}<br /> {{Flink|string|get_player_name|int}}<br /> {{Flink|int|get_power|item}}<br /> {{Flink|string|get_property|string|{{opt|boolean}}}}<br /> {{Flink|int [item]|get_related|item|string}}<br /> {{Flink|int|get_revision}}<br /> {{Flink|int [item]|get_shop}}<br /> {{Flink|string [0]|get_shop_log}}<br /> {{Flink|string|file|string|name|int|line [0]|get_stack_trace}}<br /> {{Flink|int [item]|get_stash}}<br /> {{Flink|int [item]|get_storage}}<br /> {{Flink|string|get_version}}<br /> {{Flink|item|get_workshed}}<br /> {{Flink|item|get_zap_wand}}<br /> {{Flink|boolean|git_at_head|string}}<br /> {{Flink|boolean|git_exists|string}}<br /> {{Flink|string [0]|git_list}}<br /> {{Flink|boolean|gnomads_available}}<br /> {{Flink|boolean|goal_exists|string}}<br /> {{Flink|string|group|matcher|string}}<br /> {{Flink|string|group|matcher|{{opt|int}}}}<br /> {{Flink|int|group_count|matcher}}<br /> {{Flink|boolean [string]|group_names|matcher}}<br /> {{Flink|string [int, int]|group_string|string|string}}<br /> {{Flink|boolean|guild_available}}<br /> {{Flink|boolean|guild_store_available}}<br /> <br /> ===h===<br /> {{Flink|boolean|handling_choice}}<br /> {{Flink|boolean|have_bartender}}<br /> {{Flink|boolean|have_chef}}<br /> {{Flink|boolean|have_display}}<br /> {{Flink|int|have_effect|effect}}<br /> {{Flink|boolean|have_equipped|item}}<br /> {{Flink|boolean|have_familiar|familiar}}<br /> {{Flink|boolean|have_mushroom_plot}}<br /> {{Flink|boolean|have_outfit|string}}<br /> {{Flink|boolean|have_servant|servant}}<br /> {{Flink|boolean|have_shop}}<br /> {{Flink|boolean|have_skill|skill}}<br /> {{Flink|boolean|hedge_maze|string}}<br /> {{Flink|boolean|heist|int|item}}<br /> {{Flink|boolean|heist|item}}<br /> {{Flink|item [monster, int]|heist_targets}}<br /> {{Flink|boolean|hermit|int|item}}<br /> {{Flink|boolean|hermit|item|int}}<br /> {{Flink|boolean|hidden_temple_unlocked}}<br /> {{Flink|boolean|hippy_stone_broken}}<br /> {{Flink|boolean|hippy_store_available}}<br /> {{FunctionEmbed|historical_age}}<br /> {{FunctionEmbed|historical_price}}<br /> {{Flink|string|holiday}}<br /> {{Flink|int|hp_cost|skill}}<br /> <br /> ===i===<br /> {{Flink|monster|image_to_monster|strict_string}}<br /> {{Flink|boolean|in_bad_moon}}<br /> {{Flink|boolean|in_casual}}<br /> {{Flink|boolean|in_hardcore}}<br /> {{Flink|boolean|in_moxie_sign}}<br /> {{Flink|boolean|in_multi_fight}}<br /> {{Flink|boolean|in_muscle_sign}}<br /> {{Flink|boolean|in_mysticality_sign}}<br /> {{Flink|boolean|in_terrarium|familiar}}<br /> {{Flink|string|inaccessible_reason|coinmaster}}<br /> {{FunctionEmbed|index_of|format=signature}}<br /> {{Flink|int|inebriety_limit}}<br /> {{Flink|float|initiative_modifier}}<br /> {{Flink|buffer|insert|buffer|int|string}}<br /> {{Flink|boolean|is_accessible|coinmaster}}<br /> {{Flink|boolean|is_banished|monster}}<br /> {{Flink|boolean|is_coinmaster_item|item}}<br /> {{FunctionEmbed|is_dark_mode}}<br /> {{Flink|boolean|is_discardable|item}}<br /> {{Flink|boolean|is_displayable|item}}<br /> {{Flink|boolean|is_familiar_equipment_locked}}<br /> {{Flink|boolean|is_giftable|item}}<br /> {{Flink|boolean|is_goal|item}}<br /> {{Flink|boolean|is_headless}}<br /> {{Flink|boolean|is_integer|string}}<br /> {{Flink|boolean|is_npc_item|item}}<br /> {{Flink|boolean|is_online|string}}<br /> {{Flink|boolean|is_tradeable|item}}<br /> {{Flink|boolean|is_trendy|item/familiar/skill/string}}<br /> {{Flink|boolean|is_unrestricted|item/familiar/skill/string}}<br /> {{Flink|boolean|is_wearing_outfit|string}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|float|item_drop_modifier}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}}}<br /> {{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}<br /> {{Flink|boolean [int]|item_pockets}}<br /> {{Flink|string|item_type|item}}<br /> <br /> ===j===<br /> {{Flink|boolean [int]|joke_pockets}}<br /> {{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}<br /> <br /> ===k===<br /> {{Flink|boolean|knoll_available}}<br /> <br /> ===l===<br /> {{Flink|int|last_choice}}<br /> {{Flink|int|last_decision}}<br /> {{FunctionEmbed|last_index_of|format=signature}}<br /> {{Flink|string|last_item_message}}<br /> {{Flink|monster|last_monster}}<br /> {{Flink|string|last_skill_message}}<br /> {{Flink|string|leetify|string}}<br /> {{Flink|int|length|string}}<br /> {{Flink|int|lightning_cost|skill}}<br /> {{Flink|string|limit_mode}}<br /> {{Flink|buffer|load_html|string}}<br /> {{Flink|void|lock_familiar_equipment|boolean}}<br /> {{Flink|float|log_n|float|{{opt|float}}}}<br /> {{Flink|void|logprint|string}}<br /> <br /> ===m===<br /> {{Flink|string|make_url|string|boolean|boolean}}<br /> {{FunctionEmbed|mall_price}}<br /> {{FunctionEmbed|mall_prices}}<br /> {{Flink|int|mana_cost_modifier}}<br /> {{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}<br /> {{Flink|float|max|float|float}}<br /> {{Flink|int|max|int|int}}<br /> {{Flink|boolean|maximize|string|boolean}}<br /> {{Flink|boolean|maximize|string|int|int|boolean}}<br /> {{Flink|string|display|string|command|float|score|effect|effect|item|item|skill|skill [0]|maximize|string|int|int|boolean|boolean}}<br /> {{Flink|int|meat_drop|{{opt|monster}}}}<br /> {{Flink|float|meat_drop_modifier}}<br /> {{Flink|int [int]|meat_pockets}}<br /> {{Flink|float|min|float|float}}<br /> {{Flink|int|min|int|int}}<br /> {{Flink|item|minstrel_instrument}}<br /> {{Flink|int|minstrel_level}}<br /> {{Flink|boolean|minstrel_quest}}<br /> {{Flink|float|modifier_eval|string}}<br /> {{Flink|boolean|monkey_paw|effect}}<br /> {{Flink|boolean|monkey_paw|item}}<br /> {{Flink|boolean|monkey_paw|string}}<br /> {{Flink|int|monster_attack|{{opt|monster}}}}<br /> {{Flink|int|monster_defense|{{opt|monster}}}}<br /> {{Flink|element|monster_element|{{opt|monster}}}}<br /> {{Flink|float|monster_eval|string}}<br /> {{Flink|int|monster_factoids_available|monster|boolean}}<br /> {{Flink|int|monster_hp|{{opt|monster}}}}<br /> {{Flink|int|monster_initiative|{{opt|monster}}}}<br /> {{Flink|int|monster_level_adjustment}}<br /> {{Flink|string|monster_manuel_text|monster}}<br /> {{Flink|monster|monster_modifier|effect|string}}<br /> {{Flink|phylum|monster_phylum|{{opt|monster}}}}<br /> {{Flink|boolean [int]|monster_pockets}}<br /> {{Flink|void|mood_execute|int}}<br /> {{Flink|string [0]|mood_list}}<br /> {{Flink|int|moon_light}}<br /> {{Flink|int|moon_phase}}<br /> {{Flink|int|mp_cost|skill}}<br /> {{Flink|int|my_absorbs}}<br /> {{Flink|int|my_adventures}}<br /> {{Flink|int|my_ascensions}}<br /> {{Flink|int|my_audience}}<br /> {{Flink|int|my_basestat|stat}}<br /> {{Flink|familiar|my_bjorned_familiar}}<br /> {{Flink|int|my_buffedstat|stat}}<br /> {{Flink|class|my_class}}<br /> {{Flink|int|my_closet_meat}}<br /> {{Flink|string|my_companion}}<br /> {{Flink|int|my_daycount}}<br /> {{Flink|int|my_discomomentum}}<br /> {{Flink|familiar|my_effective_familiar}}<br /> {{Flink|int [effect]|my_effects}}<br /> {{Flink|familiar|my_enthroned_familiar}}<br /> {{Flink|familiar|my_familiar}}<br /> {{Flink|int|my_fullness}}<br /> {{Flink|int|my_fury}}<br /> {{Flink|string|my_garden_type}}<br /> {{Flink|string|my_hash}}<br /> {{Flink|int|my_hp}}<br /> {{Flink|string|my_id}}<br /> {{Flink|int|my_inebriety}}<br /> {{Flink|int|my_level}}<br /> {{Flink|int|my_lightning}}<br /> {{Flink|location|my_location}}<br /> {{Flink|string|my_mask}}<br /> {{Flink|int|my_maxfury}}<br /> {{Flink|int|my_maxhp}}<br /> {{Flink|int|my_maxmp}}<br /> {{Flink|int|my_maxpp}}<br /> {{Flink|int|my_meat}}<br /> {{Flink|int|my_mp}}<br /> {{Flink|string|my_name}}<br /> {{Flink|path|my_path}}<br /> {{Flink|int|my_path_id}}<br /> {{Flink|familiar|my_poke_fam|int}}<br /> {{Flink|int|my_pp}}<br /> {{Flink|stat|my_primestat}}<br /> {{Flink|int|my_rain}}<br /> {{Flink|int|my_robot_energy}}<br /> {{Flink|int|my_robot_scraps}}<br /> {{Flink|servant|my_servant}}<br /> {{Flink|int|my_session_adv}}<br /> {{Flink|int [item]|my_session_items}}<br /> {{Flink|int|my_session_items|item}}<br /> {{Flink|int|my_session_meat}}<br /> {{Flink|int [string]|my_session_results}}<br /> {{Flink|string|my_sign}}<br /> {{Flink|int|my_soulsauce}}<br /> {{Flink|int|my_spleen_use}}<br /> {{Flink|int|my_storage_meat}}<br /> {{Flink|thrall|my_thrall}}<br /> {{Flink|int|my_thunder}}<br /> {{Flink|int|my_turncount}}<br /> {{Flink|vykea|my_vykea_companion}}<br /> {{Flink|int|my_wildfire_water}}<br /> <br /> ===n===<br /> {{Flink|int|now_to_int}}<br /> {{Flink|string|now_to_string|string}}<br /> {{Flink|int|npc_price|item}}<br /> {{Flink|string|numberology_prize|int}}<br /> {{Flink|float|numeric_modifier|effect|string}}<br /> {{Flink|float|numeric_modifier|familiar|string|int|item}}<br /> {{Flink|float|numeric_modifier|item|string}}<br /> {{Flink|float|numeric_modifier|skill|string}}<br /> {{Flink|float|numeric_modifier|{{opt|string}}|string}}<br /> <br /> ===o===<br /> {{Flink|boolean|outfit|string}}<br /> {{Flink|item [0]|outfit_pieces|string}}<br /> {{Flink|string|outfit_tattoo|{{opt|string}}}}<br /> {{Flink|float [item]|outfit_treats|string}}<br /> {{FunctionEmbed|overdrink|format=signature}}<br /> <br /> ===p===<br /> {{Flink|string|path_id_to_name|int}}<br /> {{Flink|int|path_name_to_id|string}}<br /> {{Flink|boolean|pick_pocket|int}}<br /> {{Flink|boolean|pick_pocket|monster}}<br /> {{Flink|int [effect]|pick_pocket|effect}}<br /> {{Flink|int [item]|pick_pocket|item}}<br /> {{Flink|int [stat]|pick_pocket|stat}}<br /> {{Flink|boolean [int]|picked_pockets}}<br /> {{Flink|boolean [int]|picked_scraps}}<br /> {{Flink|int [effect]|pocket_effects|int}}<br /> {{Flink|int [item]|pocket_items|int}}<br /> {{Flink|string|pocket_joke|int}}<br /> {{Flink|string [int]|pocket_meat|int}}<br /> {{Flink|monster|pocket_monster|int}}<br /> {{Flink|string [int]|pocket_poem|int}}<br /> {{Flink|string [int]|pocket_scrap|int}}<br /> {{Flink|int [stat]|pocket_stats|int}}<br /> {{Flink|int [int]|poem_pockets}}<br /> {{Flink|int [int]|potential_pockets|effect/item/monster/stat}}<br /> {{Flink|boolean|pre_validate_adventure|location}}<br /> {{Flink|boolean|prepare_for_adventure|location}}<br /> {{Flink|void|print|{{opt|string}}|{{opt|string}}}}<br /> {{Flink|void|print_html|string|boolean}}<br /> {{Flink|void|print_html|string}}<br /> {{FunctionEmbed|property_default_value|format=signature}}<br /> {{FunctionEmbed|property_exists|format=signature}}<br /> {{FunctionEmbed|property_has_default|format=signature}}<br /> {{Flink|int|pulls_remaining}}<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_display|item|int}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|put_stash|item|int}}<br /> {{Flink|int|pvp_attacks_left}}<br /> <br /> ===r===<br /> {{Flink|int|rain_cost|skill}}<br /> {{Flink|int|random|int}}<br /> {{Flink|int|raw_damage_absorption}}<br /> {{Flink|buffer|read_ccs|string}}<br /> {{Flink|void|receive_fax}}<br /> {{Flink|boolean|refresh_shop}}<br /> {{Flink|boolean|refresh_stash}}<br /> {{Flink|boolean|refresh_status}}<br /> {{Flink|void|remove_item_condition|int|item}}<br /> {{Flink|void|remove_item_condition|item|int}}<br /> {{FunctionEmbed|remove_property|format=signature}}<br /> {{FunctionEmbed|rename_property|format=signature}}<br /> {{Flink|buffer|replace|buffer|int|int|string}}<br /> {{Flink|string|replace_all|matcher|string}}<br /> {{Flink|string|replace_first|matcher|string}}<br /> {{Flink|buffer|replace_string|buffer|string|string}}<br /> {{Flink|buffer|replace_string|string|string|string}}<br /> {{Flink|boolean|reprice_shop|int|{{opt|int}}|item}}<br /> {{Flink|matcher|reset|matcher|{{opt|string}}}}<br /> {{Flink|boolean [int]|restoration_pockets}}<br /> {{Flink|boolean|restore_hp|int}}<br /> {{Flink|boolean|restore_mp|int}}<br /> {{Flink|boolean|retrieve_item|int|item}}<br /> {{Flink|boolean|retrieve_item|item|{{opt|int}}}}<br /> {{Flink|int|retrieve_price|int|item|boolean}}<br /> {{Flink|int|retrieve_price|int|item}}<br /> {{Flink|int|retrieve_price|item|int|boolean}}<br /> {{Flink|int|retrieve_price|item|int}}<br /> {{Flink|int|retrieve_price|item}}<br /> {{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}<br /> {{Flink|int|rollover}}<br /> {{Flink|int|round|float}}<br /> {{FunctionEmbed|run_choice|format=signature}}<br /> {{Flink|buffer|run_combat|{{opt|string}}}}<br /> {{Flink|buffer|run_turn}}<br /> {{Flink|buffer|runaway}}<br /> <br /> ===s===<br /> {{Flink|int [int]|scrap_pockets}}<br /> {{Flink|boolean|sell|coinmaster|int|item}}<br /> {{Flink|int|sell_price|coinmaster|item}}<br /> {{Flink|boolean|sells_item|coinmaster|item}}<br /> {{Flink|void|send_fax}}<br /> {{Flink|string [int]|session_logs|{{opt|string}}|{{opt|string}}|int}}<br /> {{Flink|void|set_auto_attack|int/string}}<br /> {{Flink|boolean|set_ccs|string}}<br /> {{Flink|void|set_length|buffer|int}}<br /> {{Flink|void|set_location|location}}<br /> {{Flink|void|set_property|string|string}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|shop_limit|item}}<br /> {{Flink|int|shop_price|item}}<br /> {{Flink|skill|skill_modifier|item|string}}<br /> {{Flink|skill|skill_modifier|string|string}}<br /> {{Flink|int|slash_count|item}}<br /> {{Flink|int|soulsauce_cost|skill}}<br /> {{Flink|int|spleen_limit}}<br /> {{Flink|string [int]|split_string|string|{{opt|string}}}}<br /> {{Flink|float|square_root|float}}<br /> {{Flink|int|start|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|starts_with|format=signature}}<br /> {{Flink|int|stash_amount|item}}<br /> {{Flink|stat|stat_bonus_today}}<br /> {{Flink|stat|stat_bonus_tomorrow}}<br /> {{Flink|stat|stat_modifier|effect|string}}<br /> {{Flink|boolean [int]|stats_pockets}}<br /> {{Flink|buffer|steal}}<br /> {{Flink|int|stills_available}}<br /> {{Flink|void|stop_counter|string}}<br /> {{Flink|int|storage_amount|item}}<br /> {{Flink|string|string_modifier|{{opt|string}}|string}}<br /> {{Flink|skill|stun_skill}}<br /> {{Flink|string|substring|string|int|{{opt|int}}}}<br /> {{Flink|boolean|svn_at_head|string}}<br /> {{Flink|boolean|svn_exists|string}}<br /> {{Flink|string [0]|svn_list}}<br /> {{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}<br /> {{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}<br /> {{Flink|item [0]|sweet_synthesis_pairing|effect|item|int}}<br /> {{Flink|item [0]|sweet_synthesis_pairing|effect|item}}<br /> {{Flink|effect|sweet_synthesis_result|item|item}}<br /> <br /> ===t===<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_display|item|int}}<br /> {{Flink|boolean|take_shop|{{opt|int}}|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_stash|item|int}}<br /> {{Flink|boolean|take_storage|int|item}}<br /> {{Flink|boolean|take_storage|item|int}}<br /> {{Flink|int|tavern|{{opt|string}}}}<br /> {{Flink|buffer|throw_item|item}}<br /> {{Flink|buffer|throw_items|item|item}}<br /> {{Flink|int|thunder_cost|skill}}<br /> {{Flink|string|time_to_string}}<br /> {{Flink|string|timestamp_to_date|int|string}}<br /> {{Flink|boolean|to_boolean|any}}<br /> {{Flink|bounty|to_bounty|strict_string}}<br /> {{Flink|class|to_class|strict_string/int}}<br /> {{Flink|coinmaster|to_coinmaster|strict_string}}<br /> {{Flink|effect|to_effect|int/skill/strict_string}}<br /> {{Flink|element|to_element|strict_string}}<br /> {{Flink|familiar|to_familiar|int/strict_string}}<br /> {{Flink|float|to_float|any}}<br /> {{Flink|int|to_int|any}}<br /> {{Flink|item|to_item|int/strict_string}}<br /> {{Flink|item|to_item|string|int}}<br /> {{Flink|string|to_json|aggregate}}<br /> {{Flink|location|to_location|int/strict_string}}<br /> {{Flink|string|to_lower_case|string}}<br /> {{Flink|monster|to_monster|int/strict_string}}<br /> {{Flink|path|to_path|int}}<br /> {{Flink|path|to_path|strict_string}}<br /> {{Flink|phylum|to_phylum|strict_string}}<br /> {{Flink|string|to_plural|item}}<br /> {{Flink|servant|to_servant|int/strict_string}}<br /> {{Flink|skill|to_skill|effect/int}}<br /> {{Flink|skill|to_skill|strict_string|{{opt|strict_string}}}}<br /> {{Flink|slot|to_slot|item/strict_string}}<br /> {{Flink|stat|to_stat|strict_string}}<br /> {{Flink|string|to_string|any}}<br /> {{Flink|thrall|to_thrall|int/strict_string}}<br /> {{Flink|string|to_upper_case|string}}<br /> {{Flink|string|to_url|location}}<br /> {{Flink|vykea|to_vykea|strict_string}}<br /> {{Flink|string|to_wiki_url|effect}}<br /> {{Flink|string|to_wiki_url|item}}<br /> {{Flink|string|to_wiki_url|monster}}<br /> {{Flink|string|to_wiki_url|skill}}<br /> {{Flink|string|to_wiki_url|string}}<br /> {{Flink|string|today_to_string}}<br /> {{Flink|int|total_free_rests}}<br /> {{Flink|int|total_turns_played}}<br /> {{Flink|boolean|tower_door}}<br /> {{Flink|void|traceprint|string}}<br /> {{Flink|int|truncate|float}}<br /> {{Flink|int|turns_per_cast|skill}}<br /> {{Flink|int|turns_played}}<br /> {{Flink|buffer|twiddle}}<br /> <br /> ===u===<br /> {{Flink|item|unusual_construct_disc}}<br /> {{Flink|void|update_candy_prices}}<br /> {{Flink|string|url|int|revision|string|last_changed_author|int|last_changed_rev|string|last_changed_date|svn_info|string}}<br /> {{Flink|string|url|string|branch|string|commit|string|last_changed_author|string|last_changed_date|git_info|string}}<br /> {{Flink|string|url_decode|string}}<br /> {{Flink|string|url_encode|string}}<br /> {{Flink|boolean|use|int|item}}<br /> {{Flink|boolean|use|item|{{opt|int}}}}<br /> {{Flink|boolean|use_familiar|familiar}}<br /> {{Flink|boolean|use_servant|servant}}<br /> {{Flink|boolean|use_skill|int|skill|{{opt|string}}}}<br /> {{Flink|boolean|use_skill|skill|int|{{opt|string}}}}<br /> {{Flink|buffer|use_skill|skill}}<br /> {{Flink|boolean|user_confirm|string|int|boolean}}<br /> {{Flink|boolean|user_confirm|string}}<br /> {{Flink|void|user_notify|string|boolean}}<br /> {{Flink|void|user_notify|string}}<br /> {{Flink|string|user_prompt|string|aggregate}}<br /> {{Flink|string|user_prompt|string|int|string}}<br /> {{Flink|string|user_prompt|string}}<br /> <br /> ===v===<br /> {{Flink|boolean|visit|coinmaster}}<br /> {{FunctionEmbed|visit_url}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|class|path|int}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}<br /> <br /> ===w===<br /> {{Flink|void|wait|int}}<br /> {{Flink|void|waitq|int}}<br /> {{Flink|int|weapon_hands|item}}<br /> {{Flink|stat|weapon_type|item}}<br /> {{Flink|int|weight_adjustment}}<br /> {{Flink|boolean|well_stocked|string|int|int}}<br /> {{Flink|boolean|white_citadel_available}}<br /> {{Flink|boolean [string]|who_clan}}<br /> {{Flink|boolean|will_usually_dodge}}<br /> {{Flink|boolean|will_usually_miss}}<br /> {{Flink|void|write|string}}<br /> {{Flink|boolean|write_ccs|buffer|string}}<br /> {{Flink|void|writeln|string}}<br /> <br /> ===x===<br /> {{Flink|string [0]|xpath|string|string}}<br /> <br /> ===z===<br /> {{Flink|item|zap|item}}<br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=NewFunctionsScript&diff=9217 2023-04-29T04:44:55Z

<p>Eliteofdelete: Created page to script adding new functions to wiki.</p> <hr /> <div>= Guide To Add New Functions To Wiki Via Script =<br /> <br /> == 1. Gather Ashref Functions ==<br /> <br /> * Open KoLmafia and sign-in.<br /> <br /> * Type the following in the CLI<br /> &lt;syntaxhighlight&gt;<br /> debug on<br /> ashref<br /> debug off<br /> &lt;/syntaxhighlight&gt;<br /> <br /> * Create a file called &quot;AshRef Function List.txt&quot; in the KoLmafia folder.<br /> * Locate the &quot;DEBUG_####.txt&quot; file in KoLmafia folder and open it.<br /> * Copy paste all the functions found between the two debugs into the &quot;AshRef Function List.txt&quot; text file.<br /> * See below as an example:&lt;syntaxhighlight&gt;<br /> void &lt;a href='https://wiki.kolmafia.us/index.php?title=abort'&gt;abort&lt;/a&gt;( string )<br /> void &lt;a href='https://wiki.kolmafia.us/index.php?title=abort'&gt;abort&lt;/a&gt;( )<br /> boolean [monster] &lt;a href='https://wiki.kolmafia.us/index.php?title=absorbed_monsters'&gt;absorbed_monsters&lt;/a&gt;( )<br /> void &lt;a href='https://wiki.kolmafia.us/index.php?title=add_item_condition'&gt;add_item_condition&lt;/a&gt;( int, item )<br /> void &lt;a href='https://wiki.kolmafia.us/index.php?title=add_item_condition'&gt;add_item_condition&lt;/a&gt;( item, int )<br /> boolean &lt;a href='https://wiki.kolmafia.us/index.php?title=adv1'&gt;adv1&lt;/a&gt;( location, int, string )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> == 2. Gather Current Wiki Functions ==<br /> <br /> * Create a file called &quot;WikiPage.txt&quot; in the KoLmafia folder.<br /> * Go to the wiki page Ash Functions and click &quot;Edit Source&quot; https://wiki.kolmafia.us/index.php?title=Ash_Functions&amp;action=edit<br /> * Copy paste the entire edit page into the created &quot;WikiPage.txt&quot;. <br /> * See below as an example:&lt;syntaxhighlight&gt;<br /> {{TOCright}}<br /> 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version.<br /> <br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{Flink|boolean [monster]|absorbed_monsters}}<br /> ...etc<br /> &lt;/syntaxhighlight&gt;<br /> <br /> == 3. Running the Script ==<br /> <br /> * Create a new .ash file in the KoLmafia folder (can be named anything)<br /> * Copy paste the following code into it and run it. <br /> * It will output a new text file called &quot;NewWikiPage.txt&quot; with the added functions from the ashref function list.&lt;syntaxhighlight&gt;<br /> # Turns the file into a map but keeps any newlines / comments<br /> string[int] fileToMap (string file) {<br /> string[int] out;<br /> int ct = 1;<br /> matcher finder = create_matcher(&quot;[^\\n]+\\n|[^\\n]+&quot;, file_to_buffer(file));<br /> while (find (finder)) {<br /> out[ct] = group(finder);<br /> ct = ct+1;<br /> }<br /> return out;<br /> }<br /> <br /> # Turns a map of strings into a buffer<br /> buffer mapToBuffer (string[int] map) {<br /> buffer o;<br /> foreach k, v in map {<br /> o = append(o, v);<br /> }<br /> return o;<br /> }<br /> <br /> # Returns the first capture group found<br /> string regexCapture (string regex, string text) {<br /> matcher f = create_matcher(regex, text);<br /> string o = &quot;&quot;;<br /> if (find(f)) {<br /> for i from 1 to group_count(f) {<br /> o = group(f, i);<br /> if (o != &quot;&quot;)<br /> return o;<br /> }<br /> }<br /> return o;<br /> }<br /> <br /> //Copy Paste the wiki into text file and then call this function, Creates a list of all the functions on the wiki<br /> string[int] createFunctionListFromWikiPage(string textFile) {<br /> buffer file = file_to_buffer (textFile);<br /> string[int] wiki; //Wiki is list of functions on wiki while ash is functions from ashref<br /> string regex = &quot;(?:Flink\\|[^\\|]+\\|)([\\w\\d]+)|(?:FunctionEmbed\\|)([\\w\\d]+)&quot;;<br /> matcher finder = create_matcher(regex, file);<br /> int ct = 1;<br /> <br /> # print(file);<br /> while (find (finder)) {<br /> if (group(finder, 1) != &quot;&quot;)<br /> wiki[ct] = group(finder, 1);<br /> else<br /> wiki[ct] = group(finder, 2);<br /> ct = ct + 1;<br /> }<br /> # foreach i, func in wiki {print(func, &quot;blue&quot;);}<br /> return wiki;<br /> }<br /> <br /> //Copy Paste the wiki into text file and then call this function, Creates a list of all the functions on the wiki<br /> string createFunctionListFromWikiText (string test) {<br /> string wiki; //Wiki is functions on wiki <br /> string regex = &quot;(?:Flink\\|[^\\|]+\\|)([\\w\\d]+)|(?:FunctionEmbed\\|)([\\w\\d]+)&quot;;<br /> matcher finder = create_matcher(regex, test);<br /> while (find (finder)) {<br /> if (group(finder, 1) != &quot;&quot;)<br /> wiki = group(finder, 1);<br /> else<br /> wiki = group(finder, 2);<br /> }<br /> return wiki;<br /> }<br /> <br /> # Turn debug on and run ashref. Turn debug off and copy paste the ashrefs from the debug file.<br /> string[int] createFunctionListFromAshRef(string textFile) { <br /> # Creating a list of wiki acceptable functions using the flink notation<br /> buffer file = file_to_buffer (textFile);<br /> matcher finder = create_matcher(&quot;([\\w\\d]+)\\(&quot;, file);<br /> int ct = 1;<br /> string[int] ashFuncs;<br /> while (find (finder)) {<br /> if (group(finder, 1) != &quot;&quot;)<br /> ashFuncs[ct] = group(finder, 1);<br /> else<br /> ashFuncs[ct] = group(finder, 2);<br /> ct = ct + 1;<br /> }<br /> # foreach i, func in ashFuncs {print(func, &quot;blue&quot;);}<br /> return ashFuncs;<br /> }<br /> <br /> //Use function on ashref textfile (that has had its links replaced)<br /> string[string] createWikiFlinkFunctions (string textFile){<br /> buffer file = file_to_buffer (textFile);<br /> string[string] ash; #Map will be key of flinkInfo, val of functionName<br /> string regex = &quot;(\\[[^\\]]+\\])|([\\w\\[\\]]+)|([\\(\\)])&quot;;<br /> matcher finder = create_matcher(regex, file);<br /> string temp = &quot;{{Flink&quot;;<br /> string text, capture;<br /> while (find (finder)) {<br /> text = group(finder);<br /> if(contains_text(text, &quot;[&quot;)) #Map parameters<br /> temp = temp + &quot; &quot; + text;<br /> else if (text == &quot;)&quot;) { #End of function<br /> temp = temp + &quot;}}&quot;;<br /> capture = regexCapture(&quot;(?:Flink[^\\]]+(?=\\]))\\]\\|([\\w\\d]+)|(?:Flink\\|[^\\|]+\\|)([\\w\\d]+)&quot;, temp);<br /> ash[temp] = capture;<br /> temp = &quot;{{Flink&quot;; #Prep for next function<br /> }<br /> else if (text == &quot;(&quot;) {} #Start of inputs<br /> else <br /> temp = temp + &quot;|&quot; + text; #everything else<br /> # foreach i, func in ash {print(func, &quot;blue&quot;);}<br /> }<br /> # foreach key, val in ash {print (&quot;Key: &quot; + key + &quot;. Val: &quot; + val);}<br /> # buffer_to_file(mapToBuffer(mapBufferFile (&quot;WikiPageTest.txt&quot;)), &quot;WikiPageTest2.txt&quot;);<br /> <br /> return ash;<br /> }<br /> <br /> buffer regexBufferReplace (string regex, string newText, buffer text) {<br /> matcher m = create_matcher(regex, text);<br /> buffer b;<br /> while (m.find()) {<br /> append_replacement(m,b , newText);<br /> }<br /> return append_tail(m, b);<br /> }<br /> <br /> void main() {<br /> print (&quot;Starting to generate the new wiki page from the ashref function list!&quot;, &quot;blue&quot;);<br /> string wikiTextFile = &quot;WikiPage.txt&quot;;<br /> string ashRefFile = &quot;AshRef Function List.txt&quot;;<br /> string newWikiFile = &quot;NewWikiPage.txt&quot;;<br /> buffer newWiki, ashRefs, file;<br /> record wikiInfo { <br /> string func;<br /> string flink;<br /> };<br /> wikiInfo[int] wikiFunctions;<br /> string temp;<br /> string[int] wikiFuncs, wikiFile;<br /> boolean[string] ashFuncs;<br /> string[string] ashrefFlinkFuncs, completedFuncs;<br /> ashRefs = file_to_buffer(ashRefFile);<br /> if (contains_text (ashRefs, &quot;&lt;&quot;)) { # Contains hyper links, remove them<br /> ashRefs = regexBufferReplace(&quot;&lt;[^\&gt;]+&gt;&quot;, &quot;&quot;, ashRefs);<br /> buffer_to_file(ashRefs, ashRefFile);<br /> }<br /> ashrefFlinkFuncs = createWikiFlinkFunctions(ashRefFile);<br /> wikiFile = fileToMap (&quot;WikiPage.txt&quot;);<br /> <br /> # Comb the existing wiki to keep any of the already updated functions. I.e. functions that have FunctionEmbed, opt, /, or any <br /> foreach i, line in wikiFile {<br /> if (contains_text(line, &quot;FunctionEmbed&quot;) || contains_text(line, &quot;{{opt&quot;) || contains_text(line, &quot;/&quot;) || contains_text(line, &quot;any&quot;)) { #Remove existing entries that have been completed<br /> temp = createFunctionListFromWikiText(line);<br /> foreach key, func in ashrefFlinkFuncs { #Also skipping any {{opt functions as I don't know that info so better to not mess with<br /> if(temp == func) {<br /> remove ashrefFlinkFuncs[key]; #Remove the current iteration<br /> completedFuncs[line] = func; #Replace it with the embed or opt<br /> ashFuncs[func] = true;<br /> }<br /> }<br /> }<br /> }<br /> <br /> # Make sure we didn't skip/miss any functions that had multiple entries but with different input parameters<br /> foreach i, line in wikiFile {<br /> temp = createFunctionListFromWikiText(line);<br /> if (ashFuncs[temp]) <br /> completedFuncs[line] = temp;<br /> }<br /> <br /> # Add the remainning new functions to the completed list<br /> foreach key, func in ashrefFlinkFuncs {completedFuncs[key] = func;}<br /> <br /> # Set the completed list to the new record for ease of sorting<br /> foreach k, v in completedFuncs { <br /> wikiFunctions[count(wikiFunctions)] = new wikiInfo(v, k);<br /> }<br /> <br /> # Sort the record by alphabetical<br /> sort wikiFunctions by value.flink; <br /> sort wikiFunctions by value.func;<br /> <br /> # foreach k, v in wikiFunctions { print (&quot;Key: &quot; + v.flink + &quot;. Val: &quot; + v.func);}<br /> <br /> # Copy text from wikiFile until &quot;===&quot;<br /> foreach i, line in wikiFile {<br /> if (contains_text(line, &quot;===&quot;))<br /> break;<br /> else <br /> append(newWiki, line);<br /> }<br /> <br /> # Start adding our alphabetical designations<br /> append(newWiki, &quot;===a===&quot;);<br /> string alpha = &quot;a&quot;;<br /> string wikiText;<br /> <br /> # Now loop through our wikiFunctions, building the new wiki page<br /> foreach k, v in wikiFunctions {<br /> append(newWiki, &quot;\n&quot;);<br /> temp = substring(v.func, 0, 1);<br /> wikiText = regexCapture(&quot;([^\\n]+)&quot;, v.flink);<br /> if (temp == alpha)<br /> append(newWiki, wikiText);<br /> else {<br /> append(newWiki, &quot;\n&quot;);<br /> append(newWiki, &quot;===&quot; + temp + &quot;===\n&quot;);<br /> append(newWiki, wikiText);<br /> alpha = temp;<br /> }<br /> }<br /> <br /> #Tack on the existing wiki page ending, everything after the last function<br /> int ct = count(wikiFile);<br /> while (!contains_text(wikiFile[ct], &quot;{{&quot;)) {<br /> ct = ct - 1;<br /> }<br /> ct = ct + 1;<br /> for i from ct to count(wikiFile){<br /> append(newWiki, wikiFile[i]);<br /> }<br /> <br /> #Replace any &quot;null&quot; with type of &quot;any&quot;<br /> newWiki = regexBufferReplace(&quot;\\|null&quot;, &quot;|any&quot;, newWiki);<br /> <br /> #Write the newWiki<br /> buffer_to_file(newWiki, newWikiFile);<br /> print (&quot;Ended. The new wiki page can be found in: &quot; + newWikiFile, &quot;green&quot;);<br /> }<br /> &lt;/syntaxhighlight&gt;<br /> <br /> == 4. Sanity Check &amp; Committing ==<br /> <br /> * Open the text file &quot;NewWikiPage.txt&quot; found in the KoLMafia folder.<br /> * Copy paste it into a diff checker (I use https://www.diffchecker.com/)<br /> * Copy paste the text from the &quot;WikiPage.txt&quot; as the original and the &quot;NewWikiPage.txt&quot; as the new.<br /> * Review results to make sure it didn't go crazy.<br /> * Commit the updated function page to the wiki once everything looks good. <br /> * Remember to change the revision number to the kolmafia number you used!</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Ash_Functions&diff=9216 2023-04-27T07:52:25Z

<p>Eliteofdelete: Added all functions for r27333. Fixed some syntax. Removed some old functions.</p> <hr /> <div>{{TOCright}}<br /> 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version.<br /> <br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{Flink|boolean [monster]|absorbed_monsters}}<br /> {{FunctionEmbed|add_item_condition|format=signature}}<br /> {{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}<br /> {{Flink|int|adv_cost|skill}}<br /> {{Flink|boolean|adventure|int|location|{{opt|string}}}}<br /> {{Flink|boolean|adventure|location|int|{{opt|string}}}}<br /> {{FunctionEmbed|all_monsters_with_id|format=signature}}<br /> {{Flink|string [0]|all_normal_outfits}}<br /> {{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}<br /> {{Flink|buffer|append|buffer|string}}<br /> {{Flink|buffer|append_replacement|matcher|buffer|string}}<br /> {{Flink|buffer|append_tail|matcher|buffer}}<br /> {{Flink|buffer|attack}}<br /> {{Flink|boolean|autosell|int|item}}<br /> {{Flink|boolean|autosell|item|int}}<br /> {{Flink|int|autosell_price|item}}<br /> {{Flink|int|available_amount|item}}<br /> {{FunctionEmbed|available_choice_options}}<br /> {{FunctionEmbed|available_choice_select_inputs}}<br /> {{Flink|string [string]|available_choice_text_inputs|int}}<br /> {{Flink|int|available_pocket|effect}}<br /> {{Flink|int|available_pocket|item}}<br /> {{Flink|int|available_pocket|monster}}<br /> {{Flink|int|available_pocket|stat}}<br /> <br /> ===b===<br /> {{Flink|boolean|batch_close}}<br /> {{Flink|void|batch_open}}<br /> {{Flink|boolean|bjornify_familiar|familiar}}<br /> {{Flink|boolean|black_market_available}}<br /> {{Flink|boolean|boolean_modifier|effect|string}}<br /> {{Flink|boolean|boolean_modifier|item|string}}<br /> {{Flink|boolean|boolean_modifier|{{opt|string}}|string}}<br /> {{Flink|int|buffed_hit_stat}}<br /> {{FunctionEmbed|buffer_to_file|format=signature}}<br /> {{Flink|boolean|buy|coinmaster|item}}<br /> {{Flink|boolean|buy|item|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}<br /> {{Flink|int|buy|int|item|int}}<br /> {{Flink|int|buy_price|coinmaster|item}}<br /> {{Flink|boolean|buy_using_storage|int|item}}<br /> {{Flink|boolean|buy_using_storage|item|int}}<br /> {{Flink|boolean|buy_using_storage|item}}<br /> {{Flink|int|buy_using_storage|int|item|int}}<br /> {{Flink|int|buy_using_storage|item|int|int}}<br /> {{Flink|boolean|buys_item|coinmaster|item}}<br /> <br /> ===c===<br /> {{Flink|boolean|can_adventure|location}}<br /> {{Flink|boolean|can_drink}}<br /> {{Flink|boolean|can_eat}}<br /> {{Flink|boolean|can_equip|familiar|{{opt|item}}}}<br /> {{Flink|boolean|can_equip|item}}<br /> {{Flink|boolean|can_faxbot|monster}}<br /> {{Flink|boolean|can_interact}}<br /> {{Flink|boolean|can_still_steal}}<br /> {{Flink|boolean|canadia_available}}<br /> {{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}<br /> {{Flink|int|ceil|float}}<br /> {{Flink|boolean|change_mcd|int}}<br /> {{Flink|string|char_at|string|int}}<br /> {{Flink|void|chat_clan|string|{{opt|string}}}}<br /> {{Flink|void|chat_macro|string}}<br /> {{Flink|void|chat_notify|string|string}}<br /> {{Flink|void|chat_private|string|string}}<br /> {{Flink|boolean|chew|int|item}}<br /> {{Flink|boolean|chew|item|{{opt|int}}}}<br /> {{Flink|boolean|choice_follows_fight}}<br /> {{Flink|class|class_modifier|item|string}}<br /> {{Flink|class|class_modifier|string|string}}<br /> {{Flink|void|clear|aggregate}}<br /> {{FunctionEmbed|clear_booze_helper|format=signature}}<br /> {{FunctionEmbed|clear_food_helper|format=signature}}<br /> {{FunctionEmbed|cli_execute|format=signature}}<br /> {{FunctionEmbed|cli_execute_output|format=signature}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|combat_mana_cost_modifier}}<br /> {{Flink|float|combat_rate_modifier}}<br /> {{Flink|boolean|combat_skill_available|skill}}<br /> {{Flink|int|concoction_price|item}}<br /> {{Flink|int|concoction_price|vykea}}<br /> {{FunctionEmbed|contains_text|format=signature}}<br /> {{Flink|void|council}}<br /> {{Flink|int|count|aggregate}}<br /> {{Flink|int|craft|string|int|item|item}}<br /> {{Flink|string|craft_type|item}}<br /> {{Flink|int|creatable_amount|item}}<br /> {{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}<br /> {{Flink|boolean|create|int|item}}<br /> {{Flink|boolean|create|item|{{opt|int}}}}<br /> {{Flink|matcher|create_matcher|string|string}}<br /> {{Flink|stat|current_hit_stat}}<br /> {{Flink|int|current_mcd}}<br /> {{Flink|int [string]|current_pvp_stances}}<br /> {{Flink|int|current_rad_sickness}}<br /> {{Flink|int|current_round}}<br /> <br /> ===d===<br /> {{Flink|element|dad_sea_monkee_weakness|int}}<br /> {{Flink|item|daily_special}}<br /> {{Flink|float|damage_absorption_percent}}<br /> {{Flink|int|damage_reduction}}<br /> {{Flink|int|date_to_timestamp|string|string}}<br /> {{Flink|int|daycount}}<br /> {{Flink|void|debugprint|string}}<br /> {{Flink|buffer|delete|buffer|int|int}}<br /> {{Flink|effect|desc_to_effect|string}}<br /> {{Flink|item|desc_to_item|string}}<br /> {{Flink|void|disable|string}}<br /> {{Flink|boolean|dispensary_available}}<br /> {{Flink|int|display_amount|item}}<br /> {{FunctionEmbed|drink|format=signature}}<br /> {{Flink|boolean|drinksilent|int|item}}<br /> {{Flink|boolean|drinksilent|item|{{opt|int}}}}<br /> {{Flink|void|dump|any|{{opt|string}}}}<br /> <br /> ===e===<br /> {{FunctionEmbed|eat|format=signature}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eatsilent|item|{{opt|int}}}}<br /> {{Flink|effect|effect_modifier|item|string}}<br /> {{Flink|effect|effect_modifier|string|string}}<br /> {{Flink|boolean [int]|effect_pockets}}<br /> {{Flink|int|eight_bit_points|location|string|float}}<br /> {{Flink|int|eight_bit_points|location}}<br /> {{Flink|float|elemental_resistance|monster}}<br /> {{Flink|float|elemental_resistance|{{opt|element}}}}<br /> {{Flink|boolean|empty_closet}}<br /> {{Flink|void|enable|string}}<br /> {{Flink|int|end|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|ends_with|format=signature}}<br /> {{Flink|boolean|enthrone_familiar|familiar}}<br /> {{Flink|string|entity_decode|string}}<br /> {{Flink|string|entity_encode|string}}<br /> {{Flink|boolean|equip|item|{{opt|slot}}}}<br /> {{Flink|boolean|equip|slot|item}}<br /> {{Flink|boolean|equip_all_familiars}}<br /> {{Flink|int|equipped_amount|item|boolean}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|item|equipped_item|slot}}<br /> {{Flink|boolean|eudora|string}}<br /> {{Flink|string|eudora}}<br /> {{Flink|item|eudora_item}}<br /> {{Flink|string|every_card_name|strict_string}}<br /> {{Flink|item [string]|expected_cold_medicine_cabinet}}<br /> {{Flink|int|expected_damage|{{opt|monster}}}}<br /> {{Flink|float|experience_bonus}}<br /> {{Flink|float|expression_eval|string}}<br /> {{Flink|int [item]|extract_items|string}}<br /> {{Flink|int|extract_meat|string}}<br /> <br /> ===f===<br /> {{Flink|item|familiar_equipment|familiar}}<br /> {{Flink|item|familiar_equipped_equipment|familiar}}<br /> {{Flink|int|familiar_weight|familiar}}<br /> {{Flink|boolean [familiar]|favorite_familiars}}<br /> {{Flink|boolean|faxbot|monster|{{opt|string}}}}<br /> {{Flink|boolean|fight_follows_choice}}<br /> {{FunctionEmbed|file_to_array|format=signature}}<br /> {{FunctionEmbed|file_to_buffer|format=signature}}<br /> {{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}<br /> {{Flink|boolean|find|matcher}}<br /> {{Flink|int|floor|float}}<br /> {{Flink|boolean|florist_available}}<br /> {{Flink|boolean|flush_monster_manuel_cache}}<br /> {{Flink|string|form_field|string}}<br /> {{Flink|string [string]|form_fields}}<br /> {{Flink|string|format_date_time|string|string|string}}<br /> {{Flink|boolean|friars_available}}<br /> {{Flink|int|fuel_cost|skill}}<br /> {{Flink|int|fullness_limit}}<br /> <br /> ===g===<br /> {{Flink|int|gameday_to_int}}<br /> {{Flink|string|gameday_to_string}}<br /> {{Flink|int|gametime_to_int}}<br /> {{Flink|boolean [string]|get_all_properties|string|boolean}}<br /> {{Flink|int|get_auto_attack}}<br /> {{Flink|location [0]|get_autumnaton_locations}}<br /> {{Flink|int [item]|get_campground}}<br /> {{Flink|string|get_ccs_action|int}}<br /> {{Flink|int [item]|get_chateau}}<br /> {{Flink|int|get_clan_id}}<br /> {{Flink|int [item]|get_clan_lounge}}<br /> {{Flink|string|get_clan_name}}<br /> {{Flink|int [string]|get_clan_rumpus}}<br /> {{Flink|int [item]|get_closet}}<br /> {{Flink|int|get_counter|string}}<br /> {{Flink|string|get_counters|string|int|int}}<br /> {{Flink|string [0]|get_custom_outfits}}<br /> {{Flink|int [item]|get_display}}<br /> {{Flink|item|get_dwelling}}<br /> {{Flink|location [string]|get_fishing_locations}}<br /> {{Flink|string [location, 3]|get_florist_plants}}<br /> {{Flink|int [item]|get_free_pulls}}<br /> {{Flink|int|get_fuel}}<br /> {{Flink|string [0]|get_goals}}<br /> {{Flink|boolean|get_ignore_zone_warnings}}<br /> {{Flink|int [item]|get_ingredients|item}}<br /> {{Flink|int [item]|get_inventory}}<br /> {{Flink|boolean [monster]|get_location_monsters|location}}<br /> {{Flink|boolean [monster]|get_locket_monsters}}<br /> {{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}<br /> {{Flink|monster [0]|get_monsters|location}}<br /> {{Flink|string [0]|get_moods}}<br /> {{Flink|string [0]|get_outfits}}<br /> {{Flink|string|get_path}}<br /> {{Flink|string|get_path_full}}<br /> {{Flink|string|get_path_variables}}<br /> {{Flink|boolean [skill]|get_permed_skills}}<br /> {{Flink|string|get_player_id|string}}<br /> {{Flink|string|get_player_name|int}}<br /> {{Flink|int|get_power|item}}<br /> {{Flink|string|get_property|string|{{opt|boolean}}}}<br /> {{Flink|int [item]|get_related|item|string}}<br /> {{Flink|int|get_revision}}<br /> {{Flink|int [item]|get_shop}}<br /> {{Flink|string [0]|get_shop_log}}<br /> {{Flink|string|file|string|name|int|line [0]|get_stack_trace}}<br /> {{Flink|int [item]|get_stash}}<br /> {{Flink|int [item]|get_storage}}<br /> {{Flink|string|get_version}}<br /> {{Flink|item|get_workshed}}<br /> {{Flink|item|get_zap_wand}}<br /> {{Flink|boolean|git_at_head|string}}<br /> {{Flink|boolean|git_exists|string}}<br /> {{Flink|string [0]|git_list}}<br /> {{Flink|boolean|gnomads_available}}<br /> {{Flink|boolean|goal_exists|string}}<br /> {{Flink|string|group|matcher|string}}<br /> {{Flink|string|group|matcher|{{opt|int}}}}<br /> {{Flink|int|group_count|matcher}}<br /> {{Flink|boolean [string]|group_names|matcher}}<br /> {{Flink|string [int, int]|group_string|string|string}}<br /> {{Flink|boolean|guild_available}}<br /> {{Flink|boolean|guild_store_available}}<br /> <br /> ===h===<br /> {{Flink|boolean|handling_choice}}<br /> {{Flink|boolean|have_bartender}}<br /> {{Flink|boolean|have_chef}}<br /> {{Flink|boolean|have_display}}<br /> {{Flink|int|have_effect|effect}}<br /> {{Flink|boolean|have_equipped|item}}<br /> {{Flink|boolean|have_familiar|familiar}}<br /> {{Flink|boolean|have_mushroom_plot}}<br /> {{Flink|boolean|have_outfit|string}}<br /> {{Flink|boolean|have_servant|servant}}<br /> {{Flink|boolean|have_shop}}<br /> {{Flink|boolean|have_skill|skill}}<br /> {{Flink|boolean|hedge_maze|string}}<br /> {{Flink|boolean|heist|int|item}}<br /> {{Flink|boolean|heist|item}}<br /> {{Flink|item [monster, int]|heist_targets}}<br /> {{Flink|boolean|hermit|int|item}}<br /> {{Flink|boolean|hermit|item|int}}<br /> {{Flink|boolean|hidden_temple_unlocked}}<br /> {{Flink|boolean|hippy_stone_broken}}<br /> {{Flink|boolean|hippy_store_available}}<br /> {{FunctionEmbed|historical_age}}<br /> {{FunctionEmbed|historical_price}}<br /> {{Flink|string|holiday}}<br /> {{Flink|int|hp_cost|skill}}<br /> <br /> ===i===<br /> {{Flink|monster|image_to_monster|strict_string}}<br /> {{Flink|boolean|in_bad_moon}}<br /> {{Flink|boolean|in_casual}}<br /> {{Flink|boolean|in_hardcore}}<br /> {{Flink|boolean|in_moxie_sign}}<br /> {{Flink|boolean|in_multi_fight}}<br /> {{Flink|boolean|in_muscle_sign}}<br /> {{Flink|boolean|in_mysticality_sign}}<br /> {{Flink|boolean|in_terrarium|familiar}}<br /> {{Flink|string|inaccessible_reason|coinmaster}}<br /> {{FunctionEmbed|index_of|format=signature}}<br /> {{Flink|int|inebriety_limit}}<br /> {{Flink|float|initiative_modifier}}<br /> {{Flink|buffer|insert|buffer|int|string}}<br /> {{Flink|boolean|is_accessible|coinmaster}}<br /> {{Flink|boolean|is_banished|monster}}<br /> {{Flink|boolean|is_coinmaster_item|item}}<br /> {{FunctionEmbed|is_dark_mode}}<br /> {{Flink|boolean|is_discardable|item}}<br /> {{Flink|boolean|is_displayable|item}}<br /> {{Flink|boolean|is_familiar_equipment_locked}}<br /> {{Flink|boolean|is_giftable|item}}<br /> {{Flink|boolean|is_goal|item}}<br /> {{Flink|boolean|is_headless}}<br /> {{Flink|boolean|is_integer|string}}<br /> {{Flink|boolean|is_npc_item|item}}<br /> {{Flink|boolean|is_online|string}}<br /> {{Flink|boolean|is_tradeable|item}}<br /> {{Flink|boolean|is_trendy|item/familiar/skill/string}}<br /> {{Flink|boolean|is_unrestricted|item/familiar/skill/string}}<br /> {{Flink|boolean|is_wearing_outfit|string}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|float|item_drop_modifier}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}}}<br /> {{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}<br /> {{Flink|boolean [int]|item_pockets}}<br /> {{Flink|string|item_type|item}}<br /> <br /> ===j===<br /> {{Flink|boolean [int]|joke_pockets}}<br /> {{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}<br /> <br /> ===k===<br /> {{Flink|boolean|knoll_available}}<br /> <br /> ===l===<br /> {{Flink|int|last_choice}}<br /> {{Flink|int|last_decision}}<br /> {{FunctionEmbed|last_index_of|format=signature}}<br /> {{Flink|string|last_item_message}}<br /> {{Flink|monster|last_monster}}<br /> {{Flink|string|last_skill_message}}<br /> {{Flink|string|leetify|string}}<br /> {{Flink|int|length|string}}<br /> {{Flink|int|lightning_cost|skill}}<br /> {{Flink|string|limit_mode}}<br /> {{Flink|buffer|load_html|string}}<br /> {{Flink|void|lock_familiar_equipment|boolean}}<br /> {{Flink|float|log_n|float|{{opt|float}}}}<br /> {{Flink|void|logprint|string}}<br /> <br /> ===m===<br /> {{Flink|string|make_url|string|boolean|boolean}}<br /> {{FunctionEmbed|mall_price}}<br /> {{FunctionEmbed|mall_prices}}<br /> {{Flink|int|mana_cost_modifier}}<br /> {{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}<br /> {{Flink|float|max|float|float}}<br /> {{Flink|int|max|int|int}}<br /> {{Flink|boolean|maximize|string|boolean}}<br /> {{Flink|boolean|maximize|string|int|int|boolean}}<br /> {{Flink|string|display|string|command|float|score|effect|effect|item|item|skill|skill [0]|maximize|string|int|int|boolean|boolean}}<br /> {{Flink|int|meat_drop|{{opt|monster}}}}<br /> {{Flink|float|meat_drop_modifier}}<br /> {{Flink|int [int]|meat_pockets}}<br /> {{Flink|float|min|float|float}}<br /> {{Flink|int|min|int|int}}<br /> {{Flink|item|minstrel_instrument}}<br /> {{Flink|int|minstrel_level}}<br /> {{Flink|boolean|minstrel_quest}}<br /> {{Flink|float|modifier_eval|string}}<br /> {{Flink|boolean|monkey_paw|effect}}<br /> {{Flink|boolean|monkey_paw|item}}<br /> {{Flink|boolean|monkey_paw|string}}<br /> {{Flink|int|monster_attack|{{opt|monster}}}}<br /> {{Flink|int|monster_defense|{{opt|monster}}}}<br /> {{Flink|element|monster_element|{{opt|monster}}}}<br /> {{Flink|float|monster_eval|string}}<br /> {{Flink|int|monster_factoids_available|monster|boolean}}<br /> {{Flink|int|monster_hp|{{opt|monster}}}}<br /> {{Flink|int|monster_initiative|{{opt|monster}}}}<br /> {{Flink|int|monster_level_adjustment}}<br /> {{Flink|string|monster_manuel_text|monster}}<br /> {{Flink|monster|monster_modifier|effect|string}}<br /> {{Flink|phylum|monster_phylum|{{opt|monster}}}}<br /> {{Flink|boolean [int]|monster_pockets}}<br /> {{Flink|void|mood_execute|int}}<br /> {{Flink|string [0]|mood_list}}<br /> {{Flink|int|moon_light}}<br /> {{Flink|int|moon_phase}}<br /> {{Flink|int|mp_cost|skill}}<br /> {{Flink|int|my_absorbs}}<br /> {{Flink|int|my_adventures}}<br /> {{Flink|int|my_ascensions}}<br /> {{Flink|int|my_audience}}<br /> {{Flink|int|my_basestat|stat}}<br /> {{Flink|familiar|my_bjorned_familiar}}<br /> {{Flink|int|my_buffedstat|stat}}<br /> {{Flink|class|my_class}}<br /> {{Flink|int|my_closet_meat}}<br /> {{Flink|string|my_companion}}<br /> {{Flink|int|my_daycount}}<br /> {{Flink|int|my_discomomentum}}<br /> {{Flink|familiar|my_effective_familiar}}<br /> {{Flink|int [effect]|my_effects}}<br /> {{Flink|familiar|my_enthroned_familiar}}<br /> {{Flink|familiar|my_familiar}}<br /> {{Flink|int|my_fullness}}<br /> {{Flink|int|my_fury}}<br /> {{Flink|string|my_garden_type}}<br /> {{Flink|string|my_hash}}<br /> {{Flink|int|my_hp}}<br /> {{Flink|string|my_id}}<br /> {{Flink|int|my_inebriety}}<br /> {{Flink|int|my_level}}<br /> {{Flink|int|my_lightning}}<br /> {{Flink|location|my_location}}<br /> {{Flink|string|my_mask}}<br /> {{Flink|int|my_maxfury}}<br /> {{Flink|int|my_maxhp}}<br /> {{Flink|int|my_maxmp}}<br /> {{Flink|int|my_maxpp}}<br /> {{Flink|int|my_meat}}<br /> {{Flink|int|my_mp}}<br /> {{Flink|string|my_name}}<br /> {{Flink|path|my_path}}<br /> {{Flink|int|my_path_id}}<br /> {{Flink|familiar|my_poke_fam|int}}<br /> {{Flink|int|my_pp}}<br /> {{Flink|stat|my_primestat}}<br /> {{Flink|int|my_rain}}<br /> {{Flink|int|my_robot_energy}}<br /> {{Flink|int|my_robot_scraps}}<br /> {{Flink|servant|my_servant}}<br /> {{Flink|int|my_session_adv}}<br /> {{Flink|int [item]|my_session_items}}<br /> {{Flink|int|my_session_items|item}}<br /> {{Flink|int|my_session_meat}}<br /> {{Flink|int [string]|my_session_results}}<br /> {{Flink|string|my_sign}}<br /> {{Flink|int|my_soulsauce}}<br /> {{Flink|int|my_spleen_use}}<br /> {{Flink|int|my_storage_meat}}<br /> {{Flink|thrall|my_thrall}}<br /> {{Flink|int|my_thunder}}<br /> {{Flink|int|my_turncount}}<br /> {{Flink|vykea|my_vykea_companion}}<br /> {{Flink|int|my_wildfire_water}}<br /> <br /> ===n===<br /> {{Flink|int|now_to_int}}<br /> {{Flink|string|now_to_string|string}}<br /> {{Flink|int|npc_price|item}}<br /> {{Flink|string|numberology_prize|int}}<br /> {{Flink|float|numeric_modifier|effect|string}}<br /> {{Flink|float|numeric_modifier|familiar|string|int|item}}<br /> {{Flink|float|numeric_modifier|item|string}}<br /> {{Flink|float|numeric_modifier|skill|string}}<br /> {{Flink|float|numeric_modifier|{{opt|string}}|string}}<br /> <br /> ===o===<br /> {{Flink|boolean|outfit|string}}<br /> {{Flink|item [0]|outfit_pieces|string}}<br /> {{Flink|string|outfit_tattoo|{{opt|string}}}}<br /> {{Flink|float [item]|outfit_treats|string}}<br /> {{FunctionEmbed|overdrink|format=signature}}<br /> <br /> ===p===<br /> {{Flink|string|path_id_to_name|int}}<br /> {{Flink|int|path_name_to_id|string}}<br /> {{Flink|boolean|pick_pocket|int}}<br /> {{Flink|boolean|pick_pocket|monster}}<br /> {{Flink|int [effect]|pick_pocket|effect}}<br /> {{Flink|int [item]|pick_pocket|item}}<br /> {{Flink|int [stat]|pick_pocket|stat}}<br /> {{Flink|boolean [int]|picked_pockets}}<br /> {{Flink|boolean [int]|picked_scraps}}<br /> {{Flink|int [effect]|pocket_effects|int}}<br /> {{Flink|int [item]|pocket_items|int}}<br /> {{Flink|string|pocket_joke|int}}<br /> {{Flink|string [int]|pocket_meat|int}}<br /> {{Flink|monster|pocket_monster|int}}<br /> {{Flink|string [int]|pocket_poem|int}}<br /> {{Flink|string [int]|pocket_scrap|int}}<br /> {{Flink|int [stat]|pocket_stats|int}}<br /> {{Flink|int [int]|poem_pockets}}<br /> {{Flink|int [int]|potential_pockets|effect/item/monster/stat}}<br /> {{Flink|boolean|pre_validate_adventure|location}}<br /> {{Flink|boolean|prepare_for_adventure|location}}<br /> {{Flink|void|print|{{opt|string}}|{{opt|string}}}}<br /> {{Flink|void|print_html|string|boolean}}<br /> {{Flink|void|print_html|string}}<br /> {{FunctionEmbed|property_default_value|format=signature}}<br /> {{FunctionEmbed|property_exists|format=signature}}<br /> {{FunctionEmbed|property_has_default|format=signature}}<br /> {{Flink|int|pulls_remaining}}<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_display|item|int}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|put_stash|item|int}}<br /> {{Flink|int|pvp_attacks_left}}<br /> <br /> ===r===<br /> {{Flink|int|rain_cost|skill}}<br /> {{Flink|int|random|int}}<br /> {{Flink|int|raw_damage_absorption}}<br /> {{Flink|buffer|read_ccs|string}}<br /> {{Flink|void|receive_fax}}<br /> {{Flink|boolean|refresh_shop}}<br /> {{Flink|boolean|refresh_stash}}<br /> {{Flink|boolean|refresh_status}}<br /> {{Flink|void|remove_item_condition|int|item}}<br /> {{Flink|void|remove_item_condition|item|int}}<br /> {{FunctionEmbed|remove_property|format=signature}}<br /> {{FunctionEmbed|rename_property|format=signature}}<br /> {{Flink|buffer|replace|buffer|int|int|string}}<br /> {{Flink|string|replace_all|matcher|string}}<br /> {{Flink|string|replace_first|matcher|string}}<br /> {{Flink|buffer|replace_string|buffer|string|string}}<br /> {{Flink|buffer|replace_string|string|string|string}}<br /> {{Flink|boolean|reprice_shop|int|{{opt|int}}|item}}<br /> {{Flink|matcher|reset|matcher|{{opt|string}}}}<br /> {{Flink|boolean [int]|restoration_pockets}}<br /> {{Flink|boolean|restore_hp|int}}<br /> {{Flink|boolean|restore_mp|int}}<br /> {{Flink|boolean|retrieve_item|int|item}}<br /> {{Flink|boolean|retrieve_item|item|{{opt|int}}}}<br /> {{Flink|int|retrieve_price|int|item|boolean}}<br /> {{Flink|int|retrieve_price|int|item}}<br /> {{Flink|int|retrieve_price|item|int|boolean}}<br /> {{Flink|int|retrieve_price|item|int}}<br /> {{Flink|int|retrieve_price|item}}<br /> {{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}<br /> {{Flink|int|rollover}}<br /> {{Flink|int|round|float}}<br /> {{FunctionEmbed|run_choice|format=signature}}<br /> {{Flink|buffer|run_combat|{{opt|string}}}}<br /> {{Flink|buffer|run_turn}}<br /> {{Flink|buffer|runaway}}<br /> <br /> ===s===<br /> {{Flink|int [int]|scrap_pockets}}<br /> {{Flink|boolean|sell|coinmaster|int|item}}<br /> {{Flink|int|sell_price|coinmaster|item}}<br /> {{Flink|boolean|sells_item|coinmaster|item}}<br /> {{Flink|void|send_fax}}<br /> {{Flink|string [int]|session_logs|{{opt|string}}|{{opt|string}}|int}}<br /> {{Flink|void|set_auto_attack|int/string}}<br /> {{Flink|boolean|set_ccs|string}}<br /> {{Flink|void|set_length|buffer|int}}<br /> {{Flink|void|set_location|location}}<br /> {{Flink|void|set_property|string|string}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|shop_limit|item}}<br /> {{Flink|int|shop_price|item}}<br /> {{Flink|skill|skill_modifier|item|string}}<br /> {{Flink|skill|skill_modifier|string|string}}<br /> {{Flink|int|slash_count|item}}<br /> {{Flink|int|soulsauce_cost|skill}}<br /> {{Flink|int|spleen_limit}}<br /> {{Flink|string [int]|split_string|string|{{opt|string}}}}<br /> {{Flink|float|square_root|float}}<br /> {{Flink|int|start|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|starts_with|format=signature}}<br /> {{Flink|int|stash_amount|item}}<br /> {{Flink|stat|stat_bonus_today}}<br /> {{Flink|stat|stat_bonus_tomorrow}}<br /> {{Flink|stat|stat_modifier|effect|string}}<br /> {{Flink|boolean [int]|stats_pockets}}<br /> {{Flink|buffer|steal}}<br /> {{Flink|int|stills_available}}<br /> {{Flink|void|stop_counter|string}}<br /> {{Flink|int|storage_amount|item}}<br /> {{Flink|string|string_modifier|{{opt|string}}|string}}<br /> {{Flink|skill|stun_skill}}<br /> {{Flink|string|substring|string|int|{{opt|int}}}}<br /> {{Flink|boolean|svn_at_head|string}}<br /> {{Flink|boolean|svn_exists|string}}<br /> {{Flink|string [0]|svn_list}}<br /> {{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}<br /> {{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}<br /> {{Flink|item [0]|sweet_synthesis_pairing|effect|item|int}}<br /> {{Flink|item [0]|sweet_synthesis_pairing|effect|item}}<br /> {{Flink|effect|sweet_synthesis_result|item|item}}<br /> <br /> ===t===<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_display|item|int}}<br /> {{Flink|boolean|take_shop|{{opt|int}}|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_stash|item|int}}<br /> {{Flink|boolean|take_storage|int|item}}<br /> {{Flink|boolean|take_storage|item|int}}<br /> {{Flink|int|tavern|{{opt|string}}}}<br /> {{Flink|buffer|throw_item|item}}<br /> {{Flink|buffer|throw_items|item|item}}<br /> {{Flink|int|thunder_cost|skill}}<br /> {{Flink|string|time_to_string}}<br /> {{Flink|string|timestamp_to_date|int|string}}<br /> {{Flink|boolean|to_boolean|any}}<br /> {{Flink|bounty|to_bounty|strict_string}}<br /> {{Flink|class|to_class|strict_string/int}}<br /> {{Flink|coinmaster|to_coinmaster|strict_string}}<br /> {{Flink|effect|to_effect|int/skill/strict_string}}<br /> {{Flink|element|to_element|strict_string}}<br /> {{Flink|familiar|to_familiar|int/strict_string}}<br /> {{Flink|float|to_float|any}}<br /> {{Flink|int|to_int|any}}<br /> {{Flink|item|to_item|int/strict_string}}<br /> {{Flink|item|to_item|string|int}}<br /> {{Flink|string|to_json|aggregate}}<br /> {{Flink|location|to_location|int/strict_string}}<br /> {{Flink|string|to_lower_case|string}}<br /> {{Flink|monster|to_monster|int/strict_string}}<br /> {{Flink|path|to_path|int}}<br /> {{Flink|path|to_path|strict_string}}<br /> {{Flink|phylum|to_phylum|strict_string}}<br /> {{Flink|string|to_plural|item}}<br /> {{Flink|servant|to_servant|int/strict_string}}<br /> {{Flink|skill|to_skill|effect/int}}<br /> {{Flink|skill|to_skill|strict_string|{{opt|strict_string}}}}<br /> {{Flink|slot|to_slot|item/strict_string}}<br /> {{Flink|stat|to_stat|strict_string}}<br /> {{Flink|string|to_string|any}}<br /> {{Flink|thrall|to_thrall|int/strict_string}}<br /> {{Flink|string|to_upper_case|string}}<br /> {{Flink|string|to_url|location}}<br /> {{Flink|vykea|to_vykea|strict_string}}<br /> {{Flink|string|to_wiki_url|effect}}<br /> {{Flink|string|to_wiki_url|item}}<br /> {{Flink|string|to_wiki_url|monster}}<br /> {{Flink|string|to_wiki_url|skill}}<br /> {{Flink|string|to_wiki_url|string}}<br /> {{Flink|string|today_to_string}}<br /> {{Flink|int|total_free_rests}}<br /> {{Flink|int|total_turns_played}}<br /> {{Flink|boolean|tower_door}}<br /> {{Flink|void|traceprint|string}}<br /> {{Flink|int|truncate|float}}<br /> {{Flink|int|turns_per_cast|skill}}<br /> {{Flink|int|turns_played}}<br /> {{Flink|buffer|twiddle}}<br /> <br /> ===u===<br /> {{Flink|item|unusual_construct_disc}}<br /> {{Flink|void|update_candy_prices}}<br /> {{Flink|string|url|int|revision|string|last_changed_author|int|last_changed_rev|string|last_changed_date|svn_info|string}}<br /> {{Flink|string|url|string|branch|string|commit|string|last_changed_author|string|last_changed_date|git_info|string}}<br /> {{Flink|string|url_decode|string}}<br /> {{Flink|string|url_encode|string}}<br /> {{Flink|boolean|use|int|item}}<br /> {{Flink|boolean|use|item|{{opt|int}}}}<br /> {{Flink|boolean|use_familiar|familiar}}<br /> {{Flink|boolean|use_servant|servant}}<br /> {{Flink|boolean|use_skill|int|skill|{{opt|string}}}}<br /> {{Flink|boolean|use_skill|skill|int|{{opt|string}}}}<br /> {{Flink|buffer|use_skill|skill}}<br /> {{Flink|boolean|user_confirm|string|int|boolean}}<br /> {{Flink|boolean|user_confirm|string}}<br /> {{Flink|void|user_notify|string|boolean}}<br /> {{Flink|void|user_notify|string}}<br /> {{Flink|string|user_prompt|string|aggregate}}<br /> {{Flink|string|user_prompt|string|int|string}}<br /> {{Flink|string|user_prompt|string}}<br /> <br /> ===v===<br /> {{Flink|boolean|visit|coinmaster}}<br /> {{FunctionEmbed|visit_url}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|class|path|int}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}<br /> <br /> ===w===<br /> {{Flink|void|wait|int}}<br /> {{Flink|void|waitq|int}}<br /> {{Flink|int|weapon_hands|item}}<br /> {{Flink|stat|weapon_type|item}}<br /> {{Flink|int|weight_adjustment}}<br /> {{Flink|boolean|well_stocked|string|int|int}}<br /> {{Flink|boolean|white_citadel_available}}<br /> {{Flink|boolean [string]|who_clan}}<br /> {{Flink|boolean|will_usually_dodge}}<br /> {{Flink|boolean|will_usually_miss}}<br /> {{Flink|void|write|string}}<br /> {{Flink|boolean|write_ccs|buffer|string}}<br /> {{Flink|void|writeln|string}}<br /> <br /> ===x===<br /> {{Flink|string [0]|xpath|string|string}}<br /> <br /> ===z===<br /> {{Flink|item|zap|item}}<br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Ash_Functions&diff=9215 2023-04-27T07:47:58Z

<p>Eliteofdelete: Undo revision 9214 by Eliteofdelete (talk)</p> <hr /> <div>{{TOCright}}<br /> Master list of all ASH functions. All functions as of r20745 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version.<br /> <br /> The list is being updated to 27335! I finished A-G...<br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{Flink|boolean [monster]|absorbed_monsters}}<br /> {{FunctionEmbed|add_item_condition|format=signature}}<br /> {{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}<br /> {{Flink|int|adv_cost|skill}}<br /> {{Flink|boolean|adventure|int|location|{{opt|string}}}}<br /> {{Flink|boolean|adventure|location|int|{{opt|string}}}}<br /> {{FunctionEmbed|all_monsters_with_id|format=signature}}<br /> {{Flink|string [int]|all_normal_outfits}}<br /> {{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}<br /> {{Flink|buffer|append|buffer|string}}<br /> {{Flink|buffer|append_replacement|matcher|buffer|string}}<br /> {{Flink|buffer|append_tail|matcher|buffer}}<br /> {{Flink|buffer|attack}}<br /> {{Flink|boolean|autosell|int|item}}<br /> {{Flink|boolean|autosell|item|int}}<br /> {{Flink|int|autosell_price|item}}<br /> {{Flink|int|available_amount|item}}<br /> {{FunctionEmbed|available_choice_options}}<br /> {{FunctionEmbed|available_choice_select_inputs}}<br /> {{Flink|string [string]|available_choice_text_inputs|int}}<br /> {{Flink|int|available_pocket|monster}}<br /> {{Flink|int|available_pocket|effect}}<br /> {{Flink|int|available_pocket|item}}<br /> {{Flink|int|available_pocket|stat}}<br /> <br /> ===b===<br /> {{Flink|boolean|batch_close}}<br /> {{Flink|void|batch_open}}<br /> {{Flink|boolean|bjornify_familiar|familiar}}<br /> {{Flink|boolean|black_market_available}}<br /> {{Flink|boolean|boolean_modifier|{{opt|string}}|string}}<br /> {{Flink|boolean|boolean_modifier|effect|string}}<br /> {{Flink|boolean|boolean_modifier|item|string}}<br /> {{Flink|int|buffed_hit_stat}}<br /> {{FunctionEmbed|buffer_to_file|format=signature}}<br /> {{Flink|boolean|buy|coinmaster|item}}<br /> {{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}<br /> {{Flink|boolean|buy|item|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|buy|int|item|int}}<br /> {{Flink|int|buy_price|coinmaster|item}}<br /> {{Flink|boolean|buy_using_storage|int|item}}<br /> {{Flink|int|buy_using_storage|int|item|int}}<br /> {{Flink|int|buy_using_storage|item|int|int}}<br /> {{Flink|boolean|buys_item|coinmaster|item}}<br /> <br /> ===c===<br /> {{Flink|boolean|can_adventure|location}}<br /> {{Flink|boolean|can_drink}}<br /> {{Flink|boolean|can_eat}}<br /> {{Flink|boolean|can_equip|familiar|{{opt|item}}}}<br /> {{Flink|boolean|can_equip|item}}<br /> {{Flink|boolean|can_faxbot|monster}}<br /> {{Flink|boolean|can_interact}}<br /> {{Flink|boolean|can_still_steal}}<br /> {{Flink|boolean|canadia_available}}<br /> {{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}<br /> {{Flink|int|ceil|float}}<br /> {{Flink|boolean|change_mcd|int}}<br /> {{Flink|string|char_at|string|int}}<br /> {{Flink|void|chat_clan|string|{{opt|string}}}}<br /> {{Flink|void|chat_macro|string}}<br /> {{Flink|void|chat_notify|string|string}}<br /> {{Flink|void|chat_private|string|string}}<br /> {{Flink|boolean|chew|int|item}}<br /> {{Flink|boolean|chew|item|{{opt|int}}}}<br /> {{Flink|boolean|choice_follows_fight}}<br /> {{Flink|class|class_modifier|string|string}}<br /> {{Flink|class|class_modifier|item|string}}<br /> {{Flink|void|clear|aggregate}}<br /> {{FunctionEmbed|clear_booze_helper|format=signature}}<br /> {{FunctionEmbed|clear_food_helper|format=signature}}<br /> {{FunctionEmbed|cli_execute|format=signature}}<br /> {{FunctionEmbed|cli_execute_output|format=signature}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|combat_mana_cost_modifier}}<br /> {{Flink|float|combat_rate_modifier}}<br /> {{FunctionEmbed|contains_text|format=signature}}<br /> {{Flink|void|council}}<br /> {{Flink|int|count|aggregate}}<br /> {{Flink|int|craft|string|int|item|item}}<br /> {{Flink|string|craft_type|item}}<br /> {{Flink|int|creatable_amount|item}}<br /> {{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}<br /> {{Flink|boolean|create|int|item}}<br /> {{Flink|boolean|create|item|{{opt|int}}}}<br /> {{Flink|matcher|create_matcher|string|string}}<br /> {{Flink|stat|current_hit_stat}}<br /> {{Flink|int|current_mcd}}<br /> {{Flink|int [string]|current_pvp_stances}}<br /> {{Flink|int|current_rad_sickness}}<br /> {{Flink|int|current_round}}<br /> <br /> ===d===<br /> {{Flink|element|dad_sea_monkee_weakness|int}}<br /> {{Flink|item|daily_special}}<br /> {{Flink|float|damage_absorption_percent}}<br /> {{Flink|int|damage_reduction}}<br /> {{Flink|int|date_to_timestamp|string|string}}<br /> {{Flink|int|daycount}}<br /> {{Flink|void|debugprint|string}}<br /> {{Flink|buffer|delete|buffer|int|int}}<br /> {{Flink|effect|desc_to_effect|string}}<br /> {{Flink|item|desc_to_item|string}}<br /> {{Flink|void|disable|string}}<br /> {{Flink|boolean|dispensary_available}}<br /> {{Flink|int|display_amount|item}}<br /> {{FunctionEmbed|drink|format=signature}}<br /> {{Flink|boolean|drinksilent|int|item}}<br /> {{Flink|boolean|drinksilent|item|{{opt|int}}}}<br /> {{Flink|void|dump|any|{{opt|string}}}}<br /> <br /> ===e===<br /> {{FunctionEmbed|eat|format=signature}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eatsilent|item|{{opt|int}}}}<br /> {{Flink|effect|effect_modifier|string|string}}<br /> {{Flink|effect|effect_modifier|item|string}}<br /> {{Flink|boolean [int]|effect_pockets}}<br /> {{Flink|int|eight_bit_points|location}}<br /> {{Flink|int|eight_bit_points |location,string,float}}<br /> {{Flink|float|elemental_resistance|{{opt|element}}}}<br /> {{Flink|float|elemental_resistance|monster}}<br /> {{Flink|boolean|empty_closet}}<br /> {{Flink|void|enable|string}}<br /> {{Flink|int|end|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|ends_with|format=signature}}<br /> {{Flink|boolean|enthrone_familiar|familiar}}<br /> {{Flink|string|entity_decode|string}}<br /> {{Flink|string|entity_encode|string}}<br /> {{Flink|boolean|equip|item|{{opt|slot}}}}<br /> {{Flink|boolean|equip|slot|item}}<br /> {{Flink|boolean|equip_all_familiars}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|item|equipped_item|slot}}<br /> {{Flink|string|eudora}}<br /> {{Flink|boolean|eudora|string}}<br /> {{Flink|item|eudora_item}}<br /> {{Flink|string|every_card_name|strict_string}}<br /> {{Flink|item [string]|expected_cold_medicine_cabinet}}<br /> {{Flink|int|expected_damage|{{opt|monster}}}}<br /> {{Flink|float|experience_bonus}}<br /> {{Flink|float|expression_eval|string}}<br /> {{Flink|int [item]|extract_items|string}}<br /> {{Flink|int|extract_meat|string}}<br /> <br /> ===f===<br /> {{Flink|item|familiar_equipment|familiar}}<br /> {{Flink|item|familiar_equipped_equipment|familiar}}<br /> {{Flink|int|familiar_weight|familiar}}<br /> {{Flink|boolean [familiar]|favorite_familiars|}}<br /> {{Flink|boolean|faxbot|monster|{{opt|string}}}}<br /> {{Flink|boolean|fight_follows_choice}}<br /> {{FunctionEmbed|file_to_array|format=signature}}<br /> {{FunctionEmbed|file_to_buffer|format=signature}}<br /> {{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}<br /> {{Flink|boolean|find|matcher}}<br /> {{Flink|int|floor|float}}<br /> {{Flink|boolean|florist_available}}<br /> {{Flink|boolean|flush_monster_manuel_cache}}<br /> {{Flink|string|form_field|string}}<br /> {{Flink|string [string]|form_fields}}<br /> {{Flink|string|format_date_time|string|string|string}}<br /> {{Flink|boolean|friars_available}}<br /> {{Flink|int|fuel_cost|skill}}<br /> {{Flink|int|fullness_limit}}<br /> <br /> ===g===<br /> {{Flink|int|gameday_to_int}}<br /> {{Flink|string|gameday_to_string}}<br /> {{Flink|int|gametime_to_int}}<br /> {{Flink|boolean [string] |get_all_properties|string|boolean}}<br /> {{Flink|int|get_auto_attack}}<br /> {{Flink|location[int]|get_autumnaton_locations}}<br /> {{Flink|int [item]|get_campground}}<br /> {{Flink|string |get_ccs_action|int}}<br /> {{Flink|int [item]|get_chateau}}<br /> {{Flink|int|get_clan_id}}<br /> {{Flink|int [item]|get_clan_lounge}}<br /> {{Flink|string|get_clan_name}}<br /> {{Flink|int [string]|get_clan_rumpus}}<br /> {{Flink|int [item]|get_closet}}<br /> {{Flink|int|get_counter|string|int|int}}<br /> {{Flink|string|get_counters|string}}<br /> {{Flink|string [int]|get_custom_outfits}}<br /> {{Flink|int [item]|get_display}}<br /> {{Flink|item|get_dwelling}}<br /> {{Flink|location [string]|get_fishing_locations}}<br /> {{Flink|string [location, 3]|get_florist_plants}}<br /> {{Flink|int [item]|get_free_pulls}}<br /> {{Flink|int|get_fuel}}<br /> {{Flink|string [int]|get_goals}}<br /> {{Flink|boolean|get_ignore_zone_warnings}}<br /> {{Flink|int [item]|get_ingredients|item}}<br /> {{Flink|int [item]|get_inventory}}<br /> {{Flink|boolean [monster]|get_location_monsters|location}}<br /> {{Flink|boolean [monster]|get_locket_monsters}}<br /> {{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}<br /> {{Flink|monster [int]|get_monsters|location}}<br /> {{Flink|string [int]|get_moods}}<br /> {{Flink|string [int]|get_outfits}}<br /> {{Flink|string|get_path}}<br /> {{Flink|string|get_path_full}}<br /> {{Flink|string|get_path_variables}}<br /> {{Flink|boolean [skill]|get_permed_skills}}<br /> {{Flink|string|get_player_id|string}}<br /> {{Flink|string|get_player_name|int}}<br /> {{Flink|int|get_power|item}}<br /> {{Flink|string|get_property|string|{{opt|boolean}}}}<br /> {{Flink|int [item]|get_related|item|string}}<br /> {{Flink|int|get_revision}}<br /> {{Flink|int [item]|get_shop}}<br /> {{Flink|string [0]|get_shop_log}}<br /> {{Flink|string string int [0]|get_stack_trace}}<br /> {{Flink|int [item]|get_stash}}<br /> {{Flink|int [item]|get_storage}}<br /> {{Flink|string|get_version}}<br /> {{Flink|item|get_workshed}}<br /> {{Flink|item|get_zap_wand}}<br /> {{Flink|boolean|git_at_head|string}}<br /> {{Flink|boolean|git_exists|string}}<br /> {{Flink|string string string string string|git_info| string}}<br /> {{Flink|string[0]|git_list}}<br /> {{Flink|boolean|gnomads_available}}<br /> {{Flink|boolean|goal_exists|string}}<br /> {{Flink|string|group|matcher|{{opt|int}}}}<br /> {{Flink|string|group|matcher|string}}<br /> {{Flink|int|group_count|matcher}}<br /> {{Flink|boolean [string]|group_names|matcher}}<br /> {{Flink|string [int, int]|group_string|string|string}}<br /> {{Flink|boolean|guild_available}}<br /> {{Flink|boolean|guild_store_available}}<br /> <br /> ===h===<br /> {{Flink|boolean|handling_choice}}<br /> {{Flink|boolean|have_bartender}}<br /> {{Flink|boolean|have_chef}}<br /> {{Flink|boolean|have_display}}<br /> {{Flink|int|have_effect|effect}}<br /> {{Flink|boolean|have_equipped|item}}<br /> {{Flink|boolean|have_familiar|familiar}}<br /> {{Flink|boolean|have_mushroom_plot}}<br /> {{Flink|boolean|have_outfit|string}}<br /> {{Flink|boolean|have_servant|servant}}<br /> {{Flink|boolean|have_shop}}<br /> {{Flink|boolean|have_skill|skill}}<br /> {{Flink|boolean|hedge_maze|string}}<br /> {{Flink|boolean|hermit|int|item}}<br /> {{Flink|boolean|hermit|item|int}}<br /> {{Flink|boolean|hidden_temple_unlocked}}<br /> {{Flink|boolean|hippy_stone_broken}}<br /> {{Flink|boolean|hippy_store_available}}<br /> {{FunctionEmbed|historical_age}}<br /> {{FunctionEmbed|historical_price}}<br /> {{Flink|string|holiday}}<br /> {{Flink|int|hp_cost|skill}}<br /> <br /> ===i===<br /> {{Flink|monster|image_to_monster|strict_string}}<br /> {{Flink|boolean|in_bad_moon}}<br /> {{Flink|boolean|in_hardcore}}<br /> {{Flink|boolean|in_moxie_sign}}<br /> {{Flink|boolean|in_multi_fight}}<br /> {{Flink|boolean|in_muscle_sign}}<br /> {{Flink|boolean|in_mysticality_sign}}<br /> {{Flink|string|inaccessible_reason|coinmaster}}<br /> {{FunctionEmbed|index_of|format=signature}}<br /> {{Flink|int|inebriety_limit}}<br /> {{Flink|float|initiative_modifier}}<br /> {{Flink|buffer|insert|buffer|int|string}}<br /> {{Flink|boolean|is_accessible|coinmaster}}<br /> {{Flink|boolean|is_banished|monster}}<br /> {{Flink|boolean|is_coinmaster_item|item}}<br /> {{FunctionEmbed|is_dark_mode}}<br /> {{Flink|boolean|is_discardable|item}}<br /> {{Flink|boolean|is_displayable|item}}<br /> {{Flink|boolean|is_familiar_equipment_locked}}<br /> {{Flink|boolean|is_giftable|item}}<br /> {{Flink|boolean|is_goal|item}}<br /> {{Flink|boolean|is_integer|string}}<br /> {{Flink|boolean|is_npc_item|item}}<br /> {{Flink|boolean|is_online|string}}<br /> {{Flink|boolean|is_tradeable|item}}<br /> {{Flink|boolean|is_trendy|item/familiar/skill/string}}<br /> {{Flink|boolean|is_unrestricted|item/familiar/skill/string}}<br /> {{Flink|boolean|is_wearing_outfit|string}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|float|item_drop_modifier}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}}}<br /> {{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}<br /> {{Flink|boolean [int]|item_pockets}}<br /> {{Flink|string|item_type|item}}<br /> <br /> ===j===<br /> {{Flink|boolean [int]|joke_pockets}}<br /> {{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}<br /> <br /> ===k===<br /> {{Flink|boolean|knoll_available}}<br /> <br /> ===l===<br /> {{Flink|int|last_choice}}<br /> {{Flink|int|last_decision}}<br /> {{FunctionEmbed|last_index_of|format=signature}}<br /> {{Flink|string|last_item_message}}<br /> {{Flink|monster|last_monster}}<br /> {{Flink|string|last_skill_message}}<br /> {{Flink|string|leetify|string}}<br /> {{Flink|int|length|string}}<br /> {{Flink|int|lightning_cost|skill}}<br /> {{Flink|string|limit_mode}}<br /> {{Flink|buffer|load_html|string}}<br /> {{Flink|void|lock_familiar_equipment|boolean}}<br /> {{Flink|float|log_n|float|{{opt|float}}}}<br /> {{Flink|void|logprint|string}}<br /> <br /> ===m===<br /> {{Flink|string|make_url|string|boolean|boolean}}<br /> {{FunctionEmbed|mall_price}}<br /> {{FunctionEmbed|mall_prices}}<br /> {{Flink|int|mana_cost_modifier}}<br /> {{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}<br /> {{Flink|float|max|float ...}}<br /> {{Flink|int|max|int ...}}<br /> {{Flink|boolean|maximize|string|boolean}}<br /> {{Flink|boolean|maximize|string|int|int|boolean}}<br /> {{Flink|{string string float effect item skill} [int]|maximize|string|int|int|boolean|boolean}}<br /> {{Flink|int|meat_drop|{{opt|monster}}}}<br /> {{Flink|float|meat_drop_modifier}}<br /> {{Flink|int [int]|meat_pockets}}<br /> {{Flink|float|min|float ...}}<br /> {{Flink|int|min|int ...}}<br /> {{Flink|item|minstrel_instrument}}<br /> {{Flink|int|minstrel_level}}<br /> {{Flink|boolean|minstrel_quest}}<br /> {{Flink|float|modifier_eval|string}}<br /> {{Flink|int|monster_attack|{{opt|monster}}}}<br /> {{Flink|int|monster_defense|{{opt|monster}}}}<br /> {{Flink|element|monster_element|{{opt|monster}}}}<br /> {{Flink|float|monster_eval|string}}<br /> {{Flink|int|monster_factoids_available|monster|boolean}}<br /> {{Flink|int|monster_hp|{{opt|monster}}}}<br /> {{Flink|int|monster_initiative|{{opt|monster}}}}<br /> {{Flink|int|monster_level_adjustment}}<br /> {{Flink|string|monster_manuel_text|monster}}<br /> {{Flink|phylum|monster_phylum|{{opt|monster}}}}<br /> {{Flink|boolean [int]|monster_pockets}}<br /> {{Flink|void|mood_execute|int}}<br /> {{Flink|string [0]|mood_list}}<br /> {{Flink|int|moon_light}}<br /> {{Flink|int|moon_phase}}<br /> {{Flink|int|mp_cost|skill}}<br /> {{Flink|int|my_absorbs}}<br /> {{Flink|int|my_adventures}}<br /> {{Flink|int|my_ascensions}}<br /> {{Flink|int|my_audience}}<br /> {{Flink|int|my_basestat|stat}}<br /> {{Flink|familiar|my_bjorned_familiar}}<br /> {{Flink|int|my_buffedstat|stat}}<br /> {{Flink|class|my_class}}<br /> {{Flink|int|my_closet_meat}}<br /> {{Flink|string|my_companion}}<br /> {{Flink|int|my_daycount}}<br /> {{Flink|int|my_discomomentum}}<br /> {{Flink|familiar|my_effective_familiar}}<br /> {{Flink|int [effect]|my_effects}}<br /> {{Flink|familiar|my_enthroned_familiar}}<br /> {{Flink|familiar|my_familiar}}<br /> {{Flink|int|my_fullness}}<br /> {{Flink|int|my_fury}}<br /> {{Flink|string|my_garden_type}}<br /> {{Flink|string|my_hash}}<br /> {{Flink|int|my_hp}}<br /> {{Flink|string|my_id}}<br /> {{Flink|int|my_inebriety}}<br /> {{Flink|int|my_level}}<br /> {{Flink|int|my_lightning}}<br /> {{Flink|location|my_location}}<br /> {{Flink|string|my_mask}}<br /> {{Flink|int|my_maxfury}}<br /> {{Flink|int|my_maxhp}}<br /> {{Flink|int|my_maxmp}}<br /> {{Flink|int|my_maxpp}}<br /> {{Flink|int|my_meat}}<br /> {{Flink|int|my_mp}}<br /> {{Flink|string|my_name}}<br /> {{Flink|string|my_path}}<br /> {{Flink|int|my_path_id}}<br /> {{Flink|familiar|my_poke_fam|int}}<br /> {{Flink|int|my_pp}}<br /> {{Flink|stat|my_primestat}}<br /> {{Flink|int|my_rain}}<br /> {{Flink|int|my_robot_energy}}<br /> {{Flink|int|my_robot_scraps}}<br /> {{Flink|servant|my_servant}}<br /> {{Flink|int|my_session_adv}}<br /> {{Flink|int [item]|my_session_items}}<br /> {{Flink|int|my_session_items|item}}<br /> {{Flink|int|my_session_meat}}<br /> {{Flink|string|my_sign}}<br /> {{Flink|int|my_soulsauce}}<br /> {{Flink|int|my_spleen_use}}<br /> {{Flink|int|my_storage_meat}}<br /> {{Flink|thrall|my_thrall}}<br /> {{Flink|int|my_thunder}}<br /> {{Flink|int|my_turncount}}<br /> {{Flink|vykea|my_vykea_companion}}<br /> <br /> ===n===<br /> {{Flink|int|now_to_int}}<br /> {{Flink|string|now_to_string|string}}<br /> {{Flink|int|npc_price|item}}<br /> {{Flink|string|numberology_prize|int}}<br /> {{Flink|float|numeric_modifier|effect|string}}<br /> {{Flink|float|numeric_modifier|familiar|string|int|item}}<br /> {{Flink|float|numeric_modifier|item|string}}<br /> {{Flink|float|numeric_modifier|skill|string}}<br /> {{Flink|float|numeric_modifier|{{opt|string}}|string}}<br /> <br /> ===o===<br /> {{Flink|boolean|outfit|string}}<br /> {{Flink|item [int]|outfit_pieces|string}}<br /> {{Flink|string|outfit_tattoo|{{opt|string}}}}<br /> {{FunctionEmbed|overdrink|format=signature}}<br /> <br /> ===p===<br /> {{Flink|string|path_id_to_name|int}}<br /> {{Flink|int|path_name_to_id|string}}<br /> {{Flink|boolean|pick_pocket|monster}}<br /> {{Flink|int [effect]|pick_pocket|effect}}<br /> {{Flink|int [item]|pick_pocket|item}}<br /> {{Flink|int [stat]|pick_pocket|stat}}<br /> {{Flink|boolean|pick_pocket|int}}<br /> {{Flink|boolean [int]|picked_pockets}}<br /> {{Flink|boolean [int]|picked_scraps}}<br /> {{Flink|int [effect]|pocket_effects|int}}<br /> {{Flink|int [item]|pocket_items|int}}<br /> {{Flink|string|pocket_joke|int}}<br /> {{Flink|string [int]|pocket_meat|int}}<br /> {{Flink|monster|pocket_monster|int}}<br /> {{Flink|string [int]|pocket_poem|int}}<br /> {{Flink|string [int]|pocket_scrap|int}}<br /> {{Flink|int [stat]|pocket_stats|int}}<br /> {{Flink|int [int]|poem_pockets}}<br /> {{Flink|int [int]|potential_pockets|effect/item/monster/stat}}<br /> {{Flink|void|print|{{opt|string}}|{{opt|string}}}}<br /> {{Flink|void|print_html|string}}<br /> {{FunctionEmbed|property_default_value|format=signature}}<br /> {{FunctionEmbed|property_exists|format=signature}}<br /> {{FunctionEmbed|property_has_default|format=signature}}<br /> {{Flink|int|pulls_remaining}}<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_display|item|int}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|put_stash|item|int}}<br /> {{Flink|int|pvp_attacks_left}}<br /> <br /> ===r===<br /> {{Flink|int|rain_cost|skill}}<br /> {{Flink|int|random|int}}<br /> {{Flink|int|raw_damage_absorption}}<br /> {{Flink|boolean|refresh_shop}}<br /> {{Flink|boolean|refresh_stash}}<br /> {{Flink|boolean|refresh_status}}<br /> {{Flink|void|remove_item_condition|int|item}}<br /> {{Flink|void|remove_item_condition|item|int}}<br /> {{FunctionEmbed|remove_property|format=signature}}<br /> {{FunctionEmbed|rename_property|format=signature}}<br /> {{Flink|boolean|replace|buffer|int|int|string}}<br /> {{Flink|string|replace_all|matcher|string}}<br /> {{Flink|string|replace_first|matcher|string}}<br /> {{Flink|buffer|replace_string|buffer|string|string}}<br /> {{Flink|buffer|replace_string|string|string|string}}<br /> {{Flink|boolean|reprice_shop|int|{{opt|int}}|item}}<br /> {{Flink|matcher|reset|matcher|{{opt|string}}}}<br /> {{Flink|boolean [int]|restoration_pockets}}<br /> {{Flink|boolean|restore_hp|int}}<br /> {{Flink|boolean|restore_mp|int}}<br /> {{Flink|boolean|retrieve_item|int|item}}<br /> {{Flink|boolean|retrieve_item|item|{{opt|int}}}}<br /> {{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}<br /> {{Flink|int|rollover}}<br /> {{Flink|int|round|float}}<br /> {{FunctionEmbed|run_choice|format=signature}}<br /> {{Flink|buffer|run_combat|{{opt|string}}}}<br /> {{Flink|buffer|run_turn}}<br /> {{Flink|buffer|runaway}}<br /> <br /> ===s===<br /> {{Flink|int [int]|scrap_pockets}}<br /> {{Flink|boolean|sell|coinmaster|int|item}}<br /> {{Flink|int|sell_price|coinmaster|item}}<br /> {{Flink|boolean|sells_item|coinmaster|item}}<br /> {{Flink|string [int]|session_logs|{{opt|string}}|{{opt|string}}|int}}<br /> {{Flink|void|set_auto_attack|int/string}}<br /> {{Flink|void|set_length|buffer|int}}<br /> {{Flink|void|set_location|location}}<br /> {{Flink|void|set_property|string|string}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|shop_limit|item}}<br /> {{Flink|int|shop_price|item}}<br /> {{Flink|skill|skill_modifier|item|string}}<br /> {{Flink|skill|skill_modifier|string|string}}<br /> {{Flink|int|slash_count|item}}<br /> {{Flink|int|soulsauce_cost|skill}}<br /> {{Flink|int|spleen_limit}}<br /> {{Flink|string [int]|split_string|string|{{opt|string}}}}<br /> {{Flink|float|square_root|float}}<br /> {{Flink|int|start|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|starts_with|format=signature}}<br /> {{Flink|int|stash_amount|item}}<br /> {{Flink|stat|stat_bonus_today}}<br /> {{Flink|stat|stat_bonus_tomorrow}}<br /> {{Flink|stat|stat_modifier|effect|string}}<br /> {{Flink|buffer|steal}}<br /> {{Flink|int|stills_available}}<br /> {{Flink|void|stop_counter|string}}<br /> {{Flink|int|storage_amount|item}}<br /> {{Flink|string|string_modifier|{{opt|string}}|string}}<br /> {{Flink|skill|stun_skill}}<br /> {{Flink|string|substring|string|int|{{opt|int}}}}<br /> {{Flink|boolean|svn_at_head|string}}<br /> {{Flink|boolean|svn_exists|string}}<br /> {{Flink|{string int string int string}|svn_info|string}}<br /> {{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}<br /> {{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}<br /> {{Flink|effect|sweet_synthesis_result|item|item}}<br /> <br /> ===t===<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_display|item|int}}<br /> {{Flink|boolean|take_shop|{{opt|int}}|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_stash|item|int}}<br /> {{Flink|boolean|take_storage|int|item}}<br /> {{Flink|boolean|take_storage|item|int}}<br /> {{Flink|int|tavern|{{opt|string}}}}<br /> {{Flink|buffer|throw_item|item}}<br /> {{Flink|buffer|throw_items|item|item}}<br /> {{Flink|int|thunder_cost|skill}}<br /> {{Flink|string|time_to_string}}<br /> {{Flink|string|timestamp_to_date|int|string}}<br /> {{Flink|boolean|to_boolean|any}}<br /> {{Flink|bounty|to_bounty|strict_string}}<br /> {{Flink|class|to_class|strict_string/int}}<br /> {{Flink|coinmaster|to_coinmaster|strict_string}}<br /> {{Flink|effect|to_effect|int/skill/strict_string}}<br /> {{Flink|element|to_element|strict_string}}<br /> {{Flink|familiar|to_familiar|int/strict_string}}<br /> {{Flink|float|to_float|any}}<br /> {{Flink|int|to_int|any}}<br /> {{Flink|item|to_item|int/strict_string}}<br /> {{Flink|item|to_item|string|int}}<br /> {{Flink|string|to_json|aggregate}}<br /> {{Flink|location|to_location|int/strict_string}}<br /> {{Flink|string|to_lower_case|string}}<br /> {{Flink|monster|to_monster|int/strict_string}}<br /> {{Flink|phylum|to_phylum|string}}<br /> {{Flink|string|to_plural|item}}<br /> {{Flink|servant|to_servant|int/strict_string}}<br /> {{Flink|skill|to_skill|effect/int}}<br /> {{Flink|skill|to_skill|strict_string|{{opt|strict_string}}}}<br /> {{Flink|slot|to_slot|item/strict_string}}<br /> {{Flink|stat|to_stat|strict_string}}<br /> {{Flink|string|to_string|any}}<br /> {{Flink|thrall|to_thrall|int/strict_string}}<br /> {{Flink|string|to_upper_case|string}}<br /> {{Flink|string|to_url|location}}<br /> {{Flink|vykea|to_vykea|strict_string}}<br /> {{Flink|string|today_to_string}}<br /> {{Flink|int|total_free_rests}}<br /> {{Flink|int|total_turns_played}}<br /> {{Flink|boolean|tower_door}}<br /> {{Flink|void|traceprint|string}}<br /> {{Flink|int|truncate|float}}<br /> {{Flink|int|turns_per_cast|skill}}<br /> {{Flink|int|turns_played}}<br /> {{Flink|buffer|twiddle}}<br /> <br /> ===u===<br /> {{Flink|item|unusual_construct_disc}}<br /> {{Flink|void|update_candy_prices}}<br /> {{Flink|string|url_decode|string}}<br /> {{Flink|string|url_encode|string}}<br /> {{Flink|boolean|use|int|item}}<br /> {{Flink|boolean|use|item|{{opt|int}}}}<br /> {{Flink|boolean|use_familiar|familiar}}<br /> {{Flink|boolean|use_servant|servant}}<br /> {{Flink|boolean|use_skill|int|skill|{{opt|string}}}}<br /> {{Flink|boolean|use_skill|skill|int|{{opt|string}}}}<br /> {{Flink|buffer|use_skill|skill}}<br /> {{Flink|boolean|user_confirm|string}}<br /> {{Flink|boolean|user_confirm|string|int|boolean}}<br /> <br /> ===v===<br /> {{Flink|boolean|visit|coinmaster}}<br /> {{FunctionEmbed|visit_url}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}<br /> <br /> ===w===<br /> {{Flink|void|wait|int}}<br /> {{Flink|void|waitq|int}}<br /> {{Flink|int|weapon_hands|item}}<br /> {{Flink|stat|weapon_type|item}}<br /> {{Flink|int|weight_adjustment}}<br /> {{Flink|boolean|white_citadel_available}}<br /> {{Flink|boolean [string]|who_clan}}<br /> {{Flink|boolean|will_usually_dodge}}<br /> {{Flink|boolean|will_usually_miss}}<br /> {{Flink|void|write|string}}<br /> {{Flink|void|writeln|string}}<br /> <br /> ===x===<br /> {{Flink|string[int]|xpath|string|string}}<br /> ===z===<br /> {{Flink|item|zap|item}}<br /> <br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Ash_Functions&diff=9214 2023-04-27T06:30:49Z

<p>Eliteofdelete: Updated functions based on r27333. This messed up some of the &quot;any&quot; or denoting functions by &quot;/&quot;. However, I recommend converting these to the FunctionEmbed form sooner rather than later.</p> <hr /> <div>{{TOCright}}<br /> 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version.<br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{Flink|boolean [monster]|absorbed_monsters}}<br /> {{FunctionEmbed|add_item_condition|format=signature}}<br /> {{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}<br /> {{Flink|int|adv_cost|skill}}<br /> {{Flink|boolean|adventure|int|location|{{opt|string}}}}<br /> {{Flink|boolean|adventure|location|int|{{opt|string}}}}<br /> {{FunctionEmbed|all_monsters_with_id|format=signature}}<br /> {{Flink|string [0]|all_normal_outfits}}<br /> {{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}<br /> {{Flink|buffer|append|buffer|string}}<br /> {{Flink|buffer|append_replacement|matcher|buffer|string}}<br /> {{Flink|buffer|append_tail|matcher|buffer}}<br /> {{Flink|buffer|attack}}<br /> {{Flink|boolean|autosell|int|item}}<br /> {{Flink|boolean|autosell|item|int}}<br /> {{Flink|int|autosell_price|item}}<br /> {{Flink|int|available_amount|item}}<br /> {{FunctionEmbed|available_choice_options}}<br /> {{FunctionEmbed|available_choice_select_inputs}}<br /> {{Flink|string [string]|available_choice_text_inputs|int}}<br /> {{Flink|int|available_pocket|effect}}<br /> {{Flink|int|available_pocket|item}}<br /> {{Flink|int|available_pocket|monster}}<br /> {{Flink|int|available_pocket|stat}}<br /> <br /> ===b===<br /> {{Flink|boolean|batch_close}}<br /> {{Flink|void|batch_open}}<br /> {{Flink|boolean|bjornify_familiar|familiar}}<br /> {{Flink|boolean|black_market_available}}<br /> {{Flink|boolean|boolean_modifier|effect|string}}<br /> {{Flink|boolean|boolean_modifier|item|string}}<br /> {{Flink|boolean|boolean_modifier|{{opt|string}}|string}}<br /> {{Flink|int|buffed_hit_stat}}<br /> {{FunctionEmbed|buffer_to_file|format=signature}}<br /> {{Flink|boolean|buy|coinmaster|item}}<br /> {{Flink|boolean|buy|item|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}<br /> {{Flink|int|buy|int|item|int}}<br /> {{Flink|int|buy_price|coinmaster|item}}<br /> {{Flink|boolean|buy_using_storage|int|item}}<br /> {{Flink|boolean|buy_using_storage|item|int}}<br /> {{Flink|boolean|buy_using_storage|item}}<br /> {{Flink|int|buy_using_storage|int|item|int}}<br /> {{Flink|int|buy_using_storage|item|int|int}}<br /> {{Flink|boolean|buys_item|coinmaster|item}}<br /> <br /> ===c===<br /> {{Flink|boolean|can_adventure|location}}<br /> {{Flink|boolean|can_drink}}<br /> {{Flink|boolean|can_eat}}<br /> {{Flink|boolean|can_equip|familiar|{{opt|item}}}}<br /> {{Flink|boolean|can_equip|item}}<br /> {{Flink|boolean|can_faxbot|monster}}<br /> {{Flink|boolean|can_interact}}<br /> {{Flink|boolean|can_still_steal}}<br /> {{Flink|boolean|canadia_available}}<br /> {{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}<br /> {{Flink|int|ceil|float}}<br /> {{Flink|boolean|change_mcd|int}}<br /> {{Flink|string|char_at|string|int}}<br /> {{Flink|void|chat_clan|string|{{opt|string}}}}<br /> {{Flink|void|chat_macro|string}}<br /> {{Flink|void|chat_notify|string|string}}<br /> {{Flink|void|chat_private|string|string}}<br /> {{Flink|boolean|chew|int|item}}<br /> {{Flink|boolean|chew|item|{{opt|int}}}}<br /> {{Flink|boolean|choice_follows_fight}}<br /> {{Flink|class|class_modifier|item|string}}<br /> {{Flink|class|class_modifier|string|string}}<br /> {{Flink|void|clear|aggregate}}<br /> {{FunctionEmbed|clear_booze_helper|format=signature}}<br /> {{FunctionEmbed|clear_food_helper|format=signature}}<br /> {{FunctionEmbed|cli_execute|format=signature}}<br /> {{FunctionEmbed|cli_execute_output|format=signature}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|combat_mana_cost_modifier}}<br /> {{Flink|float|combat_rate_modifier}}<br /> {{Flink|boolean|combat_skill_available|skill}}<br /> {{Flink|int|concoction_price|item}}<br /> {{Flink|int|concoction_price|vykea}}<br /> {{FunctionEmbed|contains_text|format=signature}}<br /> {{Flink|void|council}}<br /> {{Flink|int|count|aggregate}}<br /> {{Flink|int|craft|string|int|item|item}}<br /> {{Flink|string|craft_type|item}}<br /> {{Flink|int|creatable_amount|item}}<br /> {{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}<br /> {{Flink|boolean|create|int|item}}<br /> {{Flink|boolean|create|item|{{opt|int}}}}<br /> {{Flink|matcher|create_matcher|string|string}}<br /> {{Flink|stat|current_hit_stat}}<br /> {{Flink|int|current_mcd}}<br /> {{Flink|int [string]|current_pvp_stances}}<br /> {{Flink|int|current_rad_sickness}}<br /> {{Flink|int|current_round}}<br /> <br /> ===d===<br /> {{Flink|element|dad_sea_monkee_weakness|int}}<br /> {{Flink|item|daily_special}}<br /> {{Flink|float|damage_absorption_percent}}<br /> {{Flink|int|damage_reduction}}<br /> {{Flink|int|date_to_timestamp|string|string}}<br /> {{Flink|int|daycount}}<br /> {{Flink|void|debugprint|string}}<br /> {{Flink|buffer|delete|buffer|int|int}}<br /> {{Flink|effect|desc_to_effect|string}}<br /> {{Flink|item|desc_to_item|string}}<br /> {{Flink|void|disable|string}}<br /> {{Flink|boolean|dispensary_available}}<br /> {{Flink|int|display_amount|item}}<br /> {{FunctionEmbed|drink|format=signature}}<br /> {{Flink|boolean|drinksilent|int|item}}<br /> {{Flink|boolean|drinksilent|item|{{opt|int}}}}<br /> {{Flink|void|dump|any|{{opt|string}}}}<br /> <br /> ===e===<br /> {{FunctionEmbed|eat|format=signature}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eatsilent|item|{{opt|int}}}}<br /> {{Flink|effect|effect_modifier|item|string}}<br /> {{Flink|effect|effect_modifier|string|string}}<br /> {{Flink|boolean [int]|effect_pockets}}<br /> {{Flink|int|eight_bit_points|location|string|float}}<br /> {{Flink|int|eight_bit_points|location}}<br /> {{Flink|float|elemental_resistance|monster}}<br /> {{Flink|float|elemental_resistance|{{opt|element}}}}<br /> {{Flink|boolean|empty_closet}}<br /> {{Flink|void|enable|string}}<br /> {{Flink|int|end|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|ends_with|format=signature}}<br /> {{Flink|boolean|enthrone_familiar|familiar}}<br /> {{Flink|string|entity_decode|string}}<br /> {{Flink|string|entity_encode|string}}<br /> {{Flink|boolean|equip|item|{{opt|slot}}}}<br /> {{Flink|boolean|equip|slot|item}}<br /> {{Flink|boolean|equip_all_familiars}}<br /> {{Flink|int|equipped_amount|item|boolean}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|item|equipped_item|slot}}<br /> {{Flink|boolean|eudora|string}}<br /> {{Flink|string|eudora}}<br /> {{Flink|item|eudora_item}}<br /> {{Flink|string|every_card_name|strict_string}}<br /> {{Flink|item [string]|expected_cold_medicine_cabinet}}<br /> {{Flink|int|expected_damage|{{opt|monster}}}}<br /> {{Flink|float|experience_bonus}}<br /> {{Flink|float|expression_eval|string}}<br /> {{Flink|int [item]|extract_items|string}}<br /> {{Flink|int|extract_meat|string}}<br /> <br /> ===f===<br /> {{Flink|item|familiar_equipment|familiar}}<br /> {{Flink|item|familiar_equipped_equipment|familiar}}<br /> {{Flink|int|familiar_weight|familiar}}<br /> {{Flink|boolean [familiar]|favorite_familiars}}<br /> {{Flink|boolean|faxbot|monster|{{opt|string}}}}<br /> {{Flink|boolean|fight_follows_choice}}<br /> {{FunctionEmbed|file_to_array|format=signature}}<br /> {{FunctionEmbed|file_to_buffer|format=signature}}<br /> {{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}<br /> {{Flink|boolean|find|matcher}}<br /> {{Flink|int|floor|float}}<br /> {{Flink|boolean|florist_available}}<br /> {{Flink|boolean|flush_monster_manuel_cache}}<br /> {{Flink|string|form_field|string}}<br /> {{Flink|string [string]|form_fields}}<br /> {{Flink|string|format_date_time|string|string|string}}<br /> {{Flink|boolean|friars_available}}<br /> {{Flink|int|fuel_cost|skill}}<br /> {{Flink|int|fullness_limit}}<br /> <br /> ===g===<br /> {{Flink|int|gameday_to_int}}<br /> {{Flink|string|gameday_to_string}}<br /> {{Flink|int|gametime_to_int}}<br /> {{Flink|boolean [string]|get_all_properties|string|boolean}}<br /> {{Flink|int|get_auto_attack}}<br /> {{Flink|location [0]|get_autumnaton_locations}}<br /> {{Flink|int [item]|get_campground}}<br /> {{Flink|string|get_ccs_action|int}}<br /> {{Flink|int [item]|get_chateau}}<br /> {{Flink|int|get_clan_id}}<br /> {{Flink|int [item]|get_clan_lounge}}<br /> {{Flink|string|get_clan_name}}<br /> {{Flink|int [string]|get_clan_rumpus}}<br /> {{Flink|int [item]|get_closet}}<br /> {{Flink|int|get_counter|string}}<br /> {{Flink|string|get_counters|string|int|int}}<br /> {{Flink|string [0]|get_custom_outfits}}<br /> {{Flink|int [item]|get_display}}<br /> {{Flink|item|get_dwelling}}<br /> {{Flink|location [string]|get_fishing_locations}}<br /> {{Flink|string [location, 3]|get_florist_plants}}<br /> {{Flink|int [item]|get_free_pulls}}<br /> {{Flink|int|get_fuel}}<br /> {{Flink|string [0]|get_goals}}<br /> {{Flink|boolean|get_ignore_zone_warnings}}<br /> {{Flink|int [item]|get_ingredients|item}}<br /> {{Flink|int [item]|get_inventory}}<br /> {{Flink|boolean [monster]|get_location_monsters|location}}<br /> {{Flink|boolean [monster]|get_locket_monsters}}<br /> {{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}<br /> {{Flink|monster [0]|get_monsters|location}}<br /> {{Flink|string [0]|get_moods}}<br /> {{Flink|string [0]|get_outfits}}<br /> {{Flink|string|get_path}}<br /> {{Flink|string|get_path_full}}<br /> {{Flink|string|get_path_variables}}<br /> {{Flink|boolean [skill]|get_permed_skills}}<br /> {{Flink|string|get_player_id|string}}<br /> {{Flink|string|get_player_name|int}}<br /> {{Flink|int|get_power|item}}<br /> {{Flink|string|get_property|string|{{opt|boolean}}}}<br /> {{Flink|int [item]|get_related|item|string}}<br /> {{Flink|int|get_revision}}<br /> {{Flink|int [item]|get_shop}}<br /> {{Flink|string [0]|get_shop_log}}<br /> {{Flink|string|file|string|name|int|line [0]|get_stack_trace}}<br /> {{Flink|int [item]|get_stash}}<br /> {{Flink|int [item]|get_storage}}<br /> {{Flink|string|get_version}}<br /> {{Flink|item|get_workshed}}<br /> {{Flink|item|get_zap_wand}}<br /> {{Flink|boolean|git_at_head|string}}<br /> {{Flink|boolean|git_exists|string}}<br /> {{Flink|string [0]|git_list}}<br /> {{Flink|boolean|gnomads_available}}<br /> {{Flink|boolean|goal_exists|string}}<br /> {{Flink|string|group|matcher|string}}<br /> {{Flink|string|group|matcher|{{opt|int}}}}<br /> {{Flink|int|group_count|matcher}}<br /> {{Flink|boolean [string]|group_names|matcher}}<br /> {{Flink|string [int, int]|group_string|string|string}}<br /> {{Flink|boolean|guild_available}}<br /> {{Flink|boolean|guild_store_available}}<br /> <br /> ===h===<br /> {{Flink|boolean|handling_choice}}<br /> {{Flink|boolean|have_bartender}}<br /> {{Flink|boolean|have_chef}}<br /> {{Flink|boolean|have_display}}<br /> {{Flink|int|have_effect|effect}}<br /> {{Flink|boolean|have_equipped|item}}<br /> {{Flink|boolean|have_familiar|familiar}}<br /> {{Flink|boolean|have_mushroom_plot}}<br /> {{Flink|boolean|have_outfit|string}}<br /> {{Flink|boolean|have_servant|servant}}<br /> {{Flink|boolean|have_shop}}<br /> {{Flink|boolean|have_skill|skill}}<br /> {{Flink|boolean|hedge_maze|string}}<br /> {{Flink|boolean|heist|int|item}}<br /> {{Flink|boolean|heist|item}}<br /> {{Flink|item [monster, int]|heist_targets}}<br /> {{Flink|boolean|hermit|int|item}}<br /> {{Flink|boolean|hermit|item|int}}<br /> {{Flink|boolean|hidden_temple_unlocked}}<br /> {{Flink|boolean|hippy_stone_broken}}<br /> {{Flink|boolean|hippy_store_available}}<br /> {{FunctionEmbed|historical_age}}<br /> {{FunctionEmbed|historical_price}}<br /> {{Flink|string|holiday}}<br /> {{Flink|int|hp_cost|skill}}<br /> <br /> ===i===<br /> {{Flink|monster|image_to_monster|strict_string}}<br /> {{Flink|boolean|in_bad_moon}}<br /> {{Flink|boolean|in_casual}}<br /> {{Flink|boolean|in_hardcore}}<br /> {{Flink|boolean|in_moxie_sign}}<br /> {{Flink|boolean|in_multi_fight}}<br /> {{Flink|boolean|in_muscle_sign}}<br /> {{Flink|boolean|in_mysticality_sign}}<br /> {{Flink|boolean|in_terrarium|familiar}}<br /> {{Flink|string|inaccessible_reason|coinmaster}}<br /> {{FunctionEmbed|index_of|format=signature}}<br /> {{Flink|int|inebriety_limit}}<br /> {{Flink|float|initiative_modifier}}<br /> {{Flink|buffer|insert|buffer|int|string}}<br /> {{Flink|boolean|is_accessible|coinmaster}}<br /> {{Flink|boolean|is_banished|monster}}<br /> {{Flink|boolean|is_coinmaster_item|item}}<br /> {{FunctionEmbed|is_dark_mode}}<br /> {{Flink|boolean|is_discardable|item}}<br /> {{Flink|boolean|is_displayable|item}}<br /> {{Flink|boolean|is_familiar_equipment_locked}}<br /> {{Flink|boolean|is_giftable|item}}<br /> {{Flink|boolean|is_goal|item}}<br /> {{Flink|boolean|is_headless}}<br /> {{Flink|boolean|is_integer|string}}<br /> {{Flink|boolean|is_npc_item|item}}<br /> {{Flink|boolean|is_online|string}}<br /> {{Flink|boolean|is_tradeable|item}}<br /> {{Flink|boolean|is_trendy|familiar}}<br /> {{Flink|boolean|is_trendy|item}}<br /> {{Flink|boolean|is_trendy|skill}}<br /> {{Flink|boolean|is_trendy|string}}<br /> {{Flink|boolean|is_unrestricted|familiar}}<br /> {{Flink|boolean|is_unrestricted|item}}<br /> {{Flink|boolean|is_unrestricted|skill}}<br /> {{Flink|boolean|is_unrestricted|string}}<br /> {{Flink|boolean|is_wearing_outfit|string}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|float|item_drop_modifier}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}}}<br /> {{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}<br /> {{Flink|boolean [int]|item_pockets}}<br /> {{Flink|string|item_type|item}}<br /> <br /> ===j===<br /> {{Flink|boolean [int]|joke_pockets}}<br /> {{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}<br /> <br /> ===k===<br /> {{Flink|boolean|knoll_available}}<br /> <br /> ===l===<br /> {{Flink|int|last_choice}}<br /> {{Flink|int|last_decision}}<br /> {{FunctionEmbed|last_index_of|format=signature}}<br /> {{Flink|string|last_item_message}}<br /> {{Flink|monster|last_monster}}<br /> {{Flink|string|last_skill_message}}<br /> {{Flink|string|leetify|string}}<br /> {{Flink|int|length|string}}<br /> {{Flink|int|lightning_cost|skill}}<br /> {{Flink|string|limit_mode}}<br /> {{Flink|buffer|load_html|string}}<br /> {{Flink|void|lock_familiar_equipment|boolean}}<br /> {{Flink|float|log_n|float|{{opt|float}}}}<br /> {{Flink|void|logprint|string}}<br /> <br /> ===m===<br /> {{Flink|string|make_url|string|boolean|boolean}}<br /> {{FunctionEmbed|mall_price}}<br /> {{FunctionEmbed|mall_prices}}<br /> {{Flink|int|mana_cost_modifier}}<br /> {{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}<br /> {{Flink|float|max|float|float}}<br /> {{Flink|int|max|int|int}}<br /> {{Flink|boolean|maximize|string|boolean}}<br /> {{Flink|boolean|maximize|string|int|int|boolean}}<br /> {{Flink|string|display|string|command|float|score|effect|effect|item|item|skill|skill [0]|maximize|string|int|int|boolean|boolean}}<br /> {{Flink|int|meat_drop|{{opt|monster}}}}<br /> {{Flink|float|meat_drop_modifier}}<br /> {{Flink|int [int]|meat_pockets}}<br /> {{Flink|float|min|float|float}}<br /> {{Flink|int|min|int|int}}<br /> {{Flink|item|minstrel_instrument}}<br /> {{Flink|int|minstrel_level}}<br /> {{Flink|boolean|minstrel_quest}}<br /> {{Flink|float|modifier_eval|string}}<br /> {{Flink|boolean|monkey_paw|effect}}<br /> {{Flink|boolean|monkey_paw|item}}<br /> {{Flink|boolean|monkey_paw|string}}<br /> {{Flink|int|monster_attack|{{opt|monster}}}}<br /> {{Flink|int|monster_defense|{{opt|monster}}}}<br /> {{Flink|element|monster_element|{{opt|monster}}}}<br /> {{Flink|float|monster_eval|string}}<br /> {{Flink|int|monster_factoids_available|monster|boolean}}<br /> {{Flink|int|monster_hp|{{opt|monster}}}}<br /> {{Flink|int|monster_initiative|{{opt|monster}}}}<br /> {{Flink|int|monster_level_adjustment}}<br /> {{Flink|string|monster_manuel_text|monster}}<br /> {{Flink|monster|monster_modifier|effect|string}}<br /> {{Flink|phylum|monster_phylum|{{opt|monster}}}}<br /> {{Flink|boolean [int]|monster_pockets}}<br /> {{Flink|void|mood_execute|int}}<br /> {{Flink|string [0]|mood_list}}<br /> {{Flink|int|moon_light}}<br /> {{Flink|int|moon_phase}}<br /> {{Flink|int|mp_cost|skill}}<br /> {{Flink|int|my_absorbs}}<br /> {{Flink|int|my_adventures}}<br /> {{Flink|int|my_ascensions}}<br /> {{Flink|int|my_audience}}<br /> {{Flink|int|my_basestat|stat}}<br /> {{Flink|familiar|my_bjorned_familiar}}<br /> {{Flink|int|my_buffedstat|stat}}<br /> {{Flink|class|my_class}}<br /> {{Flink|int|my_closet_meat}}<br /> {{Flink|string|my_companion}}<br /> {{Flink|int|my_daycount}}<br /> {{Flink|int|my_discomomentum}}<br /> {{Flink|familiar|my_effective_familiar}}<br /> {{Flink|int [effect]|my_effects}}<br /> {{Flink|familiar|my_enthroned_familiar}}<br /> {{Flink|familiar|my_familiar}}<br /> {{Flink|int|my_fullness}}<br /> {{Flink|int|my_fury}}<br /> {{Flink|string|my_garden_type}}<br /> {{Flink|string|my_hash}}<br /> {{Flink|int|my_hp}}<br /> {{Flink|string|my_id}}<br /> {{Flink|int|my_inebriety}}<br /> {{Flink|int|my_level}}<br /> {{Flink|int|my_lightning}}<br /> {{Flink|location|my_location}}<br /> {{Flink|string|my_mask}}<br /> {{Flink|int|my_maxfury}}<br /> {{Flink|int|my_maxhp}}<br /> {{Flink|int|my_maxmp}}<br /> {{Flink|int|my_maxpp}}<br /> {{Flink|int|my_meat}}<br /> {{Flink|int|my_mp}}<br /> {{Flink|string|my_name}}<br /> {{Flink|path|my_path}}<br /> {{Flink|int|my_path_id}}<br /> {{Flink|familiar|my_poke_fam|int}}<br /> {{Flink|int|my_pp}}<br /> {{Flink|stat|my_primestat}}<br /> {{Flink|int|my_rain}}<br /> {{Flink|int|my_robot_energy}}<br /> {{Flink|int|my_robot_scraps}}<br /> {{Flink|servant|my_servant}}<br /> {{Flink|int|my_session_adv}}<br /> {{Flink|int [item]|my_session_items}}<br /> {{Flink|int|my_session_items|item}}<br /> {{Flink|int|my_session_meat}}<br /> {{Flink|int [string]|my_session_results}}<br /> {{Flink|string|my_sign}}<br /> {{Flink|int|my_soulsauce}}<br /> {{Flink|int|my_spleen_use}}<br /> {{Flink|int|my_storage_meat}}<br /> {{Flink|thrall|my_thrall}}<br /> {{Flink|int|my_thunder}}<br /> {{Flink|int|my_turncount}}<br /> {{Flink|vykea|my_vykea_companion}}<br /> {{Flink|int|my_wildfire_water}}<br /> <br /> ===n===<br /> {{Flink|int|now_to_int}}<br /> {{Flink|string|now_to_string|string}}<br /> {{Flink|int|npc_price|item}}<br /> {{Flink|string|numberology_prize|int}}<br /> {{Flink|float|numeric_modifier|effect|string}}<br /> {{Flink|float|numeric_modifier|familiar|string|int|item}}<br /> {{Flink|float|numeric_modifier|item|string}}<br /> {{Flink|float|numeric_modifier|skill|string}}<br /> {{Flink|float|numeric_modifier|{{opt|string}}|string}}<br /> <br /> ===o===<br /> {{Flink|boolean|outfit|string}}<br /> {{Flink|item [0]|outfit_pieces|string}}<br /> {{Flink|string|outfit_tattoo|{{opt|string}}}}<br /> {{Flink|float [item]|outfit_treats|string}}<br /> {{FunctionEmbed|overdrink|format=signature}}<br /> <br /> ===p===<br /> {{Flink|string|path_id_to_name|int}}<br /> {{Flink|int|path_name_to_id|string}}<br /> {{Flink|boolean|pick_pocket|int}}<br /> {{Flink|boolean|pick_pocket|monster}}<br /> {{Flink|int [effect]|pick_pocket|effect}}<br /> {{Flink|int [item]|pick_pocket|item}}<br /> {{Flink|int [stat]|pick_pocket|stat}}<br /> {{Flink|boolean [int]|picked_pockets}}<br /> {{Flink|boolean [int]|picked_scraps}}<br /> {{Flink|int [effect]|pocket_effects|int}}<br /> {{Flink|int [item]|pocket_items|int}}<br /> {{Flink|string|pocket_joke|int}}<br /> {{Flink|string [int]|pocket_meat|int}}<br /> {{Flink|monster|pocket_monster|int}}<br /> {{Flink|string [int]|pocket_poem|int}}<br /> {{Flink|string [int]|pocket_scrap|int}}<br /> {{Flink|int [stat]|pocket_stats|int}}<br /> {{Flink|int [int]|poem_pockets}}<br /> {{Flink|int [int]|potential_pockets|effect}}<br /> {{Flink|int [int]|potential_pockets|item}}<br /> {{Flink|int [int]|potential_pockets|monster}}<br /> {{Flink|int [int]|potential_pockets|stat}}<br /> {{Flink|boolean|pre_validate_adventure|location}}<br /> {{Flink|boolean|prepare_for_adventure|location}}<br /> {{Flink|void|print|{{opt|string}}|{{opt|string}}}}<br /> {{Flink|void|print_html|string|boolean}}<br /> {{Flink|void|print_html|string}}<br /> {{FunctionEmbed|property_default_value|format=signature}}<br /> {{FunctionEmbed|property_exists|format=signature}}<br /> {{FunctionEmbed|property_has_default|format=signature}}<br /> {{Flink|int|pulls_remaining}}<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_display|item|int}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|put_stash|item|int}}<br /> {{Flink|int|pvp_attacks_left}}<br /> <br /> ===r===<br /> {{Flink|int|rain_cost|skill}}<br /> {{Flink|int|random|int}}<br /> {{Flink|int|raw_damage_absorption}}<br /> {{Flink|buffer|read_ccs|string}}<br /> {{Flink|void|receive_fax}}<br /> {{Flink|boolean|refresh_shop}}<br /> {{Flink|boolean|refresh_stash}}<br /> {{Flink|boolean|refresh_status}}<br /> {{Flink|void|remove_item_condition|int|item}}<br /> {{Flink|void|remove_item_condition|item|int}}<br /> {{FunctionEmbed|remove_property|format=signature}}<br /> {{FunctionEmbed|rename_property|format=signature}}<br /> {{Flink|buffer|replace|buffer|int|int|string}}<br /> {{Flink|string|replace_all|matcher|string}}<br /> {{Flink|string|replace_first|matcher|string}}<br /> {{Flink|buffer|replace_string|buffer|string|string}}<br /> {{Flink|buffer|replace_string|string|string|string}}<br /> {{Flink|boolean|reprice_shop|int|{{opt|int}}|item}}<br /> {{Flink|matcher|reset|matcher|{{opt|string}}}}<br /> {{Flink|boolean [int]|restoration_pockets}}<br /> {{Flink|boolean|restore_hp|int}}<br /> {{Flink|boolean|restore_mp|int}}<br /> {{Flink|boolean|retrieve_item|int|item}}<br /> {{Flink|boolean|retrieve_item|item|{{opt|int}}}}<br /> {{Flink|int|retrieve_price|int|item|boolean}}<br /> {{Flink|int|retrieve_price|int|item}}<br /> {{Flink|int|retrieve_price|item|int|boolean}}<br /> {{Flink|int|retrieve_price|item|int}}<br /> {{Flink|int|retrieve_price|item}}<br /> {{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}<br /> {{Flink|int|rollover}}<br /> {{Flink|int|round|float}}<br /> {{FunctionEmbed|run_choice|format=signature}}<br /> {{Flink|buffer|run_combat|{{opt|string}}}}<br /> {{Flink|buffer|run_turn}}<br /> {{Flink|buffer|runaway}}<br /> <br /> ===s===<br /> {{Flink|int [int]|scrap_pockets}}<br /> {{Flink|boolean|sell|coinmaster|int|item}}<br /> {{Flink|int|sell_price|coinmaster|item}}<br /> {{Flink|boolean|sells_item|coinmaster|item}}<br /> {{Flink|void|send_fax}}<br /> {{Flink|string [int]|session_logs|{{opt|string}}|{{opt|string}}|int}}<br /> {{Flink|void|set_auto_attack|int}}<br /> {{Flink|void|set_auto_attack|string}}<br /> {{Flink|boolean|set_ccs|string}}<br /> {{Flink|void|set_length|buffer|int}}<br /> {{Flink|void|set_location|location}}<br /> {{Flink|void|set_property|string|string}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|shop_limit|item}}<br /> {{Flink|int|shop_price|item}}<br /> {{Flink|skill|skill_modifier|item|string}}<br /> {{Flink|skill|skill_modifier|string|string}}<br /> {{Flink|int|slash_count|item}}<br /> {{Flink|int|soulsauce_cost|skill}}<br /> {{Flink|int|spleen_limit}}<br /> {{Flink|string [int]|split_string|string|{{opt|string}}}}<br /> {{Flink|float|square_root|float}}<br /> {{Flink|int|start|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|starts_with|format=signature}}<br /> {{Flink|int|stash_amount|item}}<br /> {{Flink|stat|stat_bonus_today}}<br /> {{Flink|stat|stat_bonus_tomorrow}}<br /> {{Flink|stat|stat_modifier|effect|string}}<br /> {{Flink|boolean [int]|stats_pockets}}<br /> {{Flink|buffer|steal}}<br /> {{Flink|int|stills_available}}<br /> {{Flink|void|stop_counter|string}}<br /> {{Flink|int|storage_amount|item}}<br /> {{Flink|string|string_modifier|{{opt|string}}|string}}<br /> {{Flink|skill|stun_skill}}<br /> {{Flink|string|substring|string|int|{{opt|int}}}}<br /> {{Flink|boolean|svn_at_head|string}}<br /> {{Flink|boolean|svn_exists|string}}<br /> {{Flink|string [0]|svn_list}}<br /> {{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}<br /> {{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}<br /> {{Flink|item [0]|sweet_synthesis_pairing|effect|item|int}}<br /> {{Flink|item [0]|sweet_synthesis_pairing|effect|item}}<br /> {{Flink|effect|sweet_synthesis_result|item|item}}<br /> <br /> ===t===<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_display|item|int}}<br /> {{Flink|boolean|take_shop|{{opt|int}}|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_stash|item|int}}<br /> {{Flink|boolean|take_storage|int|item}}<br /> {{Flink|boolean|take_storage|item|int}}<br /> {{Flink|int|tavern|{{opt|string}}}}<br /> {{Flink|buffer|throw_item|item}}<br /> {{Flink|buffer|throw_items|item|item}}<br /> {{Flink|int|thunder_cost|skill}}<br /> {{Flink|string|time_to_string}}<br /> {{Flink|string|timestamp_to_date|int|string}}<br /> {{Flink|boolean|to_boolean|boolean}}<br /> {{Flink|boolean|to_boolean|int}}<br /> {{Flink|boolean|to_boolean|strict_string}}<br /> {{Flink|bounty|to_bounty|strict_string}}<br /> {{Flink|class|to_class|int}}<br /> {{Flink|class|to_class|strict_string}}<br /> {{Flink|coinmaster|to_coinmaster|strict_string}}<br /> {{Flink|effect|to_effect|int}}<br /> {{Flink|effect|to_effect|skill}}<br /> {{Flink|effect|to_effect|strict_string}}<br /> {{Flink|element|to_element|strict_string}}<br /> {{Flink|familiar|to_familiar|int}}<br /> {{Flink|familiar|to_familiar|strict_string}}<br /> {{Flink|float|to_float|boolean}}<br /> {{Flink|float|to_float|float}}<br /> {{Flink|float|to_float|int}}<br /> {{Flink|float|to_float|strict_string}}<br /> {{Flink|int|to_int|boolean}}<br /> {{Flink|int|to_int|class}}<br /> {{Flink|int|to_int|effect}}<br /> {{Flink|int|to_int|familiar}}<br /> {{Flink|int|to_int|float}}<br /> {{Flink|int|to_int|int}}<br /> {{Flink|int|to_int|item}}<br /> {{Flink|int|to_int|location}}<br /> {{Flink|int|to_int|monster}}<br /> {{Flink|int|to_int|path}}<br /> {{Flink|int|to_int|servant}}<br /> {{Flink|int|to_int|skill}}<br /> {{Flink|int|to_int|strict_string}}<br /> {{Flink|int|to_int|thrall}}<br /> {{Flink|int|to_int|vykea}}<br /> {{Flink|item|to_item|int}}<br /> {{Flink|item|to_item|strict_string}}<br /> {{Flink|item|to_item|string|int}}<br /> {{Flink|string|to_json|null}}<br /> {{Flink|location|to_location|int}}<br /> {{Flink|location|to_location|strict_string}}<br /> {{Flink|string|to_lower_case|string}}<br /> {{Flink|monster|to_monster|int}}<br /> {{Flink|monster|to_monster|strict_string}}<br /> {{Flink|path|to_path|int}}<br /> {{Flink|path|to_path|strict_string}}<br /> {{Flink|phylum|to_phylum|strict_string}}<br /> {{Flink|string|to_plural|item}}<br /> {{Flink|servant|to_servant|int}}<br /> {{Flink|servant|to_servant|strict_string}}<br /> {{Flink|skill|to_skill|effect/int}}<br /> {{Flink|skill|to_skill|strict_string|{{opt|strict_string}}}}<br /> {{Flink|slot|to_slot|item}}<br /> {{Flink|slot|to_slot|strict_string}}<br /> {{Flink|stat|to_stat|strict_string}}<br /> {{Flink|string|to_string|float|string}}<br /> {{Flink|string|to_string|int|string}}<br /> {{Flink|string|to_string|string}}<br /> {{Flink|thrall|to_thrall|int}}<br /> {{Flink|thrall|to_thrall|strict_string}}<br /> {{Flink|string|to_upper_case|string}}<br /> {{Flink|string|to_url|location}}<br /> {{Flink|vykea|to_vykea|strict_string}}<br /> {{Flink|string|to_wiki_url|effect}}<br /> {{Flink|string|to_wiki_url|item}}<br /> {{Flink|string|to_wiki_url|monster}}<br /> {{Flink|string|to_wiki_url|skill}}<br /> {{Flink|string|to_wiki_url|string}}<br /> {{Flink|string|today_to_string}}<br /> {{Flink|int|total_free_rests}}<br /> {{Flink|int|total_turns_played}}<br /> {{Flink|boolean|tower_door}}<br /> {{Flink|void|traceprint|string}}<br /> {{Flink|int|truncate|float}}<br /> {{Flink|int|turns_per_cast|skill}}<br /> {{Flink|int|turns_played}}<br /> {{Flink|buffer|twiddle}}<br /> <br /> ===u===<br /> {{Flink|item|unusual_construct_disc}}<br /> {{Flink|void|update_candy_prices}}<br /> {{Flink|string|url|int|revision|string|last_changed_author|int|last_changed_rev|string|last_changed_date|svn_info|string}}<br /> {{Flink|string|url|string|branch|string|commit|string|last_changed_author|string|last_changed_date|git_info|string}}<br /> {{Flink|string|url_decode|string}}<br /> {{Flink|string|url_encode|string}}<br /> {{Flink|boolean|use|int|item}}<br /> {{Flink|boolean|use|item|{{opt|int}}}}<br /> {{Flink|boolean|use_familiar|familiar}}<br /> {{Flink|boolean|use_servant|servant}}<br /> {{Flink|boolean|use_skill|int|skill|{{opt|string}}}}<br /> {{Flink|boolean|use_skill|skill|int|{{opt|string}}}}<br /> {{Flink|buffer|use_skill|skill}}<br /> {{Flink|boolean|user_confirm|string|int|boolean}}<br /> {{Flink|boolean|user_confirm|string}}<br /> {{Flink|void|user_notify|string|boolean}}<br /> {{Flink|void|user_notify|string}}<br /> {{Flink|string|user_prompt|string|aggregate}}<br /> {{Flink|string|user_prompt|string|int|string}}<br /> {{Flink|string|user_prompt|string}}<br /> <br /> ===v===<br /> {{Flink|boolean|visit|coinmaster}}<br /> {{FunctionEmbed|visit_url}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|class|path|int}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}<br /> <br /> ===w===<br /> {{Flink|void|wait|int}}<br /> {{Flink|void|waitq|int}}<br /> {{Flink|int|weapon_hands|item}}<br /> {{Flink|stat|weapon_type|item}}<br /> {{Flink|int|weight_adjustment}}<br /> {{Flink|boolean|well_stocked|string|int|int}}<br /> {{Flink|boolean|white_citadel_available}}<br /> {{Flink|boolean [string]|who_clan}}<br /> {{Flink|boolean|will_usually_dodge}}<br /> {{Flink|boolean|will_usually_miss}}<br /> {{Flink|void|write|string}}<br /> {{Flink|boolean|write_ccs|buffer|string}}<br /> {{Flink|void|writeln|string}}<br /> <br /> ===x===<br /> {{Flink|string [0]|xpath|string|string}}<br /> <br /> ===z===<br /> {{Flink|item|zap|item}}<br /> <br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Ash_Functions&diff=9204 2023-04-27T03:01:30Z

<p>Eliteofdelete: formatting issue</p> <hr /> <div>{{TOCright}}<br /> Master list of all ASH functions. All functions as of r20745 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version.<br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{FunctionEmbed|add_item_condition|format=signature}}<br /> {{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}<br /> {{Flink|int|adv_cost|skill}}<br /> {{Flink|boolean|adventure|int|location|{{opt|string}}}}<br /> {{Flink|boolean|adventure|location|int|{{opt|string}}}}<br /> {{FunctionEmbed|all_monsters_with_id|format=signature}}<br /> {{Flink|string [int]|all_normal_outfits}}<br /> {{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}<br /> {{Flink|buffer|append|buffer|string}}<br /> {{Flink|buffer|append_replacement|matcher|buffer|string}}<br /> {{Flink|buffer|append_tail|matcher|buffer}}<br /> {{Flink|buffer|attack}}<br /> {{Flink|boolean|autosell|int|item}}<br /> {{Flink|boolean|autosell|item|int}}<br /> {{Flink|int|autosell_price|item}}<br /> {{Flink|int|available_amount|item}}<br /> {{FunctionEmbed|available_choice_options}}<br /> {{FunctionEmbed|available_choice_select_inputs}}<br /> {{Flink|string [string]|available_choice_text_inputs|int}}<br /> {{Flink|int|available_pocket|monster}}<br /> {{Flink|int|available_pocket|effect}}<br /> {{Flink|int|available_pocket|item}}<br /> {{Flink|int|available_pocket|stat}}<br /> <br /> ===b===<br /> {{Flink|boolean|batch_close}}<br /> {{Flink|void|batch_open}}<br /> {{Flink|boolean|bjornify_familiar|familiar}}<br /> {{Flink|boolean|black_market_available}}<br /> {{Flink|boolean|boolean_modifier|{{opt|string}}|string}}<br /> {{Flink|boolean|boolean_modifier|effect|string}}<br /> {{Flink|boolean|boolean_modifier|item|string}}<br /> {{Flink|int|buffed_hit_stat}}<br /> {{FunctionEmbed|buffer_to_file|format=signature}}<br /> {{Flink|boolean|buy|coinmaster|item}}<br /> {{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}<br /> {{Flink|boolean|buy|item|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|buy|int|item|int}}<br /> {{Flink|int|buy_price|coinmaster|item}}<br /> {{Flink|boolean|buy_using_storage|int|item}}<br /> {{Flink|int|buy_using_storage|int|item|int}}<br /> {{Flink|int|buy_using_storage|item|int|int}}<br /> {{Flink|boolean|buys_item|coinmaster|item}}<br /> <br /> ===c===<br /> {{Flink|boolean|can_drink}}<br /> {{Flink|boolean|can_eat}}<br /> {{Flink|boolean|can_equip|familiar|{{opt|item}}}}<br /> {{Flink|boolean|can_equip|item}}<br /> {{Flink|boolean|can_faxbot|monster}}<br /> {{Flink|boolean|can_interact}}<br /> {{Flink|boolean|can_still_steal}}<br /> {{Flink|boolean|canadia_available}}<br /> {{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}<br /> {{Flink|int|ceil|float}}<br /> {{Flink|boolean|change_mcd|int}}<br /> {{Flink|string|char_at|string|int}}<br /> {{Flink|void|chat_clan|string|{{opt|string}}}}<br /> {{Flink|void|chat_macro|string}}<br /> {{Flink|void|chat_notify|string|string}}<br /> {{Flink|void|chat_private|string|string}}<br /> {{Flink|boolean|chew|int|item}}<br /> {{Flink|boolean|chew|item|{{opt|int}}}}<br /> {{Flink|boolean|choice_follows_fight}}<br /> {{Flink|class|class_modifier|string|string}}<br /> {{Flink|class|class_modifier|item|string}}<br /> {{Flink|void|clear|aggregate}}<br /> {{FunctionEmbed|clear_booze_helper|format=signature}}<br /> {{FunctionEmbed|clear_food_helper|format=signature}}<br /> {{FunctionEmbed|cli_execute|format=signature}}<br /> {{FunctionEmbed|cli_execute_output|format=signature}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|combat_mana_cost_modifier}}<br /> {{Flink|float|combat_rate_modifier}}<br /> {{FunctionEmbed|contains_text|format=signature}}<br /> {{Flink|void|council}}<br /> {{Flink|int|count|aggregate}}<br /> {{Flink|int|craft|string|int|item|item}}<br /> {{Flink|string|craft_type|item}}<br /> {{Flink|int|creatable_amount|item}}<br /> {{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}<br /> {{Flink|boolean|create|int|item}}<br /> {{Flink|boolean|create|item|{{opt|int}}}}<br /> {{Flink|matcher|create_matcher|string|string}}<br /> {{Flink|stat|current_hit_stat}}<br /> {{Flink|int|current_mcd}}<br /> {{Flink|int [string]|current_pvp_stances}}<br /> {{Flink|int|current_rad_sickness}}<br /> {{Flink|int|current_round}}<br /> <br /> ===d===<br /> {{Flink|element|dad_sea_monkee_weakness|int}}<br /> {{Flink|item|daily_special}}<br /> {{Flink|float|damage_absorption_percent}}<br /> {{Flink|int|damage_reduction}}<br /> {{Flink|int|date_to_timestamp|string|string}}<br /> {{Flink|void|debugprint|string}}<br /> {{Flink|buffer|delete|buffer|int|int}}<br /> {{Flink|effect|desc_to_effect|string}}<br /> {{Flink|item|desc_to_item|string}}<br /> {{Flink|void|disable|string}}<br /> {{Flink|boolean|dispensary_available}}<br /> {{Flink|int|display_amount|item}}<br /> {{FunctionEmbed|drink|format=signature}}<br /> {{Flink|boolean|drinksilent|int|item}}<br /> {{Flink|boolean|drinksilent|item|{{opt|int}}}}<br /> {{Flink|void|dump|any|{{opt|string}}}}<br /> <br /> ===e===<br /> {{FunctionEmbed|eat|format=signature}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eatsilent|item|{{opt|int}}}}<br /> {{Flink|effect|effect_modifier|string|string}}<br /> {{Flink|effect|effect_modifier|item|string}}<br /> {{Flink|boolean [int]|effect_pockets}}<br /> {{Flink|float|elemental_resistance|{{opt|element}}}}<br /> {{Flink|float|elemental_resistance|monster}}<br /> {{Flink|boolean|empty_closet}}<br /> {{Flink|void|enable|string}}<br /> {{Flink|int|end|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|ends_with|format=signature}}<br /> {{Flink|boolean|enthrone_familiar|familiar}}<br /> {{Flink|string|entity_decode|string}}<br /> {{Flink|string|entity_encode|string}}<br /> {{Flink|boolean|equip|item|{{opt|slot}}}}<br /> {{Flink|boolean|equip|slot|item}}<br /> {{Flink|boolean|equip_all_familiars}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|item|equipped_item|slot}}<br /> {{Flink|string|eudora}}<br /> {{Flink|boolean|eudora|string}}<br /> {{Flink|string|every_card_name|strict_string}}<br /> {{Flink|int|expected_damage|{{opt|monster}}}}<br /> {{Flink|float|experience_bonus}}<br /> {{Flink|float|expression_eval|string}}<br /> {{Flink|int [item]|extract_items|string}}<br /> {{Flink|int|extract_meat|string}}<br /> <br /> ===f===<br /> {{Flink|item|familiar_equipment|familiar}}<br /> {{Flink|item|familiar_equipped_equipment|familiar}}<br /> {{Flink|int|familiar_weight|familiar}}<br /> {{Flink|boolean [familiar]|favorite_familiars|}}<br /> {{Flink|boolean|faxbot|monster|{{opt|string}}}}<br /> {{Flink|boolean|fight_follows_choice}}<br /> {{FunctionEmbed|file_to_array|format=signature}}<br /> {{FunctionEmbed|file_to_buffer|format=signature}}<br /> {{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}<br /> {{Flink|boolean|find|matcher}}<br /> {{Flink|int|floor|float}}<br /> {{Flink|boolean|florist_available}}<br /> {{Flink|boolean|flush_monster_manuel_cache}}<br /> {{Flink|string|form_field|string}}<br /> {{Flink|string [string]|form_fields}}<br /> {{Flink|string|format_date_time|string|string|string}}<br /> {{Flink|boolean|friars_available}}<br /> {{Flink|int|fuel_cost|skill}}<br /> {{Flink|int|fullness_limit}}<br /> <br /> ===g===<br /> {{Flink|int|gameday_to_int}}<br /> {{Flink|string|gameday_to_string}}<br /> {{Flink|int|gametime_to_int}}<br /> {{Flink|boolean [string] |get_all_properties|string|boolean}}<br /> {{Flink|int|get_auto_attack}}<br /> {{Flink|int [item]|get_campground}}<br /> {{Flink|string |get_ccs_action|int}}<br /> {{Flink|int [item]|get_chateau}}<br /> {{Flink|int|get_clan_id}}<br /> {{Flink|int [item]|get_clan_lounge}}<br /> {{Flink|string|get_clan_name}}<br /> {{Flink|int [string]|get_clan_rumpus}}<br /> {{Flink|int [item]|get_closet}}<br /> {{Flink|string|get_counters|string|int|int}}<br /> {{Flink|string [int]|get_custom_outfits}}<br /> {{Flink|item|get_dwelling}}<br /> {{Flink|string [location, 3]|get_florist_plants}}<br /> {{Flink|int [item]|get_free_pulls}}<br /> {{Flink|int|get_fuel}}<br /> {{Flink|string [int]|get_goals}}<br /> {{Flink|boolean|get_ignore_zone_warnings}}<br /> {{Flink|int [item]|get_ingredients|item}}<br /> {{Flink|int [item]|get_inventory}}<br /> {{Flink|boolean [monster]|get_location_monsters|location}}<br /> {{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}<br /> {{Flink|monster [int]|get_monsters|location}}<br /> {{Flink|string [int]|get_moods}}<br /> {{Flink|string [int]|get_outfits}}<br /> {{Flink|string|get_path}}<br /> {{Flink|string|get_path_full}}<br /> {{Flink|string|get_path_variables}}<br /> {{Flink|string|get_player_id|string}}<br /> {{Flink|string|get_player_name|int}}<br /> {{Flink|int|get_power|item}}<br /> {{Flink|string|get_property|string|{{opt|boolean}}}}<br /> {{Flink|int [item]|get_related|item|string}}<br /> {{Flink|int|get_revision}}<br /> {{Flink|int [item]|get_shop}}<br /> {{Flink|string [0]|get_shop_log}}<br /> {{Flink|string string int [0]|get_stack_trace}}<br /> {{Flink|int [item]|get_stash}}<br /> {{Flink|int [item]|get_storage}}<br /> {{Flink|string|get_version}}<br /> {{Flink|string|get_workshed}}<br /> {{Flink|boolean|gnomads_available}}<br /> {{Flink|boolean|goal_exists|string}}<br /> {{Flink|string|group|matcher|{{opt|int}}}}<br /> {{Flink|string|group|matcher|string}}<br /> {{Flink|int|group_count|matcher}}<br /> {{Flink|boolean [string]|group_names|matcher}}<br /> {{Flink|string [int, int]|group_string|string|string}}<br /> {{Flink|boolean|guild_available}}<br /> {{Flink|boolean|guild_store_available}}<br /> <br /> ===h===<br /> {{Flink|boolean|handling_choice}}<br /> {{Flink|boolean|have_bartender}}<br /> {{Flink|boolean|have_chef}}<br /> {{Flink|boolean|have_display}}<br /> {{Flink|int|have_effect|effect}}<br /> {{Flink|boolean|have_equipped|item}}<br /> {{Flink|boolean|have_familiar|familiar}}<br /> {{Flink|boolean|have_mushroom_plot}}<br /> {{Flink|boolean|have_outfit|string}}<br /> {{Flink|boolean|have_servant|servant}}<br /> {{Flink|boolean|have_shop}}<br /> {{Flink|boolean|have_skill|skill}}<br /> {{Flink|boolean|hedge_maze|string}}<br /> {{Flink|boolean|hermit|int|item}}<br /> {{Flink|boolean|hermit|item|int}}<br /> {{Flink|boolean|hidden_temple_unlocked}}<br /> {{Flink|boolean|hippy_stone_broken}}<br /> {{Flink|boolean|hippy_store_available}}<br /> {{FunctionEmbed|historical_age}}<br /> {{FunctionEmbed|historical_price}}<br /> {{Flink|string|holiday}}<br /> {{Flink|int|hp_cost|skill}}<br /> <br /> ===i===<br /> {{Flink|monster|image_to_monster|strict_string}}<br /> {{Flink|boolean|in_bad_moon}}<br /> {{Flink|boolean|in_hardcore}}<br /> {{Flink|boolean|in_moxie_sign}}<br /> {{Flink|boolean|in_multi_fight}}<br /> {{Flink|boolean|in_muscle_sign}}<br /> {{Flink|boolean|in_mysticality_sign}}<br /> {{Flink|string|inaccessible_reason|coinmaster}}<br /> {{FunctionEmbed|index_of|format=signature}}<br /> {{Flink|int|inebriety_limit}}<br /> {{Flink|float|initiative_modifier}}<br /> {{Flink|buffer|insert|buffer|int|string}}<br /> {{Flink|boolean|is_accessible|coinmaster}}<br /> {{Flink|boolean|is_banished|monster}}<br /> {{Flink|boolean|is_coinmaster_item|item}}<br /> {{FunctionEmbed|is_dark_mode}}<br /> {{Flink|boolean|is_discardable|item}}<br /> {{Flink|boolean|is_displayable|item}}<br /> {{Flink|boolean|is_familiar_equipment_locked}}<br /> {{Flink|boolean|is_giftable|item}}<br /> {{Flink|boolean|is_goal|item}}<br /> {{Flink|boolean|is_integer|string}}<br /> {{Flink|boolean|is_npc_item|item}}<br /> {{Flink|boolean|is_online|string}}<br /> {{Flink|boolean|is_tradeable|item}}<br /> {{Flink|boolean|is_trendy|item/familiar/skill/string}}<br /> {{Flink|boolean|is_unrestricted|item/familiar/skill/string}}<br /> {{Flink|boolean|is_wearing_outfit|string}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|float|item_drop_modifier}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}}}<br /> {{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}<br /> {{Flink|boolean [int]|item_pockets}}<br /> {{Flink|string|item_type|item}}<br /> <br /> ===j===<br /> {{Flink|boolean [int]|joke_pockets}}<br /> {{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}<br /> <br /> ===k===<br /> {{Flink|boolean|knoll_available}}<br /> <br /> ===l===<br /> {{Flink|int|last_choice}}<br /> {{Flink|int|last_decision}}<br /> {{FunctionEmbed|last_index_of|format=signature}}<br /> {{Flink|string|last_item_message}}<br /> {{Flink|monster|last_monster}}<br /> {{Flink|string|last_skill_message}}<br /> {{Flink|string|leetify|string}}<br /> {{Flink|int|length|string}}<br /> {{Flink|int|lightning_cost|skill}}<br /> {{Flink|string|limit_mode}}<br /> {{Flink|buffer|load_html|string}}<br /> {{Flink|void|lock_familiar_equipment|boolean}}<br /> {{Flink|float|log_n|float|{{opt|float}}}}<br /> {{Flink|void|logprint|string}}<br /> <br /> ===m===<br /> {{Flink|string|make_url|string|boolean|boolean}}<br /> {{FunctionEmbed|mall_price}}<br /> {{FunctionEmbed|mall_prices}}<br /> {{Flink|int|mana_cost_modifier}}<br /> {{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}<br /> {{Flink|float|max|float ...}}<br /> {{Flink|int|max|int ...}}<br /> {{Flink|boolean|maximize|string|boolean}}<br /> {{Flink|boolean|maximize|string|int|int|boolean}}<br /> {{Flink|{string string float effect item skill} [int]|maximize|string|int|int|boolean|boolean}}<br /> {{Flink|int|meat_drop|{{opt|monster}}}}<br /> {{Flink|float|meat_drop_modifier}}<br /> {{Flink|int [int]|meat_pockets}}<br /> {{Flink|float|min|float ...}}<br /> {{Flink|int|min|int ...}}<br /> {{Flink|item|minstrel_instrument}}<br /> {{Flink|int|minstrel_level}}<br /> {{Flink|boolean|minstrel_quest}}<br /> {{Flink|float|modifier_eval|string}}<br /> {{Flink|int|monster_attack|{{opt|monster}}}}<br /> {{Flink|int|monster_defense|{{opt|monster}}}}<br /> {{Flink|element|monster_element|{{opt|monster}}}}<br /> {{Flink|float|monster_eval|string}}<br /> {{Flink|int|monster_factoids_available|monster|boolean}}<br /> {{Flink|int|monster_hp|{{opt|monster}}}}<br /> {{Flink|int|monster_initiative|{{opt|monster}}}}<br /> {{Flink|int|monster_level_adjustment}}<br /> {{Flink|string|monster_manuel_text|monster}}<br /> {{Flink|phylum|monster_phylum|{{opt|monster}}}}<br /> {{Flink|boolean [int]|monster_pockets}}<br /> {{Flink|void|mood_execute|int}}<br /> {{Flink|string [0]|mood_list}}<br /> {{Flink|int|moon_light}}<br /> {{Flink|int|moon_phase}}<br /> {{Flink|int|mp_cost|skill}}<br /> {{Flink|int|my_absorbs}}<br /> {{Flink|int|my_adventures}}<br /> {{Flink|int|my_ascensions}}<br /> {{Flink|int|my_audience}}<br /> {{Flink|int|my_basestat|stat}}<br /> {{Flink|familiar|my_bjorned_familiar}}<br /> {{Flink|int|my_buffedstat|stat}}<br /> {{Flink|class|my_class}}<br /> {{Flink|int|my_closet_meat}}<br /> {{Flink|string|my_companion}}<br /> {{Flink|int|my_daycount}}<br /> {{Flink|int|my_discomomentum}}<br /> {{Flink|familiar|my_effective_familiar}}<br /> {{Flink|int [effect]|my_effects}}<br /> {{Flink|familiar|my_enthroned_familiar}}<br /> {{Flink|familiar|my_familiar}}<br /> {{Flink|int|my_fullness}}<br /> {{Flink|int|my_fury}}<br /> {{Flink|string|my_garden_type}}<br /> {{Flink|string|my_hash}}<br /> {{Flink|int|my_hp}}<br /> {{Flink|string|my_id}}<br /> {{Flink|int|my_inebriety}}<br /> {{Flink|int|my_level}}<br /> {{Flink|int|my_lightning}}<br /> {{Flink|location|my_location}}<br /> {{Flink|string|my_mask}}<br /> {{Flink|int|my_maxfury}}<br /> {{Flink|int|my_maxhp}}<br /> {{Flink|int|my_maxmp}}<br /> {{Flink|int|my_maxpp}}<br /> {{Flink|int|my_meat}}<br /> {{Flink|int|my_mp}}<br /> {{Flink|string|my_name}}<br /> {{Flink|string|my_path}}<br /> {{Flink|int|my_path_id}}<br /> {{Flink|familiar|my_poke_fam|int}}<br /> {{Flink|int|my_pp}}<br /> {{Flink|stat|my_primestat}}<br /> {{Flink|int|my_rain}}<br /> {{Flink|int|my_robot_energy}}<br /> {{Flink|int|my_robot_scraps}}<br /> {{Flink|servant|my_servant}}<br /> {{Flink|int|my_session_adv}}<br /> {{Flink|int [item]|my_session_items}}<br /> {{Flink|int|my_session_items|item}}<br /> {{Flink|int|my_session_meat}}<br /> {{Flink|string|my_sign}}<br /> {{Flink|int|my_soulsauce}}<br /> {{Flink|int|my_spleen_use}}<br /> {{Flink|int|my_storage_meat}}<br /> {{Flink|thrall|my_thrall}}<br /> {{Flink|int|my_thunder}}<br /> {{Flink|int|my_turncount}}<br /> {{Flink|vykea|my_vykea_companion}}<br /> <br /> ===n===<br /> {{Flink|int|now_to_int}}<br /> {{Flink|string|now_to_string|string}}<br /> {{Flink|int|npc_price|item}}<br /> {{Flink|string|numberology_prize|int}}<br /> {{Flink|float|numeric_modifier|effect|string}}<br /> {{Flink|float|numeric_modifier|familiar|string|int|item}}<br /> {{Flink|float|numeric_modifier|item|string}}<br /> {{Flink|float|numeric_modifier|skill|string}}<br /> {{Flink|float|numeric_modifier|{{opt|string}}|string}}<br /> <br /> ===o===<br /> {{Flink|boolean|outfit|string}}<br /> {{Flink|item [int]|outfit_pieces|string}}<br /> {{Flink|string|outfit_tattoo|{{opt|string}}}}<br /> {{FunctionEmbed|overdrink|format=signature}}<br /> <br /> ===p===<br /> {{Flink|string|path_id_to_name|int}}<br /> {{Flink|int|path_name_to_id|string}}<br /> {{Flink|boolean|pick_pocket|monster}}<br /> {{Flink|int [effect]|pick_pocket|effect}}<br /> {{Flink|int [item]|pick_pocket|item}}<br /> {{Flink|int [stat]|pick_pocket|stat}}<br /> {{Flink|boolean|pick_pocket|int}}<br /> {{Flink|boolean [int]|picked_pockets}}<br /> {{Flink|boolean [int]|picked_scraps}}<br /> {{Flink|int [effect]|pocket_effects|int}}<br /> {{Flink|int [item]|pocket_items|int}}<br /> {{Flink|string|pocket_joke|int}}<br /> {{Flink|string [int]|pocket_meat|int}}<br /> {{Flink|monster|pocket_monster|int}}<br /> {{Flink|string [int]|pocket_poem|int}}<br /> {{Flink|string [int]|pocket_scrap|int}}<br /> {{Flink|int [stat]|pocket_stats|int}}<br /> {{Flink|int [int]|poem_pockets}}<br /> {{Flink|int [int]|potential_pockets|effect/item/monster/stat}}<br /> {{Flink|void|print|{{opt|string}}|{{opt|string}}}}<br /> {{Flink|void|print_html|string}}<br /> {{FunctionEmbed|property_default_value|format=signature}}<br /> {{FunctionEmbed|property_exists|format=signature}}<br /> {{FunctionEmbed|property_has_default|format=signature}}<br /> {{Flink|int|pulls_remaining}}<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_display|item|int}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|put_stash|item|int}}<br /> {{Flink|int|pvp_attacks_left}}<br /> <br /> ===r===<br /> {{Flink|int|rain_cost|skill}}<br /> {{Flink|int|random|int}}<br /> {{Flink|int|raw_damage_absorption}}<br /> {{Flink|boolean|refresh_shop}}<br /> {{Flink|boolean|refresh_stash}}<br /> {{Flink|boolean|refresh_status}}<br /> {{Flink|void|remove_item_condition|int|item}}<br /> {{Flink|void|remove_item_condition|item|int}}<br /> {{FunctionEmbed|remove_property|format=signature}}<br /> {{FunctionEmbed|rename_property|format=signature}}<br /> {{Flink|boolean|replace|buffer|int|int|string}}<br /> {{Flink|string|replace_all|matcher|string}}<br /> {{Flink|string|replace_first|matcher|string}}<br /> {{Flink|buffer|replace_string|buffer|string|string}}<br /> {{Flink|buffer|replace_string|string|string|string}}<br /> {{Flink|boolean|reprice_shop|int|{{opt|int}}|item}}<br /> {{Flink|matcher|reset|matcher|{{opt|string}}}}<br /> {{Flink|boolean [int]|restoration_pockets}}<br /> {{Flink|boolean|restore_hp|int}}<br /> {{Flink|boolean|restore_mp|int}}<br /> {{Flink|boolean|retrieve_item|int|item}}<br /> {{Flink|boolean|retrieve_item|item|{{opt|int}}}}<br /> {{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}<br /> {{Flink|int|rollover}}<br /> {{Flink|int|round|float}}<br /> {{FunctionEmbed|run_choice|format=signature}}<br /> {{Flink|buffer|run_combat|{{opt|string}}}}<br /> {{Flink|buffer|run_turn}}<br /> {{Flink|buffer|runaway}}<br /> <br /> ===s===<br /> {{Flink|int [int]|scrap_pockets}}<br /> {{Flink|boolean|sell|coinmaster|int|item}}<br /> {{Flink|int|sell_price|coinmaster|item}}<br /> {{Flink|boolean|sells_item|coinmaster|item}}<br /> {{Flink|string [int]|session_logs|{{opt|string}}|{{opt|string}}|int}}<br /> {{Flink|void|set_auto_attack|int/string}}<br /> {{Flink|void|set_length|buffer|int}}<br /> {{Flink|void|set_location|location}}<br /> {{Flink|void|set_property|string|string}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|shop_limit|item}}<br /> {{Flink|int|shop_price|item}}<br /> {{Flink|skill|skill_modifier|item|string}}<br /> {{Flink|skill|skill_modifier|string|string}}<br /> {{Flink|int|slash_count|item}}<br /> {{Flink|int|soulsauce_cost|skill}}<br /> {{Flink|int|spleen_limit}}<br /> {{Flink|string [int]|split_string|string|{{opt|string}}}}<br /> {{Flink|float|square_root|float}}<br /> {{Flink|int|start|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|starts_with|format=signature}}<br /> {{Flink|int|stash_amount|item}}<br /> {{Flink|stat|stat_bonus_today}}<br /> {{Flink|stat|stat_bonus_tomorrow}}<br /> {{Flink|stat|stat_modifier|effect|string}}<br /> {{Flink|buffer|steal}}<br /> {{Flink|int|stills_available}}<br /> {{Flink|void|stop_counter|string}}<br /> {{Flink|int|storage_amount|item}}<br /> {{Flink|string|string_modifier|{{opt|string}}|string}}<br /> {{Flink|skill|stun_skill}}<br /> {{Flink|string|substring|string|int|{{opt|int}}}}<br /> {{Flink|boolean|svn_at_head|string}}<br /> {{Flink|boolean|svn_exists|string}}<br /> {{Flink|{string int string int string}|svn_info|string}}<br /> {{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}<br /> {{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}<br /> {{Flink|effect|sweet_synthesis_result|item|item}}<br /> <br /> ===t===<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_display|item|int}}<br /> {{Flink|boolean|take_shop|{{opt|int}}|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_stash|item|int}}<br /> {{Flink|boolean|take_storage|int|item}}<br /> {{Flink|boolean|take_storage|item|int}}<br /> {{Flink|int|tavern|{{opt|string}}}}<br /> {{Flink|buffer|throw_item|item}}<br /> {{Flink|buffer|throw_items|item|item}}<br /> {{Flink|int|thunder_cost|skill}}<br /> {{Flink|string|time_to_string}}<br /> {{Flink|string|timestamp_to_date|int|string}}<br /> {{Flink|boolean|to_boolean|any}}<br /> {{Flink|bounty|to_bounty|strict_string}}<br /> {{Flink|class|to_class|strict_string/int}}<br /> {{Flink|coinmaster|to_coinmaster|strict_string}}<br /> {{Flink|effect|to_effect|int/skill/strict_string}}<br /> {{Flink|element|to_element|strict_string}}<br /> {{Flink|familiar|to_familiar|int/strict_string}}<br /> {{Flink|float|to_float|any}}<br /> {{Flink|int|to_int|any}}<br /> {{Flink|item|to_item|int/strict_string}}<br /> {{Flink|item|to_item|string|int}}<br /> {{Flink|string|to_json|aggregate}}<br /> {{Flink|location|to_location|int/strict_string}}<br /> {{Flink|string|to_lower_case|string}}<br /> {{Flink|monster|to_monster|int/strict_string}}<br /> {{Flink|phylum|to_phylum|string}}<br /> {{Flink|string|to_plural|item}}<br /> {{Flink|servant|to_servant|int/strict_string}}<br /> {{Flink|skill|to_skill|effect/int}}<br /> {{Flink|skill|to_skill|strict_string|{{opt|strict_string}}}}<br /> {{Flink|slot|to_slot|item/strict_string}}<br /> {{Flink|stat|to_stat|strict_string}}<br /> {{Flink|string|to_string|any}}<br /> {{Flink|thrall|to_thrall|int/strict_string}}<br /> {{Flink|string|to_upper_case|string}}<br /> {{Flink|string|to_url|location}}<br /> {{Flink|vykea|to_vykea|strict_string}}<br /> {{Flink|string|today_to_string}}<br /> {{Flink|int|total_free_rests}}<br /> {{Flink|int|total_turns_played}}<br /> {{Flink|boolean|tower_door}}<br /> {{Flink|void|traceprint|string}}<br /> {{Flink|int|truncate|float}}<br /> {{Flink|int|turns_per_cast|skill}}<br /> {{Flink|int|turns_played}}<br /> {{Flink|buffer|twiddle}}<br /> <br /> ===u===<br /> {{Flink|item|unusual_construct_disc}}<br /> {{Flink|void|update_candy_prices}}<br /> {{Flink|string|url_decode|string}}<br /> {{Flink|string|url_encode|string}}<br /> {{Flink|boolean|use|int|item}}<br /> {{Flink|boolean|use|item|{{opt|int}}}}<br /> {{Flink|boolean|use_familiar|familiar}}<br /> {{Flink|boolean|use_servant|servant}}<br /> {{Flink|boolean|use_skill|int|skill|{{opt|string}}}}<br /> {{Flink|boolean|use_skill|skill|int|{{opt|string}}}}<br /> {{Flink|buffer|use_skill|skill}}<br /> {{Flink|boolean|user_confirm|string}}<br /> {{Flink|boolean|user_confirm|string|int|boolean}}<br /> <br /> ===v===<br /> {{Flink|boolean|visit|coinmaster}}<br /> {{FunctionEmbed|visit_url}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}<br /> <br /> ===w===<br /> {{Flink|void|wait|int}}<br /> {{Flink|void|waitq|int}}<br /> {{Flink|int|weapon_hands|item}}<br /> {{Flink|stat|weapon_type|item}}<br /> {{Flink|int|weight_adjustment}}<br /> {{Flink|boolean|white_citadel_available}}<br /> {{Flink|boolean [string]|who_clan}}<br /> {{Flink|boolean|will_usually_dodge}}<br /> {{Flink|boolean|will_usually_miss}}<br /> {{Flink|void|write|string}}<br /> {{Flink|void|writeln|string}}<br /> <br /> ===x===<br /> {{Flink|string[int]|xpath|string|string}}<br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=File_to_array&diff=9202 2023-04-24T06:38:37Z

<p>Eliteofdelete: Fix link</p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=file_to_array<br /> |function1.return_type={{type|string}} &lt;nowiki&gt;[&lt;/nowiki&gt;{{type|int}}&lt;nowiki&gt;]&lt;/nowiki&gt;<br /> |function1.description=Reads data from a text file and returns a map of strings containing each line.<br /> |function1.param1=filename<br /> |function1.param1.type=string<br /> |function1.param2.optional=<br /> |function1.param2.default=<br /> |function1.param1.description=Path to the text file<br /> |description=&lt;p&gt;The returned value is actually a map of strings, one string for each line. Like &lt;code&gt;[[file_to_map|file_to_map()]]&lt;/code&gt;, empty lines and those starting with a &lt;code&gt;#&lt;/code&gt; are ignored.&lt;/p&gt;<br /> <br /> &lt;p&gt;This function was added in [https://kolmafia.us/threads/file_to_string-or-file_to_map-string-string-or-session_logs-string-int-int.22940/#post-148463 r18740].&lt;/p&gt;<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description=Reads a data file into a map of strings and prints each line<br /> |code=<br /> &lt;syntaxhighlight lang=&quot;d&quot;&gt;<br /> string [int] lines = file_to_array(&quot;mydata.txt&quot;);<br /> foreach line_no, line in lines {<br /> print(`{line_no}: {line}`);<br /> }<br /> &lt;/syntaxhighlight&gt;<br /> |moreinfo=<br /> }}<br /> |see_also={{SeeAlso|buffer_to_file|file_to_buffer|file_to_map|map_to_file}}<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Miscellaneous Functions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Ash_Functions&diff=9201 2023-04-23T10:11:17Z

<p>Eliteofdelete: </p> <hr /> <div>{{TOCright}}<br /> Master list of all ASH functions. All functions as of r20745 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.)<br /> The CLI command &quot;[[ashref]]&quot; shows every implemented ash function for your mafia version.<br /> ===a===<br /> {{FunctionEmbed|abort|format=signature}}<br /> {{FunctionEmbed|add_item_condition|format=signature}}<br /> {{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}<br /> {{Flink|int|adv_cost|skill}}<br /> {{Flink|boolean|adventure|int|location|{{opt|string}}}}<br /> {{Flink|boolean|adventure|location|int|{{opt|string}}}}<br /> {{FunctionEmbed|all_monsters_with_id|format=signature}}<br /> {{Flink|string [int]|all_normal_outfits}}<br /> {{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}<br /> {{Flink|buffer|append|buffer|string}}<br /> {{Flink|buffer|append_replacement|matcher|buffer|string}}<br /> {{Flink|buffer|append_tail|matcher|buffer}}<br /> {{Flink|buffer|attack}}<br /> {{Flink|boolean|autosell|int|item}}<br /> {{Flink|boolean|autosell|item|int}}<br /> {{Flink|int|autosell_price|item}}<br /> {{Flink|int|available_amount|item}}<br /> {{FunctionEmbed|available_choice_options}}<br /> {{FunctionEmbed|available_choice_select_inputs}}<br /> {{Flink|string [string]|available_choice_text_inputs|int}}<br /> {{Flink|int|available_pocket|monster}}<br /> {{Flink|int|available_pocket|effect}}<br /> {{Flink|int|available_pocket|item}}<br /> {{Flink|int|available_pocket|stat}}<br /> <br /> ===b===<br /> {{Flink|boolean|batch_close}}<br /> {{Flink|void|batch_open}}<br /> {{Flink|boolean|bjornify_familiar|familiar}}<br /> {{Flink|boolean|black_market_available}}<br /> {{Flink|boolean|boolean_modifier|{{opt|string}}|string}}<br /> {{Flink|boolean|boolean_modifier|effect|string}}<br /> {{Flink|boolean|boolean_modifier|item|string}}<br /> {{Flink|int|buffed_hit_stat}}<br /> {{FunctionEmbed|buffer_to_file|format=signature}}<br /> {{Flink|boolean|buy|coinmaster|item}}<br /> {{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}<br /> {{Flink|boolean|buy|item|{{opt|int}}|{{opt|int}}}}<br /> {{Flink|int|buy|int|item|int}}<br /> {{Flink|int|buy_price|coinmaster|item}}<br /> {{Flink|boolean|buy_using_storage|int|item}}<br /> {{Flink|int|buy_using_storage|int|item|int}}<br /> {{Flink|int|buy_using_storage|item|int|int}}<br /> {{Flink|boolean|buys_item|coinmaster|item}}<br /> <br /> ===c===<br /> {{Flink|boolean|can_drink}}<br /> {{Flink|boolean|can_eat}}<br /> {{Flink|boolean|can_equip|familiar|{{opt|item}}}}<br /> {{Flink|boolean|can_equip|item}}<br /> {{Flink|boolean|can_faxbot|monster}}<br /> {{Flink|boolean|can_interact}}<br /> {{Flink|boolean|can_still_steal}}<br /> {{Flink|boolean|canadia_available}}<br /> {{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}<br /> {{Flink|int|ceil|float}}<br /> {{Flink|boolean|change_mcd|int}}<br /> {{Flink|string|char_at|string|int}}<br /> {{Flink|void|chat_clan|string|{{opt|string}}}}<br /> {{Flink|void|chat_macro|string}}<br /> {{Flink|void|chat_notify|string|string}}<br /> {{Flink|void|chat_private|string|string}}<br /> {{Flink|boolean|chew|int|item}}<br /> {{Flink|boolean|chew|item|{{opt|int}}}}<br /> {{Flink|boolean|choice_follows_fight}}<br /> {{Flink|class|class_modifier|string|string}}<br /> {{Flink|class|class_modifier|item|string}}<br /> {{Flink|void|clear|aggregate}}<br /> {{FunctionEmbed|clear_booze_helper|format=signature}}<br /> {{FunctionEmbed|clear_food_helper|format=signature}}<br /> {{FunctionEmbed|cli_execute|format=signature}}<br /> {{FunctionEmbed|cli_execute_output|format=signature}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|combat_mana_cost_modifier}}<br /> {{Flink|float|combat_rate_modifier}}<br /> {{FunctionEmbed|contains_text|format=signature}}<br /> {{Flink|void|council}}<br /> {{Flink|int|count|aggregate}}<br /> {{Flink|int|craft|string|int|item|item}}<br /> {{Flink|string|craft_type|item}}<br /> {{Flink|int|creatable_amount|item}}<br /> {{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}<br /> {{Flink|boolean|create|int|item}}<br /> {{Flink|boolean|create|item|{{opt|int}}}}<br /> {{Flink|matcher|create_matcher|string|string}}<br /> {{Flink|stat|current_hit_stat}}<br /> {{Flink|int|current_mcd}}<br /> {{Flink|int [string]|current_pvp_stances}}<br /> {{Flink|int|current_rad_sickness}}<br /> {{Flink|int|current_round}}<br /> <br /> ===d===<br /> {{Flink|element|dad_sea_monkee_weakness|int}}<br /> {{Flink|item|daily_special}}<br /> {{Flink|float|damage_absorption_percent}}<br /> {{Flink|int|damage_reduction}}<br /> {{Flink|int|date_to_timestamp|string|string}}<br /> {{Flink|void|debugprint|string}}<br /> {{Flink|buffer|delete|buffer|int|int}}<br /> {{Flink|effect|desc_to_effect|string}}<br /> {{Flink|item|desc_to_item|string}}<br /> {{Flink|void|disable|string}}<br /> {{Flink|boolean|dispensary_available}}<br /> {{Flink|int|display_amount|item}}<br /> {{FunctionEmbed|drink|format=signature}}<br /> {{Flink|boolean|drinksilent|int|item}}<br /> {{Flink|boolean|drinksilent|item|{{opt|int}}}}<br /> {{Flink|void|dump|any|{{opt|string}}}}<br /> <br /> ===e===<br /> {{FunctionEmbed|eat|format=signature}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eatsilent|item|{{opt|int}}}}<br /> {{Flink|effect|effect_modifier|string|string}}<br /> {{Flink|effect|effect_modifier|item|string}}<br /> {{Flink|boolean [int]|effect_pockets}}<br /> {{Flink|float|elemental_resistance|{{opt|element}}}}<br /> {{Flink|float|elemental_resistance|monster}}<br /> {{Flink|boolean|empty_closet}}<br /> {{Flink|void|enable|string}}<br /> {{Flink|int|end|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|ends_with|format=signature}}<br /> {{Flink|boolean|enthrone_familiar|familiar}}<br /> {{Flink|string|entity_decode|string}}<br /> {{Flink|string|entity_encode|string}}<br /> {{Flink|boolean|equip|item|{{opt|slot}}}}<br /> {{Flink|boolean|equip|slot|item}}<br /> {{Flink|boolean|equip_all_familiars}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|item|equipped_item|slot}}<br /> {{Flink|string|eudora}}<br /> {{Flink|boolean|eudora|string}}<br /> {{Flink|string|every_card_name|strict_string}}<br /> {{Flink|int|expected_damage|{{opt|monster}}}}<br /> {{Flink|float|experience_bonus}}<br /> {{Flink|float|expression_eval|string}}<br /> {{Flink|int [item]|extract_items|string}}<br /> {{Flink|int|extract_meat|string}}<br /> <br /> ===f===<br /> {{Flink|item|familiar_equipment|familiar}}<br /> {{Flink|item|familiar_equipped_equipment|familiar}}<br /> {{Flink|int|familiar_weight|familiar}}<br /> {{Flink|boolean [familiar]|favorite_familiars|}}<br /> {{Flink|boolean|faxbot|monster|{{opt|string}}}}<br /> {{Flink|boolean|fight_follows_choice}}<br /> {{FunctionEmbed|file_to_array|format=signature}}<br /> {{FunctionEmbed|file_to_buffer|format=signature}}<br /> {{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}<br /> {{Flink|boolean|find|matcher}}<br /> {{Flink|int|floor|float}}<br /> {{Flink|boolean|florist_available}}<br /> {{Flink|boolean|flush_monster_manuel_cache}}<br /> {{Flink|string|form_field|string}}<br /> {{Flink|string [string]|form_fields}}<br /> {{Flink|string|format_date_time|string|string|string}}<br /> {{Flink|boolean|friars_available}}<br /> {{Flink|int|fuel_cost|skill}}<br /> {{Flink|int|fullness_limit}}<br /> <br /> ===g===<br /> {{Flink|int|gameday_to_int}}<br /> {{Flink|string|gameday_to_string}}<br /> {{Flink|int|gametime_to_int}}<br /> {{Flink|boolean [string] |get_all_properties|string|boolean}}<br /> {{Flink|int|get_auto_attack}}<br /> {{Flink|int [item]|get_campground}}<br /> {{Flink|string |get_ccs_action|int}}<br /> {{Flink|int [item]|get_chateau}}<br /> {{Flink|int|get_clan_id}}<br /> {{Flink|int [item]|get_clan_lounge}}<br /> {{Flink|string|get_clan_name}}<br /> {{Flink|int [string]|get_clan_rumpus}}<br /> {{Flink|int [item]|get_closet}}<br /> {{Flink|string|get_counters|string|int|int}}<br /> {{Flink|string [int]|get_custom_outfits}}<br /> {{Flink|item|get_dwelling}}<br /> {{Flink|string [location, 3]|get_florist_plants}}<br /> {{Flink|int [item]|get_free_pulls}}<br /> {{Flink|int|get_fuel}}<br /> {{Flink|string [int]|get_goals}}<br /> {{Flink|boolean|get_ignore_zone_warnings}}<br /> {{Flink|int [item]|get_ingredients|item}}<br /> {{Flink|int [item]|get_inventory}}<br /> {{Flink|boolean [monster]|get_location_monsters|location}}<br /> {{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}<br /> {{Flink|monster [int]|get_monsters|location}}<br /> {{Flink|string [int]|get_moods}}<br /> {{Flink|string [int]|get_outfits}}<br /> {{Flink|string|get_path}}<br /> {{Flink|string|get_path_full}}<br /> {{Flink|string|get_path_variables}}<br /> {{Flink|string|get_player_id|string}}<br /> {{Flink|string|get_player_name|int}}<br /> {{Flink|int|get_power|item}}<br /> {{Flink|string|get_property|string|{{opt|boolean}}}}<br /> {{Flink|int [item]|get_related|item|string}}<br /> {{Flink|int|get_revision}}<br /> {{Flink|int [item]|get_shop}}<br /> {{Flink|string [0]|get_shop_log}}<br /> {{Flink|string string int [0]|get_stack_trace}}<br /> {{Flink|int [item]|get_stash}}<br /> {{Flink|int [item]|get_storage}}<br /> {{Flink|string|get_version}}<br /> {{Flink|string|get_workshed}}<br /> {{Flink|boolean|gnomads_available}}<br /> {{Flink|boolean|goal_exists|string}}<br /> {{Flink|string|group|matcher|{{opt|int}}}}<br /> {{Flink|string|group|matcher|string}}<br /> {{Flink|int|group_count|matcher}}<br /> {{Flink|boolean [string]|group_names|matcher}}<br /> {{Flink|string [int, int]|group_string|string|string}}<br /> {{Flink|boolean|guild_available}}<br /> {{Flink|boolean|guild_store_available}}<br /> <br /> ===h===<br /> {{Flink|boolean|handling_choice}}<br /> {{Flink|boolean|have_bartender}}<br /> {{Flink|boolean|have_chef}}<br /> {{Flink|boolean|have_display}}<br /> {{Flink|int|have_effect|effect}}<br /> {{Flink|boolean|have_equipped|item}}<br /> {{Flink|boolean|have_familiar|familiar}}<br /> {{Flink|boolean|have_mushroom_plot}}<br /> {{Flink|boolean|have_outfit|string}}<br /> {{Flink|boolean|have_servant|servant}}<br /> {{Flink|boolean|have_shop}}<br /> {{Flink|boolean|have_skill|skill}}<br /> {{Flink|boolean|hedge_maze|string}}<br /> {{Flink|boolean|hermit|int|item}}<br /> {{Flink|boolean|hermit|item|int}}<br /> {{Flink|boolean|hidden_temple_unlocked}}<br /> {{Flink|boolean|hippy_stone_broken}}<br /> {{Flink|boolean|hippy_store_available}}<br /> {{FunctionEmbed|historical_age}}<br /> {{FunctionEmbed|historical_price}}<br /> {{Flink|string|holiday}}<br /> {{Flink|int|hp_cost|skill}}<br /> <br /> ===i===<br /> {{Flink|monster|image_to_monster|strict_string}}<br /> {{Flink|boolean|in_bad_moon}}<br /> {{Flink|boolean|in_hardcore}}<br /> {{Flink|boolean|in_moxie_sign}}<br /> {{Flink|boolean|in_multi_fight}}<br /> {{Flink|boolean|in_muscle_sign}}<br /> {{Flink|boolean|in_mysticality_sign}}<br /> {{Flink|string|inaccessible_reason|coinmaster}}<br /> {{FunctionEmbed|index_of|format=signature}}<br /> {{Flink|int|inebriety_limit}}<br /> {{Flink|float|initiative_modifier}}<br /> {{Flink|buffer|insert|buffer|int|string}}<br /> {{Flink|boolean|is_accessible|coinmaster}}<br /> {{Flink|boolean|is_banished|monster}}<br /> {{Flink|boolean|is_coinmaster_item|item}}<br /> {{FunctionEmbed|is_dark_mode}}<br /> {{Flink|boolean|is_discardable|item}}<br /> {{Flink|boolean|is_displayable|item}}<br /> {{Flink|boolean|is_familiar_equipment_locked}}<br /> {{Flink|boolean|is_giftable|item}}<br /> {{Flink|boolean|is_goal|item}}<br /> {{Flink|boolean|is_integer|string}}<br /> {{Flink|boolean|is_npc_item|item}}<br /> {{Flink|boolean|is_online|string}}<br /> {{Flink|boolean|is_tradeable|item}}<br /> {{Flink|boolean|is_trendy|item/familiar/skill/string}}<br /> {{Flink|boolean|is_unrestricted|item/familiar/skill/string}}<br /> {{Flink|boolean|is_wearing_outfit|string}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|float|item_drop_modifier}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}}}<br /> {{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}<br /> {{Flink|boolean [int]|item_pockets}}<br /> {{Flink|string|item_type|item}}<br /> <br /> ===j===<br /> {{Flink|boolean [int]|joke_pockets}}<br /> {{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}<br /> {{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}<br /> <br /> ===k===<br /> {{flink|boolean|knoll_available}}<br /> <br /> ===l===<br /> {{Flink|int|last_choice}}<br /> {{Flink|int|last_decision}}<br /> {{FunctionEmbed|last_index_of|format=signature}}<br /> {{Flink|string|last_item_message}}<br /> {{Flink|monster|last_monster}}<br /> {{Flink|string|last_skill_message}}<br /> {{Flink|string|leetify|string}}<br /> {{Flink|int|length|string}}<br /> {{Flink|int|lightning_cost|skill}}<br /> {{Flink|string|limit_mode}}<br /> {{Flink|buffer|load_html|string}}<br /> {{Flink|void|lock_familiar_equipment|boolean}}<br /> {{Flink|float|log_n|float|{{opt|float}}}}<br /> {{Flink|void|logprint|string}}<br /> <br /> ===m===<br /> {{Flink|string|make_url|string|boolean|boolean}}<br /> {{FunctionEmbed|mall_price}}<br /> {{FunctionEmbed|mall_prices}}<br /> {{Flink|int|mana_cost_modifier}}<br /> {{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}<br /> {{Flink|float|max|float ...}}<br /> {{Flink|int|max|int ...}}<br /> {{Flink|boolean|maximize|string|boolean}}<br /> {{Flink|boolean|maximize|string|int|int|boolean}}<br /> {{Flink|{string string float effect item skill} [int]|maximize|string|int|int|boolean|boolean}}<br /> {{Flink|int|meat_drop|{{opt|monster}}}}<br /> {{Flink|float|meat_drop_modifier}}<br /> {{Flink|int [int]|meat_pockets}}<br /> {{Flink|float|min|float ...}}<br /> {{Flink|int|min|int ...}}<br /> {{Flink|item|minstrel_instrument}}<br /> {{Flink|int|minstrel_level}}<br /> {{Flink|boolean|minstrel_quest}}<br /> {{Flink|float|modifier_eval|string}}<br /> {{Flink|int|monster_attack|{{opt|monster}}}}<br /> {{Flink|int|monster_defense|{{opt|monster}}}}<br /> {{Flink|element|monster_element|{{opt|monster}}}}<br /> {{Flink|float|monster_eval|string}}<br /> {{Flink|int|monster_factoids_available|monster|boolean}}<br /> {{Flink|int|monster_hp|{{opt|monster}}}}<br /> {{Flink|int|monster_initiative|{{opt|monster}}}}<br /> {{Flink|int|monster_level_adjustment}}<br /> {{Flink|string|monster_manuel_text|monster}}<br /> {{Flink|phylum|monster_phylum|{{opt|monster}}}}<br /> {{Flink|boolean [int]|monster_pockets}}<br /> {{Flink|void|mood_execute|int}}<br /> {{Flink|string [0]|mood_list}}<br /> {{Flink|int|moon_light}}<br /> {{Flink|int|moon_phase}}<br /> {{Flink|int|mp_cost|skill}}<br /> {{Flink|int|my_absorbs}}<br /> {{Flink|int|my_adventures}}<br /> {{Flink|int|my_ascensions}}<br /> {{Flink|int|my_audience}}<br /> {{Flink|int|my_basestat|stat}}<br /> {{Flink|familiar|my_bjorned_familiar}}<br /> {{Flink|int|my_buffedstat|stat}}<br /> {{Flink|class|my_class}}<br /> {{Flink|int|my_closet_meat}}<br /> {{Flink|string|my_companion}}<br /> {{Flink|int|my_daycount}}<br /> {{Flink|int|my_discomomentum}}<br /> {{Flink|familiar|my_effective_familiar}}<br /> {{Flink|int [effect]|my_effects}}<br /> {{Flink|familiar|my_enthroned_familiar}}<br /> {{Flink|familiar|my_familiar}}<br /> {{Flink|int|my_fullness}}<br /> {{Flink|int|my_fury}}<br /> {{Flink|string|my_garden_type}}<br /> {{Flink|string|my_hash}}<br /> {{Flink|int|my_hp}}<br /> {{Flink|string|my_id}}<br /> {{Flink|int|my_inebriety}}<br /> {{Flink|int|my_level}}<br /> {{Flink|int|my_lightning}}<br /> {{Flink|location|my_location}}<br /> {{Flink|string|my_mask}}<br /> {{Flink|int|my_maxfury}}<br /> {{Flink|int|my_maxhp}}<br /> {{Flink|int|my_maxmp}}<br /> {{Flink|int|my_maxpp}}<br /> {{Flink|int|my_meat}}<br /> {{Flink|int|my_mp}}<br /> {{Flink|string|my_name}}<br /> {{Flink|string|my_path}}<br /> {{Flink|int|my_path_id}}<br /> {{Flink|familiar|my_poke_fam|int}}<br /> {{Flink|int|my_pp}}<br /> {{Flink|stat|my_primestat}}<br /> {{Flink|int|my_rain}}<br /> {{Flink|int|my_robot_energy}}<br /> {{Flink|int|my_robot_scraps}}<br /> {{Flink|servant|my_servant}}<br /> {{Flink|int|my_session_adv}}<br /> {{Flink|int [item]|my_session_items}}<br /> {{Flink|int|my_session_items|item}}<br /> {{Flink|int|my_session_meat}}<br /> {{Flink|string|my_sign}}<br /> {{Flink|int|my_soulsauce}}<br /> {{Flink|int|my_spleen_use}}<br /> {{Flink|int|my_storage_meat}}<br /> {{Flink|thrall|my_thrall}}<br /> {{Flink|int|my_thunder}}<br /> {{Flink|int|my_turncount}}<br /> {{Flink|vykea|my_vykea_companion}}<br /> <br /> ===n===<br /> {{Flink|int|now_to_int}}<br /> {{Flink|string|now_to_string|string}}<br /> {{Flink|int|npc_price|item}}<br /> {{Flink|string|numberology_prize|int}}<br /> {{Flink|float|numeric_modifier|effect|string}}<br /> {{Flink|float|numeric_modifier|familiar|string|int|item}}<br /> {{Flink|float|numeric_modifier|item|string}}<br /> {{Flink|float|numeric_modifier|skill|string}}<br /> {{Flink|float|numeric_modifier|{{opt|string}}|string}}<br /> <br /> ===o===<br /> {{Flink|boolean|outfit|string}}<br /> {{Flink|item [int]|outfit_pieces|string}}<br /> {{Flink|string|outfit_tattoo|{{opt|string}}}}<br /> {{FunctionEmbed|overdrink|format=signature}}<br /> <br /> ===p===<br /> {{Flink|string|path_id_to_name|int}}<br /> {{Flink|int|path_name_to_id|string}}<br /> {{Flink|boolean|pick_pocket|monster}}<br /> {{Flink|int [effect]|pick_pocket|effect}}<br /> {{Flink|int [item]|pick_pocket|item}}<br /> {{Flink|int [stat]|pick_pocket|stat}}<br /> {{Flink|boolean|pick_pocket|int}}<br /> {{Flink|boolean [int]|picked_pockets}}<br /> {{Flink|boolean [int]|picked_scraps}}<br /> {{Flink|int [effect]|pocket_effects|int}}<br /> {{Flink|int [item]|pocket_items|int}}<br /> {{Flink|string|pocket_joke|int}}<br /> {{Flink|string [int]|pocket_meat|int}}<br /> {{Flink|monster|pocket_monster|int}}<br /> {{Flink|string [int]|pocket_poem|int}}<br /> {{Flink|string [int]|pocket_scrap|int}}<br /> {{Flink|int [stat]|pocket_stats|int}}<br /> {{Flink|int [int]|poem_pockets}}<br /> {{Flink|int [int]|potential_pockets|effect/item/monster/stat}}<br /> {{Flink|void|print|{{opt|string}}|{{opt|string}}}}<br /> {{Flink|void|print_html|string}}<br /> {{FunctionEmbed|property_default_value|format=signature}}<br /> {{FunctionEmbed|property_exists|format=signature}}<br /> {{FunctionEmbed|property_has_default|format=signature}}<br /> {{Flink|int|pulls_remaining}}<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_display|item|int}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|put_stash|item|int}}<br /> {{Flink|int|pvp_attacks_left}}<br /> <br /> ===r===<br /> {{Flink|int|rain_cost|skill}}<br /> {{Flink|int|random|int}}<br /> {{Flink|int|raw_damage_absorption}}<br /> {{Flink|boolean|refresh_shop}}<br /> {{Flink|boolean|refresh_stash}}<br /> {{Flink|boolean|refresh_status}}<br /> {{Flink|void|remove_item_condition|int|item}}<br /> {{Flink|void|remove_item_condition|item|int}}<br /> {{FunctionEmbed|remove_property|format=signature}}<br /> {{FunctionEmbed|rename_property|format=signature}}<br /> {{Flink|boolean|replace|buffer|int|int|string}}<br /> {{Flink|string|replace_all|matcher|string}}<br /> {{Flink|string|replace_first|matcher|string}}<br /> {{Flink|buffer|replace_string|buffer|string|string}}<br /> {{Flink|buffer|replace_string|string|string|string}}<br /> {{Flink|boolean|reprice_shop|int|{{opt|int}}|item}}<br /> {{Flink|matcher|reset|matcher|{{opt|string}}}}<br /> {{Flink|boolean [int]|restoration_pockets}}<br /> {{Flink|boolean|restore_hp|int}}<br /> {{Flink|boolean|restore_mp|int}}<br /> {{Flink|boolean|retrieve_item|int|item}}<br /> {{Flink|boolean|retrieve_item|item|{{opt|int}}}}<br /> {{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}<br /> {{Flink|int|rollover}}<br /> {{Flink|int|round|float}}<br /> {{FunctionEmbed|run_choice|format=signature}}<br /> {{Flink|buffer|run_combat|{{opt|string}}}}<br /> {{Flink|buffer|run_turn}}<br /> {{Flink|buffer|runaway}}<br /> <br /> ===s===<br /> {{Flink|int [int]|scrap_pockets}}<br /> {{Flink|boolean|sell|coinmaster|int|item}}<br /> {{Flink|int|sell_price|coinmaster|item}}<br /> {{Flink|boolean|sells_item|coinmaster|item}}<br /> {{Flink|string [int]|session_logs|{{opt|string}}|{{opt|string}}|int}}<br /> {{Flink|void|set_auto_attack|int/string}}<br /> {{Flink|void|set_length|buffer|int}}<br /> {{Flink|void|set_location|location}}<br /> {{Flink|void|set_property|string|string}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|shop_limit|item}}<br /> {{Flink|int|shop_price|item}}<br /> {{Flink|skill|skill_modifier|item|string}}<br /> {{Flink|skill|skill_modifier|string|string}}<br /> {{Flink|int|slash_count|item}}<br /> {{Flink|int|soulsauce_cost|skill}}<br /> {{Flink|int|spleen_limit}}<br /> {{Flink|string [int]|split_string|string|{{opt|string}}}}<br /> {{Flink|float|square_root|float}}<br /> {{Flink|int|start|matcher|{{opt|int}}}}<br /> {{FunctionEmbed|starts_with|format=signature}}<br /> {{Flink|int|stash_amount|item}}<br /> {{Flink|stat|stat_bonus_today}}<br /> {{Flink|stat|stat_bonus_tomorrow}}<br /> {{Flink|stat|stat_modifier|effect|string}}<br /> {{Flink|buffer|steal}}<br /> {{Flink|int|stills_available}}<br /> {{Flink|void|stop_counter|string}}<br /> {{Flink|int|storage_amount|item}}<br /> {{Flink|string|string_modifier|{{opt|string}}|string}}<br /> {{Flink|skill|stun_skill}}<br /> {{Flink|string|substring|string|int|{{opt|int}}}}<br /> {{Flink|boolean|svn_at_head|string}}<br /> {{Flink|boolean|svn_exists|string}}<br /> {{Flink|{string int string int string}|svn_info|string}}<br /> {{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}<br /> {{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}<br /> {{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}<br /> {{Flink|effect|sweet_synthesis_result|item|item}}<br /> <br /> ===t===<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_closet|item|{{opt|int}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_display|item|int}}<br /> {{Flink|boolean|take_shop|{{opt|int}}|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_stash|item|int}}<br /> {{Flink|boolean|take_storage|int|item}}<br /> {{Flink|boolean|take_storage|item|int}}<br /> {{Flink|int|tavern|{{opt|string}}}}<br /> {{Flink|buffer|throw_item|item}}<br /> {{Flink|buffer|throw_items|item|item}}<br /> {{Flink|int|thunder_cost|skill}}<br /> {{Flink|string|time_to_string}}<br /> {{Flink|string|timestamp_to_date|int|string}}<br /> {{Flink|boolean|to_boolean|any}}<br /> {{Flink|bounty|to_bounty|strict_string}}<br /> {{Flink|class|to_class|strict_string/int}}<br /> {{Flink|coinmaster|to_coinmaster|strict_string}}<br /> {{Flink|effect|to_effect|int/skill/strict_string}}<br /> {{Flink|element|to_element|strict_string}}<br /> {{Flink|familiar|to_familiar|int/strict_string}}<br /> {{Flink|float|to_float|any}}<br /> {{Flink|int|to_int|any}}<br /> {{Flink|item|to_item|int/strict_string}}<br /> {{Flink|item|to_item|string|int}}<br /> {{Flink|string|to_json|aggregate}}<br /> {{Flink|location|to_location|int/strict_string}}<br /> {{Flink|string|to_lower_case|string}}<br /> {{Flink|monster|to_monster|int/strict_string}}<br /> {{Flink|phylum|to_phylum|string}}<br /> {{Flink|string|to_plural|item}}<br /> {{Flink|servant|to_servant|int/strict_string}}<br /> {{Flink|skill|to_skill|effect/int}}<br /> {{Flink|skill|to_skill|strict_string|{{opt|strict_string}}}}<br /> {{Flink|slot|to_slot|item/strict_string}}<br /> {{Flink|stat|to_stat|strict_string}}<br /> {{Flink|string|to_string|any}}<br /> {{Flink|thrall|to_thrall|int/strict_string}}<br /> {{Flink|string|to_upper_case|string}}<br /> {{Flink|string|to_url|location}}<br /> {{Flink|vykea|to_vykea|strict_string}}<br /> {{Flink|string|today_to_string}}<br /> {{Flink|int|total_free_rests}}<br /> {{Flink|int|total_turns_played}}<br /> {{Flink|boolean|tower_door}}<br /> {{Flink|void|traceprint|string}}<br /> {{Flink|int|truncate|float}}<br /> {{Flink|int|turns_per_cast|skill}}<br /> {{Flink|int|turns_played}}<br /> {{Flink|buffer|twiddle}}<br /> <br /> ===u===<br /> {{Flink|item|unusual_construct_disc}}<br /> {{Flink|void|update_candy_prices}}<br /> {{Flink|string|url_decode|string}}<br /> {{Flink|string|url_encode|string}}<br /> {{Flink|boolean|use|int|item}}<br /> {{Flink|boolean|use|item|{{opt|int}}}}<br /> {{Flink|boolean|use_familiar|familiar}}<br /> {{Flink|boolean|use_servant|servant}}<br /> {{Flink|boolean|use_skill|int|skill|{{opt|string}}}}<br /> {{Flink|boolean|use_skill|skill|int|{{opt|string}}}}<br /> {{Flink|buffer|use_skill|skill}}<br /> {{Flink|boolean|user_confirm|string}}<br /> {{Flink|boolean|user_confirm|string|int|boolean}}<br /> <br /> ===v===<br /> {{Flink|boolean|visit|coinmaster}}<br /> {{FunctionEmbed|visit_url}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}<br /> {{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}<br /> <br /> ===w===<br /> {{Flink|void|wait|int}}<br /> {{Flink|void|waitq|int}}<br /> {{Flink|int|weapon_hands|item}}<br /> {{Flink|stat|weapon_type|item}}<br /> {{Flink|int|weight_adjustment}}<br /> {{Flink|boolean|white_citadel_available}}<br /> {{Flink|boolean [string]|who_clan}}<br /> {{Flink|boolean|will_usually_dodge}}<br /> {{Flink|boolean|will_usually_miss}}<br /> {{Flink|void|write|string}}<br /> {{Flink|void|writeln|string}}<br /> <br /> ===x===<br /> {{Flink|string[int]|xpath|string|string}}<br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9200 2023-04-23T10:08:25Z

<p>Eliteofdelete: </p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}{{opt|{{type|string}}, {{type|string}}}}<br /> |function1.description=For the specified decision, returns a map from NAME to a map from VALUE to DESCRIPTION.<br /> |function1.param1=decision<br /> |function1.param1.type=int<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This function was added in [https://sourceforge.net/p/kolmafia/code/19543 r19543] and explained by Veracity in the [https://kolmafia.us/threads/allow-property-choiceadventurexxx-url.24195/#post-154288 following post].<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description= Running the following Code on the [https://kol.coldfront.net/thekolwiki/index.php/The_Exploaded_Battlefield Exploaded Battlefield] choice:<br /> |code=<br /> &lt;syntaxhighlight lang=&quot;d&quot;&gt;<br /> foreach decision, description in available_choice_options() {<br /> print( &quot;Choice &quot; + decision + &quot;: &quot; + description );<br /> string[string][string] selects = available_choice_select_inputs( decision );<br /> foreach name in selects {<br /> string[string] mapping = selects[name];<br /> print( &quot; select = &quot; + name + &quot; (&quot; + count(mapping) + &quot; options)&quot; );<br /> foreach value, desc in mapping {<br /> print( &quot; &quot; + value + &quot; =&gt; &quot; + desc );<br /> }<br /> }<br /> string[string] texts = available_choice_text_inputs( decision );<br /> foreach text, desc in texts {<br /> print( &quot; text = &quot; + text );<br /> }<br /> }<br /> &lt;/syntaxhighlight&gt;|<br /> |moreinfo= Will give the following output: &lt;pre&gt;Choice 1: Toss!<br /> select = tossid (24 options)<br /> 0 =&gt; --- select an item ---<br /> 10179 =&gt; plain snowcone (12) (5 casualties)<br /> 161 =&gt; ghuol egg (2) (5 casualties)<br /> 1769 =&gt; fricasseed brains (5 casualties)<br /> 1776 =&gt; stale baguette (5 casualties)<br /> 1778 =&gt; ancient frozen dinner (6 casualties)<br /> 1952 =&gt; desiccated apricot (5 casualties)<br /> 1954 =&gt; dehydrated caviar (5 casualties)<br /> 2063 =&gt; blackberry (2) (5 casualties)<br /> 2843 =&gt; dire fudgesicle (2) (5 casualties)<br /> 330 =&gt; glass of goat's milk (5 casualties)<br /> 3555 =&gt; sea carrot (5 casualties)<br /> 471 =&gt; hot wing (6) (5 casualties)<br /> 6416 =&gt; mana curds (10 casualties)<br /> 6422 =&gt; vampire chowder (10 casualties)<br /> 669 =&gt; ghuol guolash (18 casualties)<br /> 6705 =&gt; jungle floor wax (6 casualties)<br /> 672 =&gt; cranberries (3) (5 casualties)<br /> 7368 =&gt; extra-flat panini (2) (8 casualties)<br /> 7375 =&gt; actual tapas (5 casualties)<br /> 8412 =&gt; succulent marrow (3) (6 casualties)<br /> 8413 =&gt; salacious crumbs (5) (6 casualties)<br /> 8526 =&gt; pink slime (2) (5 casualties)<br /> 9953 =&gt; PB&amp;J with the crusts cut off (4) (5 casualties)<br /> Choice 2: Never Mind&lt;/pre&gt;<br /> }}<br /> <br /> |see_also={{SeeAlso|available_choice_options|available_choice_text_inputs}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Adventuring]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9199 2023-04-23T10:08:06Z

<p>Eliteofdelete: </p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}{{opt|{{type|string}}, {{type|string}}}}<br /> |function1.description=For the specified decision, returns a map from NAME to a map from VALUE to DESCRIPTION.<br /> |function1.param1=decision<br /> |function1.param1.type=int<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This function was added in [https://sourceforge.net/p/kolmafia/code/19543 r19543] and explained by Veracity in the [https://kolmafia.us/threads/allow-property-choiceadventurexxx-url.24195/#post-154288 following post].<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description= Running the following Code on the [https://kol.coldfront.net/thekolwiki/index.php/The_Exploaded_Battlefield Exploaded Battlefield] choice:<br /> |code=<br /> &lt;syntaxhighlight lang=&quot;d&quot;&gt;<br /> foreach decision, description in available_choice_options() {<br /> print( &quot;Choice &quot; + decision + &quot;: &quot; + description );<br /> string[string][string] selects = available_choice_select_inputs( decision );<br /> foreach name in selects {<br /> string[string] mapping = selects[name];<br /> print( &quot; select = &quot; + name + &quot; (&quot; + count(mapping) + &quot; options)&quot; );<br /> foreach value, desc in mapping {<br /> print( &quot; &quot; + value + &quot; =&gt; &quot; + desc );<br /> }<br /> }<br /> string[string] texts = available_choice_text_inputs( decision );<br /> foreach text, desc in texts {<br /> print( &quot; text = &quot; + text );<br /> }<br /> }<br /> &lt;/syntaxhighlight&gt;|<br /> |moreinfo= Will give the following output: &lt;pre&gt;Choice 1: Toss!<br /> select = tossid (24 options)<br /> 0 =&gt; --- select an item ---<br /> 10179 =&gt; plain snowcone (12) (5 casualties)<br /> 161 =&gt; ghuol egg (2) (5 casualties)<br /> 1769 =&gt; fricasseed brains (5 casualties)<br /> 1776 =&gt; stale baguette (5 casualties)<br /> 1778 =&gt; ancient frozen dinner (6 casualties)<br /> 1952 =&gt; desiccated apricot (5 casualties)<br /> 1954 =&gt; dehydrated caviar (5 casualties)<br /> 2063 =&gt; blackberry (2) (5 casualties)<br /> 2843 =&gt; dire fudgesicle (2) (5 casualties)<br /> 330 =&gt; glass of goat's milk (5 casualties)<br /> 3555 =&gt; sea carrot (5 casualties)<br /> 471 =&gt; hot wing (6) (5 casualties)<br /> 6416 =&gt; mana curds (10 casualties)<br /> 6422 =&gt; vampire chowder (10 casualties)<br /> 669 =&gt; ghuol guolash (18 casualties)<br /> 6705 =&gt; jungle floor wax (6 casualties)<br /> 672 =&gt; cranberries (3) (5 casualties)<br /> 7368 =&gt; extra-flat panini (2) (8 casualties)<br /> 7375 =&gt; actual tapas (5 casualties)<br /> 8412 =&gt; succulent marrow (3) (6 casualties)<br /> 8413 =&gt; salacious crumbs (5) (6 casualties)<br /> 8526 =&gt; pink slime (2) (5 casualties)<br /> 9953 =&gt; PB&amp;J with the crusts cut off (4) (5 casualties)<br /> Choice 2: Never Mind&lt;/pre&gt;<br /> }}<br /> <br /> |see_also={{SeeAlso|available_choice_options|available_choice_text_inputs}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |needscode=no<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Adventuring]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9198 2023-04-23T10:07:21Z

<p>Eliteofdelete: </p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}{{opt|{{type|string}}, {{type|string}}}}<br /> |function1.description=For the specified decision, returns a map from NAME to a map from VALUE to DESCRIPTION.<br /> |function1.param1=decision<br /> |function1.param1.type=int<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This function was added in [https://sourceforge.net/p/kolmafia/code/19543 r19543] and explained by Veracity in the [https://kolmafia.us/threads/allow-property-choiceadventurexxx-url.24195/#post-154288 following post].<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description= Running the following Code on the [https://kol.coldfront.net/thekolwiki/index.php/The_Exploaded_Battlefield Exploaded Battlefield] choice:<br /> |code=<br /> &lt;syntaxhighlight lang=&quot;d&quot;&gt;<br /> foreach decision, description in available_choice_options() {<br /> print( &quot;Choice &quot; + decision + &quot;: &quot; + description );<br /> string[string][string] selects = available_choice_select_inputs( decision );<br /> foreach name in selects {<br /> string[string] mapping = selects[name];<br /> print( &quot; select = &quot; + name + &quot; (&quot; + count(mapping) + &quot; options)&quot; );<br /> foreach value, desc in mapping {<br /> print( &quot; &quot; + value + &quot; =&gt; &quot; + desc );<br /> }<br /> }<br /> string[string] texts = available_choice_text_inputs( decision );<br /> foreach text, desc in texts {<br /> print( &quot; text = &quot; + text );<br /> }<br /> }<br /> &lt;/syntaxhighlight&gt;|<br /> |moreinfo= Will give the following output: &lt;pre&gt;Choice 1: Toss!<br /> select = tossid (24 options)<br /> 0 =&gt; --- select an item ---<br /> 10179 =&gt; plain snowcone (12) (5 casualties)<br /> 161 =&gt; ghuol egg (2) (5 casualties)<br /> 1769 =&gt; fricasseed brains (5 casualties)<br /> 1776 =&gt; stale baguette (5 casualties)<br /> 1778 =&gt; ancient frozen dinner (6 casualties)<br /> 1952 =&gt; desiccated apricot (5 casualties)<br /> 1954 =&gt; dehydrated caviar (5 casualties)<br /> 2063 =&gt; blackberry (2) (5 casualties)<br /> 2843 =&gt; dire fudgesicle (2) (5 casualties)<br /> 330 =&gt; glass of goat's milk (5 casualties)<br /> 3555 =&gt; sea carrot (5 casualties)<br /> 471 =&gt; hot wing (6) (5 casualties)<br /> 6416 =&gt; mana curds (10 casualties)<br /> 6422 =&gt; vampire chowder (10 casualties)<br /> 669 =&gt; ghuol guolash (18 casualties)<br /> 6705 =&gt; jungle floor wax (6 casualties)<br /> 672 =&gt; cranberries (3) (5 casualties)<br /> 7368 =&gt; extra-flat panini (2) (8 casualties)<br /> 7375 =&gt; actual tapas (5 casualties)<br /> 8412 =&gt; succulent marrow (3) (6 casualties)<br /> 8413 =&gt; salacious crumbs (5) (6 casualties)<br /> 8526 =&gt; pink slime (2) (5 casualties)<br /> 9953 =&gt; PB&amp;J with the crusts cut off (4) (5 casualties)<br /> Choice 2: Never Mind&lt;/pre&gt;<br /> }}<br /> <br /> |see_also={{SeeAlso|available_choice_options|available_choice_text_inputs}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |needscode=yes<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Adventuring]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9197 2023-04-23T10:00:44Z

<p>Eliteofdelete: </p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}{{opt|{{type|string}}, {{type|string}}}}<br /> |function1.description=For the specified decision, returns a map from NAME to a map from VALUE to DESCRIPTION.<br /> |function1.param1=decision<br /> |function1.param1.type=int<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This function was added in [https://sourceforge.net/p/kolmafia/code/19543 r19543] and explained by Veracity in the [https://kolmafia.us/threads/allow-property-choiceadventurexxx-url.24195/#post-154288 following post].<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description= Running the following Code on the Exploaded Battlefield choice:<br /> |code=<br /> &lt;syntaxhighlight lang=&quot;d&quot;&gt;<br /> foreach decision, description in available_choice_options() {<br /> print( &quot;Choice &quot; + decision + &quot;: &quot; + description );<br /> string[string][string] selects = available_choice_select_inputs( decision );<br /> foreach name in selects {<br /> string[string] mapping = selects[name];<br /> print( &quot; select = &quot; + name + &quot; (&quot; + count(mapping) + &quot; options)&quot; );<br /> foreach value, desc in mapping {<br /> print( &quot; &quot; + value + &quot; =&gt; &quot; + desc );<br /> }<br /> }<br /> string[string] texts = available_choice_text_inputs( decision );<br /> foreach text, desc in texts {<br /> print( &quot; text = &quot; + text );<br /> }<br /> }<br /> &lt;/syntaxhighlight&gt;|<br /> |moreinfo= Will give the following output: &lt;pre&gt;Choice 1: Toss!<br /> select = tossid (24 options)<br /> 0 =&gt; --- select an item ---<br /> 10179 =&gt; plain snowcone (12) (5 casualties)<br /> 161 =&gt; ghuol egg (2) (5 casualties)<br /> 1769 =&gt; fricasseed brains (5 casualties)<br /> 1776 =&gt; stale baguette (5 casualties)<br /> 1778 =&gt; ancient frozen dinner (6 casualties)<br /> 1952 =&gt; desiccated apricot (5 casualties)<br /> 1954 =&gt; dehydrated caviar (5 casualties)<br /> 2063 =&gt; blackberry (2) (5 casualties)<br /> 2843 =&gt; dire fudgesicle (2) (5 casualties)<br /> 330 =&gt; glass of goat's milk (5 casualties)<br /> 3555 =&gt; sea carrot (5 casualties)<br /> 471 =&gt; hot wing (6) (5 casualties)<br /> 6416 =&gt; mana curds (10 casualties)<br /> 6422 =&gt; vampire chowder (10 casualties)<br /> 669 =&gt; ghuol guolash (18 casualties)<br /> 6705 =&gt; jungle floor wax (6 casualties)<br /> 672 =&gt; cranberries (3) (5 casualties)<br /> 7368 =&gt; extra-flat panini (2) (8 casualties)<br /> 7375 =&gt; actual tapas (5 casualties)<br /> 8412 =&gt; succulent marrow (3) (6 casualties)<br /> 8413 =&gt; salacious crumbs (5) (6 casualties)<br /> 8526 =&gt; pink slime (2) (5 casualties)<br /> 9953 =&gt; PB&amp;J with the crusts cut off (4) (5 casualties)<br /> Choice 2: Never Mind&lt;/pre&gt;<br /> }}<br /> <br /> |see_also={{SeeAlso|available_choice_options|available_choice_text_inputs}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |needscode=yes<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Adventuring]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9196 2023-04-23T09:09:32Z

<p>Eliteofdelete: Undo revision 9195 by Eliteofdelete (talk)</p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}<br /> |function1.description=Does something?<br /> |function1.param1=idk<br /> |function1.param1.type=int<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This was added in XXX.<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description=<br /> |code=<br /> |moreinfo=<br /> }}<br /> <br /> |see_also={{SeeAlso|}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |needscode=yes<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Adventuring]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9195 2023-04-23T09:07:05Z

<p>Eliteofdelete: Blanked the page</p> <hr /> <div></div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9194 2023-04-23T09:06:03Z

<p>Eliteofdelete: </p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}<br /> |function1.description=Does something?<br /> |function1.param1=idk<br /> |function1.param1.type=int<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This was added in XXX.<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description=<br /> |code=<br /> |moreinfo=<br /> }}<br /> <br /> |see_also={{SeeAlso|}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |needscode=yes<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> [[Category:Adventuring]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Available_choice_select_inputs&diff=9193 2023-04-23T09:01:04Z

<p>Eliteofdelete: Created page with &quot;&lt;onlyinclude&gt;{{{{{format|Function2}}} |name=available_choice_select_inputs |function1.return_type={{type|string}} |function1.description=Does something? |function1.param1=idk...&quot;</p> <hr /> <div>&lt;onlyinclude&gt;{{{{{format|Function2}}}<br /> |name=available_choice_select_inputs<br /> |function1.return_type={{type|string}}<br /> |function1.description=Does something?<br /> |function1.param1=idk<br /> |function1.param1.type=int<br /> |function1.param1.optional=no<br /> |function1.param1.default=<br /> |function1.param1.description=<br /> |description=This was added in XXX.<br /> |code1={{CodeSample<br /> |title=Code Samples<br /> |description=<br /> |code=<br /> |moreinfo=<br /> }}<br /> <br /> }}<br /> |see_also={{SeeAlso|}}<br /> |cli_equiv=<br /> |more_info=<br /> |special=<br /> |needscode=yes<br /> |{{{1|}}}<br /> }}&lt;/onlyinclude&gt;<br /> &lt;!-- Add an appropriate function subcategory here, e.g. [[Category:Adventuring]],<br /> then delete this comment --&gt;</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_effect&diff=5777 2019-09-22T00:35:28Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_effect}}{{<br /> #vardefine:return_type|effect}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> p1desc={{Pspan|convert}} is the int, string or skill to convert|<br /> }}|<br /> function_description=When supplied an int or string, returns the effect that corresponds to the specified parameter {{pspan|convert}}. When supplied a skill, this returns the effect that is given when the skill {{pspan|convert}} is cast on a player.&lt;br&gt;Note: This function can not return effects of items. For that, use [https://wiki.kolmafia.us/index.php?title=Effect_modifier effect_modifer()]. If you are attempting to see the duration of an effect, use [https://wiki.kolmafia.us/index.php?title=Numeric_modifier numeric_modifier(item, &quot;effect duration&quot;)].|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_effect operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> //int<br /> print(to_effect(100), &quot;green&quot;);<br /> //strings<br /> print(to_effect(&quot;Smooth&quot;), &quot;green&quot;);<br /> print(to_effect(&quot;Smooth Move&quot;), &quot;green&quot;);<br /> //skills<br /> print(to_effect($skill[Disco Aerobics]), &quot;green&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=For more info about effects from numbers and skills, see [http://kol.coldfront.net/thekolwiki/index.php/Effects Effects].<br /> &lt;br&gt;It gives the following output.<br /> &lt;pre&gt;<br /> Stabilizing Oiliness<br /> Hella Smooth<br /> Smooth Movements<br /> Disco State of Mind<br /> &lt;/pre&gt;<br /> }}<br /> <br /> {{CodeSample|<br /> description=&lt;br&gt;Following example tells which buffs you are missing but could have.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> void buffs_check() {<br /> int amount;<br /> boolean have_buff;<br /> boolean[skill] active_buffs, bot_buffs, castable_buffs;<br /> foreach it in $skills[] {<br /> amount = have_effect(to_effect(it));<br /> if (amount == 0)<br /> have_buff = false;<br /> else have_buff = true;<br /> <br /> if (have_buff) //Currently have the effect active<br /> active_buffs[it]=have_buff;<br /> if (it.buff == true &amp;&amp; !have_buff &amp;&amp; it.class != $class[none] &amp;&amp; it.level != -1 &amp;&amp; it.dailylimit == -1 &amp;&amp; it != $skill[Spiky Shell] &amp;&amp; it != $skill[Antibiotic Saucesphere]) //buff bot buffs<br /> bot_buffs[it]=have_buff;<br /> if (have_skill(it) &amp;&amp; it.combat != true &amp;&amp; !have_buff &amp;&amp; to_effect(it) != $effect[none]) //buffs you can cast on yourself<br /> castable_buffs[it]=have_buff;<br /> }<br /> print(&quot;You currently have the following buffs active:&quot;, &quot;red&quot;);<br /> foreach it in active_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;green&quot;); <br /> print(&quot;&quot;);<br /> print(&quot;You could get the following buffs from a buff bot:&quot;, &quot;red&quot;);<br /> foreach it in bot_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;blue&quot;); <br /> print(&quot;&quot;);<br /> print(&quot;You could cast the following buffs on yourself:&quot;, &quot;red&quot;);<br /> foreach it in castable_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;purple&quot;);<br /> }<br /> buffs_check();<br /> &lt;/syntaxhighlight&gt;|<br /> <br /> }}|<br /> <br /> special=If {{pspan|convert}} is an effect that cannot be given by use of a skill, and is supplied as such, or no match is found for a supplied string or int type, this function returns $effect[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_effect&diff=5776 2019-09-21T22:02:38Z

<p>Eliteofdelete: Added information to find effects of items.</p> <hr /> <div>{{<br /> #vardefine:name|to_effect}}{{<br /> #vardefine:return_type|effect}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> p1desc={{Pspan|convert}} is the int, string or skill to convert|<br /> }}|<br /> function_description=When supplied an int or string, returns the effect that corresponds to the specified parameter {{pspan|convert}}. When supplied a skill, this returns the effect that is given when the skill {{pspan|convert}} is cast on a player.&lt;br&gt;Note: This function can not return effects of items. For that, use [https://wiki.kolmafia.us/index.php?title=Effect_modifier effect_modifer()].|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_effect operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> //int<br /> print(to_effect(100), &quot;green&quot;);<br /> //strings<br /> print(to_effect(&quot;Smooth&quot;), &quot;green&quot;);<br /> print(to_effect(&quot;Smooth Move&quot;), &quot;green&quot;);<br /> //skills<br /> print(to_effect($skill[Disco Aerobics]), &quot;green&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=For more info about effects from numbers and skills, see [http://kol.coldfront.net/thekolwiki/index.php/Effects Effects].<br /> &lt;br&gt;It gives the following output.<br /> &lt;pre&gt;<br /> Stabilizing Oiliness<br /> Hella Smooth<br /> Smooth Movements<br /> Disco State of Mind<br /> &lt;/pre&gt;<br /> }}<br /> <br /> {{CodeSample|<br /> description=&lt;br&gt;Following example tells which buffs you are missing but could have.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> void buffs_check() {<br /> int amount;<br /> boolean have_buff;<br /> boolean[skill] active_buffs, bot_buffs, castable_buffs;<br /> foreach it in $skills[] {<br /> amount = have_effect(to_effect(it));<br /> if (amount == 0)<br /> have_buff = false;<br /> else have_buff = true;<br /> <br /> if (have_buff) //Currently have the effect active<br /> active_buffs[it]=have_buff;<br /> if (it.buff == true &amp;&amp; !have_buff &amp;&amp; it.class != $class[none] &amp;&amp; it.level != -1 &amp;&amp; it.dailylimit == -1 &amp;&amp; it != $skill[Spiky Shell] &amp;&amp; it != $skill[Antibiotic Saucesphere]) //buff bot buffs<br /> bot_buffs[it]=have_buff;<br /> if (have_skill(it) &amp;&amp; it.combat != true &amp;&amp; !have_buff &amp;&amp; to_effect(it) != $effect[none]) //buffs you can cast on yourself<br /> castable_buffs[it]=have_buff;<br /> }<br /> print(&quot;You currently have the following buffs active:&quot;, &quot;red&quot;);<br /> foreach it in active_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;green&quot;); <br /> print(&quot;&quot;);<br /> print(&quot;You could get the following buffs from a buff bot:&quot;, &quot;red&quot;);<br /> foreach it in bot_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;blue&quot;); <br /> print(&quot;&quot;);<br /> print(&quot;You could cast the following buffs on yourself:&quot;, &quot;red&quot;);<br /> foreach it in castable_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;purple&quot;);<br /> }<br /> buffs_check();<br /> &lt;/syntaxhighlight&gt;|<br /> <br /> }}|<br /> <br /> special=If {{pspan|convert}} is an effect that cannot be given by use of a skill, and is supplied as such, or no match is found for a supplied string or int type, this function returns $effect[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Whatif&diff=5965 2019-09-19T07:16:26Z

<p>Eliteofdelete: Updated &quot;_spec&quot; and added some additional information. Might have broke formatting.</p> <hr /> <div>{{DISPLAYTITLE:whatif (CLI)}}<br /> alias: '''speculate'''<br /> <br /> &lt;p&gt;This is a CLI command that takes a semicolon-separated list of commands that change the character state, and displays the modifier changes that would occur due to executing those commands. The supported commands are:&lt;/p&gt;<br /> * MCD &lt;num&gt;<br /> * equip [&lt;slot&gt;] &lt;item&gt;<br /> * unequip &lt;slot&gt;<br /> * familiar &lt;type&gt; - note that this doesn't change the current familiar item, whether or not the specified familiar can equip it.<br /> * enthrone &lt;familiar&gt; - considers the effect of having the specificed familiar in the crown of thrones<br /> * up &lt;effect&gt; - considers you to have 1 turn of that effect.<br /> * uneffect &lt;effect&gt;<br /> * quiet - suppresses the display of changed modifiers, for use in scripts.<br /> <br /> &lt;p&gt;Note that speculation about impossible actions is allowed - there's no checking to verify that you actually have any item, or can equip it. The predicted modifiers are stored as an object named &quot;_spec&quot;, which can be referenced by any of the ASH modifier query functions.&lt;/p&gt;<br /> <br /> &lt;p&gt;Five derived modifiers were added for use with this command, with values predicted from your base stats and other modifiers: &quot;Buffed Muscle&quot;, &quot;Buffed Mysticality&quot;, &quot;Buffed Moxie&quot;, &quot;Buffed HP Maximum&quot;, and &quot;Buffed MP Maximum&quot;. They are of little use with the character's current modifiers, since the actual values of these attributes are available, but are quite useful with the modifiers resulting from a speculation. &lt;/p&gt;<br /> <br /> &lt;p&gt;Example:&lt;/p&gt;<br /> &lt;div style=&quot;margin-bottom: 1em; border: dashed 1px green; padding: 1em; margin:0px 20px;&quot;&gt;&lt;syntaxhighlight&gt;<br /> cli_execute(&quot;whatif equip KGE helm; equip KGE polearm; equip KGE pants; quiet&quot;);<br /> if (my_mp() &gt; numeric_modifier(&quot;Generated:_spec&quot;, &quot;Buffed MP Maximum&quot;))<br /> print(&quot;Bad idea - you'd lose MP by doing that.&quot;);<br /> &lt;/syntaxhighlight&gt;&lt;/div&gt;<br /> &lt;br&gt;<br /> See [https://kolmafia.us/showthread.php?17831-Querying-speculated-modifiers-doesn-t-seem-to-work-after-modifier-revamp&amp;highlight=whatif here] and [https://kolmafia.us/showthread.php?17825-15461-Refactor-modifiers-txt-to-specify-modifier-type-Any-ash-modifier-functions-th here] for more information.<br /> [[Category:CLI Commands]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Monster_attack&diff=5276 2019-09-19T05:36:19Z

<p>Eliteofdelete: Added a precise monster hit-chance example based on monster attack.</p> <hr /> <div>{{<br /> #vardefine:name|monster_attack}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|monster|check_me}}|<br /> p1desc={{Pspan|check_me}} is the (optional) monster to get the attack value of|<br /> }}|<br /> function_description=Returns the attack value of the specified monster {{pspan|check_me}}. If {{pspan|check_me}} is not specified, it will use the current monster if you are in a fight (i.e. you're calling the function from an [[In-combat Consulting]] script), or the last monster you encountered otherwise.&lt;/p&gt;<br /> &lt;p&gt;When the function is given a monster as a parameter it will return the monster's attack at the start of a fight including all monster level modifications. This means that for monsters with unknown attack, the return value will be equivalent to {{f|monster_level_adjustment}}. If the zero parameter version is called and the character is currently in a fight, then the function will include all current combat deleveling modifiers from the current combat.&lt;/p&gt;<br /> &lt;p&gt;If you want to know the monster's raw attack without being modified by monster level adjustments, it is available through the monster.'''raw_attack''' proxy field.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example is a non-percise function that uses the monster's attack to estimate hit chance based on your moxie.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> boolean safecheck(string monstername) {<br /> int att = monster_attack(to_monster(monstername));<br /> if (att+10 &lt;= my_buffedstat($stat[moxie])) {<br /> print(&quot;Monster &quot;+monstername+&quot; will always miss! (except for crits)&quot;, &quot;green&quot;);<br /> return true;<br /> }<br /> else if (att-10 &gt;= my_buffedstat($stat[moxie])){<br /> print(att+10);<br /> print(&quot;Monster &quot;+monstername+&quot; will always hit you! (except for fumbles)&quot;, &quot;red&quot;);<br /> return false;<br /> }<br /> else {<br /> print(att);<br /> int hitchance = (att+10-my_buffedstat($stat[moxie]))*5;<br /> print(&quot;Monster &quot;+monstername+&quot; will hit you &quot;+hitchance+&quot;% of the time.&quot;, &quot;blue&quot;);<br /> return false;<br /> }<br /> return false;<br /> }<br /> <br /> safecheck(&quot;bar&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> }}|<br /> <br /> code2={{CodeSample|<br /> description=Following example returns the exact chance for a monster to hit. The function can be supplied a string or monster varible.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> float monsterHitChance(monster monsterName) {<br /> int difference = my_buffedstat($stat[moxie]) - monster_attack(monstername); //Also known as monster awesomeness<br /> if (difference &gt;= 10)<br /> return 0;<br /> else if (difference &lt;= -9)<br /> return 1;<br /> switch (difference) {<br /> case -8:<br /> return 0.99;<br /> case -7:<br /> return 0.97;<br /> case -6:<br /> return 0.9;<br /> case -5:<br /> return 0.85;<br /> case -4:<br /> return 0.79;<br /> case -3:<br /> return 0.72;<br /> case -2:<br /> return 0.64;<br /> case -1:<br /> return 0.55;<br /> case 0:<br /> return 0.5;<br /> case 1:<br /> return 0.45;<br /> case 2:<br /> return 0.36;<br /> case 3:<br /> return 0.28;<br /> case 4:<br /> return 0.21;<br /> case 5:<br /> return 0.15;<br /> case 6:<br /> return 0.1;<br /> case 7:<br /> return 0.16;<br /> case 8:<br /> return 0.03;<br /> case 9:<br /> return 0.01;<br /> }<br /> return 1;<br /> }<br /> float monsterHitChance(string monsterName) {return monsterHitChance(to_monster(monsterName));}<br /> <br /> foreach mob, freq in appearance_rates($location[The VERY Unquiet Garves]) {<br /> if (freq &gt; 0)<br /> print(&quot;The monster (&quot;+mob+&quot;) will hit you &quot;+monsterHitChance(mob)*100+&quot;% of the time.&quot;, &quot;blue&quot;); <br /> }<br /> &lt;/syntaxhighlight&gt;|<br /> }}|<br /> <br /> see_also={{SeeAlso|monster_defense|monster_initiative|monster_element|monster_hp}}|<br /> more_info=For the current discussion of what's being tracked in-combat for monster level adjustments, please see [http://kolmafia.us/showthread.php?3452 this thread].&lt;br&gt;<br /> For more details on monster hit-chance, please visit [https://kol.coldfront.net/thekolwiki/index.php/Monsters here].|<br /> special=If no monster is specified and no monster has been fought in this session, this function returns 0. This is because mafia forgets the value of {{f|last_monster}} when it logs out.|<br /> }}<br /> <br /> [[Category:Adventuring]][[Category:In-combat Consulting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Monster_hp&diff=5299 2019-09-13T03:10:14Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|monster_hp}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|monster|check_me}}|<br /> p1desc={{Pspan|check_me}} is the (optional) monster to get the HP of|<br /> }}|<br /> function_description=Returns the HP of the specified monster {{pspan|check_me}}. If {{pspan|check_me}} is not specified, it will return the HP of the current monster if you are in a fight (i.e. you're calling the function from an [[In-combat Consulting]] script), or the HP of the last monster you encountered otherwise. If you are in a fight, this will return the monster's current HP to the best of KoLmafia's knowledge.&lt;/p&gt;<br /> &lt;p&gt;The return value includes monster level modifications. This means that for monsters with unknown HP, the return value will initially be equivalent to monster_level_adjustment().&lt;/p&gt;<br /> &lt;p&gt;If you want to know the monster's raw HP without being modified by monster level adjustments, it is available through the monster.'''raw_hp''' proxy field.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following code is a simplified function of weapon damage. It will tell how many rounds it takes to kill a monster based on its HP.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> <br /> void kill (string monstername) {<br /> monster mon = to_monster(monstername);<br /> int hp = monster_hp(mon);<br /> int def = max(0, monster_defense(mon));<br /> int weaponstat = buffed_hit_stat();<br /> int total_dmg;<br /> string rounds;<br /> float weapon_multi, weapon_dmg, elemental_dmg;<br /> if (current_hit_stat() == $stat[moxie] &amp;&amp; item_type(equipped_item($slot[weapon])) != &quot;knife&quot;)<br /> weapon_multi = .75;<br /> else weapon_multi = 1.0;<br /> weapon_dmg = numeric_modifier(&quot;weapon damage&quot;);<br /> foreach it in $elements[]{<br /> string dmg = it+&quot; damage&quot;;<br /> elemental_dmg += numeric_modifier(dmg);<br /> }<br /> total_dmg = floor((weaponstat*weapon_multi)-def+weapon_dmg+elemental_dmg);<br /> total_dmg = max(0, total_dmg);<br /> if (total_dmg &gt; 0)<br /> rounds = to_string(max(1, round(hp/total_dmg)));<br /> else rounds = &quot;infinity&quot;;<br /> print(&quot;Your expected damage on &quot;+mon+&quot; is &quot;+total_dmg+&quot;. Assuming you always hit, it will take &quot;+rounds+&quot; round(s) to kill &quot;+mon+&quot;.&quot;, &quot;blue&quot;);<br /> }<br /> kill(&quot;bar&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> Note: The example does not take crits/fumbles/hit chances into account. For more information on weapon damage see [http://kol.coldfront.net/thekolwiki/index.php/Weapon_Damage Weapon Damage].<br /> }}|<br /> <br /> see_also={{SeeAlso|monster_attack|monster_defense|monster_initiative|monster_element}}|<br /> more_info=For the current discussion of what's being tracked in-combat for monster level adjustments, please see [http://kolmafia.us/showthread.php?3452 this thread].|<br /> special=If no monster is specified and no monster has been fought in this session, this function returns 0. This is because mafia forgets the value of {{f|last_monster}} when it logs out.|<br /> }}<br /> <br /> [[Category:Adventuring]][[Category:In-combat Consulting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Data_Structures&diff=3205 2015-12-06T06:39:02Z

<p>Eliteofdelete: Formatting</p> <hr /> <div>{{TOCright}}<br /> <br /> KoLmafia supports complex data structures such as maps and records made from simple [[Data Types|data types]].<br /> <br /> == Maps ==<br /> If you are new to programming or find the information below confusing, you may want to read [[Map_Guide | A Noob's Guide to Maps]] first. <br /> <br /> Most of this information was copied directly from ASH Maps Tutorial, by Veracity (http://kolmafia.sourceforge.net/advanced.html#maps)<br /> <br /> A map is indexed by one data type (the key) and associates that key with another (or the same) data type (the value). The key can be any ASH simple data type: boolean, int, float, string, item, location, class, stat, skill, effect, familiar, slot, or monster. The value can be any ASH data type at all: a simple type, a record, or can be another map. This effectively allows multi-dimensional maps and. In fact, that's how the syntax we provide for multi-dimensional maps actually operate: maps of maps of maps ...<br /> <br /> You can declare a map any time you can declare a variable: as a top level (global) variable, as a function parameter, or as a local variable in any scope.<br /> <br /> You can fetch data from a map any time you can provide a data value: in an expression, as a function parameter, on the right side of an assignment statement, from a &quot;return&quot; statement, as so on. You can pass around entire maps, individual elements, or intermediate maps: &quot;slices&quot;.<br /> <br /> === Declarations ===<br /> <br /> The syntax for declaring the data type of a map:<br /> <br /> &lt;pre&gt;<br /> &lt;data type&gt; [ &lt;key type&gt;, ... ] &lt;aggregate_name&gt;<br /> &lt;/pre&gt;<br /> <br /> For example:<br /> <br /> {{CodeSample<br /> |code=&lt;syntaxhighlight&gt;<br /> string [item] map1;<br /> float [class, string, int] another_map;<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> === Assignments ===<br /> <br /> If you use a map on the left side of an assignment, you set the whole map at once to the new value.<br /> <br /> {{CodeSample<br /> |code=&lt;syntaxhighlight&gt;<br /> int [item] my_pricelist;<br /> int [item] new_pricelist;<br /> <br /> /* Some code that updates my_pricelist with new_pricelist */<br /> <br /> my_pricelist = new_pricelist;<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> If you specify a map and a complete set of indices (of the correct types) on the left side of an assignment statement, you set a single element.<br /> <br /> {{CodeSample<br /> |code=&lt;syntaxhighlight&gt;<br /> int [item] my_pricelist;<br /> my_pricelist[ $item[ pail ] ] = 1000;<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> If you specify a map and a prefix of indices (of the correct type), you directly set one of the intermediate maps, a &quot;slice&quot;.<br /> <br /> {{CodeSample<br /> |code=&lt;syntaxhighlight&gt;<br /> float [string, int, string] my_map;<br /> float [int, string] slice1;<br /> <br /> /* Some code that fills my_map[ &quot;slice1&quot; ] with slice1 */<br /> my_map[ &quot;slice1&quot; ] = slice1;<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> === References ===<br /> <br /> The syntax for referencing an element (or slice) of a map:<br /> <br /> &lt;pre&gt;<br /> &lt;aggregate name&gt;[ &lt;key expression&gt;, ... ]<br /> &lt;/pre&gt;<br /> <br /> All the key expressions will be evaluated at run time. If you specify all the keys the map expects, you fetch data of the type specified by the map. If you specify fewer keys than the map expects, you get an intermediate map, a &quot;slice&quot;.<br /> <br /> As an example:<br /> {{<br /> CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> boolean [string, string] props; <br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> might be used to hold &quot;properties&quot; associated with names.<br /> {{<br /> CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> props[ &quot;dog&quot;, &quot;mammal&quot; ] = true; <br /> props[ &quot;dog&quot;, &quot;pet&quot; ] = true; <br /> props[ &quot;dog&quot;, &quot;fun&quot; ] = false;<br /> props[ &quot;turtle&quot;, &quot;mammal&quot; ] = false;<br /> props[ &quot;turtle&quot;, &quot;pet&quot; ] = true;<br /> props[ &quot;turtle&quot;, &quot;fun&quot; ] = false;<br /> props[ &quot;aardvark&quot;, &quot;mammal&quot; ] = true;<br /> props[ &quot;aardvark&quot;, &quot;pet&quot; ] = false;<br /> props[ &quot;aardvark&quot;, &quot;fun&quot; ] = true; <br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> <br /> references:<br /> <br /> &lt;pre&gt;<br /> props[ &quot;dog&quot;, &quot;mammal&quot;] =&gt; true<br /> boolean [string] animal = props[ &quot;turtle&quot; ];<br /> animal[ &quot;fun&quot; ] =&gt; false<br /> &lt;/pre&gt;<br /> <br /> === Contains ===<br /> <br /> You can test the presence of a key in a map using the &quot;contains&quot; operator:<br /> <br /> &lt;pre&gt;<br /> &lt;aggregate reference expression&gt; contains &lt;key expression&gt;<br /> &lt;/pre&gt;<br /> <br /> Where &lt;aggregate reference expression&gt; must evaluate at run time to a map or slice, and must evaluate at run time to a key of the appropriate type. (Note that that is enforced at parse time; ASH can tell the datatype any expression will produce).<br /> <br /> &lt;pre&gt;<br /> props contains &quot;dog&quot; =&gt; true<br /> props contains &quot;elephant&quot; =&gt; false<br /> props[ &quot;aardvark&quot; ] contains &quot;fun&quot; =&gt; true<br /> animal contains &quot;pet&quot; =&gt; true<br /> animal contains &quot;favorite food&quot; =&gt; false<br /> &lt;/pre&gt;<br /> <br /> === Remove ===<br /> <br /> You can remove a key-value association from a map using the &quot;remove&quot; unary operator:<br /> <br /> &lt;pre&gt;<br /> remove &lt;aggregate reference&gt;<br /> &lt;/pre&gt;<br /> <br /> For clarification, an aggregate reference is &quot;&lt;map name&gt;[ &lt;index 1&gt; ... &lt;index n&gt; ]&quot; where &lt;map name&gt;[ &lt;index 1&gt; ... &lt;index n-1&gt; ] specifies the &quot;slice&quot; and &lt;index n&gt; specifies the &quot;key&quot;. Which is just what you expect, if you fully specify the indices; for a single dimensional map, &quot;map[10]&quot; -&gt; &quot;map&quot; is the slice and 10 is the key. The &quot;remove&quot; operator removes the &quot;key&quot; from the &quot;slice&quot;. For example:<br /> <br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> string [int] map1;<br /> map1[5] = &quot;foo&quot;;<br /> print( count( map1 ) + &quot; &quot; + map1 contains 5 + &quot; &quot; + map1[5] );<br /> print( &quot;remove: &quot; + remove map1[5] );<br /> print( count( map1 ) + &quot; &quot; + map1 contains 5 + &quot; &quot; + map1[5] );<br /> print( &quot;remove: &quot; + remove map1[5] );<br /> int [string, string] map2;<br /> map2[&quot;me&quot;,&quot;you&quot;] = 17;<br /> print( count( map2[&quot;me&quot;] ) + &quot; &quot; + map2[&quot;me&quot;] contains &quot;you&quot; + &quot; &quot; + map2[&quot;me&quot;,&quot;you&quot;] );<br /> print( &quot;remove: &quot; + remove map2[&quot;me&quot;, &quot;you&quot;] );<br /> print( count( map2[&quot;me&quot;] ) + &quot; &quot; + map2[&quot;me&quot;] contains &quot;you&quot; + &quot; &quot; + map2[&quot;me&quot;,&quot;you&quot;] );<br /> print( &quot;remove: &quot; + remove map2[&quot;me&quot;, &quot;you&quot;] );<br /> print( count( map2 ) + &quot; &quot; + map2[&quot;me&quot;] );<br /> print( &quot;remove: &quot; + remove map2[&quot;me&quot;] );<br /> print( count( map2 ) + &quot; &quot; + map2[&quot;me&quot;] );<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> yields:<br /> <br /> &lt;pre&gt;<br /> 1 true foo<br /> remove: foo<br /> 0 false<br /> remove:<br /> 1 true 17<br /> remove: 17<br /> 0 false 0<br /> remove: 0<br /> 1 aggregate int [string]<br /> remove: aggregate int [string]<br /> 0 aggregate int [string]<br /> &lt;/pre&gt;<br /> <br /> === Clear ===<br /> <br /> You can remove all &lt;code&gt;key =&gt; value&lt;/code&gt; entries from a map using the {{f|clear}} function:<br /> <br /> {{CodeSample|code=&lt;syntaxhighlight&gt;clear( &lt;aggregate&gt; );&lt;/syntaxhighlight&gt;}}<br /> <br /> === Count ===<br /> <br /> The {{f|count}} function returns the number of defined keys for the specified aggregate.<br /> <br /> {{CodeSample|code=&lt;syntaxhighlight&gt;int size = count( &lt;aggregate&gt; );&lt;/syntaxhighlight&gt;}}<br /> <br /> === Sort ===<br /> <br /> From http://kolmafia.us/showthread.php?t=1738 and http://kolmafia.us/showthread.php?10729<br /> <br /> The syntax is:<br /> {{CodeSample|code=&lt;syntaxhighlight&gt;sort aggregate by keyExpr;&lt;/syntaxhighlight&gt;}}<br /> <br /> &lt;code&gt;aggregate&lt;/code&gt; is a reference to the object to be sorted - arrays are probably the most useful things to sort, but any mapping type can be used. But please note that when you sort a map, you change the values that correspond to the index. To sort on a map, you would want to use a multidimensional maps, but note that you can only sort along a single dimension at a time when doing this. Simply put... &quot;sort&quot; is only useful in cases where your data exists entirely in the values of the map; the keys can have no meaning beyond simply being distinct.<br /> <br /> The reference must not be enclosed in parentheses, as that would look like a call to a function named &lt;code&gt;sort()&lt;/code&gt; - which is still perfectly valid, &quot;sort&quot; has not become a [[Reserved Words|reserved word]].<br /> <br /> &lt;code&gt;keyExpr&lt;/code&gt; is an arbitrary expression that defines how the items should be ordered. It is evaluated once for every entry in the aggregate, in a scope with two additional variables implicitly defined: '&lt;code&gt;index&lt;/code&gt;' and '&lt;code&gt;value&lt;/code&gt;', holding the details of that entry. The value of the &lt;code&gt;keyExpr&lt;/code&gt; is used as the sort key; typically it would be an &lt;code&gt;int&lt;/code&gt; or &lt;code&gt;string&lt;/code&gt;, but can be any ASH type that can be compared via &quot;&lt;&quot; and the other relational operators.<br /> <br /> The most basic form of sorting would therefore be &quot;&lt;code&gt;sort ... by value&lt;/code&gt;&quot;, but many useful things can be done with the use of a more complex &lt;code&gt;keyExpr&lt;/code&gt; - the only real restriction is that the expression should not modify the object you're sorting. For example, if you had an array of items, you could sort it &quot;&lt;code&gt;by autosell_price(value)&lt;/code&gt;&quot;. An array of weapon items could be sorted &quot;&lt;code&gt;by -get_power(value)&lt;/code&gt;&quot; to put it in decreasing order of power. If the elements of your aggregate are records, you'd need to use something like &quot;&lt;code&gt;by value.fieldName&lt;/code&gt;&quot;, since the records themselves can't be meaningfully compared.<br /> <br /> After the sort statement, the aggregate will have exactly the same sets of keys and values as before (even if the keys weren't consecutive), and the iteration order of the keys will be the same, but the values will likely be associated with different keys. The sort is stable - in other words, elements with sort keys that compare as equal will remain in the same order. This means that you can sort on multiple criteria by simply performing separate sorts for each of the criteria, in increasing order of significance.<br /> <br /> To find out how many things you have, you might do:<br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> item [int] whatGot;<br /> int ctr =0;<br /> <br /> foreach it in get_inventory() {<br /> whatGot[ctr] = it;<br /> ctr+=1;<br /> }<br /> <br /> sort whatGot by item_amount(value);<br /> <br /> foreach x, it in whatGot<br /> print(item_amount(it) + ' of ' + it);<br /> &lt;/syntaxhighlight&gt;}}<br /> Note that this use of an optional feature of foreach. The second variable in the foreach is the value of whatGot[x].<br /> <br /> <br /> A few more examples of things you can do:<br /> * &quot;&lt;code&gt;by -value&lt;/code&gt;&quot; sorts integers in decreasing order (there's no similar trick for &lt;code&gt;string&lt;/code&gt; values).<br /> * &quot;&lt;code&gt;by -index&lt;/code&gt;&quot; reverses the existing order of an array (or map with integer keys).<br /> * &quot;&lt;code&gt;by random(1000000)&lt;/code&gt;&quot; shuffles into a random order.<br /> * &quot;&lt;code&gt;by otherArray[index]&lt;/code&gt;&quot; uses values from a parallel array as the sort keys (you'd then need to do &quot;&lt;code&gt;sort otherArray by value;&lt;/code&gt;&quot; if you wanted the two arrays to remain in sync).<br /> <br /> ===Iteration===<br /> To iterate through a map, use the '''foreach''' operator. For instance, if you wanted to print out how many of each item you had, you could do something like the following:<br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> int[item] map = get_inventory();<br /> foreach key in map {<br /> print(key + &quot; (&quot; + map[key] + &quot;)&quot;);<br /> }<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> Multidimensional maps are implemented as maps that map keys to maps. '''int[item][string]map''' is really a mapping of items to int[string] maps. Iteration, therefore, is as follows:<br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> int[item][string] map;<br /> file_to_map(&quot;somefile.txt&quot;, map);<br /> foreach k1 in map {<br /> print(k1 + &quot;: &quot;);<br /> foreach k2 in map[k1] {<br /> print(&quot;\t&quot; + k2 + &quot;: &quot; + map[k1][k2]);<br /> }<br /> }<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> Two things to note: First, '''int[item][string]map''' is equivalent to '''int[item, string]map'''. This really comes down to author preference, although the second form is generally more common. Second, the two following foreach loops are equivalent:<br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> int[item][string] map;<br /> foreach k1 in map {<br /> foreach k2 in map[k1] {<br /> func(map[k1][k2]);<br /> }<br /> }<br /> <br /> foreach k1, k2 in map {<br /> func(map[k1][k2]);<br /> }<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> Of course, the latter does not lend itself to, say, only printing the first key once, whereas the former can be used that way (see the preceding example).<br /> <br /> ===Implementation===<br /> Maps in ASH are implemented internally as TreeMaps [http://download.oracle.com/javase/1.5.0/docs/api/java/util/TreeMap.html]. See below for some implications.<br /> <br /> == Arrays ==<br /> These look and behave like mappings of integers to values, where the keys only take values from 0 to n, but these are implemented as Java Arrays.<br /> <br /> ===Differences between arrays and maps===<br /> <br /> '''item [12] array;'''<br /> <br /> Can use keys 0 - 11. You get a runtime error if you use any other key. It always uses memory to hold 12 items, even if you only use a couple of them. But it's a constant time - O(1) - to access any element.<br /> <br /> '''item [int] map;'''<br /> <br /> Can use any int as a key. It has constant memory for the Java map, and additional memory for each element in the map, but is O( log n) to access any particular element.<br /> <br /> If you are able to use (a fairly densely packed set of) integers as keys, your program will be faster and use (potentially) slightly more memory.<br /> <br /> If you have a sparse set of integers, you can still use an array and get fast access, but you will waste a lot of memory.<br /> <br /> If you can't use integers as keys or don't want to waste memory on a sparse array, you can have a slower but less memory consuming map.<br /> <br /> [http://kolmafia.us/showthread.php?6425-Sorting-skills-by-mana-cost&amp;p=48703&amp;viewfull=1#post48703]<br /> <br /> ====Time considerations====<br /> * Given '''if (a == item1 || a == item2 || a == item3)''' and '''if ($items[item1, item2, item3] contains a)''', which is faster?<br /> <br /> This is going to depend on the number of items in the list, and which one happens to match; if 'a' is almost always item1, then the first form is likely to win on practical grounds, even though it's theoretically slower (O(n) vs. O(log n)).<br /> <br /> The second form is a definite win assuming no such coincidences of the item chosen, a somewhat larger set of items, and that the code is executed more than once per run of the script. The first lookup in a plural constant actually builds an internal map that allows such queries to be efficiently done; this is deferred because typical use of a plural constant involves only iteration, not lookups.<br /> <br /> There's always the &quot;profile&quot; command, if you really need to know which is more efficient in a given situation - although it's unlikely that either would have a noticeable effect on your script's performance.<br /> <br /> [http://kolmafia.us/showthread.php?6425-Sorting-skills-by-mana-cost&amp;p=48728&amp;viewfull=1#post48728]<br /> <br /> == Records ==<br /> <br /> (copy-pasted from Veracity's post introducing the record [http://kolmafia.us/showthread.php?t=280])<br /> <br /> Starting with SVN revision 1311 of KoLmafia, ASH now supports a new kind of structured data: the record. Here is a little example of how you declare a record and variables of the new type you've created by doing so.<br /> <br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> record my_type {<br /> int ifield;<br /> string sfield;<br /> record {<br /> int first;<br /> int second;<br /> } rfield;<br /> int [int, int] mfield;<br /> };<br /> <br /> my_type rvar;<br /> my_type [int] mrvar;<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> What I've done with the above is declare a new data type which I've named &quot;my_type&quot;. Having declared the new type, I can use it (almost) anywhere that I can use a built-in type name. I declared a variable, &quot;rvar&quot;, of that type, and I defined a map, &quot;mrvar&quot;, which maps keys of type integer to values of type my_type.<br /> <br /> The new type, &quot;my_type&quot; is a &quot;composite&quot; type. It contains four fields. &quot;ifield&quot; is an integer. &quot;sfield&quot; is a string. &quot;rfield&quot; is another composite field: an anonymous record containing two integers named &quot;first&quot; and &quot;second&quot;. Finally, &quot;mfield&quot; is a map from [int, int] to int.<br /> <br /> As you can see, a record can combine data of all the types ASH supports: primitive, aggregate, and composite.<br /> <br /> Having defined the new data type and several variables using it, here are some examples of how to access the fields.<br /> <br /> {{CodeSample|code=&lt;syntaxhighlight&gt;<br /> rvar.ifield = 10;<br /> rvar.sfield = &quot;secret&quot;;<br /> rvar.rfield.first = 1000;<br /> rvar.rfield.second = 2000;<br /> rvar.mfield[ 2, 3 ] = 12;<br /> <br /> mrvar[ 1 ] = rvar;<br /> <br /> foreach key in mrvar<br /> foreach key1, key2 in mrvar[key].mfield<br /> print( &quot;val = &quot; + mrvar[key].mfield[key1,key2] );<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> <br /> As you can see, if you have a variable that is a record, you access the fields of the record by following the variable name with &quot;.&amp;lt;field name&amp;gt;&quot;. The resulting value will be of whatever type you declared in the definition of the record. If the value is a map, you can give a list of keys within [], just like any other map. If the value is another record, you can access the fields of the nested record by using another &quot;.&amp;lt;field name&amp;gt;&quot;.<br /> <br /> If you are familiar with Pascal &quot;records&quot; or C/C++ &quot;structs&quot;, this should all be comfortably familiar.<br /> <br /> Finally, if you create a map whose values is a record, the file_to_map and map_to_file built-in ASH functions will Do The Right Thing; they will efficiently and reliably save and restore your data.<br /> <br /> [[Category:Scripting]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Numeric_modifier&diff=2653 2015-12-05T20:57:20Z

<p>Eliteofdelete: typo</p> <hr /> <div>{{<br /> #vardefine:name|numeric_modifier}}{{<br /> #vardefine:return_type|float}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|modifier_name}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|check_me}}|<br /> parameter2={{Param|string|modifier_name}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|item|check_me}}|<br /> parameter2={{Param|string|modifier_name}}|<br /> }}|<br /> <br /> function4={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|effect|check_me}}|<br /> parameter2={{Param|string|modifier_name}}|<br /> }}|<br /> <br /> function5={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|check_me}}|<br /> parameter2={{Param|string|modifier_name}}|<br /> p1desc={{Pspan|check_me}} is the string, item, effect or skill to check|<br /> p2desc={{Pspan|modifier_name}} is the modifier to check|<br /> }}|<br /> <br /> function_description=Returns your current modifier total for {{pspan|modifier_name}}, or the amount of modification from {{pspan|check_me}} if specified.&lt;/p&gt;<br /> ===Special Syntax for Familiars===<br /> {{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|familiar|buddy}}|<br /> parameter2={{Param|string|check_me}}|<br /> parameter3={{Param|int|weight}}|<br /> parameter4={{Param|item|equipment}}|<br /> p1desc={{Pspan|buddy}} is the familiar to check|<br /> p2desc={{Pspan|check_me}} is the modifier to check|<br /> p3desc={{Pspan|weight}} is the familiar's weight (buffed, not including equipment)|<br /> p4desc={{Pspan|equipment}} is the familiar's equipment|<br /> }}<br /> &lt;p&gt;Returns the familiar's effect on this modifier (for instance, a baby gravy fairy would return some positive float for &quot;Item Drop&quot;).|<br /> <br /> code1={{CodeSample|<br /> title=Code Sample|<br /> description=Prints your current Initiative:|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> float init = numeric_modifier( &quot;initiative&quot; );<br /> print(init);<br /> &lt;/syntaxhighlight&gt;}}<br /> {{CodeSample|<br /> description=Function that checks if a single effect from a given list will buff your muscle over an amount goal. The name of the first effect to satisfy the goal is printed, or you are warned if none is found.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> boolean buffMuscleTo( int goal ) {<br /> int current_muscle = my_buffedstat( $stat[Muscle] ) ;<br /> int base_muscle = my_basestat( $stat[Muscle] ) ;<br /> int muscle_increase ;<br /> if ( current_muscle &gt;= goal ) return true ;<br /> <br /> foreach it in $effects[Tomato Power, Phorcefullness, Gr8tness, Incredibly Hulking] {<br /> if ( have_effect(it) &gt; 0 ) continue ;<br /> muscle_increase = floor( base_muscle * numeric_modifier( it, &quot;Muscle Percent&quot; ) / 100 );<br /> if ( current_muscle + muscle_increase &gt;= goal ) {<br /> print(it + &quot; will bring your muscle over &quot; + goal);<br /> return true;<br /> }<br /> }<br /> print(&quot;No effect found&quot;);<br /> return false;<br /> }<br /> &lt;/syntaxhighlight&gt;}}|<br /> <br /> cli_equiv=The CLI command &quot;modtrace&quot; gives access to the same information when the correct parameters are specified.|<br /> <br /> <br /> more_info= For a full list of numeric modifiers, see the following thread: [http://kolmafia.us/showthread.php?802 List].|<br /> }}<br /> <br /> [[Category:Modifier Functions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Damage_reduction&diff=2410 2015-11-27T06:23:48Z

<p>Eliteofdelete: typo</p> <hr /> <div>{{<br /> #vardefine:name|damage_reduction}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}<br /> }}|<br /> <br /> function_description=Returns the damage that is deducted as a result of damage reduction effects.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=The function will calculate the average damage you will take from each monster in a given location, if you are hit.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> int damage_calculator (monster opponent) {<br /> int myMoxie = my_buffedstat($stat[moxie]);<br /> int monsterAttack = monster_attack(opponent);<br /> int bonusDamage = monsterAttack-myMoxie;<br /> if (bonusDamage &lt; 0)<br /> bonusDamage = 0;<br /> float totalDamage = bonusDamage + monsterAttack*.225 - damage_reduction();<br /> totalDamage = totalDamage * (1 - damage_absorption_percent()/100);<br /> if (totalDamage &lt; 0)<br /> totalDamage = 0;<br /> print(&quot;For &quot;+opponent+&quot;: KoLMafia thinks you will take &quot;+expected_damage(opponent)+&quot; and calculator thinks &quot;+totalDamage, &quot;blue&quot;);<br /> return round(totalDamage);<br /> }<br /> <br /> void location_damage (location place) {<br /> print(&quot;&quot;+place+&quot; has the following enemies that will deal the following average damage:&quot;, &quot;purple&quot;);<br /> foreach mob, freq in appearance_rates(place) //Appearance rates is used to weed out bosses/one time specials/etc<br /> if (freq &gt; 0) <br /> print(&quot;The average damage a &quot;+mob+&quot; will deal to you is &quot;+damage_calculator(mob)+&quot;.&quot;, &quot;blue&quot;);<br /> <br /> }<br /> location_damage($location[The Black Forest]);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> The formula used to calculate damage can be found [http://kol.coldfront.net/thekolwiki/index.php/Weapon_Damage#Monster_Damage_Formula Here] Note: The example does not take in account using a shield with the passive Hero of the Half-Shell.<br /> }}|<br /> <br /> see_also={{SeeAlso|damage_absorption_percent|raw_damage_absorption}}|<br /> special=Returns 0 when not logged in.<br /> }}<br /> <br /> [[Category:Your Character]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Zlib&diff=7300 2015-11-24T08:45:38Z

<p>Eliteofdelete: Added info about changing established ZLIB properties within ASH</p> <hr /> <div>{{TOCright}}{{DISPLAYTITLE:ZLib (zlib.ash)}}<br /> {{Attention|<br /> This page details the use of functions in a script library. The information here is only useful to those who have followed the included steps to make use of these functions; they are not built-in to KoLmafia.<br /> }}<br /> == About ZLib ==<br /> ZLib is a function library intended to make life easier for both script authors and script users. A more detailed introduction, as well as instructions on installing it and other details, can be found in the [http://kolmafia.us/showthread.php?2072 ZLib thread].<br /> <br /> == String Functions ==<br /> <br /> {{HideLink|excise}}{{Function|<br /> name=excise|<br /> return_type=string|<br /> parameter1={{Param|string|source}}|<br /> parameter2={{Param|string|start}}|<br /> parameter3={{Param|string|end}}|<br /> p1desc=The original {{pspan|source}} string|<br /> p2desc={{pspan|start}} after this string|<br /> p3desc={{pspan|end}} before this string|<br /> }}<br /> This function returns a portion of the {{pspan|source}} string, from after the first occurrence of {{pspan|start}} to just before the first occurrence of {{pspan|end}}. If either {{pspan|start}} or {{pspan|end}} are missing, it will return an empty string. You can also supply either {{pspan|start}} or {{pspan|end}} as blank strings to specify the actual start or end of the {{pspan|source}} string.<br /> <br /> {{HideLink|equals}}{{Function|<br /> name=equals|<br /> return_type=boolean|<br /> parameter1={{Param|string|s1}}|<br /> parameter2={{Param|string|s2}}|<br /> p1desc={{pspan|s1}} is a string.|<br /> p2desc={{pspan|s2}} is the string to compare with {{pspan|s1}}.|<br /> }}<br /> Since string comparisons in ASH using == and != are case-insensitive, this function allows you to strictly compare two strings, including case sensitivity.<br /> <br /> {{HideLink|vprint}}{{Function|<br /> name=vprint|<br /> return_type=boolean|<br /> parameter1={{Param|string|message}}|<br /> parameter2={{Param|int|level}}|<br /> }}<br /> {{Function|<br /> name=vprint|<br /> return_type=boolean|<br /> parameter1={{Param|string|message}}|<br /> parameter2={{Param|string|color}}|<br /> parameter3={{Param|int|level}}|<br /> p1desc={{pspan|message}} and {{pspan|color}} are used as in the function {{f|print}}|<br /> p2desc={{pspan|level}} controls the return value and specifies the verbosity level of the message|<br /> }}<br /> This function is an enhanced version of the ASH function {{f|print}}. The {{pspan|message}} and optional {{pspan|color}} parameters are exactly like in print(), but the {{pspan|level}} parameter gives you a lot of additional control. Specifically, it allows you to control the return value, specify the verbosity level of the output, and maybe even abort the script.<br /> <br /> First, the return value. If level is positive, it returns true. If negative, it returns false. If level is 0, vprint() will abort with the specified message. You can see now that vprint effectively replaces both {{f|abort}} and print. I recommend it as your go-to function anytime you need to show anything in the CLI, for any reason.<br /> <br /> Having a boolean return value (as opposed to ASH's print returning void) allows you to include helpful information in your script easily, without needing to significantly edit your code. For example:<br /> {{CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> // add debugging info to an if check:<br /> if (somevar == 2 &amp;&amp; vprint(&quot;somevar equals 2&quot;,10)) dosomething();<br /> // add additional info to a return true/false:<br /> if (everythingsgreat) return vprint(&quot;Everything's great!&quot;,7);<br /> else return vprint(&quot;Everything is not great.&quot;,-7);<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> Secondly, level represents the verbosity of the message. ZLib includes a script setting called &quot;verbosity&quot;. Users can adjust this value to specify how verbose they want scripts to be. If they set it to 1, they want the script to print almost nothing -- only the most important messages. If they set it to 10, they want it to print a lot of details. The level of each vprint command thus determines whether or not the message will actually be printed. If the absolute value of level is more than verbosity, the message will not be printed. For example, a user with the default verbosity of 3 would not see any of the example messages given above. This allows users to control the chattiness of scripts, and allows authors to include helpful debugging print statements which can be shown by setting verbosity high.<br /> <br /> '''Recommendations for Verbosity Levels in vprint()'''<br /> <br /> 0: abort error<br /> <br /> +/- 1: absolutely essential (and non-cluttering) information -- use very sparingly, since a verbosity of 1 is basically &quot;silent mode&quot;<br /> <br /> +/- 2: important and useful info -- this should generally be your base level for your most important messages<br /> <br /> +/- 4: interesting but non-essential information<br /> <br /> +/- 6: info which an overly curious person might like to see on their CLI<br /> <br /> +/- 10: details which are only helpful for debugging, such as &quot;begin/end functionname()&quot; or &quot;current value of variable: value&quot;<br /> <br /> <br /> This will allow users who want extra levels of detail printed to see that detail without cluttering the CLI for users who don't prefer to see all the details. In addition, it allows users to specify a verbosity of 0 to see ONLY mafia output (no script output at all), which could prove handy.<br /> <br /> The color parameter is optional. If you omit it, the default color is black for positive values of level, and red for negative values. Usually, you won't be calling vprint() with the color parameter, unless you want to specify a different color or override the default colors.<br /> <br /> {{HideLink|vprint_html}}{{Function|<br /> name=vprint_html|<br /> return_type=boolean|<br /> parameter1={{Param|string|message}}|<br /> parameter2={{Param|int|level}}|<br /> p1desc={{pspan|message}} is used as in the function {{f|print_html}}|<br /> p2desc={{pspan|level}} is a verbosity reference|<br /> }}<br /> Same as vprint() above, but wraps {{f|print_html}}.<br /> <br /> {{HideLink|normalized}}{{Function|<br /> name=normalized|<br /> return_type=string|<br /> parameter1={{Param|string|mixvar}}|<br /> parameter2={{Param|string|type}}|<br /> p1desc={{pspan|mixvar}} is the string to normalize|<br /> p2desc={{pspan|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify &quot;list of &lt;type&gt;&quot;, for a comma-delimited list of the given type.|<br /> }}<br /> Returns {{pspan|mixvar}}, normalized to the specified KoLmafia {{pspan|type}}. For example, normalized(&quot;badger&quot;, &quot;familiar&quot;) would return &quot;Astral Badger&quot;. It can also normalize comma-delimited lists of any of these types if you specify &quot;list of &lt;type&gt;&quot; for {{pspan|type}}. For example, normalized(&quot;bloop, dair go, possess&quot;, &quot;list of monster&quot;) would return &quot;Blooper, Dairy Goat, Possessed Silverware Drawer&quot;.<br /> <br /> {{HideLink|join}}{{Function|<br /> name=join|<br /> return_type=string|<br /> parameter1={{Param|string [int]|pieces|ag=t}}|<br /> parameter2={{Param|string|glue}}|<br /> p1desc={{pspan|pieces}} is a map of strings which you want to join into a single string.|<br /> p2desc={{pspan|glue}} is the string to put between the pieces.|<br /> }}<br /> This function is the opposite of the ASH function {{f|split_string}}. It joins {{pspan|pieces}} together, inserting {{pspan|glue}} between each piece, and returns the assembly as a single string. Useful for working with comma-delimited lists (or anything-delimited lists, actually).<br /> <br /> {{HideLink|list_contains}}{{Function|<br /> name=list_contains|<br /> return_type=boolean|<br /> parameter1={{Param|string|list}}|<br /> parameter2={{Param|string|needle}}|<br /> }}<br /> {{Function|<br /> name=list_contains|<br /> return_type=boolean|<br /> parameter1={{Param|string|list}}|<br /> parameter2={{Param|string|needle}}|<br /> parameter3={{Param|string|glue}}|<br /> p1desc={{pspan|list}} is a glue-delimited string list such as returned by join().|<br /> p2desc={{pspan|needle}} is the entry to check for.|<br /> p3desc={{pspan|glue}} is optional (defaults to &quot;, &quot;) and represents the delimiter for the list.|<br /> }}<br /> Returns true if {{pspan|list}} contains {{pspan|needle}}. Avoids false positives which could result from using contains_text().<br /> <br /> {{HideLink|list_add}}{{Function|<br /> name=list_add|<br /> return_type=string|<br /> parameter1={{Param|string|list}}|<br /> parameter2={{Param|string|add}}|<br /> }}<br /> {{Function|<br /> name=list_add|<br /> return_type=string|<br /> parameter1={{Param|string|list}}|<br /> parameter2={{Param|string|add}}|<br /> parameter3={{Param|string|glue}}|<br /> p1desc={{pspan|list}} is a glue-delimited string list such as returned by join() above.|<br /> p2desc={{pspan|add}} is the entry to add to the list.|<br /> p3desc={{pspan|glue}} is optional (defaults to &quot;, &quot;) and represents the delimiter for the list.|<br /> }}<br /> Adds unique entry {{pspan|add}} to a {{pspan|glue}}-delimited {{pspan|list}}, and returns the modified list. If the entry already exists in the list, another entry will not be added. For example, list_add(&quot;a, b, c&quot;,&quot;d&quot;) would return &quot;a, b, c, d&quot;, but list_add(&quot;a, b, c&quot;, &quot;a&quot;) would return &quot;a, b, c&quot;, since the entry &quot;a&quot; already exists.<br /> <br /> {{HideLink|list_remove}}{{Function|<br /> name=list_remove|<br /> return_type=string|<br /> parameter1={{Param|string|list}}|<br /> parameter2={{Param|string|del}}|<br /> }}<br /> {{Function|<br /> name=list_remove|<br /> return_type=string|<br /> parameter1={{Param|string|list}}|<br /> parameter2={{Param|string|del}}|<br /> parameter3={{Param|string|glue}}|<br /> p1desc={{pspan|list}} is a glue-delimited string list such as returned by join() above.|<br /> p2desc={{pspan|del}} is the entry to remove from the list.|<br /> p3desc={{pspan|glue}} is optional (defaults to &quot;, &quot;) and represents the delimiter for the list.|<br /> }}<br /> Removes {{pspan|del}} from {{pspan|glue}}-delimited {{pspan|list}}, and returns the modified list. It will remove all instances of {{pspan|del}}. For example, list_remove(&quot;a, b, c&quot;,&quot;a&quot;) would return &quot;b, c&quot;, and list_remove(&quot;a, a, b, b, c, c&quot;, &quot;a&quot;) would return &quot;b, b, c, c&quot;.<br /> <br /> {{HideLink|rnum}}{{Function|<br /> name=rnum|<br /> return_type=string|<br /> parameter1={{Param|int|n}}|<br /> }}<br /> {{Function|<br /> name=rnum|<br /> return_type=string|<br /> parameter1={{Param|float|n}}|<br /> }}<br /> {{Function|<br /> name=rnum|<br /> return_type=string|<br /> parameter1={{Param|float|n}}|<br /> parameter2={{Param|int|place}}|<br /> p1desc={{pspan|n}} is a number|<br /> p2desc={{pspan|place}} is the number of decimal places to round to|<br /> }}<br /> Returns your number {{pspan|n}} as a human-readable string, appropriate to the user's computer's region. For ints, this means it adds grouping separators where appropriate. For floats, it also rounds to the nearest {{pspan|place}} after the decimal. Default {{pspan|place}} for the float-only version is 2, although it may display fewer digits if they are 0's. Examples: rnum(12580) =&gt; &quot;12,580&quot;, rnum(3.14152964,3) =&gt; &quot;3.142&quot;, rnum(4.00008) =&gt; &quot;4&quot;, rnum(123456789.87654321) =&gt; &quot;123,456,789.88&quot;. Recommended as a substitute for to_string(int).<br /> <br /> == Number Functions ==<br /> <br /> {{HideLink|abs}}{{Function|<br /> name=abs|<br /> return_type=float|<br /> parameter1={{Param|float|n}}|<br /> p1desc={{pspan|n}} is any number.|<br /> }}<br /> Returns the absolute value of the number {{pspan|n}}. Don't worry if you are working with integers, it will still work just fine. This function already exists in many programming languages; ZLib makes it handily available in ASH.<br /> <br /> {{HideLink|minmax}}{{Function|<br /> name=minmax|<br /> return_type=float|<br /> parameter1={{Param|float|a}}|<br /> parameter2={{Param|float|min}}|<br /> parameter3={{Param|float|max}}|<br /> p1desc={{pspan|a}} is the original number|<br /> p2desc={{pspan|min}} is the minimum return value|<br /> p3desc={{pspan|max}} is the maximum return value|<br /> }}<br /> Returns {{pspan|a}}, but no less than {{pspan|min}} and no more than {{pspan|max}}. Another function common to many languages.<br /> <br /> {{HideLink|set_avg}}{{Function|<br /> name=set_avg|<br /> return_type=void|<br /> parameter1={{Param|float|to_add}}|<br /> parameter2={{Param|string|which_prop}}|<br /> p1desc={{pspan|to_add}} is the data point to add|<br /> p2desc={{pspan|which_prop}} is the property to add data to|<br /> }}<br /> Useful for adding spading to scripts. Adds one more statistic to an average value being stored in a property. For example, calling this function three times with the values 2, 4, and 6 for {{pspan|to_add}} would result in the property {{pspan|which_prop}} containing &quot;4.0:3&quot;, with 4.0 being the average of the three numbers added and 3 being the amount of numbers averaged.<br /> <br /> {{HideLink|get_avg}}{{Function|<br /> name=get_avg|<br /> return_type=float|<br /> parameter1={{Param|string|which_prop}}|<br /> p1desc={{pspan|which_prop}} is the property to access|<br /> }}<br /> Returns an average value set by set_avg().<br /> <br /> {{HideLink|eval}}{{Function|<br /> name=eval|<br /> return_type=float|<br /> parameter1={{Param|string|expression}}|<br /> parameter2={{Param|float [string]|values|ag=t}}|<br /> p1desc={{pspan|expression}} is the base expression|<br /> p2desc={{pspan|values}} is a map of values to replace|<br /> }}<br /> By Jason Harper. Evaluates {{pspan|expression}} as a math expression, and allows you to substitute {{pspan|values}} for variables, as described in much greater detail here. Brief documentation is also included in ZLib. (NB: This section needs more infoz.)<br /> <br /> == Script Functions ==<br /> <br /> {{HideLink|check_version}}{{Function|<br /> name=check_version|<br /> return_type=string|<br /> parameter1={{Param|string|soft}}|<br /> parameter2={{Param|string|proj}}|<br /> parameter3={{Param|int|thread}}|<br /> p1desc={{pspan|soft}} is the script name, which must match the page source of the {{pspan|thread}} being parsed|<br /> p2desc={{pspan|proj}} is the name of the SVN project name to check.|<br /> p3desc={{pspan|thread}} is the script's thread number on kolmafia.us|<br /> }}<br /> {{Function|<br /> name=check_version|<br /> return_type=string|<br /> parameter1={{Param|string|soft}}|<br /> parameter2={{Param|string|prop}}|<br /> parameter3={{Param|string|this_version}}|<br /> parameter4={{Param|int|thread}}|<br /> p1desc={{pspan|soft}} is as above.|<br /> p2desc={{pspan|prop}} is used as part of the name of the property saved to user preferences.|<br /> p3desc={{pspan|this_version}} is the version of the script currently running|<br /> p4desc={{pspan|thread}} is as above.|<br /> }}<br /> Server-friendly once-daily version-checking. There are two versions of this function, one for SVN and one for forum threads. The three-parameter SVN version uses mafia's SVN client to check if a previously checked-out SVN project is current and if not, it updates it automatically, meaning the script will be current the next time it runs. In the event that a user has checked the option for mafia to automatically update all projects on login, it detects that the script has updated and prints an informative message with a link to the script's kolmafia.us thread -- and if the project is hosted on SourceForge, an additional link to the changelog there.<br /> <br /> For the four-parameter forum thread version, it visits the specified {{pspan|thread}} on the kolmafia.us forums to find the current version of your script. The thread must include &lt;nowiki&gt;&quot;&lt;b&gt;&lt;/nowiki&gt;{{pspan|soft}} {{pspan|version}}&lt;nowiki&gt;&lt;/b&gt;&quot;&lt;/nowiki&gt; for the version info to be successfully parsed. Optionally, you may include &lt;nowiki&gt;&quot;[requires revision XXXX]&quot;&lt;/nowiki&gt; somewhere in your post if you want to indicate a required minimum revision of mafia. If a new version is available, it alerts the user in large text and provides an update link.<br /> <br /> The return value of both versions is a blank string unless an update is/was found, in which case it is a &lt;nowiki&gt;&lt;div class='versioninfo'&gt;&lt;/nowiki&gt; containing the update message. This allows this function to work equally well for relay scripts. The current version/revision (and the last date checked) is stored in a data file &quot;zversions.txt&quot;. Example:<br /> {{CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> check_version(&quot;Hardcore Checklist&quot;,&quot;checklist&quot;,&quot;1.2.7&quot;,1045);<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> {{HideLink|load_current_map}}{{Function|<br /> name=load_current_map|<br /> return_type=boolean|<br /> parameter1={{Param|string|map_name}}|<br /> parameter2={{Param|aggregate|destination}}|<br /> p1desc={{pspan|map_name}} is the name of the map, without the file extension|<br /> p2desc={{pspan|destination}} is a previously-declared map to load with data|<br /> }}<br /> Acts as a wrapper for the built-in {{f|file_to_map}} with automatic update capability. The first time the function is called for a given map each day, it will check [http://zachbardon.com/mafiatools/autoupdate.php Zarqon's Map Manager] to see if an update for the given {{pspan|map_name}} is available, and if so will load from there. Otherwise, it merely loads it from disk. (Note: you should not include a file extension, such as &quot;.txt&quot; in the {{pspan|map_name}} parameter.)<br /> <br /> {{HideLink|setvar}}{{Function|<br /> name=setvar|<br /> return_type=void|<br /> parameter1={{Param|string|name}}|<br /> parameter2={{Param|mixed|dfault}}|<br /> p1desc={{pspan|name}} is the name of the setting|<br /> p1desc={{pspan|dfault}} can be any primitive or ASH type (e.g. item, effect, coinmaster, etc.), but not an array, map, or record.|<br /> }}<br /> This function ensures that a ZLib script setting called {{pspan|name}} exists. If not, it creates it and sets it to {{pspan|dfault}}. If the setting already exists, it normalizes it to the same type as {{pspan|dfault}}, but otherwise does nothing. Note that this function is for initializing settings, not for editing existing settings. That is done by calling ZLib in the CLI.<br /> <br /> ==== For Users ====<br /> <br /> * Script settings are now all saved in one place, separate from mafia properties. I've read more than one post wishing that script-defined settings and mafia properties would be separate. This provides a solution.<br /> * Script settings are independent from scripts. This means that you will no longer need to edit scripts to adjust your settings. Further, when you download a script update, the script will still use your saved settings and you won't need to reset them!<br /> * To see all of your current settings, type &quot;zlib vars&quot; in the CLI. You can also type &quot;zlib &lt;whatever&gt;&quot; to see a list of current settings and values containing &lt;whatever&gt;. To change a setting, type &quot;zlib settingname = value&quot;. If you're adjusting threshold, you can use &quot;up&quot; or &quot;down&quot; as the value to adjust your threshold relatively. This is almost exactly as convenient as mafia settings (possibly more so since you don't need to open a text file to find setting names!).<br /> * If for some reason you prefer to open a text file, ZLib settings are stored in a file called vars_myname.txt in your data directory.<br /> * Scripts that use Zlib script settings will only create these settings when you run them for the first time. Attempting to edit a nonexisting setting won't work, so you'll need to run a script once (then, usually, mash the ESC key before it actually does anything) before you can configure it. Script documentation should tell you which settings to change to get your desired behavior.<br /> <br /> ==== For Script Authors ====<br /> <br /> * Script settings may now be used across scripts, in exactly the same way that mafia properties are. Basically, this works almost exactly like mafia properties, except that new settings can only be created by setvar() or manually editing the file (&quot;zlib nonexistentsetting = value&quot; will fail).<br /> * Settings are only stored if you run a script that defines/uses them. So your settings file will not contain any extraneous unused settings.<br /> * Script authors can now test for a setting's existence, which means you can check to see if a user has used a given script. It's almost as good as a script_exists() function. This can allow scripts to work together with other scripts, if they exist!<br /> * Scripts with overlapping or related functionality can be designed to access a single shared setting, in much the same way that my scripts have until now all shared a &quot;threshold&quot; mafia setting. Changing a single setting can now change the behavior of every script that accesses that setting.<br /> * To change a setting after setvar() within ash use: vars[&quot;propertyToChange&quot;] = newValue; followed by: updatevars(); to update the map with the new setting. If you don't use updatevars(), the change will not stick.<br /> <br /> ==== Functional Details ====<br /> <br /> When importing ZLib, it loads a map of your script settings from vars_myname.txt. It is a basic string[string] map called vars. To access a script setting within an ASH script, use vars[varname]. To check if a setting exists you can simply use if (vars contains varname).<br /> <br /> When a script calls setvar(&quot;threshold&quot;,4), ZLib checks to see if a variable called &quot;threshold&quot; already exists in vars. If so, since dfault is an integer, it ensures that the value is an integer using normalize() (saving changes if necessary), but unless normalization changed the value, nothing else happens. If &quot;threshold&quot; does not exist in vars, it creates it, sets it to 4, and saves the updated map back to vars_myname.txt.<br /> <br /> ==== Choosing Setting Names ====<br /> <br /> The file of script settings will contain all script settings, sorted alphabetically. Also, there is no way to detect if a setting is unused, so if you decide to change the name, the old setting will never be deleted. '''Please think carefully about your setting names.''' If you have a setting named &quot;setting1&quot;, a user will probably not have a clue which script that is for or what it does. True, this can be overcome with documentation, but it is far better to have settings that make sense just by looking at them.<br /> <br /> '''Recommendations:'''<br /> <br /> 1. Use a name that clearly identifies what the setting is/does.<br /> <br /> 2. Prefix your setting names with a script identifier. For example, here are some of my One-Click Wossname script settings:<br /> <br /> {{CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> setvar(&quot;ocw_warplan&quot;,&quot;optimal&quot;);<br /> setvar(&quot;ocw_change_to_meat&quot;,true);<br /> setvar(&quot;ocw_nunspeed&quot;,false);<br /> setvar(&quot;defaultoutfit&quot;,&quot;current&quot;);<br /> setvar(&quot;ocw_f_default&quot;,&quot;zombie&quot;);<br /> setvar(&quot;ocw_m_default&quot;,&quot;&quot;);<br /> &lt;/syntaxhighlight&gt;}}<br /> Those settings which are specific to OCW are prefixed with &quot;ocw_&quot; so as to be found together in the settings file. However, some of the settings are usable across scripts, and are not so prefixed. For example, the &quot;defaultoutfit&quot; will be used by nearly all of my adventuring scripts that swap outfits, so no prefix is given.<br /> <br /> == Adventuring Functions ==<br /> <br /> {{HideLink|be_good}}{{Function|<br /> name=be_good|<br /> return_type=boolean|<br /> parameter1={{Param|string|johnny}}|<br /> }}<br /> {{Function|<br /> name=be_good|<br /> return_type=boolean|<br /> parameter1={{Param|item|johnny}}|<br /> }}<br /> {{Function|<br /> name=be_good|<br /> return_type=boolean|<br /> parameter1={{Param|familiar|johnny}}|<br /> }}<br /> {{Function|<br /> name=be_good|<br /> return_type=boolean|<br /> parameter1={{Param|skill|johnny}}|<br /> p1desc={{pspan|johnny}} is the thing you want to check|<br /> }}<br /> This function, originally created to check whether items were allowed in the Bees Hate You path (hence the name), has been expanded to an all-purpose check to see whether something is acceptable in your current path. For example, in a Trendy path, or any of the newer paths that have similar restrictions, outdated items would not be_good. Likewise, during Bees Hate You, a familiar containing a 'b' would not be_good. In Fistcore, anything you hold in your hands is not allowed. In an Avatar of Boris run, your normal permed skills are not active. And so forth.<br /> <br /> {{HideLink|mall_val}}{{Function|<br /> name=mall_val|<br /> return_type=int|<br /> parameter1={{Param|item|it}}|<br /> parameter2={{Param|float|expirydays}}|<br /> parameter3={{Param|boolean|combatsafe}}|<br /> p1desc={{pspan|it}} is the item being valued.|<br /> p2desc={{pspan|expirydays}} is optional, default 0. It represents the age at which {{f|historical_price}} is no longer valid, after which {{f|mall_price}} is used.|<br /> p3desc={{pspan|combatsafe}} is optional, default false. If true, the function will avoid calling mall_price and use only historical_price, regardless of age.|<br /> }}<br /> The ASH functions {{f|mall_price}}, {{f|historical_price}}, and {{f|historical_age}} are often combined to save server hits when checking for the price of multiple items. Scripts will use the historical price if it is fairly recent, or hit the server with mall_price if it is too old. This function wraps all of that up, and even adds a flag for getting item values during combat (when you don't have mall access). You'll generally call this with only one of the two parameters.<br /> <br /> If you want to only use historical_price: mall_val(someitem, true)<br /> If you want to only use mall price: mall_val(someitem,0)<br /> If you want to use historical prices no more than 2 days old, otherwise use mall price: mall_val(someitem,3)<br /> <br /> {{HideLink|sell_val}}{{Function|<br /> name=sell_val|<br /> return_type=int|<br /> parameter1={{Param|item|it}}|<br /> parameter2={{Param|float|expirydays}}|<br /> parameter3={{Param|boolean|combatsafe}}|<br /> p1desc={{pspan|it}} is the item being valued.|<br /> p2desc={{pspan|expirydays}} is the same as in mall_val() above.|<br /> p3desc={{pspan|combatsafe}} is also as in mall_val() above.|<br /> }}<br /> This function is concerned with the meat you could realistically expect to get from selling the item. It returns mall_val, unless the mall value is at minimum, meaning it's junk which probably won't sell. In that case it returns the item's autosell value.<br /> <br /> {{HideLink|have_item}}{{Function|<br /> name=have_item|<br /> return_type=int|<br /> parameter1={{Param|string|to_lookup}}|<br /> p1desc={{pspan|to_lookup}} is the item to count|<br /> }}<br /> A residual function, used by the following and probably in several other scripts. Returns the amount of an item you have both in your inventory and equipped. Similar but not equivalent to the ASH function {{f|available_amount}}, since this function completely ignores your closet and storage.<br /> <br /> {{HideLink|braindrop}}{{Function|<br /> name=braindrop|<br /> return_type=item|<br /> parameter1={{Param|monster|patient}}|<br /> p1desc={{pspan|patient}} is the monster under inquiry|<br /> }}<br /> Returns the brain dropped by {{pspan|patient}} in Zombiecore. All five types of brains are properly accounted for, as well as monsters that drop no brains. Will always return $item[none] outside of Zombiecore.<br /> <br /> {{HideLink|is_goal}}{{Function|<br /> name=is_goal|<br /> return_type=boolean|<br /> parameter1={{Param|stat|whichstat}}|<br /> p1desc={{pspan|whichstat}} is the stat to check|<br /> }}<br /> The ASH function {{f|is_goal}} takes an item parameter and returns true if the given item is a goal. ZLib extends that function by also including a version which accepts a stat as a parameter. Stats can be goals when a user or script sets &quot;level X&quot; or &quot;X muscle&quot; as a goal.<br /> <br /> {{HideLink|isxpartof}}{{Function|<br /> name=isxpartof|<br /> return_type=float|<br /> parameter1={{Param|item|child}}|<br /> parameter2={{Param|item|ancestor}}|<br /> p1desc={{pspan|child}} is the ingredient/component you want to check.|<br /> p2desc={{pspan|ancestor}} is the concoction you want to check.|<br /> }}<br /> In the sentence &quot;child is X part of ancestor&quot;, this function returns X. It assumes the minimum amount of other ingredients necessary. For example, isxpartof($item[white pixel], $item[digital key]) returns 0.033333335 (1/30), since 30 white pixels are needed to make a digital key. However, isxpartof($item[red pixel], $item[digital key]) returns 0.03125 (1/32), assuming 1 each of green and blue pixels and 29 other white pixels (rather than 30 each RGB pixels -- 1/90). This function is used by has_goal(item) but may have uses in your own script.<br /> <br /> {{HideLink|has_goal}}{{Function|<br /> name=has_goal|<br /> return_type=float|<br /> parameter1={{Param|item|check_me}}|<br /> }}<br /> {{Function|<br /> name=has_goal|<br /> return_type=float|<br /> parameter1={{Param|monster|check_me}}|<br /> }}<br /> {{Function|<br /> name=has_goal|<br /> return_type=float|<br /> parameter1={{Param|location|check_me}}|<br /> p1desc={{pspan|check_me}} is the item, monster or locationto check|<br /> }}<br /> At the base of this function is the item parameter version, which returns the chance that the item {{pspan|check_me}} is or results in a goal. If the item is itself a goal, returns 1.0. Otherwise, returns what percentage of a goal the item is, which could be nonzero in two cases: 1) you could get a goal by using the item (returns the chance of success), or 2) the item is an ingredient of a goal. For example, with a goal of black pepper, has_goal($item[black picnic basket]) would return 0.58.<br /> <br /> When supplied a monster as the parameter for {{pspan|check_me}}, returns the percent chance that encountering the given monster will result in a goal, taking into account +items, pickpocket availability (and +pickpocket), and Torso. For instance, with no +item and black pepper as a goal, has_goal($monster[black widow]) would return 0.087 (0.58 basket contains pepper * 0.15 basket drop rate). Also note that it will add multiple goals together, so with white pixels as a goal, a Blooper would return 2.1.<br /> <br /> When supplied a location as the parameter for {{pspan|check_me}}, returns the chance that adventuring at a given location will yield a goal. For our black pepper example, has_goal($location[black forest]) would return 0.0174 (0.2 black widow appearance rate * 0.087 chance that a widow has black pepper). Presently this accounts for combat frequency modifiers but not Olfaction, and it will be off for areas with noncombats that grant goals, because it assumes that all noncombats do not yield items.<br /> <br /> These functions also have an optional boolean parameter, usespec. If supplied as true, these functions will use speculative values. (See &quot;whatif&quot;)<br /> <br /> {{HideLink|obtain}}{{Function|<br /> name=obtain|<br /> return_type=boolean|<br /> parameter1={{Param|int|qty}}|<br /> parameter2={{Param|string|condition}}|<br /> parameter3={{Param|location|place}}|<br /> }}<br /> {{Function|<br /> name=obtain|<br /> return_type=boolean|<br /> parameter1={{Param|int|qty}}|<br /> parameter2={{Param|string|condition}}|<br /> parameter3={{Param|location|place}}|<br /> parameter4={{Param|string|filter}}|<br /> p1desc={{pspan|qty}} is the quantity of the item or choice adventure desired|<br /> p2desc={{pspan|condition}} is the item or choice adventure to use as a goal|<br /> p3desc={{pspan|place}} is the location to adventure to obtain your goal|<br /> p4desc={{pspan|filter}} is an optional combat filter used the same as in {{f|adventure}}|<br /> }}<br /> Attempts to get {{pspan|qty}} (minus existing) of {{pspan|condition}}, either by purchasing (if you have the KoLmafia preference set), pulling from Hangk's, or adventuring at the specified {{pspan|place}}. It also works with choice adventures.<br /> <br /> {{HideLink|use_upto}}{{Function|<br /> name=use_upto|<br /> return_type=boolean|<br /> parameter1={{Param|int|qty}}|<br /> parameter2={{Param|item|thing}}|<br /> parameter3={{Param|boolean|purchase}}|<br /> p1desc={{pspan|qty}} is the quantity to use|<br /> p2desc={{pspan|thing}} is the item to use|<br /> p3desc={{pspan|purchase}} is true if KoLmafia should purchase extras if you don't already have {{pspan|qty}}|<br /> }}<br /> Gets (if purchase is true) and uses {{pspan|qty}} of the item(s) {{pspan|thing}} if possible. Otherwise, uses as many as you have up to {{pspan|qty}}.<br /> <br /> {{HideLink|resist}}{{Function|<br /> name=resist|<br /> return_type=boolean|<br /> parameter1={{Param|element|resist_it}}|<br /> parameter2={{Param|boolean|really}}|<br /> p1desc={{pspan|resist_it}} is the element to resist|<br /> p2desc={{pspan|really}} is true to actually attemp resistance, false to check only|<br /> }}<br /> Returns whether you are able to resist a given element {{pspan|resist_it}}, or if {{pspan|really}} is true, attempts to actually achieve that resistance (casting buffs, changing gear, or equipping your Exotic Parrot) and returns its success.<br /> <br /> {{HideLink|my_defstat}}{{Function|<br /> name=my_defstat|<br /> return_type=int|<br /> parameter1={{Param|boolean|usespec}}|<br /> p1desc={{pspan|usespec}} is optional. If true, uses speculative values rather than real values.|<br /> }}<br /> Returns the value of your buffed defense stat, taking into account Hero of the Half-Shell.<br /> <br /> {{HideLink|get_safemox}}{{Function|<br /> name=get_safemox|<br /> return_type=int|<br /> parameter1={{Param|location|where}}|<br /> p1desc={{pspan|where}} is the location to check for safe moxie|<br /> }}<br /> Using mafia's location/monster data, returns the safe moxie of a given zone {{pspan|where}}.<br /> <br /> {{HideLink|auto_mcd}}{{Function|<br /> name=auto_mcd|<br /> return_type=boolean|<br /> parameter1={{Param|int|check_me}}|<br /> }}<br /> {{Function|<br /> name=auto_mcd|<br /> return_type=boolean|<br /> parameter1={{Param|monster|check_me}}|<br /> }}<br /> {{Function|<br /> name=auto_mcd|<br /> return_type=boolean|<br /> parameter1={{Param|location|check_me}}|<br /> p1desc={{pspan|check_me}} is the int, monster or location to check|<br /> }}<br /> If your ZLib setting &quot;automcd&quot; is true, automatically adjusts your mind-control device for maximum stat gains based on safe moxie and your ZLib &quot;threshold&quot; setting. Does not adjust for MCD-sensitive areas (certain bosses, Slime Tube), or areas with no known combats. Returns true unless KoLmafia is unable to do so, even though the script thinks it should be capable (still returns true if you can't currently access an mcd-changing device).<br /> <br /> {{HideLink|best_fam}}{{Function|<br /> name=best_fam|<br /> return_type=familiar|<br /> parameter1={{Param|string|type}}|<br /> p1desc={{pspan|type}} is the type of familiar ability to check for|<br /> }}<br /> Returns your heaviest familiar of a given type (currently possible: items, meat, produce, stat, delevel). If your ZLib &quot;is_100_run&quot; setting is anything other than $familiar[none], returns that familiar (so you don't have to make the check in your script).<br /> <br /> == Kmail Functions ==<br /> <br /> {{HideLink|load_kmail}}{{Function|<br /> name=load_kmail|<br /> return_type=void|<br /> parameter1={{Param|string|calledby}}|<br /> p1desc={{pspan|calledby}} is optional and allows you to specify the name of the script calling this function, which will be submitted when the script visits api.php. The default value is &quot;ZLib-powered-script&quot;.|<br /> }}<br /> This function parses your kmail inbox in a single server hit and loads it into the global variable &quot;mail&quot;, which is of type kmessage[int]. A kmessage is a record type, with the following fields:<br /> {{CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> record kmessage {<br /> int id; // message id<br /> string type; // possible values observed thus far: normal, giftshop<br /> int fromid; // sender's playerid (0 for npc's)<br /> int azunixtime; // KoL server's unix timestamp<br /> string message; // message (not including items/meat)<br /> int[item] items; // items included in the message<br /> int meat; // meat included in the message<br /> string fromname; // sender's playername<br /> string localtime; // your local time according to your KoL account, human-readable string<br /> };<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> Thus, after calling this function your inbox is very easy to work with. You can foreach over each message if you like, accessing the fields for details.<br /> <br /> {{HideLink|process_kmail}}{{Function|<br /> name=process_kmail|<br /> return_type=void|<br /> parameter1={{Param|string|functionname}}|<br /> p1desc={{pspan|functionname}} specifies the name of a function designed to parse kmail.|<br /> }}<br /> If you liked load_kmail(), you'll like this even better. First off, this function loads your kmail into the mail variable if you haven't already done so. Next, it calls a function named {{pspan|functionname}} on each kmail message. The function must be at top level, accept a single kmessage parameter, and return a boolean. For each kmail in your inbox, if the called function returns true, that message will be deleted once all messages have been processed.<br /> <br /> Here's a simple example which will delete all messages from your lovely Pen Pal:<br /> {{CodeSample|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> boolean no_penpal(kmessage m) {<br /> if (m.fromname == &quot;Your Pen Pal&quot;) return true;<br /> return false;<br /> }<br /> process_kmail(&quot;no_penpal&quot;);<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> {{HideLink|send_gift}}{{Function|<br /> name=send_gift|<br /> return_type=boolean|<br /> parameter1={{Param|string|recipient}}|<br /> parameter2={{Param|string|message}}|<br /> parameter3={{Param|int|meat}}|<br /> parameter4={{Param|int [item]|goodies|ag=t}}|<br /> }}<br /> {{Function|<br /> name=send_gift|<br /> return_type=boolean|<br /> parameter1={{Param|string|recipient}}|<br /> parameter2={{Param|string|message}}|<br /> parameter3={{Param|int|meat}}|<br /> parameter4={{Param|int [item]|goodies|ag=t}}|<br /> parameter5={{Param|string|inside_note}}|<br /> p1desc={{pspan|recipient}} is the player to send to|<br /> p2desc={{pspan|message}} is the outside message|<br /> p3desc={{pspan|meat}} is the amount of meat to send|<br /> p4desc={{pspan|goodies}} is a map of items &amp; amounts to send|<br /> p5desc={{pspan|inside_note}} is an optional inside message|<br /> }}<br /> Sends a gift to a player. Able to split large amounts of items. Returns true if the package is sent and false if not. See kmail() below.<br /> <br /> {{HideLink|kmail}}{{Function|<br /> name=kmail|<br /> return_type=boolean|<br /> parameter1={{Param|string|recipient}}|<br /> parameter2={{Param|string|message}}|<br /> parameter3={{Param|int|meat}}|<br /> }}<br /> {{Function|<br /> name=kmail|<br /> return_type=boolean|<br /> parameter1={{Param|string|recipient}}|<br /> parameter2={{Param|string|message}}|<br /> parameter3={{Param|int|meat}}|<br /> parameter4={{Param|int [item]|goodies|ag=t}}|<br /> }}<br /> {{Function|<br /> name=kmail|<br /> return_type=boolean|<br /> parameter1={{Param|string|recipient}}|<br /> parameter2={{Param|string|message}}|<br /> parameter3={{Param|int|meat}}|<br /> parameter4={{Param|int [item]|goodies|ag=t}}|<br /> parameter5={{Param|string|inside_note}}|<br /> p1desc={{pspan|recipient}} is the player to send to|<br /> p2desc={{pspan|message}} is the outside message|<br /> p3desc={{pspan|meat}} is the amount of meat to send|<br /> p4desc={{pspan|goodies}} is an optional map of items &amp; amounts to send|<br /> p5desc={{pspan|inside_note}} is an optional inside message if sent as a gift|<br /> }}<br /> {{Function|<br /> name=kmail|<br /> return_type=boolean|<br /> parameter1={{Param|kmessage|km}}|<br /> p1desc={{pspan|km}} allows you to send a kmail supplied in kmessage format. The only thing unusual here is that the &quot;fromname&quot; field will be used as the recipient. The other fields will be used appropriately to call the above kmail function.|<br /> }}<br /> Sends a kmail to player {{pspan|recipient}}, returning true if the kmail is successfully sent. Handles splitting the {{pspan|message}} into multiple messages if the number of item types in {{pspan|goodies}} is too large. Returns the result of send_gift() if the intended {{pspan|recipient}} is unable to receive the {{pspan|message}} due to being in HC or somesuch. Note that you can also specify the {{pspan|inside_note}} to be used inside gifts in that case. Use &quot;\n&quot; to specify a new line in the {{pspan|message}}.<br /> <br /> == More Information ==<br /> &lt;p&gt;See the thread for ZLib on the mafia forum [http://kolmafia.us/showthread.php?2072 here].&lt;/p&gt;<br /> <br /> [[Category:Scripting]][[Category:ASH Function Libraries]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Turns_played&diff=6016 2015-11-22T07:14:44Z

<p>Eliteofdelete: Fixed some types in the code sample</p> <hr /> <div>{{<br /> #vardefine:name|turns_played}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> }}|<br /> <br /> function_description=This function returns the total number of adventures used thus far by the logged-in character during the current ascension.&lt;/p&gt;<br /> &lt;p&gt;This exactly duplicates the function [[my_turncount|my_turncount()]]. Indications are that it was added as part at attempt to support semirare counters, but nothing ever came of it. Oops. &lt;span class=&quot;plainlinks&quot;&gt;[http://kolmafia.us/showthread.php?4061 Discussion here]&lt;/span&gt;.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=The following example is a function that saves relevant ascension info into a text file called &quot;Ascension History&quot; located in Data. It should be called after, and only after, the Naughty Sorc was defeated.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> void ascension_tracker() {<br /> if (get_property(&quot;questL13Final&quot;) == &quot;finished&quot;) {<br /> string[int] info;<br /> string class2;<br /> if (my_class() == $class[Accordion Thief])<br /> class2 = &quot;an Accordion Thief&quot;;<br /> else<br /> class2 = &quot;a &quot;+my_class()+&quot;&quot;;<br /> file_to_map(&quot;Ascension History.txt&quot;, info); <br /> string ascension_tracker = &quot;&quot;+my_name()+&quot; completed a &quot;+my_turncount()+&quot; adventure ascension in &quot;+my_daycount()+&quot; days as &quot;+class2+&quot; with path &quot;+my_path()+&quot; on &quot;+now_to_string(&quot;MM/dd/yyyy&quot;)+&quot;.&quot;;<br /> print(ascension_trackr, &quot;green&quot;);<br /> info [count(info)] = ascension_tracker;<br /> map_to_file(info, &quot;Ascension History.txt&quot;, false);<br /> }<br /> }<br /> //Insert Code to kill Naughty Sorc, or kill her by hand<br /> //Call ascension_tracker<br /> ascension_tracker();<br /> &lt;/syntaxhighlight&gt;|<br /> <br /> }}|<br /> <br /> see_also={{SeeAlso|my_turncount}}|<br /> special=When not logged in, this function returns 0.<br /> }}<br /> <br /> [[Category:Your Character]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=Use&diff=4857 2015-11-17T07:26:45Z

<p>Eliteofdelete: Added Chew reference</p> <hr /> <div>{{<br /> #vardefine:name|use}}{{<br /> #vardefine:return_type|boolean}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|qty}}|<br /> parameter2={{Param|item|it}}|<br /> p1desc={{pspan|qty}} is the quantity to use|<br /> p2desc={{pspan|it}} is the item to use|<br /> }}|<br /> <br /> function_description=Attempts to use {{pspan|qty}} amount of item {{pspan|it}}. Returns true if the item is used or false if it fails to do so. Note that food must be &quot;used&quot; via eat() &amp; drinks via drink() &amp; spleen via chew(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=The following example uses the festive warbear bank if you have one.|<br /> code= <br /> &lt;syntaxhighlight&gt;<br /> if (item_amount($item[festive warbear bank]) &gt; 0) <br /> use(1, $item[festive warbear bank]);<br /> else print(&quot;You do not have a festive warbear bank.&quot;, &quot;red&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> <br /> }}|<br /> <br /> see_also={{SeeAlso|drink|eat|equip|chew}}|<br /> cli_equiv=The CLI command &quot;use&quot; functions similarly.|<br /> more_info=If {{pspan|qty}} is 0 or negative, no item will be used and the function will return true.|<br /> }}<br /> <br /> [[Category:Item Management]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_int&diff=5762 2015-01-26T15:52:00Z

<p>Eliteofdelete: Still only 5/9 functions shown</p> <hr /> <div>{{<br /> #vardefine:name|to_int}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|boolean|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|float|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function4={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|item|convert}}|<br /> }}|<br /> <br /> function5={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|class|convert}}|<br /> p1desc={{Pspan|convert}} is the boolean, int, string, item, class, effect, familiar, skill, or thrall to convert|<br /> }}|<br /> <br /> function6={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|familiar|convert}}|<br /> }}|<br /> <br /> <br /> <br /> function7={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|effect|convert}}|<br /> }}|<br /> <br /> <br /> function8={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> }}|<br /> <br /> function9={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|thrall|convert}}|<br /> }}|<br /> <br /> function_description=This function looks for the best integer match to the specified input, which varies by datatype.<br /> * boolean values return 0 for false and 1 for true<br /> * float values return the same as they would with [[truncate|truncate()]]<br /> * string values are parsed in several ways:<br /> ** fully numeric strings, optionally with + or - as the first character, return as they would for a float (commas are also ignored)<br /> ** all other strings return 0, with a message saying that the string is not a valid integer<br /> * special datatypes (class, skill, thrall etc.) return their ID number as referenced in KoL.<br /> Note: All the possible functions are not listed yet.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_int operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> boolean first, second;<br /> float third;<br /> string fourth;<br /> item fifth;<br /> class sixth;<br /> effect seventh;<br /> familiar eighth;<br /> skill ninth;<br /> thrall tenth;<br /> <br /> first = true;<br /> second = false;<br /> third = 3.141592;<br /> fourth = &quot;933,029&quot;;<br /> fifth = $item[mae west];<br /> sixth = $class[disco bandit];<br /> seventh = $effect[smooth movements];<br /> eighth = $familiar[hobo monkey];<br /> ninth = $skill[smooth movement];<br /> tenth = $thrall[Penne Dreadful];<br /> <br /> print(first+&quot; gives &quot;+to_int(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_int(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_int(third)+&quot;.&quot;, &quot;blue&quot;);<br /> print(fourth+&quot; gives &quot;+to_int(fourth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(fifth+&quot; gives &quot;+to_int(fifth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(sixth+&quot; gives &quot;+to_int(sixth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(seventh+&quot; gives &quot;+to_int(seventh)+&quot;.&quot;, &quot;blue&quot;);<br /> print(eighth+&quot; gives &quot;+to_int(eighth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(ninth+&quot; gives &quot;+to_int(ninth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(tenth+&quot; gives &quot;+to_int(tenth)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> true gives 1.<br /> false gives 0.<br /> 3.141592 gives 3.<br /> 933,029 gives 933029.<br /> Mae West gives 1584.<br /> Disco Bandit gives 5.<br /> Smooth Movements gives 165.<br /> Hobo Monkey gives 89.<br /> Smooth Movement gives 5017.<br /> Penne Dreadful gives 5.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_int&diff=5761 2015-01-26T15:45:25Z

<p>Eliteofdelete: Still don&#039;t know how to get the other functions to show up, currently only does 5 of 9</p> <hr /> <div>{{<br /> #vardefine:name|to_int}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|boolean|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|float|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function4={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|item|convert}}|<br /> }}|<br /> <br /> function5={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|class|convert}}|<br /> p1desc={{Pspan|convert}} is the boolean, int, string, item, class, effect, familiar, skill, or thrall to convert|<br /> }}|<br /> <br /> <br /> function6={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|familiar|convert}}|<br /> }}|<br /> <br /> <br /> <br /> function7={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|effect|convert}}|<br /> }}|<br /> <br /> <br /> function8={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> }}|<br /> <br /> function9={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|thrall|convert}}|<br /> }}|<br /> <br /> function_description=This function looks for the best integer match to the specified input, which varies by datatype.<br /> * boolean values return 0 for false and 1 for true<br /> * float values return the same as they would with [[truncate|truncate()]]<br /> * string values are parsed in several ways:<br /> ** fully numeric strings, optionally with + or - as the first character, return as they would for a float (commas are also ignored)<br /> ** all other strings return 0, with a message saying that the string is not a valid integer<br /> * special datatypes (class, skill, thrall etc.) return their ID number as referenced in KoL.<br /> |<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_int operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> boolean first, second;<br /> float third;<br /> string fourth;<br /> item fifth;<br /> class sixth;<br /> effect seventh;<br /> familiar eighth;<br /> skill ninth;<br /> thrall tenth;<br /> <br /> first = true;<br /> second = false;<br /> third = 3.141592;<br /> fourth = &quot;933,029&quot;;<br /> fifth = $item[mae west];<br /> sixth = $class[disco bandit];<br /> seventh = $effect[smooth movements];<br /> eighth = $familiar[hobo monkey];<br /> ninth = $skill[smooth movement];<br /> tenth = $thrall[Penne Dreadful];<br /> <br /> print(first+&quot; gives &quot;+to_int(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_int(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_int(third)+&quot;.&quot;, &quot;blue&quot;);<br /> print(fourth+&quot; gives &quot;+to_int(fourth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(fifth+&quot; gives &quot;+to_int(fifth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(sixth+&quot; gives &quot;+to_int(sixth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(seventh+&quot; gives &quot;+to_int(seventh)+&quot;.&quot;, &quot;blue&quot;);<br /> print(eighth+&quot; gives &quot;+to_int(eighth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(ninth+&quot; gives &quot;+to_int(ninth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(tenth+&quot; gives &quot;+to_int(tenth)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> true gives 1.<br /> false gives 0.<br /> 3.141592 gives 3.<br /> 933,029 gives 933029.<br /> Mae West gives 1584.<br /> Disco Bandit gives 5.<br /> Smooth Movements gives 165.<br /> Hobo Monkey gives 89.<br /> Smooth Movement gives 5017.<br /> Penne Dreadful gives 5.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_location&diff=5744 2015-01-26T15:44:40Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_location}}{{<br /> #vardefine:return_type|location}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{Pspan|convert}} is the int or string to convert|<br /> }}|<br /> <br /> function_description=Returns the location that matches {{pspan|name}} or {{pspan|id}} as specified.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_location operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> int first;<br /> string second, third;<br /> <br /> first = 32;<br /> second = &quot;top floor&quot;;<br /> third = &quot;poop deck&quot;;<br /> <br /> print(first+&quot; gives &quot;+to_location(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_location(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_location(third)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> 32 gives The Batrat and Ratbat Burrow.<br /> top floor gives The Castle in the Clouds in the Sky (Top Floor).<br /> poop deck gives The Poop Deck.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=While direct casting via $location[ ] is case-insensitive and able to catch partial matches, this function has the added benefit of passing variables as a string parameter.|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_monster&diff=5736 2015-01-26T15:44:27Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_monster}}{{<br /> #vardefine:return_type|monster}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|name}}|<br /> p1desc={{Pspan|name}} is the monster name to convert|<br /> }}|<br /> <br /> function_description=Returns the specified monster {{pspan|name}} as a monster.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_monster operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> string first, second, third;<br /> <br /> first = &quot;goth giant&quot;;<br /> second = &quot;beefy bat&quot;;<br /> third = &quot;flock of sta&quot;;<br /> <br /> print(first+&quot; gives &quot;+to_monster(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_monster(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_monster(third)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> goth giant gives Goth Giant.<br /> beefy bat gives beefy bodyguard bat.<br /> flock of sta gives Flock of Stab-Bats.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=Since direct casting with $monster[ ] is already case-insensitive and accepts partial matches, this function is only useful for converting a string variable to a monster.|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_skill&diff=3271 2015-01-26T15:43:59Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_skill}}{{<br /> #vardefine:return_type|skill}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|effect|convert}}|<br /> p1desc={{Pspan|convert}} is the int, string or effect to convert|<br /> }}|<br /> function_description=When supplied an int or string, returns the skill that corresponds to the specified parameter {{pspan|convert}}. When supplied an effect, this returns the skill that, when cast on a player, gives them the effect {{pspan|convert}}.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_skill operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> int first;<br /> string second;<br /> effect third;<br /> <br /> first = 53;<br /> second = &quot;disco eye&quot;;<br /> third = $effect[she-who-was];<br /> <br /> print(first+&quot; gives &quot;+to_skill(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_skill(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_skill(third)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> 53 gives Summon Crimbo Candy.<br /> disco eye gives Disco Eye-Poke.<br /> Avatar of She-Who-Was gives Turtle Power.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=If {{pspan|convert}} cannot be given by use of a skill and is supplied as such, or no match is found for a supplied string or int type, this function returns $skill[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_stat&diff=6383 2015-01-26T15:43:44Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_stat}}{{<br /> #vardefine:return_type|stat}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function_description=When supplied a string, returns the stat that corresponds to the specified parameter {{pspan|convert}}.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_stat operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> string first, second, third;<br /> <br /> first = &quot;mox&quot;;<br /> second = &quot;moxie&quot;;<br /> third = &quot;MuSclE&quot;;<br /> <br /> print(first+&quot; gives &quot;+to_stat(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_stat(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_stat(third)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> mox gives none.<br /> moxie gives Moxie.<br /> MuSclE gives Muscle.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> see_also={{SeeAlso|to_item|to_skill|to_monster}}|<br /> <br /> special=If no match is found for {{pspan|convert}}, this function returns $stat[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_thrall&diff=8424 2015-01-26T15:43:30Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_thrall}}{{<br /> #vardefine:return_type|thrall}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> function_description=When supplied an int or string, returns the thrall that corresponds to the specified parameter {{pspan|convert}}. Matching for the string is fuzzy.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_thrall operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> int first;<br /> string second, third;<br /> <br /> first = 3;<br /> second = &quot;dread&quot;;<br /> third = &quot;ver&quot;;<br /> <br /> print(first+&quot; gives &quot;+to_thrall(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_thrall(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_thrall(third)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> 3 gives Angel Hair Wisp.<br /> dread gives Penne Dreadful.<br /> ver gives Vermincelli.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=If no match is found for a supplied string or int type, this function returns $thrall[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_url&diff=5200 2015-01-26T15:42:33Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_url}}{{<br /> #vardefine:return_type|string}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|location|place}}|<br /> p1desc={{Pspan|place}} is an in-game location to parse|<br /> }}|<br /> <br /> function_description=Returns the short url (normally of the form &quot;adventure.php?snarfblat=&quot;) used to visit the location {{pspan|place}}.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_url operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> location first;<br /> first = $location[The Poop Deck];<br /> print(first+&quot; gives &quot;+to_url(first)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> The Poop Deck gives adventure.php?snarfblat=159.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> see_also={{SeeAlso|visit_url}}|<br /> special=Trying to use $location[none] will generate an &quot;Unexpected error.&quot;|<br /> }}<br /> <br /> [[Category:String Handling Routines]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_phylum&diff=7853 2015-01-26T15:18:21Z

<p>Eliteofdelete: Updated</p> <hr /> <div>{{<br /> #vardefine:name|to_phylum}}{{<br /> #vardefine:return_type|phylum}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|name}}|<br /> p1desc={{Pspan|name}} is the phylum name to convert|<br /> }}|<br /> <br /> function_description=Converts the specified string {{pspan|name}} to a phylum. Does not account for case sensitivity and partial matches.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_phylum operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> string first, second, third;<br /> <br /> first = &quot;FiSh&quot;;<br /> second = &quot;human&quot;;<br /> third = &quot;humanoid&quot;;<br /> <br /> print(first+&quot; gives &quot;+to_phylum(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_phylum(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_phylum(third)+&quot;.&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> FiSh gives none.<br /> human gives none.<br /> humanoid gives humanoid.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_float&diff=5767 2015-01-26T14:46:14Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_float}}{{<br /> #vardefine:return_type|float}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|boolean|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{Pspan|convert}} is the boolean, int, or string to convert|<br /> }}|<br /> <br /> function_description=This function looks for the best float match to the specified input, which varies by datatype. For int types, this function merely tacks &quot;.0&quot; to the end. For booleans, a transparent conversion as per [[to_int|to_int()]] is performed first, and then converted to a float. All other data types do not work.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_float operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> int first = 25;<br /> print(&quot;Int &quot;+first+&quot; gives &quot;+to_float(first), &quot;green&quot;);<br /> foreach it in $booleans[]<br /> print(&quot;Boolean &quot;+it+&quot; gives &quot;+to_float(it), &quot;blue&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> Int 25 gives 25.0<br /> Boolean true gives 1.0<br /> Boolean false gives 0.0<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_familiar&diff=5770 2015-01-26T14:45:32Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_familiar}}{{<br /> #vardefine:return_type|familiar}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{pspan|convert}} is an ID # or familiar name to convert|<br /> }}|<br /> <br /> function_description=Returns the familiar associated with either the KoL in-game ID # or name matching {{pspan|convert}}.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_familiar operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> int hobomonkey = 89;<br /> foreach it in $strings[baby gravy fairy, LaMa lAmA, spirit]<br /> print(&quot;String -&quot;+it+&quot;- gives familiar &quot;+to_familiar(it), &quot;blue&quot;); <br /> print(&quot;Int &quot;+hobomonkey+&quot; gives familiar &quot;+to_familiar(hobomonkey), &quot;green&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo= For more information of familiar numbers see [http://kol.coldfront.net/thekolwiki/index.php/Familiars_by_number Familiars by number].<br /> &lt;br&gt;It gives the following output.<br /> &lt;pre&gt;<br /> String -baby gravy fairy- gives familiar Baby Gravy Fairy<br /> String -LaMa lAmA- gives familiar Llama Lama<br /> String -spirit- gives familiar Spirit Hobo<br /> Int 89 gives familiar Hobo Monkey<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=If no match is found, this function returns $familiar[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_element&diff=6364 2015-01-26T14:44:41Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_element}}{{<br /> #vardefine:return_type|element}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|name}}|<br /> p1desc={{Pspan|name}} is the element name to convert|<br /> }}|<br /> <br /> function_description=Returns the specified element {{pspan|name}} as an element.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_element operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> foreach it in $strings[hot, colD, slime, SpookY, stench]<br /> print(&quot;The string -&quot;+it+&quot;- gives element: &quot;+to_element(it), &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> The string -hot- gives element: hot<br /> The string -colD- gives element: none<br /> The string -slime- gives element: slime<br /> The string -SpookY- gives element: none<br /> The string -stench- gives element: stench<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=Note that this function is case-sensitive, as with direct casting. Anything besides the following list will return $element[ none ], including strings with extra or missing characters: cold, hot, sleaze, spooky, stench, slime.|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_effect&diff=5775 2015-01-26T14:43:24Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_effect}}{{<br /> #vardefine:return_type|effect}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> p1desc={{Pspan|convert}} is the int, string or skill to convert|<br /> }}|<br /> function_description=When supplied an int or string, returns the effect that corresponds to the specified parameter {{pspan|convert}}. When supplied a skill, this returns the effect that is given when the skill {{pspan|convert}} is cast on a player.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_effect operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> //int<br /> print(to_effect(100), &quot;green&quot;);<br /> //strings<br /> print(to_effect(&quot;Smooth&quot;), &quot;green&quot;);<br /> print(to_effect(&quot;Smooth Move&quot;), &quot;green&quot;);<br /> //skills<br /> print(to_effect($skill[Disco Aerobics]), &quot;green&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=For more info about effects from numbers and skills, see [http://kol.coldfront.net/thekolwiki/index.php/Effects Effects].<br /> &lt;br&gt;It gives the following output.<br /> &lt;pre&gt;<br /> Stabilizing Oiliness<br /> Hella Smooth<br /> Smooth Movements<br /> Disco State of Mind<br /> &lt;/pre&gt;<br /> }}<br /> <br /> {{CodeSample|<br /> description=&lt;br&gt;Following example tells which buffs you are missing but could have.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> void buffs_check() {<br /> int amount;<br /> boolean have_buff;<br /> boolean[skill] active_buffs, bot_buffs, castable_buffs;<br /> foreach it in $skills[] {<br /> amount = have_effect(to_effect(it));<br /> if (amount == 0)<br /> have_buff = false;<br /> else have_buff = true;<br /> <br /> if (have_buff) //Currently have the effect active<br /> active_buffs[it]=have_buff;<br /> if (it.buff == true &amp;&amp; !have_buff &amp;&amp; it.class != $class[none] &amp;&amp; it.level != -1 &amp;&amp; it.dailylimit == -1 &amp;&amp; it != $skill[Spiky Shell] &amp;&amp; it != $skill[Antibiotic Saucesphere]) //buff bot buffs<br /> bot_buffs[it]=have_buff;<br /> if (have_skill(it) &amp;&amp; it.combat != true &amp;&amp; !have_buff &amp;&amp; to_effect(it) != $effect[none]) //buffs you can cast on yourself<br /> castable_buffs[it]=have_buff;<br /> }<br /> print(&quot;You currently have the following buffs active:&quot;, &quot;red&quot;);<br /> foreach it in active_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;green&quot;); <br /> print(&quot;&quot;);<br /> print(&quot;You could get the following buffs from a buff bot:&quot;, &quot;red&quot;);<br /> foreach it in bot_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;blue&quot;); <br /> print(&quot;&quot;);<br /> print(&quot;You could cast the following buffs on yourself:&quot;, &quot;red&quot;);<br /> foreach it in castable_buffs<br /> print(&quot;&quot;+it+&quot;&quot;, &quot;purple&quot;);<br /> }<br /> buffs_check();<br /> &lt;/syntaxhighlight&gt;|<br /> <br /> }}|<br /> <br /> special=If {{pspan|convert}} is an effect that cannot be given by use of a skill, and is supplied as such, or no match is found for a supplied string or int type, this function returns $effect[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_effect&diff=5774 2015-01-26T14:40:40Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_effect}}{{<br /> #vardefine:return_type|effect}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> p1desc={{Pspan|convert}} is the int, string or skill to convert|<br /> }}|<br /> function_description=When supplied an int or string, returns the effect that corresponds to the specified parameter {{pspan|convert}}. When supplied a skill, this returns the effect that is given when the skill {{pspan|convert}} is cast on a player.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_effect operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> //int<br /> print(to_effect(100), &quot;green&quot;);<br /> //strings<br /> print(to_effect(&quot;Smooth&quot;), &quot;green&quot;);<br /> print(to_effect(&quot;Smooth Move&quot;), &quot;green&quot;);<br /> //skills<br /> print(to_effect($skill[Disco Aerobics]), &quot;green&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=For more info about effects from numbers and skills, see [http://kol.coldfront.net/thekolwiki/index.php/Effects Effects].<br /> &lt;br&gt;It gives the following output.<br /> &lt;pre&gt;<br /> Stabilizing Oiliness<br /> Hella Smooth<br /> Smooth Movements<br /> Disco State of Mind<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=If {{pspan|convert}} is an effect that cannot be given by use of a skill, and is supplied as such, or no match is found for a supplied string or int type, this function returns $effect[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_class&diff=5733 2015-01-26T14:39:54Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_class}}{{<br /> #vardefine:return_type|class}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|name}}|<br /> p1desc={{Pspan|name}} is the class int or name to convert|<br /> }}|<br /> <br /> function_description=Returns the specified class {{pspan|name}} as a class.|<br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_class operations.||<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> print(to_class(&quot;DiScO BanDiT&quot;), &quot;green&quot;);<br /> print(to_class(&quot;disco ban&quot;), &quot;red&quot;);<br /> print(&quot;&quot;);<br /> if (to_class(&quot;DiScO BanDiT&quot;) == my_class())<br /> print(&quot;I am a Disco Bandit!&quot;, &quot;green&quot;);<br /> else print(&quot;I am not a Disco Bandit...&quot;, &quot;blue&quot;);<br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output (for DBs).<br /> &lt;pre&gt;<br /> Disco Bandit<br /> none<br /> <br /> I am a Disco Bandit!<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> special=Unlike direct casting with $class[ ], this function is case-insensitive. Full name is still required (partial names, or names with extra characters, return $class[ none ]).|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_bounty&diff=8422 2015-01-26T14:39:32Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_bounty}}{{<br /> #vardefine:return_type|bounty}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{Pspan|convert}} is the string to convert|<br /> }}|<br /> <br /> function_description=When supplied a string, returns the bounty that corresponds to the specified parameter {{pspan|convert}}. This is not a fuzzy match and it is not case-sensitive. The string needs to strictly match the name of the bounty, exactly.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_bounty operations.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> print(to_bounty(&quot;dirty coal button&quot;), &quot;green&quot;);<br /> print(to_bounty(&quot;dirty coal butto&quot;), &quot;red&quot;);<br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=<br /> It gives the following output.<br /> &lt;pre&gt;<br /> dirty coal button<br /> none<br /> &lt;/pre&gt;<br /> }}|<br /> see_also={{SeeAlso|to_item|to_skill|to_stat}}|<br /> special=If no match is found for {{pspan|convert}}, this function returns $bounty[ none ].|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_boolean&diff=5472 2015-01-26T14:18:54Z

<p>Eliteofdelete: Updated</p> <hr /> <div>{{<br /> #vardefine:name|to_boolean}}{{<br /> #vardefine:return_type|boolean}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|float|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{Pspan|convert}} is the int, float, or string to convert|<br /> }}|<br /> <br /> function_description=Datatype behaviour:<br /> This function converts the supplied datatype to a boolean value. For strings, this means that it will return false for everything except &quot;true&quot;. For all other datatypes, it returns to_int(anything) != 0. More details:<br /> <br /> * As indicated, integers return true for anything except 0, even negative values.<br /> * floats return true for anything except -1.0 to 1.0 (not inclusive). This is because to_int(float) truncates the float.<br /> Note: The string is case insensitive.|<br /> <br /> code1={{CodeSample|<br /> title=Code Samples|<br /> description=Following example shows basic to_boolean operations.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> string first, second, third, fourth;<br /> int fifth, sixth;<br /> <br /> first = &quot;random stuff&quot;;<br /> second = &quot;true&quot;;<br /> third = &quot;tRuE&quot;;<br /> fourth = &quot;TRUE&quot;;<br /> fifth = 5;<br /> sixth = 0;<br /> <br /> print(first+&quot; gives &quot;+to_boolean(first)+&quot;.&quot;, &quot;blue&quot;);<br /> print(second+&quot; gives &quot;+to_boolean(second)+&quot;.&quot;, &quot;blue&quot;);<br /> print(third+&quot; gives &quot;+to_boolean(third)+&quot;.&quot;, &quot;blue&quot;);<br /> print(fourth+&quot; gives &quot;+to_boolean(fourth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(fifth+&quot; gives &quot;+to_boolean(fifth)+&quot;.&quot;, &quot;blue&quot;);<br /> print(sixth+&quot; gives &quot;+to_boolean(sixth)+&quot;.&quot;, &quot;blue&quot;);<br /> <br /> <br /> &lt;/syntaxhighlight&gt;|<br /> moreinfo=It gives the following output.<br /> &lt;pre&gt;<br /> random stuff gives false.<br /> true gives true.<br /> tRuE gives true.<br /> TRUE gives true.<br /> 5 gives true.<br /> 0 gives false.<br /> &lt;/pre&gt;<br /> }}|<br /> <br /> see_also={{SeeAlso|to_int}}<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_location&diff=5743 2015-01-26T13:01:28Z

<p>Eliteofdelete: </p> <hr /> <div>{{<br /> #vardefine:name|to_location}}{{<br /> #vardefine:return_type|location}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{Pspan|convert}} is the int or string to convert|<br /> }}|<br /> <br /> function_description=Returns the location that matches {{pspan|name}} or {{pspan|id}} as specified.|<br /> <br /> needscode=yes|<br /> <br /> special=While direct casting via $location[ ] is case-insensitive and able to catch partial matches, this function has the added benefit of passing variables as a string parameter.|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_int&diff=5760 2015-01-26T11:35:36Z

<p>Eliteofdelete: Updated....seems to have a formatting issue where I can&#039;t go above 5 functions. Not sure how to get the other 4 to show up....</p> <hr /> <div>{{<br /> #vardefine:name|to_int}}{{<br /> #vardefine:return_type|int}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|boolean|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|float|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> }}|<br /> <br /> function4={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|item|convert}}|<br /> }}|<br /> <br /> function5={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|class|convert}}|<br /> p1desc={{Pspan|convert}} is the boolean, int, string, item, class, effect, familiar, skill, or thrall to convert|<br /> }}|<br /> <br /> <br /> function6={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|familiar|convert}}|<br /> }}|<br /> <br /> <br /> <br /> function7={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|effect|convert}}|<br /> }}|<br /> <br /> <br /> function8={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|skill|convert}}|<br /> }}|<br /> <br /> function9={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|thrall|convert}}|<br /> }}|<br /> <br /> function_description=This function looks for the best integer match to the specified input, which varies by datatype.<br /> * boolean values return 0 for false and 1 for true<br /> * float values return the same as they would with [[truncate|truncate()]]<br /> * string values are parsed in several ways:<br /> ** fully numeric strings, optionally with + or - as the first character, return as they would for a float (commas are also ignored)<br /> ** all other strings return 0, with a message saying that the string is not a valid integer<br /> * special datatypes (class, skill, thrall etc.) return their ID number as referenced in KoL.<br /> |<br /> <br /> needscode=yes|<br /> <br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_float&diff=5766 2015-01-26T11:03:50Z

<p>Eliteofdelete: Updated</p> <hr /> <div>{{<br /> #vardefine:name|to_float}}{{<br /> #vardefine:return_type|float}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|boolean|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function3={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|convert}}|<br /> p1desc={{Pspan|convert}} is the boolean, int, or string to convert|<br /> }}|<br /> <br /> function_description=This function looks for the best float match to the specified input, which varies by datatype. For int types, this function merely tacks &quot;.0&quot; to the end. For booleans, a transparent conversion as per [[to_int|to_int()]] is performed first, and then converted to a float. All other data types do not work.|<br /> <br /> needscode=yes|<br /> <br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete https://wiki.kolmafia.us/index.php?title=To_class&diff=5732 2015-01-26T10:40:56Z

<p>Eliteofdelete: Updated</p> <hr /> <div>{{<br /> #vardefine:name|to_class}}{{<br /> #vardefine:return_type|class}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|int|convert}}|<br /> }}|<br /> <br /> function2={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|string|name}}|<br /> p1desc={{Pspan|name}} is the class int or name to convert|<br /> }}|<br /> <br /> function_description=Returns the specified class {{pspan|name}} as a class.|<br /> <br /> needscode=yes|<br /> <br /> special=Unlike direct casting with $class[ ], this function is case-insensitive. Full name is still required (partial names, or names with extra characters, return $class[ none ]).|<br /> }}<br /> <br /> [[Category:Datatype Conversions]]</div>

Eliteofdelete