Kolmafia - User contributions [en]

Help:To Do List

2014-03-30T07:30:31Z

Gnocchi masala: Revisions 10765, 10772 & 10774 implement static scope for code that is only to be executed once on loading.

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==
10078: ash function format_dtg
10081: ash function format_dtg renamed to be
string '''format_date_time(inFormat, dtg, outFormat)'''
more info: http://kolmafia.us/showthread.php?8451-time_to_string()-with-parameter&p=64058&viewfull=1#post64058

Modify examples on proxy record page because of:
10122: Add the boolean "fancy" and "candy" fields to item '''proxy records'''.
10147: Initial support for "Crimbo 2011" coinmaster: trade candy for Candy Credits
10412: Add $skill '''proxy records''': .dailylimit and .timescast
10879: Add a boolean "boss" field to $monster[]

10227: Add the <s>"'''closet empty'''" CLI command, and</s> the '''empty_closet()''' ASH function.

r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods

r10344 Add '''tavern( string goal )''' ASH function.
goal can be "faucet", "baron", or "explore" (to explore all remaining unexplored squares).
r10345 Add ASH '''tavern( "fight" )''' to explore cellar until the Baron's mansion is found
and then go in to fight him.

r10753-6 '''get_goals()''' returns a string[int] containing all the conditions that KoLmafia will
try to satisfy. Add g'''oal_exists()''' where you can pass in a goal type (choiceadv, autostop,
meat, health, mana, item) and KoLmafia will tell you if there are any goals that match.

10922: Add '''get_player_id()''' method to ASH

10937: Add '''minstrel_quest()''' boolean function,
which returns true when Clancy has a new quest for you.

10971: Added boolean '''hippy_stone_broken()''' function

11023: Make the CLI "attack" command work again. Make "pvp" equivalent to "steal" instead
of "attack". Added "swagger" as equivalent to "flowers".

11055: Added a 2-parameter version of '''to_string()''', where the first parameter can
currently be an int or float (other types are possible, but didn't seem
useful), and the second is a format string as defined by the Java
String.format() method (which in turn is based on C printf() format strings).
For example, "%.2f" will output a float with exactly two digits after the
(localized) decimal point.

11110: Add ASH function: '''pvp_attacks_left()'''. This is guaranteed accurate only if you
have recently looked at the Fight! page. Tracking of PVP fights gained via
consumption or familiar action and initialization at login will come later -
after api.php is updated to include the figure.

Add '''beforePVPScript''' setting which contains a script to be executed before a PVP
attack. At the moment, this is only called from the Relay Browser - and only if
relayRunsBeforePVPScript is true

11112: Call beforePVPScript, if present, during automated PVP via the "flowers" command

11112: Change ASH '''have_outfit()''' to work with custom outfits, as well as normal outfit
Add ASH '''is_wearing_outfit()''' to return TRUE if you are currently wearing the
specified custom or normal outfit.

10815: Allow certain ASH constants to be used in custom combat settings.
$phylum[] refers to the monster categorization, see the built-in ASH constants documentation for more information.
$element[] refers to either the attack or the defense element. As long as one matches, this check will be satisfied. This may limit its usefulness, but we can evaluate it later.
$item[] refers to an item that the monster drops. If there are multiple monsters that drop the item, or if you just can't remember which one it is, and your combat strategy happens to depend on it...
In order to match, everything that you specify must match. So if you specify an impossible combination, that CCS section will not run.

[ $element[ spooky ] $item[ hobo nickel ] ]
skill entangling noodles
skill weapon of the pastalord

[ bathroom $element[ spooky ] ]
attack

[ $phylum[ beast ] ]
skill stomp
attack

11197: new ASH functions:
boolean '''is_familiar_equipment_locked()'''
-returns true if current familiar equipment is locked, otherwise false
void '''lock_familiar_equipment(boolean locking)'''
-tries to lock/unlock fam equipment accordingly.

11208: Add int '''get_clan_id()''' and string '''get_clan_name()''' functions.

11267: Pass chat events along to '''chatbotscript'''. The sender is an empty string,
the channel is "Events", and the message is stripped of its HTML.

11432: Add '''is_discardable()''' which will return true even if an item can be autosold,
so be careful you don't get cheated out of some meat.

11438: Revert use of gift flag to previous interpretation: KoL has the item marked as
a "Gift Item". Instead, change isGiftable() - which is also used by the ASH
is_giftable() function - to allow either the "tradeable" or "gift" flags.
Fix the item.gift proxy field to return the value of the gift flag, rather than
being a synonym for is_giftable().

11555: Add monster.raw_attack, monster.raw_defense, and monster.raw_hp to return the
unmodified stats from monsters.txt.

11561: Add monster '''image_to_monster( string )''' ASH function for looking up monster by image file name.
Add monster.image proxy field for going the other way.

11771: experimental: add overloaded maximize() signature in ASH

'''maximize( string maximizerString, int maxPrice, int priceLevel, boolean simulate, boolean showEquipment )'''

returns an aggregate of records with each record containing the fields:
**display => display text, as it is shown in the maximizer frame
**cmd => actual command string that the maximizer runs to get the boost
**score => the boost's score
**effect => the effect provided by the boost - if applicable. effect[none] if it is equipment.
**item => $item[] that is being suggested for use or equipment
**skill => $skill[] that is being suggested

If the showEquipment argument is false, equipment will be omitted from the results.

r11707: Experimental ASH feature: the main() function of imported scripts can now be
invoked, under the alternate name main@filename()
(where 'filename' can be overridden by a 'script' directive, any ".ash"
suffix is dropped, and non-alphanumeric characters are replaced by
underscores). Note that no spaces are allowed around the @, the whole thing
is a single token.

r11965: Add my_companion()

r11985: Add the "skeleton" CLI command.

r12019: Add "eudora" CLI command

r12060: add ASH get_moods(), returns an aggregate of currently defined mood names.
"mood listall" in the gCLI will also print a list of defined moods.

r12062: add ASH get_outfits() and get_custom_outfits()

r12070: Overloaded version of appearance_rates considers monster queue:
appearance_rates( $location[] location, boolean includeQueue )

r12105: maximizerMRULength is now maximizerMRUSize
That affects this page: [[Hidden_Features#Most_Recently_Used_Modifier_Maximizer_Expression]]

'''SVN Features added''' by Roippi! SVN integration was (brokenly) implemented in r12141 and more correctly implemented in r12144.

FOR USERS:
* svn checkout <svnurl> - checks out a svn repository and adds the files from the working copy to the appropriate locations.
* svn update - updates all of your installed projects and pushes any changes to the appropriate locations.
* svn list - lists installed projects.
* svn delete <scriptname> - deletes installed projects and the corresponding files that it pushed. <scriptname> fuzzy matches the script names from svn list.

FOR SCRIPTERS:
You can provide a <nowiki>svn://, http://, or https://</nowiki> link to a valid svn repo. The link does not need to be to the root of the repository.
At the location specified by the url, there are only four permissible folders:
* ccs/
* data/
* images/
* relay/
* scripts/

Any files or directories in the location specified by your url that are not named the above will cause your repo to fail validation and thus it will not be checked out.
Within the valid folders, you can nest files however you want.
When users check out your project, the files (and nested folders) will be pushed to the corresponding mafia directories.

r12157: '''svn increment <projectname>''' and '''svn decrement <projectname>''' moves an installed svn project up/down one revision, respectively.
'''svn update''' can also take <projectname> argument or a <SVNURL> argument. Or just be blank to update everything.
r12177 svn inc/dec does the same thing as svn increment/decrement. Because typing stuff is hard.

12167: command "'''svn sync'''"

Looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the WC file is copied over the local copy one.
Note that this is very different from "svn update" and indeed does not contact the repository server at all.

If you are unsure if you want this feature, this is only for people who maintain modifications to the files in their svn/ folders that they want merged in with updates from the repo.
If you are just doing checkout/update operations and don't know what this "merging" business is about, you don't need this feature.

Users who want to automatically sync after update operations can set syncAfterSvnUpdate = true.

r12153: add '''svnUpdateOnLogin''' (global, default false), which runs svn update before breakfast/loginScript.
This could be useful if your loginScript has svn dependencies.

r12188: add global preference '''_svnUpdated'''
only do login svn update (mediated by svnUpdateOnLogin) at most once per day.

r12181: add preference '''simpleSvnUpdate''' (global, default true)
If true, simply checks if the root of your working copy is at HEAD, skipping it if so.
Speeds up the average update operation by 75% (and is probably nicer on servers).
Advanced users who have done something like a non-root "svn switch" or are using svn externals should know whether they want to turn this off.

Again the ticky box goes at the bottom of general preferences, it is soon time for these to be moved to their own page.

r12198 new ash svn functions:
boolean '''svn_exists'''( String projectname ) - returns true if a valid working copy named projectname exists in the svn/ folder
boolean '''svn_at_head'''( String projectname ) - returns true if projectname exists, is a valid WC, and is currently at the same revision # as the repository.
This will hit the repo server, so be nice.

r12206: initial support for automatic svn dependency installation.
global preference '''svnInstallDependencies''' (default true) controls whether svn will try to install dependencies.

Scripters are now allowed to place a file called dependencies.txt in the top-level of a project.
Calling it anything else will fail validation, as before. This special file will not be "pushed" to anywhere locally, it will just remain in the working copy folder.
On each line of dependencies.txt, you specify one URL to another SVN project.

r12211: preference '''svnShowCommitMessages''' (global, default false) controls whether you want to see new commit messages from svn update operations.

r12215: add ash function: '''record svn_info( String project )'''
record has the following fields-

String url: the url that the project was checked out from
int revision: the revision that the working copy is at
String lastChangedAuthor: the author who committed the last change
int lastChangedRev: the revision that most recently modified this working copy (note, not necessarily the same as revision field)
String lastChangedDate: the date/time when lastChangedRevision happened

r12238: Add _floristPlantsUsed as a comma-separated list and '''florist_available()'''.
Add "florist plant [plantname]" to add a plant. [plantname] is case-insensitive, but otherwise must exactly match KoL's name for the plant.
Check what is currently planted when you log in.

r12244: Add string [location][int] '''get_florist_plants()'''

example 1...
foreach loc, counter, plant in get_florist_plants() {
print( "Location '" + loc + "'" );
print( "Counter '" + counter + "'" );
print( "Plant '" + plant + "'" );
}

example 2...
string [location][int] plants = get_florist_plants();
foreach loc in plants {
print( "Location '" + loc + "'" );
string [int] array = plants[ loc ];
foreach index in array {
string plant = array[index];
if ( plant != "" )
print( "Plant = " + plant );
}
}

r12255: Experimental support for Dad Sea Monkee - untested in-game.
- When we first see Dad Sea Monkee, parse the clues and solve for them.
- "'''dad'''" CLI command lists the elemental weakness (and spell) for rounds 1-10
- element '''dad_sea_monkee_weakness( int round )''' ASH function for consult scripts.

12657: Add "'''cache clear'''" command to remove all cached images from /images

12659: New setting - lastImageCacheClear - records the time when you last cleared the
image cache. "'''cache'''" command with no arguments reports that time.

12662: Add '''get_ignore_zone_warnings()'''

12932: Adds my_discomomentum().

13088: Make Prismatic Damage a real, if derived, modifier name. It cannot be used in
modifiers.txt, bit you can ask for it by name either in ASH or the Maximizer

13175: Add ash command my_soulsauce().

13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing
ASH tracing goes into ASH_datestamp.txt

13222: Add preference banishedMonsters to track banishes. Add ash command is_banished($monsterName[name])

13223: Add "thrall" datatype to ASH.
New ASH function: thrall my_thrall()

13234: New ASH functions: to_thrall( int ), to_thrall( string ), to_int( thrall )
New proxy fields for thralls: .id, .image, .tinyimage, .skill

13256: Add CLI command to buy or sell from a coinmaster:
coinmaster buy nickname item, item ...
coinmaster sell nickname item, item, ...

r13280 & r13282: Added Ash functions:
'''monster_initiative( [monster] )''' - returns initiative + ML penalty

13299: Add "'''bugbears'''" command to give status of the 9 Bugbear Mothership zones

13393: Added ash function '''stun_skill()''', returns the character's stun skill based on lass/preferences.

13395: CLI command '''restores''' added, tells you detail on all currently available restores. "restores all" tells you about all restores, "restores obtainable" tells you about all restores that you have or are tradeable.

13576: New ash data type $bounty

13581: Add ash to_bounty() function

13617: Add '''bounty''' CLI command.
bounty - lists bounty progress and untaken bounties
bounty easy|hard|special - accepts a bounty

13618: Add faxbot ash( $monster ) command. Note that chat must be open for this to successfully work, just as for other mafia fax interfaces.

13638: Add "bjornify" gCLI command, bjornify_familiar( familiar ), and my_bjorned_familiar().

13704: Add "grim" gCLI command to get a Grim Brother effect

13725: Track Audience (only works with character pane at present, request to add to api has been made). Appears on mafia side panel, also available with ash command my_audience().

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

r10025: Added '''choice''' CLI command, to resolve manual or unsupported choiceadventures
Added "choice" CLI command, to resolve manual or unsupported choice
adventures without having to visit the relay browser - which might be
inconvenient if you're already in the CLI, and don't need to see the full
adventure text to decide which option you want. With no parameter, "choice"
just lists the options. With a numeric parameter, it picks that option.
With any other parameter, it picks the first option containing that text (in
either the actual button text, or mafia's spoiler text).

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]

Control Structures

2014-03-30T07:23:55Z

Gnocchi masala: Revisions 10765, 10772 & 10774 implement static scope for code that is only to be executed once on loading.

{{TOCright}}
==Conditional==
===if===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean )
{
// any statements here
// are only going to be executed
// if the boolean returns true
}
</syntaxhighlight>}}
{{
CodeSample|
description=Single-statement conditionals may omit the curly braces.|
code=
<syntaxhighlight>
if ( boolean )
// curly braces aren't required if only one statement follows the conditional
</syntaxhighlight>}}
===else===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean )
{
// statements if true
}
else
{
// the statements here
// are only going to be executed
// if the boolean returns false
}
</syntaxhighlight>}}

===else if===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean 1 )
{
// statements if true
}
else if ( boolean 2 )
{
// the statements here
// are only going to be executed
// if boolean 1 returns false
// & boolean 2 returns true
}
</syntaxhighlight>}}

===switch===
{{
CodeSample|
code=
<syntaxhighlight>
switch ( variable )
{
case value:
// statements if variable == value
// more such statements
break;
//repeat above for as many values as desired
default:
// statements executed if
// none of the cases were true
}
</syntaxhighlight>}}

Note that each "case" can only test against a single value; that value can be a variable itself, but not a test expression.

{{
CodeSample|
description=If switch has no parameter, then each case is evaluated as a boolean expression, like a string of if-then statements.|
code=
<syntaxhighlight>
switch
{
case boolean expression:
// if the expression is true, this statement is executed
// more such statements
break;
//repeat above for as many conditionals as desired
default:
// statements executed if
// none of the cases were true
}
</syntaxhighlight>}}

==Unconditional==
===try / finally===
{{
CodeSample|
description=Block1 is executed as normal, and then block2 is executed regardless of whether
block1 finished normally, generated an error, or encountered a 'return',
'break', or 'continue' statement.|
code=
<syntaxhighlight>
try
{
// block1
}
finally
{
// block2
}
</syntaxhighlight>}}

===static===
{{
CodeSample|
code=
<syntaxhighlight>
static
{
// any statements here
// are only going to be executed once at the
// first time the script executes in a session.
}
</syntaxhighlight>}}
{{
CodeSample|
description=Single-statement static declarations may omit the curly braces.|
code=
<syntaxhighlight>
static
// curly braces aren't required if only one statement follows the static keyword.
</syntaxhighlight>}}

==Loops==
===while===
{{
CodeSample|
code=
<syntaxhighlight>
while ( boolean )
{
// as with an if statement
// this area is only entered
// if the boolean tests true
// once all this is done
// it goes back to the begining
// and will keep executing
// as long as the boolean remains true
}
</syntaxhighlight>}}

===repeat until===

This is similar to the [http://en.wikipedia.org/wiki/Do_while_loop do...while loop], but only ends the loop when the <code>boolean</code> expression evaluates to <code>true</code>.

{{
CodeSample|
code=
<syntaxhighlight>
repeat
{
// this is the same
// as the while loop above
// with one exception:
// all of this code will
// execute at least once
// as the test doesn't occur
// until the very end
} until ( boolean );
</syntaxhighlight>}}

===for===
{{
CodeSample|
code=
<syntaxhighlight>
for x from a to b by c {
//do stuff
}
</syntaxhighlight>}}
Above is the general case. You don't need to specify whether it's going up or down - although doing so by using upto or downto does allow a runtime check to make sure you didn't screw up.

If you don't specify "c", it defaults to incrementing/decrementing by 1. The first iteration is at a and the last is at b (that is to say, it goes from a to b, inclusive).

===foreach===
{{
CodeSample|
code=
<syntaxhighlight>
foreach key in aggregate {
//do stuff
}
</syntaxhighlight>}}
Assigns each key in the supplied map or slice to "<code>key</code>" and iterates through the map. Due to how maps are handled, <code>foreach</code> is guaranteed to iterate through the map in sorted order.

{{
CodeSample|
description=For example:|
code=
<syntaxhighlight>
boolean [int][string] map;
map[15]["test"] = true;
foreach int_index in map {
print(int_index); //this will print '15' once, since there is only one valid value for this index
foreach string_index in map[int_index] //this iterates over the "slice" of the map where 1 is fixed as the index
{
print(string_index); //This will print "test" once, since there is only one valid value for this index
print(map[int_index][string_index]); //this will print "true"
}
}
</syntaxhighlight>|
moreinfo=
So the output is
<pre>
15
test
true
</pre>}}
{{
CodeSample|
description=For a multidimensional map, instead of nesting <code>foreach</code> statements two iterators can be used inline.|
code=
<syntaxhighlight>
foreach x, y in map {
//do stuff
}
</syntaxhighlight>}}
{{
CodeSample|
description=This is identical to:|
code=
<syntaxhighlight>
foreach x in map {
foreach y in map[x] {
//do stuff
}
}
</syntaxhighlight>}}

{{CodeSample|
description=You can also directly specify the value stored in the map by specifying one more variable than the number of keys in the map:|
code=
<syntaxhighlight>
//string [string, int, item] my_map;
foreach s, i, m, value in my_map {
print( s + ", " + i + ", " + m + " => " + value );
}
</syntaxhighlight>
}}

See the page for [[Data Structures]] for more information on aggregates.

==Continuation & Exiting==
Like many languages with looping structures, ASH supports the break and continue statements. All looping structures (for, while, repeat until, and foreach) support these statements.

===break===
Breaks out of the smallest enclosing loop. In a switch statement, breaks out of the switch statement. Execution resumes at the first statement after the end of the loop/switch statement.

===continue===
Continues on to the next iteration of the loop (skipping any statements in this iteration that occur after the continue statement). In a switch statement, continue is allowed iff the switch is inside a loop, and acts as any other continue.

===return===
Exits the function and returns the value following the return statement, if specified. Note that the value's datatype must match that of the function itself (void functions can only use return by itself).

===exit===
Exits the script. Using return when in main() achieves the same effect. Note that while this will end the current script, it will not stop automation.

[[Category:Scripting]]

Proxy Records

2014-03-30T07:06:04Z

Gnocchi masala: Refreshed output of code samples.

Proxy Records is a way for KoLmafia to pass additional information to the scripter. Many datatypes contain these proxy records. such as items, skills, effects, monsters and coinmasters. This information is referred to as proxy records because the manner of reference is similar to a field of a [[Data_Structures#Records|record]].

{{CodeSample|
description=This is an example of how to retrieve proxy record information in a script. Notice it uses the same notation as if the item datatype is a record.|
code=<syntaxhighlight>
item it = $item[coffee pixie stick];
print("You can buy a "+ it +" at the "+ it.seller);
print("It will consume "+ it.spleen +" spleen and give "+ it.adventures +" adventures.");
</syntaxhighlight>}}

Here's an example of displaying a proxy record in the CLI. Note that it displays all fields associated with that datatype.
<pre>
> ash $item[coffee pixie stick]

Returned: coffee pixie stick
plural => coffee pixie sticks
descid => 936288573
image => cpstick.gif
smallimage => cpstick.gif
levelreq => 4
quality =>
adventures => 5-10
muscle => 0
mysticality => 0
moxie => 0
fullness => 0
inebriety => 0
spleen => 4
minhp => 0
maxhp => 0
minmp => 0
maxmp => 0
dailyusesleft => 0
notes =>
quest => false
gift => false
tradeable => false
discardable => true
combat => false
reusable => false
usable => true
multi => true
fancy => false
candy => false
seller => Arcade Ticket Counter
buyer => none
name_length => 18

> ash $coinmaster[Arcade Ticket Counter]

Returned: Arcade Ticket Counter
token => ticket
item => Game Grid ticket
property =>
available_tokens => 13
buys => false
sells => true

> ash $location[The Penultimate Fantasy Airship]

Returned: The Penultimate Fantasy Airship
nocombats => false
zone => Beanstalk
parent => Beanstalk
parentdesc => Above the Beanstalk
environment => outdoor
bounty => burned-out arcanodiode
combat_queue => Irritating Series of Random Encounters; Quiet Healer; Irritating Series of Random Encounters; Burly Sidekick; Protagonist
noncombat_queue => Rip Rop Wrappety Do; F-F-Fantastic!; The Super Secret Canadian Mind-Control Device; The Super Secret Canadian Mind-Control Device; The Super Secret Canadian Mind-Control Device
kisses => 0

> ash $item[burned-out arcanodiode]

Returned: burned-out arcanodiode
plural => burned-out arcanodiodes
descid => 207784873
image => diode.gif
smallimage => diode.gif
levelreq => 0
quality =>
adventures =>
muscle =>
mysticality =>
moxie =>
fullness => 0
inebriety => 0
spleen => 0
minhp => 0
maxhp => 0
minmp => 0
maxmp => 0
dailyusesleft => 0
notes =>
quest => true
gift => false
tradeable => false
discardable => false
combat => false
reusable => false
usable => false
multi => false
fancy => false
candy => false
seller => none
buyer => none
name_length => 22

> ash $skill[empathy of the newt]

Returned: Empathy of the Newt
level => 8
image => empathy.gif
traincost => 3250
class => Turtle Tamer
libram => false
passive => false
buff => true
combat => false
song => false
expression => false
permable => true
dailylimit => -1
timescast => 0

> ash $familiar[slimeling]

Returned: Slimeling
combat => true
hatchling => squirming Slime larva
image => slimeling.gif
name => Princess Vina
charges => 0

> ash $monster[black widow]

Returned: black widow
base_hp => 121
base_attack => 132
base_defense => 110
raw_hp => 121
raw_attack => 132
raw_defense => 110
base_initiative => 50
raw_initiative => 50
attack_element => none
defense_element => none
physical_resistance => 0
min_meat => 40
max_meat => 60
base_mainstat_exp => 16.5
phylum => bug
poison => Really Quite Poisoned
boss => false
image => blackwidow.gif

> ash $effect[sugar rush]

Returned: Sugar Rush
default => use either 1 Angry Farmer candy, 1 Tasty Fun Good rice candy, 1 Crimbo candied pecan, Crimbo fudge, Crimbo peppermint bark, 1 Breath mint, 1 that gum you like
note =>
all => aggregate boolean [string]
 use 1 Angry Farmer candy => true
 use 1 Tasty Fun Good rice candy => true
 use 1 Crimbo candied pecan => true
 use Crimbo fudge => true
 use Crimbo peppermint bark => true
 use 1 Breath mint => true
 use 1 that gum you like => true
image => http://images.kingdomofloathing.com/itemimages/hoppedup.gif
descid => 83695b70e0470a36125feca3198a16b4
</pre>

[[Category:Scripting]]

Help:To Do List

2014-03-30T06:55:16Z

Gnocchi masala: Revision 12906 add shop_price() & refresh_shop() functions.

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==
10078: ash function format_dtg
10081: ash function format_dtg renamed to be
string '''format_date_time(inFormat, dtg, outFormat)'''
more info: http://kolmafia.us/showthread.php?8451-time_to_string()-with-parameter&p=64058&viewfull=1#post64058

Modify examples on proxy record page because of:
10122: Add the boolean "fancy" and "candy" fields to item '''proxy records'''.
10147: Initial support for "Crimbo 2011" coinmaster: trade candy for Candy Credits
10412: Add $skill '''proxy records''': .dailylimit and .timescast
10879: Add a boolean "boss" field to $monster[]

10227: Add the <s>"'''closet empty'''" CLI command, and</s> the '''empty_closet()''' ASH function.

r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods

r10344 Add '''tavern( string goal )''' ASH function.
goal can be "faucet", "baron", or "explore" (to explore all remaining unexplored squares).
r10345 Add ASH '''tavern( "fight" )''' to explore cellar until the Baron's mansion is found
and then go in to fight him.

r10753-6 '''get_goals()''' returns a string[int] containing all the conditions that KoLmafia will
try to satisfy. Add g'''oal_exists()''' where you can pass in a goal type (choiceadv, autostop,
meat, health, mana, item) and KoLmafia will tell you if there are any goals that match.

'''static''' scope is added!
r10765: Add a "final" scope type to ASH which allows data/commands to be executed only
once per session.
r10772: A final declaration can either take a block, surrounded by {}, or a single
command or declaration.
r10774: ASH: "final" -> "static"

10922: Add '''get_player_id()''' method to ASH

10937: Add '''minstrel_quest()''' boolean function,
which returns true when Clancy has a new quest for you.

10971: Added boolean '''hippy_stone_broken()''' function

11023: Make the CLI "attack" command work again. Make "pvp" equivalent to "steal" instead
of "attack". Added "swagger" as equivalent to "flowers".

11055: Added a 2-parameter version of '''to_string()''', where the first parameter can
currently be an int or float (other types are possible, but didn't seem
useful), and the second is a format string as defined by the Java
String.format() method (which in turn is based on C printf() format strings).
For example, "%.2f" will output a float with exactly two digits after the
(localized) decimal point.

11110: Add ASH function: '''pvp_attacks_left()'''. This is guaranteed accurate only if you
have recently looked at the Fight! page. Tracking of PVP fights gained via
consumption or familiar action and initialization at login will come later -
after api.php is updated to include the figure.

Add '''beforePVPScript''' setting which contains a script to be executed before a PVP
attack. At the moment, this is only called from the Relay Browser - and only if
relayRunsBeforePVPScript is true

11112: Call beforePVPScript, if present, during automated PVP via the "flowers" command

11112: Change ASH '''have_outfit()''' to work with custom outfits, as well as normal outfit
Add ASH '''is_wearing_outfit()''' to return TRUE if you are currently wearing the
specified custom or normal outfit.

10815: Allow certain ASH constants to be used in custom combat settings.
$phylum[] refers to the monster categorization, see the built-in ASH constants documentation for more information.
$element[] refers to either the attack or the defense element. As long as one matches, this check will be satisfied. This may limit its usefulness, but we can evaluate it later.
$item[] refers to an item that the monster drops. If there are multiple monsters that drop the item, or if you just can't remember which one it is, and your combat strategy happens to depend on it...
In order to match, everything that you specify must match. So if you specify an impossible combination, that CCS section will not run.

[ $element[ spooky ] $item[ hobo nickel ] ]
skill entangling noodles
skill weapon of the pastalord

[ bathroom $element[ spooky ] ]
attack

[ $phylum[ beast ] ]
skill stomp
attack

11197: new ASH functions:
boolean '''is_familiar_equipment_locked()'''
-returns true if current familiar equipment is locked, otherwise false
void '''lock_familiar_equipment(boolean locking)'''
-tries to lock/unlock fam equipment accordingly.

11208: Add int '''get_clan_id()''' and string '''get_clan_name()''' functions.

11267: Pass chat events along to '''chatbotscript'''. The sender is an empty string,
the channel is "Events", and the message is stripped of its HTML.

11432: Add '''is_discardable()''' which will return true even if an item can be autosold,
so be careful you don't get cheated out of some meat.

11438: Revert use of gift flag to previous interpretation: KoL has the item marked as
a "Gift Item". Instead, change isGiftable() - which is also used by the ASH
is_giftable() function - to allow either the "tradeable" or "gift" flags.
Fix the item.gift proxy field to return the value of the gift flag, rather than
being a synonym for is_giftable().

11555: Add monster.raw_attack, monster.raw_defense, and monster.raw_hp to return the
unmodified stats from monsters.txt.

11561: Add monster '''image_to_monster( string )''' ASH function for looking up monster by image file name.
Add monster.image proxy field for going the other way.

11771: experimental: add overloaded maximize() signature in ASH

'''maximize( string maximizerString, int maxPrice, int priceLevel, boolean simulate, boolean showEquipment )'''

returns an aggregate of records with each record containing the fields:
**display => display text, as it is shown in the maximizer frame
**cmd => actual command string that the maximizer runs to get the boost
**score => the boost's score
**effect => the effect provided by the boost - if applicable. effect[none] if it is equipment.
**item => $item[] that is being suggested for use or equipment
**skill => $skill[] that is being suggested

If the showEquipment argument is false, equipment will be omitted from the results.

r11707: Experimental ASH feature: the main() function of imported scripts can now be
invoked, under the alternate name main@filename()
(where 'filename' can be overridden by a 'script' directive, any ".ash"
suffix is dropped, and non-alphanumeric characters are replaced by
underscores). Note that no spaces are allowed around the @, the whole thing
is a single token.

r11965: Add my_companion()

r11985: Add the "skeleton" CLI command.

r12019: Add "eudora" CLI command

r12060: add ASH get_moods(), returns an aggregate of currently defined mood names.
"mood listall" in the gCLI will also print a list of defined moods.

r12062: add ASH get_outfits() and get_custom_outfits()

r12070: Overloaded version of appearance_rates considers monster queue:
appearance_rates( $location[] location, boolean includeQueue )

r12105: maximizerMRULength is now maximizerMRUSize
That affects this page: [[Hidden_Features#Most_Recently_Used_Modifier_Maximizer_Expression]]

'''SVN Features added''' by Roippi! SVN integration was (brokenly) implemented in r12141 and more correctly implemented in r12144.

FOR USERS:
* svn checkout <svnurl> - checks out a svn repository and adds the files from the working copy to the appropriate locations.
* svn update - updates all of your installed projects and pushes any changes to the appropriate locations.
* svn list - lists installed projects.
* svn delete <scriptname> - deletes installed projects and the corresponding files that it pushed. <scriptname> fuzzy matches the script names from svn list.

FOR SCRIPTERS:
You can provide a <nowiki>svn://, http://, or https://</nowiki> link to a valid svn repo. The link does not need to be to the root of the repository.
At the location specified by the url, there are only four permissible folders:
* ccs/
* data/
* images/
* relay/
* scripts/

Any files or directories in the location specified by your url that are not named the above will cause your repo to fail validation and thus it will not be checked out.
Within the valid folders, you can nest files however you want.
When users check out your project, the files (and nested folders) will be pushed to the corresponding mafia directories.

r12157: '''svn increment <projectname>''' and '''svn decrement <projectname>''' moves an installed svn project up/down one revision, respectively.
'''svn update''' can also take <projectname> argument or a <SVNURL> argument. Or just be blank to update everything.
r12177 svn inc/dec does the same thing as svn increment/decrement. Because typing stuff is hard.

12167: command "'''svn sync'''"

Looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the WC file is copied over the local copy one.
Note that this is very different from "svn update" and indeed does not contact the repository server at all.

If you are unsure if you want this feature, this is only for people who maintain modifications to the files in their svn/ folders that they want merged in with updates from the repo.
If you are just doing checkout/update operations and don't know what this "merging" business is about, you don't need this feature.

Users who want to automatically sync after update operations can set syncAfterSvnUpdate = true.

r12153: add '''svnUpdateOnLogin''' (global, default false), which runs svn update before breakfast/loginScript.
This could be useful if your loginScript has svn dependencies.

r12188: add global preference '''_svnUpdated'''
only do login svn update (mediated by svnUpdateOnLogin) at most once per day.

r12181: add preference '''simpleSvnUpdate''' (global, default true)
If true, simply checks if the root of your working copy is at HEAD, skipping it if so.
Speeds up the average update operation by 75% (and is probably nicer on servers).
Advanced users who have done something like a non-root "svn switch" or are using svn externals should know whether they want to turn this off.

Again the ticky box goes at the bottom of general preferences, it is soon time for these to be moved to their own page.

r12198 new ash svn functions:
boolean '''svn_exists'''( String projectname ) - returns true if a valid working copy named projectname exists in the svn/ folder
boolean '''svn_at_head'''( String projectname ) - returns true if projectname exists, is a valid WC, and is currently at the same revision # as the repository.
This will hit the repo server, so be nice.

r12206: initial support for automatic svn dependency installation.
global preference '''svnInstallDependencies''' (default true) controls whether svn will try to install dependencies.

Scripters are now allowed to place a file called dependencies.txt in the top-level of a project.
Calling it anything else will fail validation, as before. This special file will not be "pushed" to anywhere locally, it will just remain in the working copy folder.
On each line of dependencies.txt, you specify one URL to another SVN project.

r12211: preference '''svnShowCommitMessages''' (global, default false) controls whether you want to see new commit messages from svn update operations.

r12215: add ash function: '''record svn_info( String project )'''
record has the following fields-

String url: the url that the project was checked out from
int revision: the revision that the working copy is at
String lastChangedAuthor: the author who committed the last change
int lastChangedRev: the revision that most recently modified this working copy (note, not necessarily the same as revision field)
String lastChangedDate: the date/time when lastChangedRevision happened

r12238: Add _floristPlantsUsed as a comma-separated list and '''florist_available()'''.
Add "florist plant [plantname]" to add a plant. [plantname] is case-insensitive, but otherwise must exactly match KoL's name for the plant.
Check what is currently planted when you log in.

r12244: Add string [location][int] '''get_florist_plants()'''

example 1...
foreach loc, counter, plant in get_florist_plants() {
print( "Location '" + loc + "'" );
print( "Counter '" + counter + "'" );
print( "Plant '" + plant + "'" );
}

example 2...
string [location][int] plants = get_florist_plants();
foreach loc in plants {
print( "Location '" + loc + "'" );
string [int] array = plants[ loc ];
foreach index in array {
string plant = array[index];
if ( plant != "" )
print( "Plant = " + plant );
}
}

r12255: Experimental support for Dad Sea Monkee - untested in-game.
- When we first see Dad Sea Monkee, parse the clues and solve for them.
- "'''dad'''" CLI command lists the elemental weakness (and spell) for rounds 1-10
- element '''dad_sea_monkee_weakness( int round )''' ASH function for consult scripts.

12657: Add "'''cache clear'''" command to remove all cached images from /images

12659: New setting - lastImageCacheClear - records the time when you last cleared the
image cache. "'''cache'''" command with no arguments reports that time.

12662: Add '''get_ignore_zone_warnings()'''

12932: Adds my_discomomentum().

13088: Make Prismatic Damage a real, if derived, modifier name. It cannot be used in
modifiers.txt, bit you can ask for it by name either in ASH or the Maximizer

13175: Add ash command my_soulsauce().

13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing
ASH tracing goes into ASH_datestamp.txt

13222: Add preference banishedMonsters to track banishes. Add ash command is_banished($monsterName[name])

13223: Add "thrall" datatype to ASH.
New ASH function: thrall my_thrall()

13234: New ASH functions: to_thrall( int ), to_thrall( string ), to_int( thrall )
New proxy fields for thralls: .id, .image, .tinyimage, .skill

13256: Add CLI command to buy or sell from a coinmaster:
coinmaster buy nickname item, item ...
coinmaster sell nickname item, item, ...

r13280 & r13282: Added Ash functions:
'''monster_initiative( [monster] )''' - returns initiative + ML penalty

13299: Add "'''bugbears'''" command to give status of the 9 Bugbear Mothership zones

13393: Added ash function '''stun_skill()''', returns the character's stun skill based on lass/preferences.

13395: CLI command '''restores''' added, tells you detail on all currently available restores. "restores all" tells you about all restores, "restores obtainable" tells you about all restores that you have or are tradeable.

13576: New ash data type $bounty

13581: Add ash to_bounty() function

13617: Add '''bounty''' CLI command.
bounty - lists bounty progress and untaken bounties
bounty easy|hard|special - accepts a bounty

13618: Add faxbot ash( $monster ) command. Note that chat must be open for this to successfully work, just as for other mafia fax interfaces.

13638: Add "bjornify" gCLI command, bjornify_familiar( familiar ), and my_bjorned_familiar().

13704: Add "grim" gCLI command to get a Grim Brother effect

13725: Track Audience (only works with character pane at present, request to add to api has been made). Appears on mafia side panel, also available with ash command my_audience().

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

r10025: Added '''choice''' CLI command, to resolve manual or unsupported choiceadventures
Added "choice" CLI command, to resolve manual or unsupported choice
adventures without having to visit the relay browser - which might be
inconvenient if you're already in the CLI, and don't need to see the full
adventure text to decide which option you want. With no parameter, "choice"
just lists the options. With a numeric parameter, it picks that option.
With any other parameter, it picks the first option containing that text (in
either the actual button text, or mafia's spoiler text).

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]

Item Management

2014-03-30T06:52:00Z

Gnocchi masala: Revision 12906 add shop_price() function.

{{TOCright}}
==Informational==
{{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}
{{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
{{Flink|int|my_storage_meat|desc=Returns the amount of meat you have in Hagnk's Ancestral Mini-Storage.}}
{{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
{{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
{{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
{{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
{{Flink|item|get_dwelling|desc=Returns the item corresponding with your dwelling.}}
{{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
{{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
{{Flink|string|item_type|item|desc=Returns the type of item specified.}}
{{Flink|int|item_amount|item}}
{{Flink|int|closet_amount|item}}
{{Flink|int|display_amount|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|int|shop_amount|item}}
{{Flink|int [item]|get_shop|desc=Returns entire contents of shop and quantity of each item}}
{{Flink|int|stash_amount|item|}}
{{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}
{{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}
{{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}
{{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}
{{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}
{{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}
[[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]
{{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}
{{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}
{{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}
{{Flink|boolean|have_display|desc=Returns whether you have a display case.}}
{{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}
{{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|void|refresh_shop|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|int|shop_price|item|desc=Returns the current price for the given item if it is present in your mall store.}}
{{Flink|int|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|npc_price|item|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
{{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
{{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}
{{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
{{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}
{{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}
{{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}
{{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

==Moving Items Around==
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success. If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item|desc=Adds or removes items in your store and returns success.}}

==Acquiring & Using Items==
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|boolean|buy|int|item}}
{{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
{{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|eatsilent|int|item|desc=Attempts to eat items as specified.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
{{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}
{{Flink|boolean|overdrink|int|item}}
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}
{{Flink|string|last_item_message|desc=Returns message that KoL reports in the event of error.}}

==Coinmaster Control==
Some items can be bought from or sold to various "coinmasters" which are like shops that deal in a currency other than meat. These coinmasters include the Dimemaster and Quartermaster during the Island War, the Hermit, the Mr. Store and many others. Some relevant information can be found in [[proxy records]] for the item and coinmaster data types. The rest is controlled by the following functions.

===Inquiries===
{{Flink|coinmaster|to_coinmaster|string|desc=Converts a string to a valid coinmaster.}}
{{Flink|boolean|is_coinmaster_item|item|desc=Is a given item acquirable from a coinmster.}}
{{Flink|boolean|buys_item|coinmaster|item|desc=Is a specific item acquirable from the named coinmster.}}
{{Flink|int|buy_price|coinmaster|item|desc=What is the coinmaster's purchase price for an item.}}
{{Flink|boolean|sells_item|coinmaster|item|desc=Is a specific item sellable to the named coinmster.}}
{{Flink|int|sell_price|coinmaster|item|desc=What is the coinmaster's selling price for an item.}}

===Coinmaster transactions===
{{Flink|boolean|is_accessible|coinmaster|desc=Is a given coinmaster currently accessible.}}
{{Flink|string|inaccessible_reason|coinmaster|desc=The reason a given coinmaster is currently inaccessible.}}
{{Flink|boolean|visit|coinmaster|desc=Refreshes information at a coinmaster.}}
{{Flink|boolean|buy|coinmaster|int|item|desc=Buys an item from a coinmaster.}}
{{Flink|boolean|sell|coinmaster|int|item|desc=Sells an item to a coinmaster.}}

[[Category:Scripting]]

Shop price

2014-03-30T06:48:52Z

Gnocchi masala: Revision 12906 add shop_price() function.

{{
#vardefine:name|shop_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|it}}|
p1desc={{Pspan|it}} is the item to check|
}}|

function_description=Returns the price of a given item that are currently for sale in your mall store. If the item is not currently for sale then 999999999 is returned.|
needscode=yes|
see_also={{SeeAlso|mall_price|historical_price|autosell_price|npc_price}}|
}}

[[Category:Item Management]]

Ash Functions

2014-03-30T06:42:44Z

Gnocchi masala: Revision 12906 add shop_price() function.

{{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.)
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{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}}
===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|string|{{opt|string}}}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|boolean|buy|coinmaster|int|item}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buys_item|coinmaster|item}}
===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|chamber}}
{{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|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|int|creatable_amount|item}}
{{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|entryway}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{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|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{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|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string|get_ccs_action|int}}
{{Flink|int|get_clan_id}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling|}}
{{Flink|string [int]|get_goals}}
{{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}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{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|item|guardians}}
{{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_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hedgemaze}}
{{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}}

===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_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{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|any}}
{{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_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|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|int|monster_initiative|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{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_basestat|stat}}
{{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_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{Flink|location|my_location}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxfury}}
{{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|string|my_sign}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{Flink|int|my_turncount}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|string|{{opt|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|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|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|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|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_combat}}
{{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|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|string}}
{{Flink|string|string_modifier|string|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}

===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|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|class|to_class|string}}
{{Flink|coinmaster|to_coinmaster|string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|null}}
{{Flink|location|to_location|string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|string}}
{{Flink|skill|to_skill|effect}}
{{Flink|slot|to_slot|item}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{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_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|string}}
{{Flink|buffer|visit_url|string|boolean}}
{{Flink|buffer|visit_url|string|boolean|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}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

Item Management

2014-03-30T06:34:32Z

Gnocchi masala: Revision 12906 add refresh_shop() function.

{{TOCright}}
==Informational==
{{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}
{{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
{{Flink|int|my_storage_meat|desc=Returns the amount of meat you have in Hagnk's Ancestral Mini-Storage.}}
{{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
{{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
{{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
{{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
{{Flink|item|get_dwelling|desc=Returns the item corresponding with your dwelling.}}
{{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
{{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
{{Flink|string|item_type|item|desc=Returns the type of item specified.}}
{{Flink|int|item_amount|item}}
{{Flink|int|closet_amount|item}}
{{Flink|int|display_amount|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|int|shop_amount|item}}
{{Flink|int [item]|get_shop|desc=Returns entire contents of shop and quantity of each item}}
{{Flink|int|stash_amount|item|}}
{{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}
{{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}
{{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}
{{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}
{{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}
{{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}
[[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]
{{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}
{{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}
{{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}
{{Flink|boolean|have_display|desc=Returns whether you have a display case.}}
{{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}
{{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|void|refresh_shop|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|int|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|npc_price|item|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
{{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
{{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}
{{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
{{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}
{{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}
{{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}
{{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

==Moving Items Around==
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success. If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item|desc=Adds or removes items in your store and returns success.}}

==Acquiring & Using Items==
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|boolean|buy|int|item}}
{{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
{{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|eatsilent|int|item|desc=Attempts to eat items as specified.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
{{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}
{{Flink|boolean|overdrink|int|item}}
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}
{{Flink|string|last_item_message|desc=Returns message that KoL reports in the event of error.}}

==Coinmaster Control==
Some items can be bought from or sold to various "coinmasters" which are like shops that deal in a currency other than meat. These coinmasters include the Dimemaster and Quartermaster during the Island War, the Hermit, the Mr. Store and many others. Some relevant information can be found in [[proxy records]] for the item and coinmaster data types. The rest is controlled by the following functions.

===Inquiries===
{{Flink|coinmaster|to_coinmaster|string|desc=Converts a string to a valid coinmaster.}}
{{Flink|boolean|is_coinmaster_item|item|desc=Is a given item acquirable from a coinmster.}}
{{Flink|boolean|buys_item|coinmaster|item|desc=Is a specific item acquirable from the named coinmster.}}
{{Flink|int|buy_price|coinmaster|item|desc=What is the coinmaster's purchase price for an item.}}
{{Flink|boolean|sells_item|coinmaster|item|desc=Is a specific item sellable to the named coinmster.}}
{{Flink|int|sell_price|coinmaster|item|desc=What is the coinmaster's selling price for an item.}}

===Coinmaster transactions===
{{Flink|boolean|is_accessible|coinmaster|desc=Is a given coinmaster currently accessible.}}
{{Flink|string|inaccessible_reason|coinmaster|desc=The reason a given coinmaster is currently inaccessible.}}
{{Flink|boolean|visit|coinmaster|desc=Refreshes information at a coinmaster.}}
{{Flink|boolean|buy|coinmaster|int|item|desc=Buys an item from a coinmaster.}}
{{Flink|boolean|sell|coinmaster|int|item|desc=Sells an item to a coinmaster.}}

[[Category:Scripting]]

Refresh shop

2014-03-30T06:32:41Z

Gnocchi masala: Revision 12906 add refresh_shop() function.

{{
#vardefine:name|refresh_shop}}{{
#vardefine:return_type|void}}{{

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

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

function_description=Forces mafia to re-check your mall store (useful since it's impossible for mafia to internally track this section of "your" inventory).|

needscode=yes|

cli_equiv=Not Known|
}}

[[Category:Item Management]]

Ash Functions

2014-03-30T06:30:16Z

Gnocchi masala: Revision 12906 add refresh_shop() function. Also all refresh_* functions so far return void not boolean.

{{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.)
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{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}}
===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|string|{{opt|string}}}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|boolean|buy|coinmaster|int|item}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buys_item|coinmaster|item}}
===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|chamber}}
{{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|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|int|creatable_amount|item}}
{{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|entryway}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{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|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{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|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string|get_ccs_action|int}}
{{Flink|int|get_clan_id}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling|}}
{{Flink|string [int]|get_goals}}
{{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}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{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|item|guardians}}
{{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_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hedgemaze}}
{{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}}

===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_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{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|any}}
{{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_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|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|int|monster_initiative|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{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_basestat|stat}}
{{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_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{Flink|location|my_location}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxfury}}
{{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|string|my_sign}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{Flink|int|my_turncount}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|string|{{opt|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|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|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|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|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_combat}}
{{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|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|string}}
{{Flink|string|string_modifier|string|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}

===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|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|class|to_class|string}}
{{Flink|coinmaster|to_coinmaster|string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|null}}
{{Flink|location|to_location|string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|string}}
{{Flink|skill|to_skill|effect}}
{{Flink|slot|to_slot|item}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{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_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|string}}
{{Flink|buffer|visit_url|string|boolean}}
{{Flink|buffer|visit_url|string|boolean|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}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

Ash Functions

2014-03-30T06:25:36Z

Gnocchi masala: Veracity's revision 12905 implementing changed shop funcionality.

{{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.)
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{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}}
===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|string|{{opt|string}}}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|boolean|buy|coinmaster|int|item}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buys_item|coinmaster|item}}
===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|chamber}}
{{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|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|int|creatable_amount|item}}
{{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|entryway}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{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|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{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|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string|get_ccs_action|int}}
{{Flink|int|get_clan_id}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling|}}
{{Flink|string [int]|get_goals}}
{{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}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{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|item|guardians}}
{{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_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hedgemaze}}
{{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}}

===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_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{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|any}}
{{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_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|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|int|monster_initiative|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{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_basestat|stat}}
{{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_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{Flink|location|my_location}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxfury}}
{{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|string|my_sign}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{Flink|int|my_turncount}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|string|{{opt|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|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|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|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{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_combat}}
{{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|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|string}}
{{Flink|string|string_modifier|string|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}

===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|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|class|to_class|string}}
{{Flink|coinmaster|to_coinmaster|string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|null}}
{{Flink|location|to_location|string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|string}}
{{Flink|skill|to_skill|effect}}
{{Flink|slot|to_slot|item}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{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_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|string}}
{{Flink|buffer|visit_url|string|boolean}}
{{Flink|buffer|visit_url|string|boolean|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}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

Help:To Do List

2014-03-30T06:06:12Z

Gnocchi masala: Veracity's revision 12905 implementing changed shop funcionality.

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==
10078: ash function format_dtg
10081: ash function format_dtg renamed to be
string '''format_date_time(inFormat, dtg, outFormat)'''
more info: http://kolmafia.us/showthread.php?8451-time_to_string()-with-parameter&p=64058&viewfull=1#post64058

Modify examples on proxy record page because of:
10122: Add the boolean "fancy" and "candy" fields to item '''proxy records'''.
10147: Initial support for "Crimbo 2011" coinmaster: trade candy for Candy Credits
10412: Add $skill '''proxy records''': .dailylimit and .timescast
10879: Add a boolean "boss" field to $monster[]

10227: Add the <s>"'''closet empty'''" CLI command, and</s> the '''empty_closet()''' ASH function.

r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods

r10344 Add '''tavern( string goal )''' ASH function.
goal can be "faucet", "baron", or "explore" (to explore all remaining unexplored squares).
r10345 Add ASH '''tavern( "fight" )''' to explore cellar until the Baron's mansion is found
and then go in to fight him.

r10753-6 '''get_goals()''' returns a string[int] containing all the conditions that KoLmafia will
try to satisfy. Add g'''oal_exists()''' where you can pass in a goal type (choiceadv, autostop,
meat, health, mana, item) and KoLmafia will tell you if there are any goals that match.

'''static''' scope is added!
r10765: Add a "final" scope type to ASH which allows data/commands to be executed only
once per session.
r10772: A final declaration can either take a block, surrounded by {}, or a single
command or declaration.
r10774: ASH: "final" -> "static"

10922: Add '''get_player_id()''' method to ASH

10937: Add '''minstrel_quest()''' boolean function,
which returns true when Clancy has a new quest for you.

10971: Added boolean '''hippy_stone_broken()''' function

11023: Make the CLI "attack" command work again. Make "pvp" equivalent to "steal" instead
of "attack". Added "swagger" as equivalent to "flowers".

11055: Added a 2-parameter version of '''to_string()''', where the first parameter can
currently be an int or float (other types are possible, but didn't seem
useful), and the second is a format string as defined by the Java
String.format() method (which in turn is based on C printf() format strings).
For example, "%.2f" will output a float with exactly two digits after the
(localized) decimal point.

11110: Add ASH function: '''pvp_attacks_left()'''. This is guaranteed accurate only if you
have recently looked at the Fight! page. Tracking of PVP fights gained via
consumption or familiar action and initialization at login will come later -
after api.php is updated to include the figure.

Add '''beforePVPScript''' setting which contains a script to be executed before a PVP
attack. At the moment, this is only called from the Relay Browser - and only if
relayRunsBeforePVPScript is true

11112: Call beforePVPScript, if present, during automated PVP via the "flowers" command

11112: Change ASH '''have_outfit()''' to work with custom outfits, as well as normal outfit
Add ASH '''is_wearing_outfit()''' to return TRUE if you are currently wearing the
specified custom or normal outfit.

10815: Allow certain ASH constants to be used in custom combat settings.
$phylum[] refers to the monster categorization, see the built-in ASH constants documentation for more information.
$element[] refers to either the attack or the defense element. As long as one matches, this check will be satisfied. This may limit its usefulness, but we can evaluate it later.
$item[] refers to an item that the monster drops. If there are multiple monsters that drop the item, or if you just can't remember which one it is, and your combat strategy happens to depend on it...
In order to match, everything that you specify must match. So if you specify an impossible combination, that CCS section will not run.

[ $element[ spooky ] $item[ hobo nickel ] ]
skill entangling noodles
skill weapon of the pastalord

[ bathroom $element[ spooky ] ]
attack

[ $phylum[ beast ] ]
skill stomp
attack

11197: new ASH functions:
boolean '''is_familiar_equipment_locked()'''
-returns true if current familiar equipment is locked, otherwise false
void '''lock_familiar_equipment(boolean locking)'''
-tries to lock/unlock fam equipment accordingly.

11208: Add int '''get_clan_id()''' and string '''get_clan_name()''' functions.

11267: Pass chat events along to '''chatbotscript'''. The sender is an empty string,
the channel is "Events", and the message is stripped of its HTML.

11432: Add '''is_discardable()''' which will return true even if an item can be autosold,
so be careful you don't get cheated out of some meat.

11438: Revert use of gift flag to previous interpretation: KoL has the item marked as
a "Gift Item". Instead, change isGiftable() - which is also used by the ASH
is_giftable() function - to allow either the "tradeable" or "gift" flags.
Fix the item.gift proxy field to return the value of the gift flag, rather than
being a synonym for is_giftable().

11555: Add monster.raw_attack, monster.raw_defense, and monster.raw_hp to return the
unmodified stats from monsters.txt.

11561: Add monster '''image_to_monster( string )''' ASH function for looking up monster by image file name.
Add monster.image proxy field for going the other way.

11771: experimental: add overloaded maximize() signature in ASH

'''maximize( string maximizerString, int maxPrice, int priceLevel, boolean simulate, boolean showEquipment )'''

returns an aggregate of records with each record containing the fields:
**display => display text, as it is shown in the maximizer frame
**cmd => actual command string that the maximizer runs to get the boost
**score => the boost's score
**effect => the effect provided by the boost - if applicable. effect[none] if it is equipment.
**item => $item[] that is being suggested for use or equipment
**skill => $skill[] that is being suggested

If the showEquipment argument is false, equipment will be omitted from the results.

r11707: Experimental ASH feature: the main() function of imported scripts can now be
invoked, under the alternate name main@filename()
(where 'filename' can be overridden by a 'script' directive, any ".ash"
suffix is dropped, and non-alphanumeric characters are replaced by
underscores). Note that no spaces are allowed around the @, the whole thing
is a single token.

r11965: Add my_companion()

r11985: Add the "skeleton" CLI command.

r12019: Add "eudora" CLI command

r12060: add ASH get_moods(), returns an aggregate of currently defined mood names.
"mood listall" in the gCLI will also print a list of defined moods.

r12062: add ASH get_outfits() and get_custom_outfits()

r12070: Overloaded version of appearance_rates considers monster queue:
appearance_rates( $location[] location, boolean includeQueue )

r12105: maximizerMRULength is now maximizerMRUSize
That affects this page: [[Hidden_Features#Most_Recently_Used_Modifier_Maximizer_Expression]]

'''SVN Features added''' by Roippi! SVN integration was (brokenly) implemented in r12141 and more correctly implemented in r12144.

FOR USERS:
* svn checkout <svnurl> - checks out a svn repository and adds the files from the working copy to the appropriate locations.
* svn update - updates all of your installed projects and pushes any changes to the appropriate locations.
* svn list - lists installed projects.
* svn delete <scriptname> - deletes installed projects and the corresponding files that it pushed. <scriptname> fuzzy matches the script names from svn list.

FOR SCRIPTERS:
You can provide a <nowiki>svn://, http://, or https://</nowiki> link to a valid svn repo. The link does not need to be to the root of the repository.
At the location specified by the url, there are only four permissible folders:
* ccs/
* data/
* images/
* relay/
* scripts/

Any files or directories in the location specified by your url that are not named the above will cause your repo to fail validation and thus it will not be checked out.
Within the valid folders, you can nest files however you want.
When users check out your project, the files (and nested folders) will be pushed to the corresponding mafia directories.

r12157: '''svn increment <projectname>''' and '''svn decrement <projectname>''' moves an installed svn project up/down one revision, respectively.
'''svn update''' can also take <projectname> argument or a <SVNURL> argument. Or just be blank to update everything.
r12177 svn inc/dec does the same thing as svn increment/decrement. Because typing stuff is hard.

12167: command "'''svn sync'''"

Looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the WC file is copied over the local copy one.
Note that this is very different from "svn update" and indeed does not contact the repository server at all.

If you are unsure if you want this feature, this is only for people who maintain modifications to the files in their svn/ folders that they want merged in with updates from the repo.
If you are just doing checkout/update operations and don't know what this "merging" business is about, you don't need this feature.

Users who want to automatically sync after update operations can set syncAfterSvnUpdate = true.

r12153: add '''svnUpdateOnLogin''' (global, default false), which runs svn update before breakfast/loginScript.
This could be useful if your loginScript has svn dependencies.

r12188: add global preference '''_svnUpdated'''
only do login svn update (mediated by svnUpdateOnLogin) at most once per day.

r12181: add preference '''simpleSvnUpdate''' (global, default true)
If true, simply checks if the root of your working copy is at HEAD, skipping it if so.
Speeds up the average update operation by 75% (and is probably nicer on servers).
Advanced users who have done something like a non-root "svn switch" or are using svn externals should know whether they want to turn this off.

Again the ticky box goes at the bottom of general preferences, it is soon time for these to be moved to their own page.

r12198 new ash svn functions:
boolean '''svn_exists'''( String projectname ) - returns true if a valid working copy named projectname exists in the svn/ folder
boolean '''svn_at_head'''( String projectname ) - returns true if projectname exists, is a valid WC, and is currently at the same revision # as the repository.
This will hit the repo server, so be nice.

r12206: initial support for automatic svn dependency installation.
global preference '''svnInstallDependencies''' (default true) controls whether svn will try to install dependencies.

Scripters are now allowed to place a file called dependencies.txt in the top-level of a project.
Calling it anything else will fail validation, as before. This special file will not be "pushed" to anywhere locally, it will just remain in the working copy folder.
On each line of dependencies.txt, you specify one URL to another SVN project.

r12211: preference '''svnShowCommitMessages''' (global, default false) controls whether you want to see new commit messages from svn update operations.

r12215: add ash function: '''record svn_info( String project )'''
record has the following fields-

String url: the url that the project was checked out from
int revision: the revision that the working copy is at
String lastChangedAuthor: the author who committed the last change
int lastChangedRev: the revision that most recently modified this working copy (note, not necessarily the same as revision field)
String lastChangedDate: the date/time when lastChangedRevision happened

r12238: Add _floristPlantsUsed as a comma-separated list and '''florist_available()'''.
Add "florist plant [plantname]" to add a plant. [plantname] is case-insensitive, but otherwise must exactly match KoL's name for the plant.
Check what is currently planted when you log in.

r12244: Add string [location][int] '''get_florist_plants()'''

example 1...
foreach loc, counter, plant in get_florist_plants() {
print( "Location '" + loc + "'" );
print( "Counter '" + counter + "'" );
print( "Plant '" + plant + "'" );
}

example 2...
string [location][int] plants = get_florist_plants();
foreach loc in plants {
print( "Location '" + loc + "'" );
string [int] array = plants[ loc ];
foreach index in array {
string plant = array[index];
if ( plant != "" )
print( "Plant = " + plant );
}
}

r12255: Experimental support for Dad Sea Monkee - untested in-game.
- When we first see Dad Sea Monkee, parse the clues and solve for them.
- "'''dad'''" CLI command lists the elemental weakness (and spell) for rounds 1-10
- element '''dad_sea_monkee_weakness( int round )''' ASH function for consult scripts.

12657: Add "'''cache clear'''" command to remove all cached images from /images

12659: New setting - lastImageCacheClear - records the time when you last cleared the
image cache. "'''cache'''" command with no arguments reports that time.

12662: Add '''get_ignore_zone_warnings()'''

12906: Add '''shop_price( item )''' and '''refresh_shop()'''

12932: Adds my_discomomentum().

13088: Make Prismatic Damage a real, if derived, modifier name. It cannot be used in
modifiers.txt, bit you can ask for it by name either in ASH or the Maximizer

13175: Add ash command my_soulsauce().

13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing
ASH tracing goes into ASH_datestamp.txt

13222: Add preference banishedMonsters to track banishes. Add ash command is_banished($monsterName[name])

13223: Add "thrall" datatype to ASH.
New ASH function: thrall my_thrall()

13234: New ASH functions: to_thrall( int ), to_thrall( string ), to_int( thrall )
New proxy fields for thralls: .id, .image, .tinyimage, .skill

13256: Add CLI command to buy or sell from a coinmaster:
coinmaster buy nickname item, item ...
coinmaster sell nickname item, item, ...

r13280 & r13282: Added Ash functions:
'''monster_initiative( [monster] )''' - returns initiative + ML penalty

13299: Add "'''bugbears'''" command to give status of the 9 Bugbear Mothership zones

13393: Added ash function '''stun_skill()''', returns the character's stun skill based on lass/preferences.

13395: CLI command '''restores''' added, tells you detail on all currently available restores. "restores all" tells you about all restores, "restores obtainable" tells you about all restores that you have or are tradeable.

13576: New ash data type $bounty

13581: Add ash to_bounty() function

13617: Add '''bounty''' CLI command.
bounty - lists bounty progress and untaken bounties
bounty easy|hard|special - accepts a bounty

13618: Add faxbot ash( $monster ) command. Note that chat must be open for this to successfully work, just as for other mafia fax interfaces.

13638: Add "bjornify" gCLI command, bjornify_familiar( familiar ), and my_bjorned_familiar().

13704: Add "grim" gCLI command to get a Grim Brother effect

13725: Track Audience (only works with character pane at present, request to add to api has been made). Appears on mafia side panel, also available with ash command my_audience().

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

r10025: Added '''choice''' CLI command, to resolve manual or unsupported choiceadventures
Added "choice" CLI command, to resolve manual or unsupported choice
adventures without having to visit the relay browser - which might be
inconvenient if you're already in the CLI, and don't need to see the full
adventure text to decide which option you want. With no parameter, "choice"
just lists the options. With a numeric parameter, it picks that option.
With any other parameter, it picks the first option containing that text (in
either the actual button text, or mafia's spoiler text).

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]

Take shop

2014-03-30T04:35:47Z

Gnocchi masala: Veracity's revision 12905 implementing changed shop funcionality.

{{
#vardefine:name|take_shop}}{{
#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|it}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|it}}|

p1desc={{pspan|qty}} an optional parameter for the quantity of items to take from your mall store (defaults to all if not provided)|
p2desc={{pspan|it}} is the item to take from your mall store|
}}|

function_description=This command will remove {{pspan|it}} from your mall store. The 1-parameter version will remove all of the item. If you want to remove less than the maximum amount, then you will need to use the 2-parameter version with the optional first parameter set to the count you wish to remove.|

needscode=yes|

see_also={{SeeAlso|have_shop|put_shop|shop_amount}}|
cli_equiv=The CLI command "shop take " works similarly.|
}}

[[Category:Item Management]]

Item Management

2014-03-30T04:25:34Z

Gnocchi masala: Veracity's revision 12905 implementing changed shop funcionality.

{{TOCright}}
==Informational==
{{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}
{{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
{{Flink|int|my_storage_meat|desc=Returns the amount of meat you have in Hagnk's Ancestral Mini-Storage.}}
{{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
{{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
{{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
{{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
{{Flink|item|get_dwelling|desc=Returns the item corresponding with your dwelling.}}
{{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
{{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
{{Flink|string|item_type|item|desc=Returns the type of item specified.}}
{{Flink|int|item_amount|item}}
{{Flink|int|closet_amount|item}}
{{Flink|int|display_amount|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|int|shop_amount|item}}
{{Flink|int [item]|get_shop|desc=Returns entire contents of shop and quantity of each item}}
{{Flink|int|stash_amount|item|}}
{{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}
{{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}
{{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}
{{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}
{{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}
{{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}
[[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]
{{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}
{{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}
{{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}
{{Flink|boolean|have_display|desc=Returns whether you have a display case.}}
{{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}
{{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|int|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|npc_price|item|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
{{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
{{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}
{{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
{{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}
{{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}
{{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}
{{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

==Moving Items Around==
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success. If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item|desc=Adds or removes items in your store and returns success.}}

==Acquiring & Using Items==
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|boolean|buy|int|item}}
{{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
{{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|eatsilent|int|item|desc=Attempts to eat items as specified.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
{{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}
{{Flink|boolean|overdrink|int|item}}
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}
{{Flink|string|last_item_message|desc=Returns message that KoL reports in the event of error.}}

==Coinmaster Control==
Some items can be bought from or sold to various "coinmasters" which are like shops that deal in a currency other than meat. These coinmasters include the Dimemaster and Quartermaster during the Island War, the Hermit, the Mr. Store and many others. Some relevant information can be found in [[proxy records]] for the item and coinmaster data types. The rest is controlled by the following functions.

===Inquiries===
{{Flink|coinmaster|to_coinmaster|string|desc=Converts a string to a valid coinmaster.}}
{{Flink|boolean|is_coinmaster_item|item|desc=Is a given item acquirable from a coinmster.}}
{{Flink|boolean|buys_item|coinmaster|item|desc=Is a specific item acquirable from the named coinmster.}}
{{Flink|int|buy_price|coinmaster|item|desc=What is the coinmaster's purchase price for an item.}}
{{Flink|boolean|sells_item|coinmaster|item|desc=Is a specific item sellable to the named coinmster.}}
{{Flink|int|sell_price|coinmaster|item|desc=What is the coinmaster's selling price for an item.}}

===Coinmaster transactions===
{{Flink|boolean|is_accessible|coinmaster|desc=Is a given coinmaster currently accessible.}}
{{Flink|string|inaccessible_reason|coinmaster|desc=The reason a given coinmaster is currently inaccessible.}}
{{Flink|boolean|visit|coinmaster|desc=Refreshes information at a coinmaster.}}
{{Flink|boolean|buy|coinmaster|int|item|desc=Buys an item from a coinmaster.}}
{{Flink|boolean|sell|coinmaster|int|item|desc=Sells an item to a coinmaster.}}

[[Category:Scripting]]

Sell

2012-03-18T05:54:57Z

Gnocchi masala: Fix obsolete syntax

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|int|qty}}|
parameter3={{Param|item|it}}|
p1desc={{pspan|master}} is the coinmaster to purchase from|
p2desc={{pspan|qty}} is the number to purchase|
p3desc={{pspan|it}} is the item to purchase|
}}|

function_description=Attempts to purchase {{pspan|qty}} amount of item {{pspan|it}} from {{pspan|master}}. If {{pspan|qty}} is less than 1, the function will return true without purchasing anything. Otherwise it returns true if the purchase succeeded and false if it did not.|

code1={{CodeSample|
title=Code Sample|
description=This expands upon selling to a coinmaster to show many related functions.|
code=
<syntaxhighlight>
boolean sell_coinmaster(int qty, item it) {
coinmaster master = it.buyer;
if(master == $coinmaster[none]) {
print("No coinmaster will purchase that", "red");
return false;
}
if(!is_accessible(master)) {
print(inaccessible_reason(master), "red");
return false;
}
int coins = master.available_tokens;
int price = sell_price(master, it);
print("Selling "+it+" to "+master+" for "+price+" "+coins+(qty > 1? " each.": "."));
return sell(master, qty, it);
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|buy|sell_price}}|
}}

[[Category:Item Management]]

Buy

2012-03-18T05:52:30Z

Gnocchi masala: Fix obsolete syntax

{{
#vardefine:name|buy}}{{
#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|it}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|int|qty}}|
parameter3={{Param|item|it}}|
}}|

function3={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=int|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|it}}|
parameter3={{Param|int|price}}|
p1desc={{pspan|qty}} is the number to purchase|
p2desc={{pspan|it}} is the item to purchase|
p3desc={{pspan|price}} is the (optional) maximum price to spend per item|
p4desc={{pspan|master}} is the coinmaster to purchase from|
}}|

function_description=Attempts to purchase {{pspan|qty}} amount of item {{pspan|it}}. If {{pspan|qty}} is less than 1, the function will return true without purchasing anything. If the optional maximum {{pspan|price}} is specified, it returns the integer amount of items purchased; otherwise it returns true if the purchase succeeded and false if it did not. Without the optional {{pspan|price}} parameter, first preference is given to NPC stores when attempting purchases, after which it will attempt to use the mall.

The versions that return a boolean value determine success depending on whether your inventory of the desired item went up by the amount you tried to buy. If you have clover protection active, that will always fail when you buy ten-leaf clovers - either from the hermit or from the mall.

If a {{pspan|coinmaster}} is listed, it will attempt to purchase from the coinmaster using the correct alternate currency. Otherwise it will be purchased from an NPC store or mall using meat.|

code1={{CodeSample|
title=Code Sample|
description=Buy a broken skull.|
code=
<syntaxhighlight>
buy(1 , $item[broken skull]);
</syntaxhighlight>}}

{{CodeSample|
description=This expands upon purchasing from a coinmaster to show many related functions.|
code=
<syntaxhighlight>
boolean buy_coinmaster(int qty, item it) {
coinmaster master = it.seller;
if(master == $coinmaster[none]) {
print("You do not need a coinmaster to purchase that", "red");
return false;
}
if(!is_accessible(master)) {
print(inaccessible_reason(master), "red");
return false;
}
int coins = master.available_tokens;
int price = buy_price(master, it);
if(price > coins) {
print("You only have "+coins+" "+master.token+", but it costs "+price+" "+master.token, "red");
return false;
}
return buy(master, qty, it);
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|sell|buy_price}}|
cli_equiv=The CLI commands "buy" and "acquire" work similarly.|
}}

[[Category:Item Management]]

Sell price

2012-03-18T05:45:41Z

Gnocchi masala: Fix obsolete syntax

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|item|it}}|
p1desc={{pspan|master}} is the coinmaster to query|
p2desc={{pspan|it}} is the item to check|
}}|

function_description=Returns the number of tokens that {{pspan|master}} will charge you if you want him to sell {{pspan|it}} to you.|

code1={{CodeSample|
title=Code Sample|
description=This prints the price for which you can buy an item from a coinmaster.|
code=
<syntaxhighlight>
void print_price(item it) {
if(is_coinmaster_item(it)) {
coinmaster master = it.buyer;
string token = master.token;
int price = buy_price(master, it);
if(price > 1) token += "s";
print("You can buy that for "+ price + " "+token +".");
} else if(is_tradeable(it))
print("You can buy that from the mall for "+mall_price(it)+ " meat.");
else print("You cannot buy that!", "red");
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|sell|buy_price}}|
}}

[[Category:Item Management]]

Buy price

2012-03-18T05:44:21Z

Gnocchi masala: Fix obsolete syntax

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|item|it}}|
p1desc={{pspan|master}} is the coinmaster to query|
p2desc={{pspan|it}} is the item to check|
}}|

function_description=Returns the number of tokens that {{pspan|master}} will trade you if you sell {{pspan|it}} to him.|

code1={{CodeSample|
title=Code Sample|
description=This prints the price for which you can sell an item to a coinmaster.|
code=
<syntaxhighlight>
void print_price(item it) {
if(is_coinmaster_item(it)) {
coinmaster master = it.seller;
string token = master.token;
int price = buy_price(master, it);
if(price > 1) token += "s";
print("You can sell that for "+ price + " "+token +".");
} else if(is_tradeable(it))
print("You can sell that in the mall for "+mall_price(it)+ " meat.");
else if(autosell_price(it) > 0)
print("You can autosell that for "+autosell_price(it)+ " meat.");
else print("You cannot sell that!", "red");
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|buy|sell_price}}|
}}

[[Category:Item Management]]

Is coinmaster item

2012-03-18T05:42:53Z

Gnocchi masala: fix obsolete syntax

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
p1desc={{pspan|it}} is the item to check|

}}|

function_description=Returns true if {{pspan|it}} can be '''purchased''' from a coinmaster. You'll need to discover which coinmaster by checking the seller proxy record.|

code1={{CodeSample|
title=Code Sample|
description=Purchases an item from a coinmaster if possible. Otherwise purchased from the mall.|
code=
<syntaxhighlight>
boolean buyit(int qty, item it) {
if(is_coinmaster_item(it)) {
coinmaster seller = it.seller;
int price = sell_price(seller, it);
if(!is_accessible(seller) || seller.available_tokens < price) {
print("You cannot afford to purchase that from the "+ seller+ ".", "red");
} else if(seller.available_tokens < price * qty) {
print("You don't have enough "+ seller.token+ "s to purchase that many. "
+" Buying as many from the coinmaster as you can afford.");
buy(seller, floor(qty / price), it);
} else return buy(seller, qty, it);
}
return buy(qty, it);
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|sells_item|sell_price|is_accessible}}|
}}

[[Category:Item Management]]

Item Management

2012-03-18T05:37:53Z

Gnocchi masala: Signature of to_coinmaster is string only.

{{TOCright}}
==Informational==
{{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}
{{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
{{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
{{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
{{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
{{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
{{Flink|item|get_dwelling|desc=Returns the item corresponding with your dwelling.}}
{{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
{{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
{{Flink|string|item_type|item|desc=Returns the type of item specified.}}
{{Flink|int|item_amount|item}}
{{Flink|int|closet_amount|item}}
{{Flink|int|display_amount|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|int|shop_amount|item}}
{{Flink|int|stash_amount|item|}}
{{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}
{{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}
{{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}
{{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}
{{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}
{{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}
[[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]
{{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}
{{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}
{{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}
{{Flink|boolean|have_display|desc=Returns whether you have a display case.}}
{{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}
{{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|int|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|npc_price|item|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
{{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
{{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}
{{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
{{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}
{{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}
{{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}
{{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

==Moving Items Around==
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success. If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|take_shop|item|{{opt|boolean}}|desc=Adds or removes items in your store and returns success.}}

==Acquiring & Using Items==
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
{{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}
{{Flink|string|last_item_message|desc=Returns message that KoL reports in the event of error.}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|overdrink|int|item}}
{{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}

==Coinmaster Control==
Some items can be bought from or sold to various "coinmasters" which are like shops that deal in a currency other than meat. These coinmasters include the Dimemaster and Quartermaster during the Island War, the Hermit, the Mr. Store and many others. Some relevant information can be found in [[proxy records]] for the item and coinmaster data types. The rest is controlled by the following functions.

===Inquiries===
{{Flink|coinmaster|to_coinmaster|string|desc=Converts a string to a valid coinmaster.}}
{{Flink|boolean|is_coinmaster_item|item|desc=Is a given item acquirable from a coinmster.}}
{{Flink|boolean|buys_item|coinmaster|item|desc=Is a specific item acquirable from the named coinmster.}}
{{Flink|int|buy_price|coinmaster|item|desc=What is the coinmaster's purchase price for an item.}}
{{Flink|boolean|sells_item|coinmaster|item|desc=Is a specific item sellable to the named coinmster.}}
{{Flink|int|sell_price|coinmaster|item|desc=What is the coinmaster's selling price for an item.}}

===Coinmaster transactions===
{{Flink|boolean|is_accessible|coinmaster|desc=Is a given coinmaster currently accessible.}}
{{Flink|string|inaccessible_reason|coinmaster|desc=The reason a given coinmaster is currently inaccessible.}}
{{Flink|boolean|visit|coinmaster|desc=Refreshes information at a coinmaster.}}
{{Flink|boolean|buy|coinmaster|int|item|desc=Buys an item from a coinmaster.}}
{{Flink|boolean|sell|coinmaster|int|item|desc=Sells an item to a coinmaster.}}

[[Category:Scripting]]

To coinmaster

2012-03-18T05:32:08Z

Gnocchi masala: Make it a meaningful use of to_coinmaster again.

{{
#vardefine:name|to_coinmaster}}{{
#vardefine:return_type|coinmaster}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|string|store}}|
p1desc={{pspan|store}} is hopefully the name of a coinmaster|
}}|

code1={{CodeSample|
title=Code Sample|
description=This sells off all the Island War vendor Frat boy trash to the hippy coinmaster for dimes.|
code=
<syntaxhighlight>
foreach trash in $items[red class ring, blue class ring, white class ring, PADL Phone]
if(item_amount(trash) > 0)
sell(to_coinmaster("Dimemaster"), item_amount(trash), trash);
</syntaxhighlight>
}}|

see_also={{SeeAlso|visit|is_accessible|buys_item|sells_item}}|
}}

[[Category:Item Management]]

Miscellaneous ASH Features

2012-03-18T01:01:45Z

Gnocchi masala: added the new After Adventure Script option and mentioned that both AAS & BBS can be turned on for the relay browser.

{{TOCright}}
==Special Features of ASH Scripting==
These features are not exactly ASH commands, but they are used to improve script usage.

===Special Syntax Functions===

'''[[notify]]'''

Used to send a simple kmail to the script's author, letting them know you use their script.

'''[[import]]'''

Used to load an external script into your current one.

'''[[call]]'''

Enables the script writer to invoke a function whose name is known at runtime.

'''[[new]]'''

Constructor function used to populate a record.

===Comments===

Adding '''[[Comments]]''' to your code can make it much easier to maintain, and helps other users understand what's going on.

==Errors==

There are a wide variety of error messages. For help when things go wrong, please see the page on [[ASH Errors]].

==Relay Override Scripts==
A relay override script is a script that modifies a web page in the relay browser. It is only in the relay browser that the effects of this scripts can be seen. The purpose of this is to alter a KoL page to improve functionality or appearance.

Detailed information is at [[Relay_Override_Scripting#Relay_Script|Relay Override Script]].

==User Interface Script==
A User Interface script is a script that creates a web page viewable in the relay browser. It is only in the relay browser that this special page can be seen. The purpose of this is to extend KoLmafia abilities or present information to the user.

Detailed information is at [[Relay_Override_Scripting#User_Interface_Script|User Interface Script]].

==Consult Scripts==
Consult scripts are used to script combat. They can be used in automated adventuring or in the relay browser.

Detailed information is at [[Custom_Combat_Script#Consult_Scripts|Consult Scripts]].

==Additional Script Uses==

In addition to regular scripts, override scripts, UI scripts, and consult scripts, mafia has a few other hooks for adding event-driven scripts. These situations are listed below, along with the preference that you can set a script name to (in parentheses).

==== After Adventure (afterAdventureScript) ====

*Executed just after mafia has finished an adventure.
*The afterAdventureScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.
*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsAfterAdventureScript to true.

==== Between Battle (betweenBattleScript) ====

*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
*The betweenBattleScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.
*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.
*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]

==== Buy (buyScript) ====

*Will execute whenever mafia needs to determine if it is to purchase or create an item.
*Requires a special main declaration boolean main(item itm, int qty, int ingredientLevel, boolean defaultBuy). These values will be supplied by mafia when the script is automatically called. A return value of true will instruct mafia to purchase the item and false will cause it to create the item possibly leading to other buy/create decisions.
**''itm'' and ''qty'' specify the item under consideration.
**''ingredientLevel'' indicates what's already available:
***0 = none of the ingredients
***1 = some of them
***2 = enough to create at least one of the requested item
**defaultBuy indicates what KoLmafia would have done otherwise; returning this value is the safest thing your script could do. It will normally be true if ingredientLevel is 0, false if 2. The default at level 1 depends on the item, and is subject to change - normally, anything made with star charts, pixels, the Malus, or multi-use are bought, anything else is created.
*Example: Bale's [http://kolmafia.us/showthread.php?p=18313#post18313 potionBuy].

==== Chatbot (chatbotScript) ====

*Will execute whenever a private message is received
*Requires a special main declaration which can have an optional third parameter:
*:void main(string sender, string message)
*:void main(string sender, string message, string channel)
**'sender' is the name of the player who sent the message
**'message' is the message that was sent
**'channel' is "/clan" for clan messages and the empty string for private messages

==== Counters (counterScript) ====

*Will execute whenever a counter will expire as a result of an intended use of adventures.
*Requires a special main declaration: boolean main(string name, int remain). These values will be supplied by mafia when the script is automatically called and the return value will determine whether mafia continues operation (true) or aborts (false).
**''name'' will be the name of the counter that is about to expire.
**''remain'' is the number of turns remaining before the counter expires. Remain will usually be 0, but may be higher if you are about to multi-create items, adventure underwater, or take a vacation. It may be negative if the counter was informational (one that doesn't abort adventuring), and it actually expired in the middle of an action that used multiple turns at once.
*Example: Bale's [http://kolmafia.us/showthread.php?t=2519 CounterChecker].

==== Login (loginScript) ====

:This script is immediately executed once your character is logged in. The loginScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

==== Logout (logoutScript) ====

:Same as the loginScript, but runs on logout. Note that an [[abort|abort()]] in the script won't stop a logout unless the logout was called in (specific ways, please list).

==== Planting (plantingScript) ====

*This script can be used to manage the mushroom fields, which are available when under a muscle zodiac sign. It runs after logging in, if you have a mushroom field. Main function takes no arguments. Generally should take into account current [[moon phase]] so that it can be started in the middle of a cycle.
*The plantingScript has to be the name of an ASH file without the extension (if the plantingScript setting is "plant", KoLMafia will call "plant.ash").
*Example: [http://kolmafia.us/showthread.php?563-Modified-mushroom-script-to-produce-3rd-4th-gen-crop&p=7507&viewfull=1#post7507 Sandiman's mushroom planting script].

==== Post-Ascension (postAscensionScript) ====

:Executed at once when your character starts a new ascension. (Example: Bales's [http://kolmafia.us/showthread.php?t=2769 newLife]). The postAscensionScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

==== Pre-Ascension (preAscensionScript) ====

:Same as the Post-Ascension, but executed right before entering Valhalla.

==== Recovery (recoveryScript) ====

*Executed whenever mafia would recover your HP / MP.
*Requires a special main() declaration: boolean main(string type, int amount). These values will be supplied when mafia automatically calls the script, and the return value will instruct mafia if it should attempt to use mafia's default healing after the script concludes.
**''type'' is either "HP" or "MP".
**''amount'' is the desired amount of restoration needed or 0 to use mafia's default recovery level and target.
*Example: Bale's [http://kolmafia.us/showthread.php?t=1780 Universal Recovery]

==A little CLI help==

Three CLI commands are of great use to ASH scripters:
* [[ashref]] allows one to get a list of ASH functions
* [[ash (CLI)|ash]] or [[ash (CLI)|ashq]] allows one to run ASH directly on the CLI.
* [[ashwiki]] allows you to search this wiki by launching a web browser.

==Useful forum threads==
[http://kolmafia.us/showthread.php?523-Did-you-know...-It-s-a-secret-feature.&p=2968&viewfull=1#post2968 This thread], started by holatuwol, is a tidy compilation of various undocumented features in KoLmafia.

[[Category:Scripting]]