Difference between revisions of "Ash Functions"
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 | + | 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'''= | ='''A'''= | ||
− | [[abort | + | [[abort()]] <--example of a command that is usable in both the gCLI and ash<br> |
− | [[add_item_condition | + | [[add_item_condition()]]<br> |
− | [[adventure | + | [[adventure()]]<br> |
− | [[append | + | [[append()]]<br> |
− | [[append_tail | + | [[append_tail()]]<br> |
− | [[append_replacement | + | [[append_replacement()]]<br> |
− | [[attack | + | [[attack()]] <-- example of a command that is consult script only<br> |
− | [[autosell | + | [[autosell()]]<br> |
− | [[available_amount | + | [[available_amount()]] <---example of a command that is ash/consult script only<br> |
='''B'''= | ='''B'''= | ||
− | [[boolean_modifier | + | [[boolean_modifier()]]<br> |
− | [[buffed_hit_stat | + | [[buffed_hit_stat()]]<br> |
− | [[buy | + | [[buy()]]<br> |
='''C'''= | ='''C'''= | ||
− | [[can_drink | + | [[can_drink()]]<br> |
− | [[can_eat | + | [[can_eat()]]<br> |
− | [[can_equip | + | [[can_equip()]]<br> |
− | [[can_interact | + | [[can_interact()]]<br> |
− | [[ceil | + | [[ceil()]]<br> |
− | [[chamber | + | [[chamber()]]<br> |
− | [[change_mcd | + | [[change_mcd()]]<br> |
− | [[chat_reply | + | [[chat_reply()]]<br> |
− | [[class_modifier | + | [[class_modifier()]]<br> |
− | [[clear | + | [[clear()]]<br> |
− | [[cli_execute | + | [[cli_execute()]]<br> |
− | [[closet_amount | + | [[closet_amount()]]<br> |
− | [[combat_rate_modifier | + | [[combat_rate_modifier()]]<br> |
− | [[contains_text | + | [[contains_text()]]<br> |
− | [[council | + | [[council()]]<br> |
− | [[count | + | [[count()]]<br> |
− | [[creatable_amount | + | [[creatable_amount()]]<br> |
− | [[create | + | [[create()]]<br> |
− | [[create_matcher | + | [[create_matcher()]]<br> |
− | [[current_hit_stat | + | [[current_hit_stat()]]<br> |
− | [[current_mcd | + | [[current_mcd()]]<br> |
='''D'''= | ='''D'''= | ||
− | [[daily_special | + | [[daily_special()]]<br> |
− | [[damage_absorption_percent | + | [[damage_absorption_percent()]]<br> |
− | [[damage_reduction | + | [[damage_reduction()]]<br> |
− | [[delete | + | [[delete()]]<br> |
− | [[disable | + | [[disable()]]<br> |
− | [[display_amount | + | [[display_amount()]]<br> |
− | [[drink | + | [[drink()]]<br> |
='''E'''= | ='''E'''= | ||
− | [[eat | + | [[eat()]]<br> |
− | [[effect_modifier | + | [[effect_modifier()]]<br> |
− | [[elemental_resistance | + | [[elemental_resistance()]]<br> |
− | [[end | + | [[end()]]<br> |
− | [[enable | + | [[enable()]]<br> |
− | [[entryway | + | [[entryway()]]<br> |
− | [[equip | + | [[equip()]]<br> |
− | [[equipped_item | + | [[equipped_item()]]<br> |
− | [[extract_items | + | [[extract_items()]]<br> |
− | [[extract_meat | + | [[extract_meat()]]<br> |
− | [[expected_damage | + | [[expected_damage()]]<br> |
− | [[experience_bonus | + | [[experience_bonus()]]<br> |
='''F'''= | ='''F'''= | ||
− | [[familiar_equipment | + | [[familiar_equipment()]]<br> |
− | [[familiar_weight | + | [[familiar_weight()]]<br> |
− | [[file_to_map | + | [[file_to_map()]]<br> |
− | [[find | + | [[find()]]<br> |
− | [[form_field | + | [[form_field()]]<br> |
− | [[floor | + | [[floor()]]<br> |
− | [[fullness_limit | + | [[fullness_limit()]]<br> |
='''G'''= | ='''G'''= | ||
− | [[get_ingredients | + | [[get_ingredients()]]<br> |
− | [[get_inventory | + | [[get_inventory()]]<br> |
− | [[get_monsters | + | [[get_monsters()]]<br> |
− | [[get_power | + | [[get_power()]]<br> |
− | [[get_property | + | [[get_property()]]<br> |
− | [[group | + | [[group()]]<br> |
− | [[group_count | + | [[group_count()]]<br> |
− | [[group_string | + | [[group_string()]]<br> |
− | [[guardians | + | [[guardians()]]<br> |
='''H'''= | ='''H'''= | ||
− | [[have_bartender | + | [[have_bartender()]]<br> |
− | [[have_chef | + | [[have_chef()]]<br> |
− | [[have_effect | + | [[have_effect()]]<br> |
− | [[have_equipped | + | [[have_equipped()]]<br> |
− | [[have_familiar | + | [[have_familiar()]]<br> |
− | [[have_mushroom_plot | + | [[have_mushroom_plot()]]<br> |
− | [[have_outfit | + | [[have_outfit()]]<br> |
− | [[have_skill | + | [[have_skill()]]<br> |
− | [[hedgemaze | + | [[hedgemaze()]]<br> |
− | [[hermit | + | [[hermit()]]<br> |
='''I'''= | ='''I'''= | ||
− | [[ | + | [[import]]<br> |
− | [[ | + | [[in_bad_moon()]]<br> |
− | [[ | + | [[in_hardcore()]]<br> |
− | [[ | + | [[in_moxie_sign()]]<br> |
− | [[ | + | [[in_muscle_sign()]]<br> |
− | [[ | + | [[in_mysticality_sign()]]<br> |
− | [[index_of | + | [[index_of()]]<br> |
− | [[inebriety_limit | + | [[inebriety_limit()]]<br> |
− | [[initiative_modifier | + | [[initiative_modifier()]]<br> |
− | [[insert | + | [[insert()]]<br> |
− | [[is_npc_item | + | [[is_npc_item()]]<br> |
− | [[is_tradeable | + | [[is_tradeable()]]<br> |
− | [[item_amount | + | [[item_amount()]]<br> |
− | [[item_drop_modifier | + | [[item_drop_modifier()]]<br> |
− | [[item_drops | + | [[item_drops()]]<br> |
− | [[item_type | + | [[item_type()]]<br> |
='''J'''= | ='''J'''= | ||
Line 118: | Line 118: | ||
='''L'''= | ='''L'''= | ||
− | [[last_index_of | + | [[last_index_of()]]<br> |
− | [[length | + | [[length()]]<br> |
− | [[load_html | + | [[load_html()]]<br> |
− | [[logprint | + | [[logprint()]]<br> |
='''M'''= | ='''M'''= | ||
− | [[mana_cost_modifier | + | [[mana_cost_modifier()]]<br> |
− | [[map_to_file | + | [[map_to_file()]]<br> |
− | [[meat_drop_modifier | + | [[meat_drop_modifier()]]<br> |
− | [[monster_attack | + | [[monster_attack()]]<br> |
− | [[monster_defense | + | [[monster_defense()]]<br> |
− | [[monster_element | + | [[monster_element()]]<br> |
− | [[monster_hp | + | [[monster_hp()]]<br> |
− | [[monster_level_adjustment | + | [[monster_level_adjustment()]]<br> |
− | [[moon_light | + | [[moon_light()]]<br> |
− | [[moon_phase | + | [[moon_phase()]]<br> |
− | [[mp_cost | + | [[mp_cost()]]<br> |
− | [[my_adventures | + | [[my_adventures()]]<br> |
− | [[my_basestat | + | [[my_basestat()]]<br> |
− | [[my_buffedstat | + | [[my_buffedstat()]]<br> |
− | [[my_class | + | [[my_class()]]<br> |
− | [[my_familiar | + | [[my_familiar()]]<br> |
− | [[my_fullness | + | [[my_fullness()]]<br> |
− | [[my_hash | + | [[my_hash()]]<br> |
− | [[my_hp | + | [[my_hp()]]<br> |
− | [[my_id | + | [[my_id()]]<br> |
− | [[my_inebriety | + | [[my_inebriety()]]<br> |
− | [[my_level | + | [[my_level()]]<br> |
− | [[my_location | + | [[my_location()]]<br> |
− | [[my_maxhp | + | [[my_maxhp()]]<br> |
− | [[my_maxmp | + | [[my_maxmp()]]<br> |
− | [[my_meat | + | [[my_meat()]]<br> |
− | [[my_mp | + | [[my_mp()]]<br> |
− | [[my_name | + | [[my_name()]]<br> |
− | [[my_primestat | + | [[my_primestat()]]<br> |
− | [[my_spleen_use | + | [[my_spleen_use()]]<br> |
− | [[my_turncount | + | [[my_turncount()]]<br> |
='''N'''= | ='''N'''= | ||
− | [[notify | + | [[notify]]<br> |
− | [[numeric_modifier | + | [[numeric_modifier()]]<br> |
='''O'''= | ='''O'''= | ||
− | [[outfit | + | [[outfit()]]<br> |
='''P'''= | ='''P'''= | ||
− | [[print | + | [[print()]]<br> |
− | [[print_html | + | [[print_html()]]<br> |
− | [[put_closet | + | [[put_closet()]]<br> |
− | [[put_display | + | [[put_display()]]<br> |
− | [[pulls_remaining | + | [[pulls_remaining()]]<br> |
− | [[put_shop | + | [[put_shop()]]<br> |
− | [[put_stash | + | [[put_stash()]]<br> |
='''Q'''= | ='''Q'''= | ||
='''R'''= | ='''R'''= | ||
− | [[random | + | [[random()]]<br> |
− | [[raw_damage_absorption | + | [[raw_damage_absorption()]]<br> |
− | [[retrieve_item | + | [[retrieve_item()]]<br> |
− | [[refresh_stash | + | [[refresh_stash()]]<br> |
− | [[refresh_status | + | [[refresh_status()]]<br> |
− | [[replace | + | [[replace()]]<br> |
− | [[replace_all | + | [[replace_all()]]<br> |
− | [[replace_first | + | [[replace_first()]]<br> |
− | [[replace_string | + | [[replace_string()]]<br> |
− | [[reset | + | [[reset()]]<br> |
− | [[restore_hp | + | [[restore_hp()]]<br> |
− | [[restore_mp | + | [[restore_mp()]]<br> |
− | [[round | + | [[round()]]<br> |
− | [[run_combat | + | [[run_combat()]]<br> |
− | [[runaway | + | [[runaway()]]<br> |
='''S'''= | ='''S'''= | ||
− | [[session_logs | + | [[session_logs()]]<br> |
− | [[set_property | + | [[set_property()]]<br> |
− | [[shop_amount | + | [[shop_amount()]]<br> |
− | [[spleen_limit | + | [[spleen_limit()]]<br> |
− | [[split_string | + | [[split_string()]]<br> |
− | [[start | + | [[start()]]<br> |
− | [[stash_amount | + | [[stash_amount()]]<br> |
− | [[stat_bonus_today | + | [[stat_bonus_today()]]<br> |
− | [[stat_bonus_tomorrow | + | [[stat_bonus_tomorrow()]]<br> |
− | [[stat_modifier | + | [[stat_modifier()]]<br> |
− | [[steal | + | [[steal()]]<br> |
− | [[stills_available | + | [[stills_available()]]<br> |
− | [[storage_amount | + | [[storage_amount()]]<br> |
− | [[substring | + | [[substring()]]<br> |
− | [[square_root | + | [[square_root()]]<br> |
='''T'''= | ='''T'''= | ||
− | [[take_closet | + | [[take_closet()]]<br> |
− | [[take_display | + | [[take_display()]]<br> |
− | [[take_stash | + | [[take_stash()]]<br> |
− | [[take_storage | + | [[take_storage()]]<br> |
− | [[tavern | + | [[tavern()]]<br> |
− | [[throw_item | + | [[throw_item()]]<br> |
− | [[throw_items | + | [[throw_items()]]<br> |
− | [[to_boolean | + | [[to_boolean()]]<br> |
− | [[to_class | + | [[to_class()]]<br> |
− | [[to_effect | + | [[to_effect()]]<br> |
− | [[to_familiar | + | [[to_familiar()]]<br> |
− | [[to_float | + | [[to_float()]]<br> |
− | [[to_int | + | [[to_int()]]<br> |
− | [[to_item | + | [[to_item()]] <---- example of a simple overloaded function<br> |
− | [[to_location | + | [[to_location()]]<br> |
− | [[to_lower_case | + | [[to_lower_case()]]<br> |
− | [[to_monster | + | [[to_monster()]]<br> |
− | [[to_skill | + | [[to_skill()]]<br> |
− | [[to_slot | + | [[to_slot()]]<br> |
− | [[to_stat | + | [[to_stat()]]<br> |
− | [[to_string | + | [[to_string()]]<br> |
− | [[to_upper_case | + | [[to_upper_case()]]<br> |
− | [[to_url | + | [[to_url()]]<br> |
− | [[today_to_string | + | [[today_to_string()]]<br> |
− | [[truncate | + | [[truncate()]]<br> |
− | [[turns_played | + | [[turns_played()]]<br> |
− | [[turns_per_cast | + | [[turns_per_cast()]]<br> |
='''U'''= | ='''U'''= | ||
− | [[url_decode | + | [[url_decode()]]<br> |
− | [[url_encode | + | [[url_encode()]]<br> |
− | [[use | + | [[use()]]<br> |
− | [[use_familiar | + | [[use_familiar()]]<br> |
− | [[use_skill | + | [[use_skill()]]<br> |
− | [[user_confirm | + | [[user_confirm()]]<br> |
='''V'''= | ='''V'''= | ||
− | [[visit_url | + | [[visit_url()]]<br> |
='''W'''= | ='''W'''= | ||
− | [[wait | + | [[wait()]]<br> |
− | [[weapon_hands | + | [[weapon_hands()]]<br> |
− | [[weapon_type | + | [[weapon_type()]]<br> |
− | [[weight_adjustment | + | [[weight_adjustment()]]<br> |
− | [[will_usually_miss | + | [[will_usually_miss()]]<br> |
− | [[will_usually_dodge | + | [[will_usually_dodge()]]<br> |
− | [[write | + | [[write()]]<br> |
− | [[writeln | + | [[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
O
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
W
wait()
weapon_hands()
weapon_type()
weight_adjustment()
will_usually_miss()
will_usually_dodge()
write()
writeln()