Kolmafia - User contributions [en]

Retrieve price

2022-12-27T22:26:32Z

Taltamir:

{{
#vardefine:name|retrieve_price}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
p1desc={{Pspan|get}} is the item to acquire|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
parameter2={{Param|int|qty}}|
p1desc={{Pspan|get}} is the item to acquire|
p2desc={{Pspan|qty}} is the quantity to acquire|
}}|

function3={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
}}|

function4={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
parameter2={{Param|int|qty}}|
parameter3={{Param|boolean|exact}}|
p1desc={{Pspan|get}} is the item to acquire|
p2desc={{Pspan|qty}} is the quantity to acquire|
p3desc={{Pspan|exact}} if true will perform new mallsearch to make sure the price is exact|
}}|

function5={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
parameter3={{Param|boolean|exact}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
p3desc={{Pspan|exact}} if true will perform new mallsearch to make sure the price is exact|
}}|

function_description=Returns the meat worth of item or items. This shares some code with [[retrieve_item]]. It does include the value of items you already own. To determine the value of items you own it uses valueOfInventory preference. 
0.0 - Items already in inventory are considered free. 
1.0 - Items are valued at their autosell price. 
2.0 - Items are valued at current Mall price, unless they are min-priced. 
3.0 - Items are always valued at Mall price (not really realistic). 
Values in between are interpolated. The default value is 1.8.
|

code1={{CodeSample|
title=Code Sample|
description=This is an example of a very simple aftercore logout script.|
code=<syntaxhighlight>
item nightcap = $item[ Mon Tiki ];
int price = retrieve_price(nightcap);
if(price > 30000)
abort( nightcap+ " is unreasonably expensive, it will be a waste to use it. It is worth " +price );
if(my_inebriety() == inebriety_limit())
{
if ( !retrieve_item( nightcap ) )
abort( "Could not make/buy a " + nightcap + " for a nightcap." );
else
overdrink( 1 , nightcap );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|retrieve_item|buy}}|
cli_equiv=?|
}}

[[Category:Item Management]]

Retrieve price

2022-12-27T22:12:47Z

Taltamir:

{{
#vardefine:name|retrieve_price}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
p1desc={{Pspan|get}} is the item to acquire|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
parameter2={{Param|int|qty}}|
p1desc={{Pspan|get}} is the item to acquire|
p2desc={{Pspan|qty}} is the quantity to acquire|
}}|

function3={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
}}|

function4={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
parameter2={{Param|int|qty}}|
parameter3={{Param|boolean|exact}}|
p1desc={{Pspan|get}} is the item to acquire|
p2desc={{Pspan|qty}} is the quantity to acquire|
p3desc={{Pspan|exact}} if true will perform new mallsearch to make sure the price is exact|
}}|

function5={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
parameter3={{Param|boolean|exact}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
p3desc={{Pspan|exact}} if true will perform new mallsearch to make sure the price is exact|
}}|

function_description=Returns the total meat cost of using [[retrieve_item]]. This does include the mall value of items you already own.|

code1={{CodeSample|
title=Code Sample|
description=This is an example of a very simple aftercore logout script.|
code=<syntaxhighlight>
item nightcap = $item[ Mon Tiki ];
int price = retrieve_price(nightcap);
if(price > 30000)
abort( nightcap+ " is unreasonably expensive, it will be a waste to use it. It is worth " +price );
if(my_inebriety() == inebriety_limit())
{
if ( !retrieve_item( nightcap ) )
abort( "Could not make/buy a " + nightcap + " for a nightcap." );
else
overdrink( 1 , nightcap );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|retrieve_item|buy}}|
cli_equiv=?|
}}

[[Category:Item Management]]

Retrieve item

2022-12-27T22:03:55Z

Taltamir: fixed wrong syntax in special which caused on of the special notes to not show up.

{{
#vardefine:name|retrieve_item}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
}}|

function_description=Uses KoLmafia's internal logic to gather the items in the least destructive manner. Returns true if items are acquired as specified and false if not.|

code1={{CodeSample|
title=Code Sample|
description=This is an example of a very simple aftercore logout script.|
code=<syntaxhighlight>
item nightcap = $item[ Mon Tiki ];
while (my_inebriety() <= inebriety_limit())
{
if ( !retrieve_item( 1 , nightcap ) )
abort( "Could not make/buy a " + nightcap + " for a nightcap." );
else
overdrink( 1 , nightcap );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|buy}}|
cli_equiv=The CLI command "acquire" works similarly.|
special=Unlike a few other ASH commands, retrieve_item() will still return false on attempts to acquire items that are not possible to get (such as a sparkly engagement ring).
 
This function and it's CLI equivalent "acquire" will not purchase items from the mall that can not be discarded. This is because many of those items are surprisingly expensive. Such items can be detected by checking to see if their {{f|autosell_price}} is 0. There are a few hard-coded exceptions to this rule: clovers, phials, divine favors, love songs and white rice can all be purchased with this command despite not being discardable.|
more_info=For information on order of operations, see [[Retrieval order]].|
}}
{{RFI|Are there exceptions to the info listed under Special?}}

[[Category:Item Management]]

Retrieve price

2022-12-27T22:01:40Z

Taltamir: Created page with "{{ #vardefine:name|retrieve_price}}{{ #vardefine:return_type|int}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}..."

{{
#vardefine:name|retrieve_price}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
p1desc={{Pspan|get}} is the item to acquire|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
parameter2={{Param|int|qty}}|
p1desc={{Pspan|get}} is the item to acquire|
p2desc={{Pspan|qty}} is the quantity to acquire|
}}|

function3={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
}}|

function4={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|get}}|
parameter2={{Param|int|qty}}|
parameter3={{Param|boolean|exact}}|
p1desc={{Pspan|get}} is the item to acquire|
p2desc={{Pspan|qty}} is the quantity to acquire|
p3desc={{Pspan|exact}} if true will perform new mallsearch to make sure the price is exact|
}}|

function5={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|get}}|
parameter3={{Param|boolean|exact}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
p3desc={{Pspan|exact}} if true will perform new mallsearch to make sure the price is exact|
}}|

function_description=Returns the total meat cost of using [[retrieve_item]]. This does include the mall value of items you already own.|

code1={{CodeSample|
title=Code Sample|
description=This is an example of a very simple aftercore logout script.|
code=<syntaxhighlight>
item nightcap = $item[ Mon Tiki ];
int price = retrieve_price(nightcap);
if(price > 30000)
abort( nightcap+ " is unreasonably expensive. It costs " +price );
if(my_inebriety() == inebriety_limit())
{
if ( !retrieve_item( nightcap ) )
abort( "Could not make/buy a " + nightcap + " for a nightcap." );
else
overdrink( 1 , nightcap );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|retrieve_item|buy}}|
cli_equiv=?|
}}

[[Category:Item Management]]

Talk:Adv1

2020-09-11T04:51:08Z

Taltamir: forgot signature

==PENDING state==
https://kolmafia.us/showthread.php?25370

The above link contains an explanation on when and why adv1 returns false on successful adventuring that lead to a PENDING state
--[[User:Taltamir|Taltamir]] ([[User talk:Taltamir|talk]]) 04:51, 11 September 2020 (UTC)

Talk:Adv1

2020-09-11T04:50:28Z

Taltamir: Created page with "==PENDING state== https://kolmafia.us/showthread.php?25370 The above link contains an explanation on when and why adv1 returns false on successful adventuring that lead to a..."

==PENDING state==
https://kolmafia.us/showthread.php?25370

The above link contains an explanation on when and why adv1 returns false on successful adventuring that lead to a PENDING state

Adv1

2020-09-11T04:48:10Z

Taltamir:

{{
#vardefine:name|adv1}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|location|place}}|
parameter2={{Param|int|turnsUsed}}|
parameter3={{Param|string|filterFunc}}|
p1desc={{Pspan|place}} is the adventuring location.|
p2desc={{Pspan|turnsUsed}} overrides the normal number of adventures that are expected to be consumed at this location, or -1 can be passed to use the default. Specifically, 0 will prevent any counters from triggering - of course, if an adventure actually is consumed, any counters that you kept from triggering will be lost.|
p3desc={{Pspan|filterFunc}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of [[adventure]](). An empty string can be passed to use your battle action or CCS as normal.}}|

function_description=This will adventure exactly once in the specified {{pspan|place}} (even if it took no turns), although it will follow chained choice adventures for as long as you have preset options.

If {{Pspan|filter}} contains a semicolon it will use {{Pspan|filter}} as a macro.
This function does not have to make use of its return value, but if you wish to do so, it will return true if all adventures were used. It will return false if it is unable to do so for any reason (not enough adventures, location unavailable, etc.). It will also return false when you successfully adventured in a zone but mafia was put into PENDING state, which indicates that we might be done adventuring in this location (usually because we successfully finished the quest related action in that zone)

|code1={{CodeSample|
title=Code Sample|
description=Adventures 1 time at the Slime Tube. If an adventure takes no turns, possibly because the Gall Bladder was already squeezed, that adventure will still count. Counters will trigger as normal.|
code=
<syntaxhighlight>
adv1($location[slime tube], -1, "");
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|run_combat|run_choice}}|
cli_equiv=None - "adv" will always try adventuring again if an adventure took no turns.|
}}

[[Category:Adventuring]]

Run combat

2020-06-28T04:07:18Z

Taltamir: as of r20210 mafia no longer requires special abort procedure for combat filter function

{{
#vardefine:name|run_combat}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|filter}}|
p1desc={{Pspan|filter}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=Proceeds to run a combat using your current KoLmafia settings. This function returns the HTML from the final round of combat (not just what is displayed, but all markup). Most commonly used to finish up combats started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up combats that were started in the relay browser, or were interrupted (causing mafia to pop up the minibrowser). Typing "ashq run_combat()" into the CLI will finish up the combat for you using your current CCS/battle action. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire combat results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = visit_url("choice.php?pwd&whichchoice="+ choiceAdventure +"&option="+ choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_choice|run_turn}}|

special=Will return the text of the last combat encounter when called independently of a fight page.

Using run_combat() to execute fights will not do the normal post-fight processing that mafia normally performs with [[adv1]] or [[adventure]].
*it will not cause your afterAdventureScript to run
*it will not trigger post-combat restoration
*it will not check if adventuring goals have been met
*it does not obey counter aborts (e.g. fortune cookie)
*it does not update mafia's custom quest progress properties (e.g. palindomeDudesDefeated)
|
}}

[[Category:Adventuring]]

Is unrestricted

2020-06-18T18:17:16Z

Taltamir:

{{
#vardefine:name|is_unrestricted}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|check}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|familiar|check}}|
}}|

function3={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|skill|check}}|
}}|

function4={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|check}}|
}}|

function_description=Checks whether {{pspan|check}} is available for use, given current standard restrictions. It does not check for path restrictions|

code1={{CodeSample|
title=Code Sample|
description=This will attempt to fax in a blooper.|
code=
<syntaxhighlight>
if(is_unrestricted("deluxe fax machine")) {
faxbot($monster[blooper]);
}
else {
print("Fax machine is not available", "red");
}
</syntaxhighlight>}}

}}

[[Category:Your_Character]]

Run combat

2020-06-15T20:24:27Z

Taltamir:

{{
#vardefine:name|run_combat}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|filter}}|
p1desc={{Pspan|filter}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=Proceeds to run a combat using your current KoLmafia settings. This function returns the HTML from the final round of combat (not just what is displayed, but all markup). Most commonly used to finish up combats started via [[visit_url|visit_url()]].

Note that while using a filter function an abort() command will not stop your script, instead defaulting to your CCS for combat. To abort you need to have the filter function return "abort" as a string

Another handy use for this function is to finish up combats that were started in the relay browser, or were interrupted (causing mafia to pop up the minibrowser). Typing "ashq run_combat()" into the CLI will finish up the combat for you using your current CCS/battle action. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire combat results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = visit_url("choice.php?pwd&whichchoice="+ choiceAdventure +"&option="+ choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_choice|run_turn}}|

special=Will return the text of the last combat encounter when called independently of a fight page.

Using run_combat() to execute fights will not do the normal post-fight processing that mafia normally performs with [[adv1]] or [[adventure]].
*it will not cause your afterAdventureScript to run
*it will not trigger post-combat restoration
*it will not check if adventuring goals have been met
*it does not obey counter aborts (e.g. fortune cookie)
*it does not update mafia's custom quest progress properties (e.g. palindomeDudesDefeated)
|
}}

[[Category:Adventuring]]

Get player id

2020-06-01T20:01:49Z

Taltamir:

{{
#vardefine:name|get_player_id}}{{
#vardefine:return_type|string}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|player}}|
}}|

function_description=Returns the user id number of a given player. If KoLmafia does not already know the player's id number, it will return the input string.|

code1={{CodeSample|
title=Code Sample|
description=Get user id so that we can check the user's page for their current class.|
code=
<syntaxhighlight>
class player_to_class( string player ) {
string id = get_player_id( name );
matcher classy = create_matcher( "Class:</td><td>(.+?)</td>", visit_url( "showplayer.php?who=" + id ) );
if(find(classy))
return classy.group(1).to_class();
return $class[none];
}
</syntaxhighlight>|

}}|
}}
{{SeeAlso|my_name|my_id|get_clan_id|get_clan_name}}

[[Category:Miscellaneous Functions]]

Ash Functions

2020-05-20T03:00:07Z

Taltamir: /* m */ mmg functions have been removed from mafia since mmg was removed from kol

{{TOCright}}
Master list of all ASH functions. All functions as of r8144 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
The CLI command "[[ashref]]" shows every implemented ash function for your mafia version.
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|int|adv_cost|skill}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|string [int]|all_normal_outfits}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
{{Flink|string [int]|available_choice_options|{{opt|boolean}}}}

===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|bjornify_familiar|familiar}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|{{opt|string}}|string}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buy_using_storage|int|item}}
{{Flink|int|buy_using_storage|int|item|int}}
{{Flink|boolean|buys_item|coinmaster|item}}

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{Flink|boolean|cli_execute|string}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{Flink|boolean|contains_text|string|string}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|boolean|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|{{opt|item}}|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|void|disable|string}}
{{flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{Flink|boolean|drink|int|item}}

===e===
{{Flink|boolean|eat|int|item}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|float|elemental_resistance|element}}
{{Flink|float|elemental_resistance|{{opt|monster}}}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|boolean|galaktik_cures_discounted}}
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|monster [int]|get_monsters|location}}
{{Flink|string [int]|get_moods}}
{{Flink|string [int]|get_outfits}}
{{Flink|string|get_path}}
{{Flink|string|get_path_full}}
{{Flink|string|get_path_variables}}
{{Flink|string|get_player_id|string}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{flink|boolean|gnomads_available}}
{{flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|int|group_count|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_store_available}}

===h===
{{Flink|boolean|have_bartender}}
{{Flink|boolean|have_chef}}
{{Flink|boolean|have_display}}
{{Flink|int|have_effect|effect}}
{{Flink|boolean|have_equipped|item}}
{{Flink|boolean|have_familiar|familiar}}
{{Flink|boolean|have_mushroom_plot}}
{{Flink|boolean|have_outfit|string}}
{{Flink|boolean|have_servant|servant}}
{{Flink|boolean|have_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hermit|int|item}}
{{flink|boolean|hidden_temple_unlocked}}
{{Flink|boolean|hippy_stone_broken}}
{{Flink|boolean|hippy_store_available}}
{{Flink|float|historical_age|item}}
{{Flink|int|historical_price|item}}
{{Flink|string|holiday}}

===i===
{{Flink|monster|image_to_monster|strict_string}}
{{Flink|boolean|in_bad_moon}}
{{Flink|boolean|in_hardcore}}
{{Flink|boolean|in_moxie_sign}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{Flink|int|index_of|string|string|{{opt|int}}}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}}}
{{Flink|string|item_type|item}}

===j===
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}

===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_factoids_available|monster|boolean}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_initiative|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|string|monster_manuel_text|monster}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|void|mood_execute}}
{{Flink|string [0]|mood_list}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_absorbs}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_audience}}
{{Flink|int|my_basestat|stat}}
{{Flink|familiar|my_bjorned_familiar}}
{{Flink|int|my_buffedstat|stat}}
{{Flink|class|my_class}}
{{Flink|int|my_closet_meat}}
{{Flink|string|my_companion}}
{{Flink|int|my_daycount}}
{{Flink|int|my_discomomentum}}
{{Flink|familiar|my_effective_familiar}}
{{Flink|int [effect]|my_effects}}
{{Flink|familiar|my_enthroned_familiar}}
{{Flink|familiar|my_familiar}}
{{Flink|int|my_fullness}}
{{Flink|int|my_fury}}
{{Flink|string|my_garden_type}}
{{Flink|string|my_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{flink|int|my_lightning}}
{{Flink|location|my_location}}
{{Flink|string|my_mask}}
{{Flink|int|my_maxfury}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_maxpp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{flink|familiar|my_poke_fam}}
{{Flink|int|my_pp}}
{{Flink|stat|my_primestat}}
{{flink|int|my_rain}}
{{Flink|servant|my_servant|servant}}
{{flink|int|my_session_adv}}
{{flink|int [item]|my_session_items}}
{{flink|int|my_session_meat}}
{{flink|string|my_sign}}
{{flink|int|my_soulsauce}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{flink|thrall|my_thrall}}
{{flink|int|my_thunder}}
{{Flink|int|my_turncount}}
{{Flink|vykea|my_vykea_companion}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|{{opt|string}}|string}}
{{Flink|float|numeric_modifier|item|string}}
{{Flink|float|numeric_modifier|effect|string}}
{{Flink|float|numeric_modifier|skill|string}}
{{Flink|float|numeric_modifier|familiar|string|int|item}}

===o===
{{Flink|boolean|outfit|string}}
{{Flink|item [int]|outfit_pieces|string}}
{{Flink|string|outfit_tattoo|{{opt|string}}}}
{{Flink|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|string|property_default_value|string}}
{{Flink|boolean|property_exists|string|{{opt|boolean}}}}
{{Flink|boolean|property_has_default|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|void|refresh_shop}}
{{Flink|void|refresh_stash}}
{{Flink|void|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_property|string|{{opt|boolean}}}}
{{Flink|boolean|rename_property|string|string}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_choice|int}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|boolean|sell|coinmaster|int|item}}
{{Flink|int|sell_price|coinmaster|item}}
{{Flink|boolean|sells_item|coinmaster|item}}
{{Flink|string [int]|session_logs|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int}}
{{Flink|void|set_length|buffer|int}}
{{Flink|void|set_location|location}}
{{Flink|void|set_property|string|string}}
{{Flink|int|shop_amount|item}}
{{Flink|int|shop_price|item}}
{{Flink|int|soulsauce_cost|skill}}
{{Flink|int|spleen_limit}}
{{Flink|string [int]|split_string|string|{{opt|string}}}}
{{Flink|float|square_root|float}}
{{Flink|int|start|matcher|{{opt|int}}}}
{{Flink|int|stash_amount|item}}
{{Flink|stat|stat_bonus_today}}
{{Flink|stat|stat_bonus_tomorrow}}
{{Flink|stat|stat_modifier|effect|string}}
{{Flink|buffer|steal}}
{{Flink|int|stills_available}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|record|svn_info|string}}

===t===
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item}}
{{Flink|int|tavern|{{opt|string}}}}
{{Flink|buffer|throw_item|item}}
{{Flink|buffer|throw_items|item|item}}
{{Flink|int|thunder_cost|skill}}
{{Flink|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|bounty|to_bounty|strict_string}}
{{Flink|class|to_class|strict_string/int}}
{{Flink|coinmaster|to_coinmaster|strict_string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|strict_string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|strict_string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|strict_string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|strict_string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|aggregate}}
{{Flink|location|to_location|strict_string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|strict_string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|servant|to_servant|int}}
{{Flink|servant|to_servant|strict_string}}
{{Flink|skill|to_skill|effect}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|strict_string}}
{{Flink|slot|to_slot|item}}
{{Flink|skill|to_slot|strict_string}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|thrall|to_thrall|{{opt|string}}|{{opt|int}}}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{flink|int|total_free_rests}}
{{flink|int|total_turns_played}}
{{Flink|int|truncate|float}}
{{Flink|int|turns_per_cast|skill}}
{{Flink|int|turns_played}}

===u===
{{Flink|string|url_decode|string}}
{{Flink|string|url_encode|string}}
{{Flink|boolean|use|int|item}}
{{Flink|boolean|use_familiar|familiar}}
{{Flink|boolean|use_servant|servant}}
{{Flink|boolean|use_skill|int|skill|{{opt|string}}}}
{{Flink|buffer|use_skill|skill}}
{{Flink|boolean|user_confirm|string}}
{{Flink|boolean|user_confirm|string|int|boolean}}

===v===
{{Flink|boolean|visit|coinmaster}}
{{Flink|buffer|visit_url|{{opt|string}}|{{opt|boolean}}|{{opt|boolean}}}}

===w===
{{Flink|void|wait|int}}
{{Flink|void|waitq|int}}
{{Flink|int|weapon_hands|item}}
{{Flink|stat|weapon_type|item}}
{{Flink|int|weight_adjustment}}
{{Flink|boolean|white_citadel_available}}
{{Flink|boolean [string]|who_clan|{{opt|string}}}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

===x===
{{Flink|string[int]|xpath|string|string}}

[[Category:Scripting]]

Ash Functions

2020-05-20T02:58:43Z

Taltamir: /* m */ more additions

{{TOCright}}
Master list of all ASH functions. All functions as of r8144 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
The CLI command "[[ashref]]" shows every implemented ash function for your mafia version.
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|int|adv_cost|skill}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|string [int]|all_normal_outfits}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
{{Flink|string [int]|available_choice_options|{{opt|boolean}}}}

===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|bjornify_familiar|familiar}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|{{opt|string}}|string}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buy_using_storage|int|item}}
{{Flink|int|buy_using_storage|int|item|int}}
{{Flink|boolean|buys_item|coinmaster|item}}

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{Flink|boolean|cli_execute|string}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{Flink|boolean|contains_text|string|string}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|boolean|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|{{opt|item}}|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|void|disable|string}}
{{flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{Flink|boolean|drink|int|item}}

===e===
{{Flink|boolean|eat|int|item}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|float|elemental_resistance|element}}
{{Flink|float|elemental_resistance|{{opt|monster}}}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|boolean|galaktik_cures_discounted}}
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|monster [int]|get_monsters|location}}
{{Flink|string [int]|get_moods}}
{{Flink|string [int]|get_outfits}}
{{Flink|string|get_path}}
{{Flink|string|get_path_full}}
{{Flink|string|get_path_variables}}
{{Flink|string|get_player_id|string}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{flink|boolean|gnomads_available}}
{{flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|int|group_count|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_store_available}}

===h===
{{Flink|boolean|have_bartender}}
{{Flink|boolean|have_chef}}
{{Flink|boolean|have_display}}
{{Flink|int|have_effect|effect}}
{{Flink|boolean|have_equipped|item}}
{{Flink|boolean|have_familiar|familiar}}
{{Flink|boolean|have_mushroom_plot}}
{{Flink|boolean|have_outfit|string}}
{{Flink|boolean|have_servant|servant}}
{{Flink|boolean|have_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hermit|int|item}}
{{flink|boolean|hidden_temple_unlocked}}
{{Flink|boolean|hippy_stone_broken}}
{{Flink|boolean|hippy_store_available}}
{{Flink|float|historical_age|item}}
{{Flink|int|historical_price|item}}
{{Flink|string|holiday}}

===i===
{{Flink|monster|image_to_monster|strict_string}}
{{Flink|boolean|in_bad_moon}}
{{Flink|boolean|in_hardcore}}
{{Flink|boolean|in_moxie_sign}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{Flink|int|index_of|string|string|{{opt|int}}}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}}}
{{Flink|string|item_type|item}}

===j===
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}

===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|int|mmg_bet_amount|int}}
{{Flink|string|mmg_bet_owner|int}}
{{Flink|int|mmg_bet_owner_id|int}}
{{Flink|string|mmg_bet_taker}}
{{Flink|string|mmg_bet_taker_id}}
{{Flink|int|mmg_bet_winnings}}
{{Flink|int|mmg_make_bet|int|boolean}}
{{Flink|int [int]|mmg_my_bets}}
{{Flink|int [int]|mmg_offered_bets}}
{{Flink|boolean|mmg_retract_bet|int}}
{{Flink|void|mmg_search|int|int}}
{{Flink|int|mmg_take_bet|int|boolean}}
{{Flink|void|mmg_visit}}
{{Flink|int|mmg_wait_event|int}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_factoids_available|monster|boolean}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_initiative|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|string|monster_manuel_text|monster}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|void|mood_execute}}
{{Flink|string [0]|mood_list}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_absorbs}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_audience}}
{{Flink|int|my_basestat|stat}}
{{Flink|familiar|my_bjorned_familiar}}
{{Flink|int|my_buffedstat|stat}}
{{Flink|class|my_class}}
{{Flink|int|my_closet_meat}}
{{Flink|string|my_companion}}
{{Flink|int|my_daycount}}
{{Flink|int|my_discomomentum}}
{{Flink|familiar|my_effective_familiar}}
{{Flink|int [effect]|my_effects}}
{{Flink|familiar|my_enthroned_familiar}}
{{Flink|familiar|my_familiar}}
{{Flink|int|my_fullness}}
{{Flink|int|my_fury}}
{{Flink|string|my_garden_type}}
{{Flink|string|my_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{flink|int|my_lightning}}
{{Flink|location|my_location}}
{{Flink|string|my_mask}}
{{Flink|int|my_maxfury}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_maxpp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{flink|familiar|my_poke_fam}}
{{Flink|int|my_pp}}
{{Flink|stat|my_primestat}}
{{flink|int|my_rain}}
{{Flink|servant|my_servant|servant}}
{{flink|int|my_session_adv}}
{{flink|int [item]|my_session_items}}
{{flink|int|my_session_meat}}
{{flink|string|my_sign}}
{{flink|int|my_soulsauce}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{flink|thrall|my_thrall}}
{{flink|int|my_thunder}}
{{Flink|int|my_turncount}}
{{Flink|vykea|my_vykea_companion}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|{{opt|string}}|string}}
{{Flink|float|numeric_modifier|item|string}}
{{Flink|float|numeric_modifier|effect|string}}
{{Flink|float|numeric_modifier|skill|string}}
{{Flink|float|numeric_modifier|familiar|string|int|item}}

===o===
{{Flink|boolean|outfit|string}}
{{Flink|item [int]|outfit_pieces|string}}
{{Flink|string|outfit_tattoo|{{opt|string}}}}
{{Flink|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|string|property_default_value|string}}
{{Flink|boolean|property_exists|string|{{opt|boolean}}}}
{{Flink|boolean|property_has_default|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|void|refresh_shop}}
{{Flink|void|refresh_stash}}
{{Flink|void|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_property|string|{{opt|boolean}}}}
{{Flink|boolean|rename_property|string|string}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_choice|int}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|boolean|sell|coinmaster|int|item}}
{{Flink|int|sell_price|coinmaster|item}}
{{Flink|boolean|sells_item|coinmaster|item}}
{{Flink|string [int]|session_logs|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int}}
{{Flink|void|set_length|buffer|int}}
{{Flink|void|set_location|location}}
{{Flink|void|set_property|string|string}}
{{Flink|int|shop_amount|item}}
{{Flink|int|shop_price|item}}
{{Flink|int|soulsauce_cost|skill}}
{{Flink|int|spleen_limit}}
{{Flink|string [int]|split_string|string|{{opt|string}}}}
{{Flink|float|square_root|float}}
{{Flink|int|start|matcher|{{opt|int}}}}
{{Flink|int|stash_amount|item}}
{{Flink|stat|stat_bonus_today}}
{{Flink|stat|stat_bonus_tomorrow}}
{{Flink|stat|stat_modifier|effect|string}}
{{Flink|buffer|steal}}
{{Flink|int|stills_available}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|record|svn_info|string}}

===t===
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item}}
{{Flink|int|tavern|{{opt|string}}}}
{{Flink|buffer|throw_item|item}}
{{Flink|buffer|throw_items|item|item}}
{{Flink|int|thunder_cost|skill}}
{{Flink|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|bounty|to_bounty|strict_string}}
{{Flink|class|to_class|strict_string/int}}
{{Flink|coinmaster|to_coinmaster|strict_string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|strict_string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|strict_string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|strict_string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|strict_string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|aggregate}}
{{Flink|location|to_location|strict_string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|strict_string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|servant|to_servant|int}}
{{Flink|servant|to_servant|strict_string}}
{{Flink|skill|to_skill|effect}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|strict_string}}
{{Flink|slot|to_slot|item}}
{{Flink|skill|to_slot|strict_string}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|thrall|to_thrall|{{opt|string}}|{{opt|int}}}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{flink|int|total_free_rests}}
{{flink|int|total_turns_played}}
{{Flink|int|truncate|float}}
{{Flink|int|turns_per_cast|skill}}
{{Flink|int|turns_played}}

===u===
{{Flink|string|url_decode|string}}
{{Flink|string|url_encode|string}}
{{Flink|boolean|use|int|item}}
{{Flink|boolean|use_familiar|familiar}}
{{Flink|boolean|use_servant|servant}}
{{Flink|boolean|use_skill|int|skill|{{opt|string}}}}
{{Flink|buffer|use_skill|skill}}
{{Flink|boolean|user_confirm|string}}
{{Flink|boolean|user_confirm|string|int|boolean}}

===v===
{{Flink|boolean|visit|coinmaster}}
{{Flink|buffer|visit_url|{{opt|string}}|{{opt|boolean}}|{{opt|boolean}}}}

===w===
{{Flink|void|wait|int}}
{{Flink|void|waitq|int}}
{{Flink|int|weapon_hands|item}}
{{Flink|stat|weapon_type|item}}
{{Flink|int|weight_adjustment}}
{{Flink|boolean|white_citadel_available}}
{{Flink|boolean [string]|who_clan|{{opt|string}}}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

===x===
{{Flink|string[int]|xpath|string|string}}

[[Category:Scripting]]

Ash Functions

2020-05-20T02:48:51Z

Taltamir: /* m */ added functions

{{TOCright}}
Master list of all ASH functions. All functions as of r8144 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
The CLI command "[[ashref]]" shows every implemented ash function for your mafia version.
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|int|adv_cost|skill}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|string [int]|all_normal_outfits}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
{{Flink|string [int]|available_choice_options|{{opt|boolean}}}}

===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|bjornify_familiar|familiar}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|{{opt|string}}|string}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buy_using_storage|int|item}}
{{Flink|int|buy_using_storage|int|item|int}}
{{Flink|boolean|buys_item|coinmaster|item}}

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{Flink|boolean|cli_execute|string}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{Flink|boolean|contains_text|string|string}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|boolean|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|{{opt|item}}|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|void|disable|string}}
{{flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{Flink|boolean|drink|int|item}}

===e===
{{Flink|boolean|eat|int|item}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|float|elemental_resistance|element}}
{{Flink|float|elemental_resistance|{{opt|monster}}}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|boolean|galaktik_cures_discounted}}
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|monster [int]|get_monsters|location}}
{{Flink|string [int]|get_moods}}
{{Flink|string [int]|get_outfits}}
{{Flink|string|get_path}}
{{Flink|string|get_path_full}}
{{Flink|string|get_path_variables}}
{{Flink|string|get_player_id|string}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{flink|boolean|gnomads_available}}
{{flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|int|group_count|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_store_available}}

===h===
{{Flink|boolean|have_bartender}}
{{Flink|boolean|have_chef}}
{{Flink|boolean|have_display}}
{{Flink|int|have_effect|effect}}
{{Flink|boolean|have_equipped|item}}
{{Flink|boolean|have_familiar|familiar}}
{{Flink|boolean|have_mushroom_plot}}
{{Flink|boolean|have_outfit|string}}
{{Flink|boolean|have_servant|servant}}
{{Flink|boolean|have_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hermit|int|item}}
{{flink|boolean|hidden_temple_unlocked}}
{{Flink|boolean|hippy_stone_broken}}
{{Flink|boolean|hippy_store_available}}
{{Flink|float|historical_age|item}}
{{Flink|int|historical_price|item}}
{{Flink|string|holiday}}

===i===
{{Flink|monster|image_to_monster|strict_string}}
{{Flink|boolean|in_bad_moon}}
{{Flink|boolean|in_hardcore}}
{{Flink|boolean|in_moxie_sign}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{Flink|int|index_of|string|string|{{opt|int}}}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}}}
{{Flink|string|item_type|item}}

===j===
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}

===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|int|mmg_bet_amount|int}}
{{Flink|string|mmg_bet_owner|int}}
{{Flink|int|mmg_bet_owner_id|int}}
{{Flink|string|mmg_bet_taker}}
{{Flink|string|mmg_bet_taker_id}}
{{Flink|int|mmg_bet_winnings}}
{{Flink|int|mmg_make_bet|int|boolean}}
{{Flink|int [int]|mmg_my_bets}}
{{Flink|int [int]|mmg_offered_bets}}
{{Flink|boolean|mmg_retract_bet|int}}
{{Flink|void|mmg_search|int|int}}
{{Flink|int|mmg_take_bet|int|boolean}}
{{Flink|void|mmg_visit}}
{{Flink|int|mmg_wait_event|int}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_initiative|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_audience}}
{{Flink|int|my_basestat|stat}}
{{Flink|familiar|my_bjorned_familiar}}
{{Flink|int|my_buffedstat|stat}}
{{Flink|class|my_class}}
{{Flink|int|my_closet_meat}}
{{Flink|string|my_companion}}
{{Flink|int|my_daycount}}
{{Flink|int|my_discomomentum}}
{{Flink|familiar|my_effective_familiar}}
{{Flink|int [effect]|my_effects}}
{{Flink|familiar|my_enthroned_familiar}}
{{Flink|familiar|my_familiar}}
{{Flink|int|my_fullness}}
{{Flink|int|my_fury}}
{{Flink|string|my_garden_type}}
{{Flink|string|my_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{flink|int|my_lightning}}
{{Flink|location|my_location}}
{{Flink|string|my_mask}}
{{Flink|int|my_maxfury}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_maxpp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{flink|familiar|my_poke_fam}}
{{Flink|int|my_pp}}
{{Flink|stat|my_primestat}}
{{flink|int|my_rain}}
{{Flink|servant|my_servant|servant}}
{{flink|int|my_session_adv}}
{{flink|int [item]|my_session_items}}
{{flink|int|my_session_meat}}
{{flink|string|my_sign}}
{{flink|int|my_soulsauce}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{flink|thrall|my_thrall}}
{{flink|int|my_thunder}}
{{Flink|int|my_turncount}}
{{Flink|vykea|my_vykea_companion}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|{{opt|string}}|string}}
{{Flink|float|numeric_modifier|item|string}}
{{Flink|float|numeric_modifier|effect|string}}
{{Flink|float|numeric_modifier|skill|string}}
{{Flink|float|numeric_modifier|familiar|string|int|item}}

===o===
{{Flink|boolean|outfit|string}}
{{Flink|item [int]|outfit_pieces|string}}
{{Flink|string|outfit_tattoo|{{opt|string}}}}
{{Flink|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|string|property_default_value|string}}
{{Flink|boolean|property_exists|string|{{opt|boolean}}}}
{{Flink|boolean|property_has_default|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|void|refresh_shop}}
{{Flink|void|refresh_stash}}
{{Flink|void|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_property|string|{{opt|boolean}}}}
{{Flink|boolean|rename_property|string|string}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_choice|int}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|boolean|sell|coinmaster|int|item}}
{{Flink|int|sell_price|coinmaster|item}}
{{Flink|boolean|sells_item|coinmaster|item}}
{{Flink|string [int]|session_logs|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int}}
{{Flink|void|set_length|buffer|int}}
{{Flink|void|set_location|location}}
{{Flink|void|set_property|string|string}}
{{Flink|int|shop_amount|item}}
{{Flink|int|shop_price|item}}
{{Flink|int|soulsauce_cost|skill}}
{{Flink|int|spleen_limit}}
{{Flink|string [int]|split_string|string|{{opt|string}}}}
{{Flink|float|square_root|float}}
{{Flink|int|start|matcher|{{opt|int}}}}
{{Flink|int|stash_amount|item}}
{{Flink|stat|stat_bonus_today}}
{{Flink|stat|stat_bonus_tomorrow}}
{{Flink|stat|stat_modifier|effect|string}}
{{Flink|buffer|steal}}
{{Flink|int|stills_available}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|record|svn_info|string}}

===t===
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item}}
{{Flink|int|tavern|{{opt|string}}}}
{{Flink|buffer|throw_item|item}}
{{Flink|buffer|throw_items|item|item}}
{{Flink|int|thunder_cost|skill}}
{{Flink|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|bounty|to_bounty|strict_string}}
{{Flink|class|to_class|strict_string/int}}
{{Flink|coinmaster|to_coinmaster|strict_string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|strict_string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|strict_string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|strict_string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|strict_string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|aggregate}}
{{Flink|location|to_location|strict_string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|strict_string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|servant|to_servant|int}}
{{Flink|servant|to_servant|strict_string}}
{{Flink|skill|to_skill|effect}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|strict_string}}
{{Flink|slot|to_slot|item}}
{{Flink|skill|to_slot|strict_string}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|thrall|to_thrall|{{opt|string}}|{{opt|int}}}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{flink|int|total_free_rests}}
{{flink|int|total_turns_played}}
{{Flink|int|truncate|float}}
{{Flink|int|turns_per_cast|skill}}
{{Flink|int|turns_played}}

===u===
{{Flink|string|url_decode|string}}
{{Flink|string|url_encode|string}}
{{Flink|boolean|use|int|item}}
{{Flink|boolean|use_familiar|familiar}}
{{Flink|boolean|use_servant|servant}}
{{Flink|boolean|use_skill|int|skill|{{opt|string}}}}
{{Flink|buffer|use_skill|skill}}
{{Flink|boolean|user_confirm|string}}
{{Flink|boolean|user_confirm|string|int|boolean}}

===v===
{{Flink|boolean|visit|coinmaster}}
{{Flink|buffer|visit_url|{{opt|string}}|{{opt|boolean}}|{{opt|boolean}}}}

===w===
{{Flink|void|wait|int}}
{{Flink|void|waitq|int}}
{{Flink|int|weapon_hands|item}}
{{Flink|stat|weapon_type|item}}
{{Flink|int|weight_adjustment}}
{{Flink|boolean|white_citadel_available}}
{{Flink|boolean [string]|who_clan|{{opt|string}}}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

===x===
{{Flink|string[int]|xpath|string|string}}

[[Category:Scripting]]

Ash Functions

2020-05-20T02:41:29Z

Taltamir: /* m */

{{TOCright}}
Master list of all ASH functions. All functions as of r8144 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
The CLI command "[[ashref]]" shows every implemented ash function for your mafia version.
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|int|adv_cost|skill}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|string [int]|all_normal_outfits}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
{{Flink|string [int]|available_choice_options|{{opt|boolean}}}}

===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|bjornify_familiar|familiar}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|{{opt|string}}|string}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buy_using_storage|int|item}}
{{Flink|int|buy_using_storage|int|item|int}}
{{Flink|boolean|buys_item|coinmaster|item}}

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{Flink|boolean|cli_execute|string}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{Flink|boolean|contains_text|string|string}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|boolean|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|{{opt|item}}|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|void|disable|string}}
{{flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{Flink|boolean|drink|int|item}}

===e===
{{Flink|boolean|eat|int|item}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|float|elemental_resistance|element}}
{{Flink|float|elemental_resistance|{{opt|monster}}}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|boolean|galaktik_cures_discounted}}
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|monster [int]|get_monsters|location}}
{{Flink|string [int]|get_moods}}
{{Flink|string [int]|get_outfits}}
{{Flink|string|get_path}}
{{Flink|string|get_path_full}}
{{Flink|string|get_path_variables}}
{{Flink|string|get_player_id|string}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{flink|boolean|gnomads_available}}
{{flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|int|group_count|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_store_available}}

===h===
{{Flink|boolean|have_bartender}}
{{Flink|boolean|have_chef}}
{{Flink|boolean|have_display}}
{{Flink|int|have_effect|effect}}
{{Flink|boolean|have_equipped|item}}
{{Flink|boolean|have_familiar|familiar}}
{{Flink|boolean|have_mushroom_plot}}
{{Flink|boolean|have_outfit|string}}
{{Flink|boolean|have_servant|servant}}
{{Flink|boolean|have_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hermit|int|item}}
{{flink|boolean|hidden_temple_unlocked}}
{{Flink|boolean|hippy_stone_broken}}
{{Flink|boolean|hippy_store_available}}
{{Flink|float|historical_age|item}}
{{Flink|int|historical_price|item}}
{{Flink|string|holiday}}

===i===
{{Flink|monster|image_to_monster|strict_string}}
{{Flink|boolean|in_bad_moon}}
{{Flink|boolean|in_hardcore}}
{{Flink|boolean|in_moxie_sign}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{Flink|int|index_of|string|string|{{opt|int}}}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}}}
{{Flink|string|item_type|item}}

===j===
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}

===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|int|mmg_bet_amount|int}}
{{Flink|string|mmg_bet_owner|int}}
{{Flink|int|mmg_bet_owner_id|int}}
{{Flink|string|mmg_bet_taker}}
{{Flink|string|mmg_bet_taker_id}}
{{Flink|int|mmg_bet_winnings}}
{{Flink|int|mmg_make_bet|int|boolean}}
{{Flink|int [int]|mmg_my_bets}}
{{Flink|int [int]|mmg_offered_bets}}
{{Flink|boolean|mmg_retract_bet|int}}
{{Flink|void|mmg_search|int|int}}
{{Flink|int|mmg_take_bet|int|boolean}}
{{Flink|void|mmg_visit}}
{{Flink|int|mmg_wait_event|int}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_initiative|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_audience}}
{{Flink|int|my_basestat|stat}}
{{Flink|familiar|my_bjorned_familiar}}
{{Flink|int|my_buffedstat|stat}}
{{Flink|class|my_class}}
{{Flink|int|my_closet_meat}}
{{Flink|string|my_companion}}
{{Flink|int|my_daycount}}
{{Flink|int|my_discomomentum}}
{{Flink|familiar|my_effective_familiar}}
{{Flink|int [effect]|my_effects}}
{{Flink|familiar|my_enthroned_familiar}}
{{Flink|familiar|my_familiar}}
{{Flink|int|my_fullness}}
{{Flink|int|my_fury}}
{{Flink|string|my_garden_type}}
{{Flink|string|my_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{flink|int|my_lightning}}
{{Flink|location|my_location}}
{{Flink|int|my_maxfury}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{Flink|stat|my_primestat}}
{{flink|int|my_rain}}
{{Flink|servant|my_servant|servant}}
{{flink|string|my_sign}}
{{flink|int|my_soulsauce}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{flink|thrall|my_thrall}}
{{flink|int|my_thunder}}
{{Flink|int|my_turncount}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|{{opt|string}}|string}}
{{Flink|float|numeric_modifier|item|string}}
{{Flink|float|numeric_modifier|effect|string}}
{{Flink|float|numeric_modifier|skill|string}}
{{Flink|float|numeric_modifier|familiar|string|int|item}}

===o===
{{Flink|boolean|outfit|string}}
{{Flink|item [int]|outfit_pieces|string}}
{{Flink|string|outfit_tattoo|{{opt|string}}}}
{{Flink|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|string|property_default_value|string}}
{{Flink|boolean|property_exists|string|{{opt|boolean}}}}
{{Flink|boolean|property_has_default|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|void|refresh_shop}}
{{Flink|void|refresh_stash}}
{{Flink|void|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_property|string|{{opt|boolean}}}}
{{Flink|boolean|rename_property|string|string}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_choice|int}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|boolean|sell|coinmaster|int|item}}
{{Flink|int|sell_price|coinmaster|item}}
{{Flink|boolean|sells_item|coinmaster|item}}
{{Flink|string [int]|session_logs|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int}}
{{Flink|void|set_length|buffer|int}}
{{Flink|void|set_location|location}}
{{Flink|void|set_property|string|string}}
{{Flink|int|shop_amount|item}}
{{Flink|int|shop_price|item}}
{{Flink|int|soulsauce_cost|skill}}
{{Flink|int|spleen_limit}}
{{Flink|string [int]|split_string|string|{{opt|string}}}}
{{Flink|float|square_root|float}}
{{Flink|int|start|matcher|{{opt|int}}}}
{{Flink|int|stash_amount|item}}
{{Flink|stat|stat_bonus_today}}
{{Flink|stat|stat_bonus_tomorrow}}
{{Flink|stat|stat_modifier|effect|string}}
{{Flink|buffer|steal}}
{{Flink|int|stills_available}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|record|svn_info|string}}

===t===
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item}}
{{Flink|int|tavern|{{opt|string}}}}
{{Flink|buffer|throw_item|item}}
{{Flink|buffer|throw_items|item|item}}
{{Flink|int|thunder_cost|skill}}
{{Flink|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|bounty|to_bounty|strict_string}}
{{Flink|class|to_class|strict_string/int}}
{{Flink|coinmaster|to_coinmaster|strict_string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|strict_string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|strict_string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|strict_string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|strict_string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|aggregate}}
{{Flink|location|to_location|strict_string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|strict_string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|servant|to_servant|int}}
{{Flink|servant|to_servant|strict_string}}
{{Flink|skill|to_skill|effect}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|strict_string}}
{{Flink|slot|to_slot|item}}
{{Flink|skill|to_slot|strict_string}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|thrall|to_thrall|{{opt|string}}|{{opt|int}}}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{flink|int|total_free_rests}}
{{flink|int|total_turns_played}}
{{Flink|int|truncate|float}}
{{Flink|int|turns_per_cast|skill}}
{{Flink|int|turns_played}}

===u===
{{Flink|string|url_decode|string}}
{{Flink|string|url_encode|string}}
{{Flink|boolean|use|int|item}}
{{Flink|boolean|use_familiar|familiar}}
{{Flink|boolean|use_servant|servant}}
{{Flink|boolean|use_skill|int|skill|{{opt|string}}}}
{{Flink|buffer|use_skill|skill}}
{{Flink|boolean|user_confirm|string}}
{{Flink|boolean|user_confirm|string|int|boolean}}

===v===
{{Flink|boolean|visit|coinmaster}}
{{Flink|buffer|visit_url|{{opt|string}}|{{opt|boolean}}|{{opt|boolean}}}}

===w===
{{Flink|void|wait|int}}
{{Flink|void|waitq|int}}
{{Flink|int|weapon_hands|item}}
{{Flink|stat|weapon_type|item}}
{{Flink|int|weight_adjustment}}
{{Flink|boolean|white_citadel_available}}
{{Flink|boolean [string]|who_clan|{{opt|string}}}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

===x===
{{Flink|string[int]|xpath|string|string}}

[[Category:Scripting]]

Can drink

2020-04-05T07:08:32Z

Taltamir: plumber also returns false

{{
#vardefine:name|can_drink}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function_description=This function returns true if the logged-in character is not subject to dietary restrictions that completely forbid drinking. Those being Plumber, Teetotaler, or Oxygenarian path. If the character is subject to those restrictions this function returns false.|

code1={{CodeSample|
title=Code Samples|
description=If the character is able to drink, this code will make them drink 3 bottles of gin.|
code=
<syntaxhighlight>
if(can_drink()) {
drink(3 , $item[bottle of gin]);
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|can_eat|drink}}|
special=When not logged in, this function returns true.
}}

[[Category:Your Character]]

Talk:Galaktik cures discounted

2020-03-05T22:21:47Z

Taltamir:

Maybe this should be in miscellaneous... but a few things here are already more about "Your World" than "Your Character." Still not sure how to handle that... --[[User:StDoodle|StDoodle (#1059825)]] 23:33, 19 April 2010 (UTC)

==Removed Function==
This function seems to have been removed. you can replicate its functionality via
* if ( get_property( "questM24Doc" ) == "finished" )
https://kolmafia.us/showthread.php?24590-mafia-says-documented-function-does-not-exist&p=155910#post155910
--[[User:Taltamir|Taltamir]] ([[User talk:Taltamir|talk]]) 22:21, 5 March 2020 (UTC)

Coinmaster

2019-03-14T06:31:44Z

Taltamir:

{{DISPLAYTITLE:coinmaster}}

{{TOCright}}

This data type represents all shops that deal with currency other than meat.
Known values include:

* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}
* {{kolwiki|Mr. Store}}
* {{kolwiki|Hermit}}
* {{kolwiki|The Shore, Inc. Gift Shop}}
* {{kolwiki|The Trapper's Cabin|The Trapper}}
* {{kolwiki|A Vending Machine|Vending Machine}}
* {{kolwiki|The Swagger Shop}}
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}
* {{kolwiki|The Orcish Frat House|Quartersmaster}}
* {{kolwiki|BURT|Bugbear Token}}
* {{kolwiki|Freshwater Fishbonery}}
* {{kolwiki|Big Brother}}
* {{kolwiki|The Terrified Eagle Inn}}
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}
* {{kolwiki|Cashier|Game Shoppe}}
* {{kolwiki|Cashier|Game Shoppe Snacks}}
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}
* {{kolwiki|Dollhawker's Emporium}}
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}
* {{kolwiki|Paul's Boutique}}
* {{kolwiki|The Frozen Brogurt Stand}}
* {{kolwiki|Buff Jimmy's Souvenir Shop}}
* {{kolwiki|Taco Dan's Taco Stand}}
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}
* {{kolwiki|The Neandermall}}
* {{kolwiki|Legitimate Shoe Repair, Inc.}}
* {{kolwiki|warbear black box|Warbear Black Box}}
* {{kolwiki|The Dinsey Company Store}}
* {{kolwiki|Internet Meme Shop}}

==Related Functions==

{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buys_item|coinmaster|item}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{Flink|boolean|sell|coinmaster|int|item}}
{{Flink|int|sell_price|coinmaster|item}}
{{Flink|boolean|sells_item|coinmaster|item}}
{{Flink|coinmaster|to_coinmaster|strict_string}}
{{Flink|boolean|visit|coinmaster}}

==Proxy Record Fields==

Here are the proxy record fields for coinmasters. Proxy records are discussed in more
detail [[Proxy Records|here]].

{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| token
| string
| ""
|
|-
| item
| item
| none
|
|-
| property
| string
| ""
|
|-
| available_tokens
| int
| 0
|
|-
| buys
| boolean
| false
|
|-
| sells
| boolean
| false
|
|}

[[Category:Scripting]] [[Category:Data Types]]

Data Types

2019-03-14T06:31:02Z

Taltamir: /* coinmaster */

{{TOCright}}
==Primitive Datatypes==

===void===
Can be thought of better as the absence of a datatype. No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''.

===boolean===
A boolean value is either '''true''' or '''false'''. By default, a boolean variable is set to false.

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 32-bit signed int, meaning it has a maximum value of 2,147,483,647 and a minimum value of -2,147,483,648. The default value of a integer variable is 0.

Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every step of the operation when only integer types are used. For example:
{{
CodeSample|
code=
<syntaxhighlight>
int a = 1;
int b = 2;
print( a / b * 2 );
</syntaxhighlight>}}
Will give the output "0," not "1" as you may expect. Changing either variable to a float type will "correct" this.

===float===

The float data type is a single-precision 32-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in section 4.2.3 of the Java Language Specification. [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3]

When assigning to a variable of type float, one should be careful to always enter numbers in decimal form, as unwanted behavior can result from supplying a value that KoLmafia may interpret as an int type without the decimal point.

Note that float is not infinitely precise; it intrinsically rounds off after a certain point. This loss of accuracy is for the sake of storage, but beware of the possibility of small errors compounding from multiple float types.
{{
CodeSample|
description=For instance, try the following code as an example of how rather long post-decimal portions are handled:|
code=
<syntaxhighlight>
float f;
f = 4.9999999;
print( f );
</syntaxhighlight>}}
The default value of a <code>float</code> variable is 0.0.

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, always enclose the desired value in either single or double quotes (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.{{CodeSample|
description=For example:|
code=
<syntaxhighlight>
string s = "This is my \"friend\" Pete.";
</syntaxhighlight>|
moreinfo=
Will result in the following being stored to s:
<pre>This is my "friend" Pete</pre>}}
The default value of a string is an empty string, or literally <code>""</code>.

===buffer===

Similar to a string, but more efficient in certain operations, including concatenation and passing as function arguments. For the most part, you can interchange references to strings and buffers. However, you should test all such actions first, as a few functions require a specific datatype to be supplied as a parameter. (Most notably, those listed under [[String Handling Routines#Regular Expressions|Regular Expressions]].)

==Special Datatypes==

Several datatypes are included in KoLmafia to represent common categories within the KoL universe.

Note that while variables of these types are declared in the same way as for Primitive Datatypes; assigning and referencing them is done differently.
{{CodeSample|
description=For example, to declare an item datatype and assign it a value, you would use the following line of code:|
code=
<syntaxhighlight>
item it = $item[ broken skull ];
</syntaxhighlight>}}
The default values of any variable of one of the following types is <code>$''type''[ none ]</code>. For example, the default value of a <code>item</code> variable is <code>$item[ none ]</code>.

===bounty===

([[Bounty#Related Functions|Related Functions]]) ([[Bounty#Proxy Record Fields|Proxy Record Fields]])

These are the non-items that the bounty hunter asks you to retrieve from monsters around the kingdom. There are quite a lot of them (42 in total) so I won't list them all here. You can find more about bounties at the {{kolwiki|The Bounty Hunter Hunter's Shack}}.

===class===

([[Class#Related Functions|Related Functions]]) ([[Class#Proxy Record Fields|Proxy Record Fields]])

Besides $class[ none ], there are six possible values for this datatype:

* Seal Clubber
* Turtle Tamer
* Pastamancer
* Sauceror
* Disco Bandit
* Accordion Thief

===coinmaster===

([[Coinmaster#Related Functions|Related Functions]]) ([[Coinmaster#Proxy Record Fields|Proxy Record Fields]])

All shops that deal with currency other than meat. Known values include:

* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}
* {{kolwiki|Mr. Store}}
* {{kolwiki|Hermit}}
* {{kolwiki|The Shore, Inc. Gift Shop}}
* {{kolwiki|The Trapper's Cabin|The Trapper}}
* {{kolwiki|A Vending Machine|Vending Machine}}
* {{kolwiki|The Swagger Shop}}
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}
* {{kolwiki|The Orcish Frat House|Quartersmaster}}
* {{kolwiki|BURT|Bugbear Token}}
* {{kolwiki|Freshwater Fishbonery}}
* {{kolwiki|Big Brother}}
* {{kolwiki|The Terrified Eagle Inn}}
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}
* {{kolwiki|Cashier|Game Shoppe}}
* {{kolwiki|Cashier|Game Shoppe Snacks}}
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}
* {{kolwiki|Dollhawker's Emporium}}
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}
* {{kolwiki|Paul's Boutique}}
* {{kolwiki|The Frozen Brogurt Stand}}
* {{kolwiki|Buff Jimmy's Souvenir Shop}}
* {{kolwiki|Taco Dan's Taco Stand}}
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}
* {{kolwiki|The Neandermall}}
* {{kolwiki|Legitimate Shoe Repair, Inc.}}
* {{kolwiki|warbear black box|Warbear Black Box}}
* {{kolwiki|The Dinsey Company Store}}
* {{kolwiki|Internet Meme Shop}}

===effect===

([[Effect#Related Functions|Related Functions]]) ([[Effect#Proxy Record Fields|Proxy Record Fields]])

Any effect you can be under in KoL, whether from items, skills, or what-have-you, is valid for this datatype.

The full range, besides $effect[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Effects}} page for more information.

===element===

([[Element#Related Functions|Related Functions]]) ([[Element#Proxy Record Fields|Proxy Record Fields]])

Besides $element[ none ], there are seven possible values for this datatype. (Note that "Bad Spelling" is not considered a true element.)
Also note that these names are case-sensitive (referencing $element[ Spooky ] will generate an error).

* cold
* hot
* sleaze
* spooky
* stench
* slime
* supercold

===familiar===

([[Familiar#Related Functions|Related Functions]]) ([[Familiar#Proxy Record Fields|Proxy Record Fields]])

Any familiar available in KoL is valid for this datatype.

The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Familiars}} page for more information.

===item===

([[Item#Related Functions|Related Functions]]) ([[Item#Proxy Record Fields|Proxy Record Fields]])

Any item in all of KoL is valid for this datatype. Note that unlike most special datatypes, item references can make use of the item ID number.
{{CodeSample|
description=For example, you could assign the item plexiglass pants as follows:|
code=
<syntaxhighlight>
item it = $item[ 1234 ];
</syntaxhighlight>}}
The full range, besides $item[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Items}} page for more information.

===location===

([[Location#Related Functions|Related Functions]]) ([[Location#Proxy Record Fields|Proxy Record Fields]])

Any location one can adventure at in KoL is valid for this datatype.

The full range, besides $location[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Locations}} page for more information.

===monster===

([[Monster#Related Functions|Related Functions]]) ([[Monster#Proxy Record Fields|Proxy Record Fields]])

Any monster you can encounter in KoL is valid for this datatype.

The full range, besides $monster[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Monster Compendium}} page for more information.

===phylum===

([[Phylum#Related Functions|Related Functions]]) ([[Phylum#Proxy Record Fields|Proxy Record Fields]])

Each monster has a {{kolwiki|Phylum}}. Besides $phylum[none], the possible values for this datatype are:

* beast
* bug
* constellation
* construct
* demon
* dude
* elemental
* elf
* fish
* goblin
* hippy
* hobo
* humanoid
* horror
* mer-kin
* orc
* penguin
* pirate
* plant
* slime
* undead
* weird

===servant===

([[Servant#Related Functions|Related Functions]]) ([[Servant#Proxy Record Fields|Proxy Record Fields]])

Servants are unique to the {{kolwiki|Actually Ed the Undying}} path and located {{kolwiki|The Servants' Quarters}}, replacing familiars.

* Assassin
* Belly-Dancer
* Bodyguard
* Cat
* Maid
* Priest
* Scribe

===skill===

([[Skill#Related Functions|Related Functions]]) ([[Skill#Proxy Record Fields|Proxy Record Fields]])

Any skill you can have in KoL, whether permable or not, granted by items, ''etc''., is valid for this datatype.

The full range, besides $skill[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Skills}} page for more information.

===slot===

([[Slot#Related Functions|Related Functions]]) (slot has no proxy record fields)

Besides $slot[ none ], there are 16 possible values for this datatype.

* hat
* back
* weapon
* off-hand
* shirt
* pants
* acc1
* acc2
* acc3
* familiar
* sticker1
* sticker2
* sticker3
* fakehand
* bootspur
* bootskin

===stat===

([[Stat#Related Functions|Related Functions]]) (stat has no proxy record fields)

Besides $stat[ none ], there are six possible values for this datatype (the last three are for referencing sub-stats).

* muscle
* mysticality
* moxie
* submuscle
* submysticality
* submoxie

===thrall===

([[Thrall#Related Functions|Related Functions]]) ([[Thrall#Proxy Record Fields|Proxy Record Fields]])

Pastamancers have the ability to summon {{kolwiki|Pasta Thralls}}.

* Angel Hair Wisp
* Elbow Macaroni
* Lasagmbie
* Penne Dreadful
* Spaghetti Elemental
* Spice Ghost
* Vampieroghi
* Vermincelli

==aggregate==

An aggregate is a complex datatype composed of two or more primitive or special datatypes. For more information, see [[Data Structures]].

==record==

Records are user-defined datatypes that hold as many sub-datatypes as desired. For more information, see the page for [[Data Structures]].

==Plural Typed Constants==

(see http://kolmafia.us/showthread.php?p=15592, from which this section is reproduced)

Plural typed constants allow you to easily do something with a list of specified objects, without having to replicate code or laboriously build up an array of the objects so that you can iterate over it. Here's a quick example:
{{CodeSample|code=<syntaxhighlight>
foreach weapon in $items[star sword, star staff, star crossbow] {
if (available_amount(weapon) > 0) {
equip(weapon);
break;
}
}</syntaxhighlight>}}
The syntax is basically the same as the existing typed constant feature, but with an "s" or "es" after the type name. (The "es" case is there so that you can properly pluralize "class".) The text between the square brackets is interpreted as a comma-separated list of elements, each of which is converted to the specified type as if it were an individual constant. More details:
* The list can span multiple lines.
* Whitespace before or after elements is ignored.
* Completely empty elements are ignored (so that you can leave a comma at the end of the list).
* You can include a comma or closing square bracket in an element by writing it as "\," or "\]".
* All the other escape sequences allowed in strings are possible, such as "\n" (newline), "\t" (tab), and "\uXXXX" (Unicode character value). To put an actual backslash in an element, you have to write it as "\\".

The value generated by a plural constant is of type boolean[type], with the keys being the specified elements, and the boolean value always being true - although you won't normally do anything with the boolean, you'd use a foreach loop to iterate over the keys. You can assign a plural constant to a variable declared as that type, but note that the value differs from a normal map in three important respects:
* Since the expression that generates it is syntactically a constant, the value has to be immutable. If you were allowed to change it in any way, those changes would appear in every future use of the same constant.
* There can be multiple instances of the same key - $ints[1,1,2,3,5,8] is perfectly valid, and will result in the value 1 appearing twice in a foreach loop.
* The keys will appear in the order you wrote them, rather than being sorted alphanumerically as maps usually do.

In addition to being used in a foreach loop, plural constants also efficiently support membership testing via the 'contains' operator. Here's another example:
{{CodeSample|code=<syntaxhighlight>
for hour from 1 to 12 {
print("It's " + hour + " o'clock.");
if ($ints[10, 2, 4] contains hour) {
print("Time to drink a Dr Pepper!");
}
}</syntaxhighlight>}}
(Yes, that example could just as easily have been done with a switch statement.)

Iterating over an empty list is rather pointless, so plural constants with no elements are given a different meaning: they represent every value of the specified type, where this is practical. (The 'none' value, if defined for a given type, is omitted.) The biggest benefit here is $items[], which lets you loop over every defined item, more efficiently than you could otherwise write in a script (since the list is generated once per session and then cached), and without having to hard-code a maximum item ID number in your script. Example:
{{CodeSample|code=<syntaxhighlight>
foreach it in $items[] {
if (autosell_price(it) == 42) print(it);
}</syntaxhighlight>}}
Enumeration of all possible values works with the following types:
* $booleans[] - false and true.
* $items[]
* $locations[]
* $classes[]
* $stats[] - Muscle, Mysticality, Moxie: the substat values are omitted.
* $skills[]
* $effects[]
* $familiars[]
* $slots[] - includes sticker slots and fake hands, which you might not want to consider as normal slots.
* $monsters[]
* $elements[] - includes slime now, and possibly other not-quite-elements like cute in the future.

The remaining types that can be used in plural constants require an explicit list of elements, since there are too many possible values:
* $ints[] - you don't have enough RAM to store a list with 4 billion elements.
* $floats[] - ditto.
* $strings[] - nobody has that much RAM.

==Custom==

===matcher===

A matcher isn't really a datatype so much as it's a class, but it is included here for reference, as it is used much as datatypes are in ASH. It can only be declared through the function {{f|create_matcher}}, using two strings. One is the string to find matches in, the other a regular expression to test against. For more information on using a matcher, see [[Regular Expressions]].

[[Category:Scripting]]