Difference between revisions of "Ash Functions"

From Kolmafia
Jump to navigation Jump to search
imported>Paragon99
imported>Zarqon
(removed alpha's to allow more immediate creation -- and, moving all the alpha pages would leave a lot of useless redirects later.)
Line 1: Line 1:
  This line, and all instances of the tailing alpha will be removed if/when this project leaves the alpha stage. So, the tailing<br>
+
  This is a good jump-off point for creating ASH function documentation.  Any of the red links have not yet been created.  Feel free.
alpha should be disreguarded.<br>
+
 
 
='''A'''=
 
='''A'''=
[[abort alpha ]] <--example of a command that is usable in both the gCLI and ash<br>
+
[[abort()]] <--example of a command that is usable in both the gCLI and ash<br>
[[add_item_condition alpha ]]<br>
+
[[add_item_condition()]]<br>
[[adventure alpha ]]<br>
+
[[adventure()]]<br>
[[append alpha ]]<br>
+
[[append()]]<br>
[[append_tail alpha ]]<br>
+
[[append_tail()]]<br>
[[append_replacement alpha ]]<br>
+
[[append_replacement()]]<br>
[[attack alpha ]] <-- example of a command that is consult script only<br>
+
[[attack()]] <-- example of a command that is consult script only<br>
[[autosell alpha ]]<br>
+
[[autosell()]]<br>
[[available_amount alpha ]] <---example of a command that is ash/consult script only<br>
+
[[available_amount()]] <---example of a command that is ash/consult script only<br>
  
 
='''B'''=
 
='''B'''=
[[boolean_modifier alpha ]]<br>
+
[[boolean_modifier()]]<br>
[[buffed_hit_stat alpha ]]<br>
+
[[buffed_hit_stat()]]<br>
[[buy alpha ]]<br>
+
[[buy()]]<br>
  
 
='''C'''=
 
='''C'''=
[[can_drink alpha ]]<br>
+
[[can_drink()]]<br>
[[can_eat alpha ]]<br>
+
[[can_eat()]]<br>
[[can_equip alpha ]]<br>
+
[[can_equip()]]<br>
[[can_interact alpha ]]<br>
+
[[can_interact()]]<br>
[[ceil alpha ]]<br>
+
[[ceil()]]<br>
[[chamber alpha ]]<br>
+
[[chamber()]]<br>
[[change_mcd alpha ]]<br>
+
[[change_mcd()]]<br>
[[chat_reply alpha ]]<br>
+
[[chat_reply()]]<br>
[[class_modifier alpha ]]<br>
+
[[class_modifier()]]<br>
[[clear alpha ]]<br>
+
[[clear()]]<br>
[[cli_execute alpha]]<br>
+
[[cli_execute()]]<br>
[[closet_amount alpha ]]<br>
+
[[closet_amount()]]<br>
[[combat_rate_modifier alpha ]]<br>
+
[[combat_rate_modifier()]]<br>
[[contains_text alpha ]]<br>
+
[[contains_text()]]<br>
[[council alpha ]]<br>
+
[[council()]]<br>
[[count alpha ]]<br>
+
[[count()]]<br>
[[creatable_amount alpha ]]<br>
+
[[creatable_amount()]]<br>
[[create alpha ]]<br>
+
[[create()]]<br>
[[create_matcher alpha ]]<br>
+
[[create_matcher()]]<br>
[[current_hit_stat alpha ]]<br>
+
[[current_hit_stat()]]<br>
[[current_mcd alpha ]]<br>
+
[[current_mcd()]]<br>
  
 
='''D'''=
 
='''D'''=
[[daily_special alpha ]]<br>
+
[[daily_special()]]<br>
[[damage_absorption_percent alpha ]]<br>
+
[[damage_absorption_percent()]]<br>
[[damage_reduction alpha ]]<br>
+
[[damage_reduction()]]<br>
[[delete alpha ]]<br>
+
[[delete()]]<br>
[[disable alpha]]<br>
+
[[disable()]]<br>
[[display_amount alpha ]]<br>
+
[[display_amount()]]<br>
[[drink alpha ]]<br>
+
[[drink()]]<br>
  
 
='''E'''=
 
='''E'''=
[[eat alpha ]]<br>
+
[[eat()]]<br>
[[effect_modifier alpha ]]<br>
+
[[effect_modifier()]]<br>
[[elemental_resistance alpha ]]<br>
+
[[elemental_resistance()]]<br>
[[end alpha ]]<br>
+
[[end()]]<br>
[[enable alpha]]<br>
+
[[enable()]]<br>
[[entryway alpha ]]<br>
+
[[entryway()]]<br>
[[equip alpha ]]<br>
+
[[equip()]]<br>
[[equipped_item alpha ]]<br>
+
[[equipped_item()]]<br>
[[extract_items alpha ]]<br>
+
[[extract_items()]]<br>
[[extract_meat alpha ]]<br>
+
[[extract_meat()]]<br>
[[expected_damage alpha ]]<br>
+
[[expected_damage()]]<br>
[[experience_bonus alpha ]]<br>
+
[[experience_bonus()]]<br>
  
 
='''F'''=
 
='''F'''=
[[familiar_equipment alpha]]<br>
+
[[familiar_equipment()]]<br>
[[familiar_weight alpha]]<br>
+
[[familiar_weight()]]<br>
[[file_to_map alpha]]<br>
+
[[file_to_map()]]<br>
[[find alpha]]<br>
+
[[find()]]<br>
[[form_field alpha]]<br>
+
[[form_field()]]<br>
[[floor alpha]]<br>
+
[[floor()]]<br>
[[fullness_limit alpha]]<br>
+
[[fullness_limit()]]<br>
  
 
='''G'''=
 
='''G'''=
[[get_ingredients alpha]]<br>
+
[[get_ingredients()]]<br>
[[get_inventory alpha]]<br>
+
[[get_inventory()]]<br>
[[get_monsters alpha]]<br>
+
[[get_monsters()]]<br>
[[get_power alpha]]<br>
+
[[get_power()]]<br>
[[get_property alpha]]<br>
+
[[get_property()]]<br>
[[group alpha]]<br>
+
[[group()]]<br>
[[group_count alpha]]<br>
+
[[group_count()]]<br>
[[group_string alpha]]<br>
+
[[group_string()]]<br>
[[guardians alpha]]<br>
+
[[guardians()]]<br>
  
 
='''H'''=
 
='''H'''=
[[have_bartender alpha]]<br>
+
[[have_bartender()]]<br>
[[have_chef alpha]]<br>
+
[[have_chef()]]<br>
[[have_effect alpha]]<br>
+
[[have_effect()]]<br>
[[have_equipped alpha]]<br>
+
[[have_equipped()]]<br>
[[have_familiar alpha]]<br>
+
[[have_familiar()]]<br>
[[have_mushroom_plot alpha]]<br>
+
[[have_mushroom_plot()]]<br>
[[have_outfit alpha]]<br>
+
[[have_outfit()]]<br>
[[have_skill alpha]]<br>
+
[[have_skill()]]<br>
[[hedgemaze alpha]]<br>
+
[[hedgemaze()]]<br>
[[hermit alpha]]<br>
+
[[hermit()]]<br>
  
 
='''I'''=
 
='''I'''=
[[in_bad_moon alpha]]<br>
+
[[import]]<br>
[[in_hardcore alpha]]<br>
+
[[in_bad_moon()]]<br>
[[in_moxie_sign alpha]]<br>
+
[[in_hardcore()]]<br>
[[in_muscle_sign alpha]]<br>
+
[[in_moxie_sign()]]<br>
[[in_mysticality_sign alpha]]<br>
+
[[in_muscle_sign()]]<br>
[[index_of alpha]]<br>
+
[[in_mysticality_sign()]]<br>
[[index_of alpha]]<br>
+
[[index_of()]]<br>
[[inebriety_limit alpha]]<br>
+
[[inebriety_limit()]]<br>
[[initiative_modifier alpha]]<br>
+
[[initiative_modifier()]]<br>
[[insert alpha]]<br>
+
[[insert()]]<br>
[[is_npc_item alpha]]<br>
+
[[is_npc_item()]]<br>
[[is_tradeable alpha]]<br>
+
[[is_tradeable()]]<br>
[[item_amount alpha]]<br>
+
[[item_amount()]]<br>
[[item_drop_modifier alpha]]<br>
+
[[item_drop_modifier()]]<br>
[[item_drops alpha]]<br>
+
[[item_drops()]]<br>
[[item_type alpha]]<br>
+
[[item_type()]]<br>
  
 
='''J'''=
 
='''J'''=
Line 118: Line 118:
  
 
='''L'''=
 
='''L'''=
[[last_index_of alpha]]<br>
+
[[last_index_of()]]<br>
[[length alpha]]<br>
+
[[length()]]<br>
[[load_html alpha]]<br>
+
[[load_html()]]<br>
[[logprint alpha]]<br>
+
[[logprint()]]<br>
  
 
='''M'''=
 
='''M'''=
[[mana_cost_modifier alpha]]<br>
+
[[mana_cost_modifier()]]<br>
[[map_to_file alpha]]<br>
+
[[map_to_file()]]<br>
[[meat_drop_modifier alpha]]<br>
+
[[meat_drop_modifier()]]<br>
[[monster_attack alpha]]<br>
+
[[monster_attack()]]<br>
[[monster_defense alpha]]<br>
+
[[monster_defense()]]<br>
[[monster_element alpha]]<br>
+
[[monster_element()]]<br>
[[monster_hp alpha]]<br>
+
[[monster_hp()]]<br>
[[monster_level_adjustment alpha]]<br>
+
[[monster_level_adjustment()]]<br>
[[moon_light alpha]]<br>
+
[[moon_light()]]<br>
[[moon_phase alpha]]<br>
+
[[moon_phase()]]<br>
[[mp_cost alpha]]<br>
+
[[mp_cost()]]<br>
[[my_adventures alpha]]<br>
+
[[my_adventures()]]<br>
[[my_basestat alpha]]<br>
+
[[my_basestat()]]<br>
[[my_buffedstat alpha]]<br>
+
[[my_buffedstat()]]<br>
[[my_class alpha]]<br>
+
[[my_class()]]<br>
[[my_familiar alpha]]<br>
+
[[my_familiar()]]<br>
[[my_fullness alpha]]<br>
+
[[my_fullness()]]<br>
[[my_hash alpha]]<br>
+
[[my_hash()]]<br>
[[my_hp alpha]]<br>
+
[[my_hp()]]<br>
[[my_id alpha]]<br>
+
[[my_id()]]<br>
[[my_inebriety alpha]]<br>
+
[[my_inebriety()]]<br>
[[my_level alpha]]<br>
+
[[my_level()]]<br>
[[my_location alpha]]<br>
+
[[my_location()]]<br>
[[my_maxhp alpha]]<br>
+
[[my_maxhp()]]<br>
[[my_maxmp alpha]]<br>
+
[[my_maxmp()]]<br>
[[my_meat alpha]]<br>
+
[[my_meat()]]<br>
[[my_mp alpha]]<br>
+
[[my_mp()]]<br>
[[my_name alpha]]<br>
+
[[my_name()]]<br>
[[my_primestat alpha]]<br>
+
[[my_primestat()]]<br>
[[my_spleen_use alpha]]<br>
+
[[my_spleen_use()]]<br>
[[my_turncount alpha]]<br>
+
[[my_turncount()]]<br>
  
 
='''N'''=
 
='''N'''=
[[notify alpha]]<br>
+
[[notify]]<br>
[[numeric_modifier alpha]]<br>
+
[[numeric_modifier()]]<br>
  
 
='''O'''=
 
='''O'''=
[[outfit alpha]]<br>
+
[[outfit()]]<br>
  
 
='''P'''=
 
='''P'''=
[[print alpha]]<br>
+
[[print()]]<br>
[[print_html alpha]]<br>
+
[[print_html()]]<br>
[[put_closet alpha]]<br>
+
[[put_closet()]]<br>
[[put_display alpha]]<br>
+
[[put_display()]]<br>
[[pulls_remaining alpha]]<br>
+
[[pulls_remaining()]]<br>
[[put_shop alpha]]<br>
+
[[put_shop()]]<br>
[[put_stash alpha]]<br>
+
[[put_stash()]]<br>
  
 
='''Q'''=
 
='''Q'''=
  
 
='''R'''=
 
='''R'''=
[[random alpha]]<br>
+
[[random()]]<br>
[[raw_damage_absorption alpha]]<br>
+
[[raw_damage_absorption()]]<br>
[[retrieve_item alpha]]<br>
+
[[retrieve_item()]]<br>
[[refresh_stash alpha]]<br>
+
[[refresh_stash()]]<br>
[[refresh_status alpha]]<br>
+
[[refresh_status()]]<br>
[[replace alpha]]<br>
+
[[replace()]]<br>
[[replace_all alpha]]<br>
+
[[replace_all()]]<br>
[[replace_first alpha]]<br>
+
[[replace_first()]]<br>
[[replace_string alpha]]<br>
+
[[replace_string()]]<br>
[[reset alpha]]<br>
+
[[reset()]]<br>
[[restore_hp alpha]]<br>
+
[[restore_hp()]]<br>
[[restore_mp alpha]]<br>
+
[[restore_mp()]]<br>
[[round alpha]]<br>
+
[[round()]]<br>
[[run_combat alpha]]<br>
+
[[run_combat()]]<br>
[[runaway alpha]]<br>
+
[[runaway()]]<br>
  
 
='''S'''=
 
='''S'''=
[[session_logs alpha]]<br>
+
[[session_logs()]]<br>
[[set_property alpha]]<br>
+
[[set_property()]]<br>
[[shop_amount alpha]]<br>
+
[[shop_amount()]]<br>
[[spleen_limit alpha]]<br>
+
[[spleen_limit()]]<br>
[[split_string alpha]]<br>
+
[[split_string()]]<br>
[[start alpha]]<br>
+
[[start()]]<br>
[[stash_amount alpha]]<br>
+
[[stash_amount()]]<br>
[[stat_bonus_today alpha]]<br>
+
[[stat_bonus_today()]]<br>
[[stat_bonus_tomorrow alpha]]<br>
+
[[stat_bonus_tomorrow()]]<br>
[[stat_modifier alpha]]<br>
+
[[stat_modifier()]]<br>
[[steal alpha]]<br>
+
[[steal()]]<br>
[[stills_available alpha]]<br>
+
[[stills_available()]]<br>
[[storage_amount alpha]]<br>
+
[[storage_amount()]]<br>
[[substring alpha]]<br>
+
[[substring()]]<br>
[[square_root alpha]]<br>
+
[[square_root()]]<br>
  
 
='''T'''=
 
='''T'''=
[[take_closet alpha]]<br>
+
[[take_closet()]]<br>
[[take_display alpha]]<br>
+
[[take_display()]]<br>
[[take_stash alpha]]<br>
+
[[take_stash()]]<br>
[[take_storage alpha]]<br>
+
[[take_storage()]]<br>
[[tavern alpha]]<br>
+
[[tavern()]]<br>
[[throw_item alpha]]<br>
+
[[throw_item()]]<br>
[[throw_items alpha]]<br>
+
[[throw_items()]]<br>
[[to_boolean alpha]]<br>
+
[[to_boolean()]]<br>
[[to_class alpha]]<br>
+
[[to_class()]]<br>
[[to_effect alpha]]<br>
+
[[to_effect()]]<br>
[[to_familiar alpha]]<br>
+
[[to_familiar()]]<br>
[[to_float alpha]]<br>
+
[[to_float()]]<br>
[[to_int alpha]]<br>
+
[[to_int()]]<br>
[[to_item alpha]] <---- example of a simple overloaded function<br>
+
[[to_item()]] <---- example of a simple overloaded function<br>
[[to_location alpha]]<br>
+
[[to_location()]]<br>
[[to_lower_case alpha]]<br>
+
[[to_lower_case()]]<br>
[[to_monster alpha]]<br>
+
[[to_monster()]]<br>
[[to_skill alpha]]<br>
+
[[to_skill()]]<br>
[[to_slot alpha]]<br>
+
[[to_slot()]]<br>
[[to_stat alpha]]<br>
+
[[to_stat()]]<br>
[[to_string alpha]]<br>
+
[[to_string()]]<br>
[[to_upper_case alpha]]<br>
+
[[to_upper_case()]]<br>
[[to_url alpha]]<br>
+
[[to_url()]]<br>
[[today_to_string alpha]]<br>
+
[[today_to_string()]]<br>
[[truncate alpha]]<br>
+
[[truncate()]]<br>
[[turns_played alpha]]<br>
+
[[turns_played()]]<br>
[[turns_per_cast alpha]]<br>
+
[[turns_per_cast()]]<br>
  
 
='''U'''=
 
='''U'''=
[[url_decode alpha]]<br>
+
[[url_decode()]]<br>
[[url_encode alpha]]<br>
+
[[url_encode()]]<br>
[[use alpha]]<br>
+
[[use()]]<br>
[[use_familiar alpha]]<br>
+
[[use_familiar()]]<br>
[[use_skill alpha]]<br>
+
[[use_skill()]]<br>
[[user_confirm alpha]]<br>
+
[[user_confirm()]]<br>
  
 
='''V'''=
 
='''V'''=
[[visit_url alpha]]<br>  
+
[[visit_url()]]<br>  
  
 
='''W'''=
 
='''W'''=
[[wait alpha]]<br>
+
[[wait()]]<br>
[[weapon_hands alpha]]<br>
+
[[weapon_hands()]]<br>
[[weapon_type alpha]]<br>
+
[[weapon_type()]]<br>
[[weight_adjustment alpha]]<br>
+
[[weight_adjustment()]]<br>
[[will_usually_miss alpha]]<br>
+
[[will_usually_miss()]]<br>
[[will_usually_dodge alpha]]<br>
+
[[will_usually_dodge()]]<br>
[[write alpha]]<br>
+
[[write()]]<br>
[[writeln alpha]]<br>
+
[[writeln()]]<br>
  
 
='''X'''=
 
='''X'''=

Revision as of 04:01, 31 January 2009

This is a good jump-off point for creating ASH function documentation.  Any of the red links have not yet been created.  Feel free.

A

abort() <--example of a command that is usable in both the gCLI and ash
add_item_condition()
adventure()
append()
append_tail()
append_replacement()
attack() <-- example of a command that is consult script only
autosell()
available_amount() <---example of a command that is ash/consult script only

B

boolean_modifier()
buffed_hit_stat()
buy()

C

can_drink()
can_eat()
can_equip()
can_interact()
ceil()
chamber()
change_mcd()
chat_reply()
class_modifier()
clear()
cli_execute()
closet_amount()
combat_rate_modifier()
contains_text()
council()
count()
creatable_amount()
create()
create_matcher()
current_hit_stat()
current_mcd()

D

daily_special()
damage_absorption_percent()
damage_reduction()
delete()
disable()
display_amount()
drink()

E

eat()
effect_modifier()
elemental_resistance()
end()
enable()
entryway()
equip()
equipped_item()
extract_items()
extract_meat()
expected_damage()
experience_bonus()

F

familiar_equipment()
familiar_weight()
file_to_map()
find()
form_field()
floor()
fullness_limit()

G

get_ingredients()
get_inventory()
get_monsters()
get_power()
get_property()
group()
group_count()
group_string()
guardians()

H

have_bartender()
have_chef()
have_effect()
have_equipped()
have_familiar()
have_mushroom_plot()
have_outfit()
have_skill()
hedgemaze()
hermit()

I

import
in_bad_moon()
in_hardcore()
in_moxie_sign()
in_muscle_sign()
in_mysticality_sign()
index_of()
inebriety_limit()
initiative_modifier()
insert()
is_npc_item()
is_tradeable()
item_amount()
item_drop_modifier()
item_drops()
item_type()

J

K

L

last_index_of()
length()
load_html()
logprint()

M

mana_cost_modifier()
map_to_file()
meat_drop_modifier()
monster_attack()
monster_defense()
monster_element()
monster_hp()
monster_level_adjustment()
moon_light()
moon_phase()
mp_cost()
my_adventures()
my_basestat()
my_buffedstat()
my_class()
my_familiar()
my_fullness()
my_hash()
my_hp()
my_id()
my_inebriety()
my_level()
my_location()
my_maxhp()
my_maxmp()
my_meat()
my_mp()
my_name()
my_primestat()
my_spleen_use()
my_turncount()

N

notify
numeric_modifier()

O

outfit()

P

print()
print_html()
put_closet()
put_display()
pulls_remaining()
put_shop()
put_stash()

Q

R

random()
raw_damage_absorption()
retrieve_item()
refresh_stash()
refresh_status()
replace()
replace_all()
replace_first()
replace_string()
reset()
restore_hp()
restore_mp()
round()
run_combat()
runaway()

S

session_logs()
set_property()
shop_amount()
spleen_limit()
split_string()
start()
stash_amount()
stat_bonus_today()
stat_bonus_tomorrow()
stat_modifier()
steal()
stills_available()
storage_amount()
substring()
square_root()

T

take_closet()
take_display()
take_stash()
take_storage()
tavern()
throw_item()
throw_items()
to_boolean()
to_class()
to_effect()
to_familiar()
to_float()
to_int()
to_item() <---- example of a simple overloaded function
to_location()
to_lower_case()
to_monster()
to_skill()
to_slot()
to_stat()
to_string()
to_upper_case()
to_url()
today_to_string()
truncate()
turns_played()
turns_per_cast()

U

url_decode()
url_encode()
use()
use_familiar()
use_skill()
user_confirm()

V

visit_url()

W

wait()
weapon_hands()
weapon_type()
weight_adjustment()
will_usually_miss()
will_usually_dodge()
write()
writeln()

X

Y

Z