Kolmafia - User contributions [en]

Reserved Words

2016-05-26T19:02:22Z

Ulti: /* More Information */ updating broken link

{{TOCright}}
Following is a list of words that are reserved for special usage by KoLmafia. They can not be used as variable or function names.

They are listed by category for ease of reference; the category names are not reserved words, themselves (though using them as variables would be considered poor practice in most cases).

==Constants==
*"true"
*"false"

==Operators==
*"contains"
*"remove"
*"new"

==Control flow==
*"if"
*"else"
*"foreach"
*"in"
*"for"
*"from"
*"upto"
*"downto"
*"by"
*"while"
*"repeat"
*"until"
*"break"
*"continue"
*"return"
*"exit"
*"switch"
*"case"
*"default"
*"try"
*"finally"

==Data types==
*"void"
*"boolean"
*"int"
*"float"
*"string"
*"buffer"
*"matcher"
*"aggregate"
*"item"
*"location"
*"class"
*"stat"
*"skill"
*"effect"
*"familiar"
*"slot"
*"monster"
*"element"
*"record"
*"typedef"

==More Information==
[https://sourceforge.net/p/kolmafia/code/HEAD/tree/src/net/sourceforge/kolmafia/textui/Parser.java This particular page] contains the most up-to-date version of this list around line 272.
[[Category:Scripting]]

Compiling from Source

2016-02-21T05:10:31Z

Ulti: /* Windows */

To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:

==Windows==
# Download and install the Java Development Kit, available here: http://java.sun.com/javase/downloads/index.jsp
# Download and install Subversion, available here: http://www.collab.net/downloads/subversion/
# Download and install Tortoise SVN (or of course, another SVN program), available here: http://tortoisesvn.tigris.org/
# Download and install WinAnt, available here: http://code.google.com/p/winant/
# Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
# Copy C:/Program Files/WinAnt/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up WinAnt correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
===Troubleshooting===
Due to how bat files work, ''ant.bat'' will auto-close on you before you can read its output. An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>
When you run it again, you'll be able to read its output. If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br>
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.

==Linux==

# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
# Install Subversion ( debian: apt-get install svn )
# Install Ant ( debian: apt-get install ant )
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
# Verify tou are using sun-java with ( debian: update-alternatives --all )
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )

==MacOSX==

# Install the appropriate developer tools for your version of MacOSX from the Mac Dev Center (http://developer.apple.com/devcenter/mac/index.action) or from your original OS install disks.
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
# Connect to the SVN server and download the source code for the Mafia Project. (svn checkout <nowiki>svn://svn.code.sf.net/p/kolmafia/code/</nowiki> kolmafia )
# Compile kolmafia with Ant (cd kolmafia && ant jarbundler) (use ant daily jarbundler after the initial install to update kol and build in one step)
# copy the application to your preferred location: (cp ./dist/KoLMafia.app /Applications)

[[Category:Tech Support]]

Compiling from Source

2016-02-21T05:09:34Z

Ulti: /* Windows */

To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:

==Windows==
# Download and install the Java Development Kit, available here: http://java.sun.com/javase/downloads/index.jsp
# Download and install Subversion, available here: http://www.collab.net/downloads/subversion/
# Download and install Tortoise SVN (or of course, another SVN program), available here: http://tortoisesvn.tigris.org/
# Download and install WinAnt, available here: http://code.google.com/p/winant/
# Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
# Copy C:/Program Files/WinAnt/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up WinAnt correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
<br>
===Troubleshooting===
Due to how bat files work, ''ant.bat'' will auto-close on you before you can read its output. An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>
When you run it again, you'll be able to read its output. If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br>
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.

==Linux==

# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
# Install Subversion ( debian: apt-get install svn )
# Install Ant ( debian: apt-get install ant )
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
# Verify tou are using sun-java with ( debian: update-alternatives --all )
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )

==MacOSX==

# Install the appropriate developer tools for your version of MacOSX from the Mac Dev Center (http://developer.apple.com/devcenter/mac/index.action) or from your original OS install disks.
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
# Connect to the SVN server and download the source code for the Mafia Project. (svn checkout <nowiki>svn://svn.code.sf.net/p/kolmafia/code/</nowiki> kolmafia )
# Compile kolmafia with Ant (cd kolmafia && ant jarbundler) (use ant daily jarbundler after the initial install to update kol and build in one step)
# copy the application to your preferred location: (cp ./dist/KoLMafia.app /Applications)

[[Category:Tech Support]]

Compiling from Source

2016-02-21T05:08:56Z

Ulti: /* Windows */ adding a troubleshooting section

To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:

==Windows==
# Download and install the Java Development Kit, available here: http://java.sun.com/javase/downloads/index.jsp
# Download and install Subversion, available here: http://www.collab.net/downloads/subversion/
# Download and install Tortoise SVN (or of course, another SVN program), available here: http://tortoisesvn.tigris.org/
# Download and install WinAnt, available here: http://code.google.com/p/winant/
# Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
# Copy C:/Program Files/WinAnt/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up WinAnt correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
<br>
Troubleshooting:<br>
Due to how bat files work, ''ant.bat'' will auto-close on you before you can read its output. An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>
When you run it again, you'll be able to read its output. If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br>
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.

==Linux==

# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
# Install Subversion ( debian: apt-get install svn )
# Install Ant ( debian: apt-get install ant )
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
# Verify tou are using sun-java with ( debian: update-alternatives --all )
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )

==MacOSX==

# Install the appropriate developer tools for your version of MacOSX from the Mac Dev Center (http://developer.apple.com/devcenter/mac/index.action) or from your original OS install disks.
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
# Connect to the SVN server and download the source code for the Mafia Project. (svn checkout <nowiki>svn://svn.code.sf.net/p/kolmafia/code/</nowiki> kolmafia )
# Compile kolmafia with Ant (cd kolmafia && ant jarbundler) (use ant daily jarbundler after the initial install to update kol and build in one step)
# copy the application to your preferred location: (cp ./dist/KoLMafia.app /Applications)

[[Category:Tech Support]]

Template:NavLink/doc

2015-09-30T09:08:43Z

Ulti: Adding an example with the new "shortened form"

{| class="wikitable" cellpadding="3"
|-
| {{NavLink|Template:NavLink|NavLink}}
| {{NavLink|Template:NavLink/doc|NavLink/doc}}
|}
The above is an example which renders from:
<pre><nowiki>
{| class="wikitable" cellpadding="3"
|-
| {{NavLink|Template:NavLink|NavLink}}
| {{NavLink|Template:NavLink/doc|NavLink/doc}}
|}
</nowiki></pre>

Alternatively, we can omit a parameter and not specify text for the link:

<pre><nowiki>
{| class="wikitable" cellpadding="3"
|-
| {{NavLink|Template:NavLink}}
| {{NavLink|Template:NavLink/doc}}
|}
</nowiki></pre>

which renders the slightly different:

{| class="wikitable" cellpadding="3"
|-
| {{NavLink|Template:NavLink}}
| {{NavLink|Template:NavLink/doc}}
|}

Template:NavLink

2015-09-30T08:51:40Z

Ulti: allowing both encoded and non-encoded page names to be tested in the ifeq, to detect if it's the active page

<includeonly>{{#if:{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | true |}}{{#ifeq: {{FULLPAGENAME}} | {{{1}}} | true |}}| style="{{{currentcss|background-color:#e9ebf5;}}}"| style="{{{css|background-color:white;}}}"}} |<nowiki>  </nowiki>[[{{{1}}}|<span style="font-weight:normal;">{{{2|{{{1}}}}}}</span>]]<nowiki>  </nowiki></includeonly><noinclude>{{Documentation}}[[Category:Basic Templates]]</noinclude>

Xpath

2015-04-30T13:43:40Z

Ulti:

{{
#vardefine:name|xpath}}{{
#vardefine:return_type|string[int]}}{{
#vardefine:aggregate|yes}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|htmldocument}}|
parameter2={{Param|string|xpathselector}}|
p1desc={{Pspan|htmldocument}} is a string representing an html document such as that returned from visit_url|
p2desc={{Pspan|xpathselector}} is a standard xpath selector for selecting nodes in the document|
}}|

function_description=This function returns an array of strings, for efficiency purposes, not a map, representing the node(s) which xpath has selected for you in the html document. Unlike a map, arrays will encounter an "out of bounds" exception when attempting to add new elements to it, do note the difference. This function will return an empty array if no nodes match the selector. In the event the selector uses invalid syntax, this function will error with "invalid xpath expression"|

code1={{CodeSample|
title=Code Sample|
description=The following code, if you are stuck in a choice adventure, will output the options of that choice adventure.|
code=<syntaxhighlight>
string[int] textOptions;
string[int] valueOptions;
string[int] choiceAdventureNumber;
string[int] choiceAdventureName;
string page=visit_url('charsheet.php');
textOptions=xpath(page,'//form[@action="choice.php"]//input[@type="submit"]/@value');
valueOptions=xpath(page,'//form[@action="choice.php"]//input[@type="hidden"][@name="option"]/@value');
choiceAdventureNumber=xpath(page,'//form[@action="choice.php"]//input[@type="hidden"][@name="whichchoice"]/@value');
choiceAdventureName=xpath(page,'//tr/td/b/text()');
if(count(textOptions)==0 || count(valueOptions)==0 || count(choiceAdventureNumber)==0)
{
print('not in a choice adventure');
}else{
string choiceAdvName;
string choiceAdvNum=choiceAdventureNumber[0];
if(count(choiceAdventureName)==0)
{
choiceAdvName='unnamed choice adventure';
}else{
choiceAdvName=choiceAdventureName[0];
}
print('choice adventure #'+choiceAdvNum+':'+choiceAdvName);
for x from 0 to count(valueOptions)-1
{
print('option '+valueOptions[x]+':'+textOptions[x]);
}
}
</syntaxhighlight>
|moreinfo=
For example, if you used "intriguing puzzle box" from your inventory and ran the above script, you'd see the following output:
<pre>choice adventure #525:Fiddling with a Puzzle
option 1:Push the left face.
option 2:Turn the right face clockwise.
option 3:Turn the rear face counterclockwise.
option 4:Push the right face.
option 5:Turn the right face counterclockwise.
option 6:Turn the left face counterclockwise.
option 7:Stop messing with this dang puzzle.</pre>
}}|

see_also={{SeeAlso|visit_url}}|
}}

[[Category:String Handling Routines]]

Xpath

2015-04-30T13:42:21Z

Ulti: Created page with "{{ #vardefine:name|xpath}}{{ #vardefine:return_type|string[int]}}{{ #vardefine:aggregate|yes}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}|..."

Category:New User Help

2015-04-28T20:28:12Z

Ulti: added to "categories" category

Help for New Users
[[Category:Categories]]

Category:Tech Support

2015-04-28T20:26:44Z

Ulti:

These pages deal with the technical aspects of KoL Mafia.
[[Category:Categories]]

User:Ulti/sandbox

2015-04-16T08:59:00Z

Ulti: /* migrating to ASH from PHP (work in progress) */

{{User:Ulti/Nav|active=sandbox}}
<div style="clear:right;">

This page is a sandbox used for testing my code before putting it live elsewhere on the wiki

</div>
<div style="margin-bottom: .5em; float: left; padding: .5em 0 .8em 1.4em; background: none; width: auto;">__TOC__</div>
<div style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ececf7;padding: 1em;">
===migrating to ASH from PHP/JavaScript (work in progress)===
ASH is basically half-ass Java because of feature limitations made specific for interacting with KoL.<br>
<div style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ecfcf4;padding: 1em;">
====Default Function Parameters====
In PHP you can define default values for your arguments like so:
<pre>
function helloWorld($msg='Hello world!')
{
return $msg;
}
echo helloWorld();//prints "Hello world!" to the browser
</pre>
In ASH, default parameters is accomplished like so:
<pre>
string helloWorld(string msg)
{
return msg;
}
string hellowWorld()
{
string msg='Hello world!';
return helloWorld(msg);
}
print(helloWorld());//prints "Hello world!" to kolmafia's command line interface.
</pre>
====Simple For Loops====
In PHP, you write simple for loops like so:
<pre>
for($i=1;$i<=5;$i++)
{
echo "Loop $i";
}
</pre>
In Ash you write such loops like so:
<pre>
for i from 1 to 5
{
print('Loop '+i);
}
</pre>
====dialog boxes====
In JavaScript you write:
<pre>
confirm("Are you sure?");//returns true or false depending if the user presses ok or cancel in the popup
</pre>
In ash you write it like so:
<pre>
print(user_confirm("Are you sure?"));//returns true or false depending if the user presses yes or no in the popup
</pre>
</div>
</div>
<div style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ececf7;padding: 1em;">

===new main page for the wiki (work in progress)===
<pre style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ecfcf4;padding: 1em;">New User Help
Installation
Kolmafia Guide
FAQ
How Does Kolmafia Help
Automation
Help with Quests
Basement Diving
Related Links
ASH Scripting
CLI
Language Conventions
Functions
Related Links
Contributing
Java
Compiling from Source
Mafia's Code
Making a patch
Wiki
Editing the Documentation
"To do" List</pre>
</div>

Help:To Do List

2014-10-30T16:50:45Z

Ulti: category "Contributing"

{{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

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().

13927: Relay overrides can be made for specific place.php pages by making a file called (for example) place.plains.ash in the relay folder.
The same can be done with shop.php and store.php.

For place.php?whichplace=plains, place.ash will be used only if place.plains.ash does not exist.

13988: Start tracking elemental planes quests, Hidden Temple quest, Spookyraven Babies quest, from quest log.
questESlAudit
questESlBacteria
questESlCheeseburger
questESlCocktail
questESlDebt
questESlFish
questESlMushStash
questESlSalt
questESlSprinkles
questM16Temple
questM17Babies

r13996: Get turnsplayed from charpane and api and make available in total_turns_played()

r14012: Adds command "poolskill" which shows your current estimated pool skill, based on current spading on the mechanics.
ie. Pool Skill = drunkenness up to 10, -2 for each drunkenness over 10, +1 for each time you've met the pool shark semi-rare up to 10 times,
plus bonuses from equipment/effects, plus training in current ascension.

r14017: Add "spookyraven" command. Use "spookyraven on" to track Lights Out all the time.

r14389 adds:
boolean buy_using_storage( count, item )
int buy_using_storage( count, item, max_price )
which are like the equivalent buy() functions, but use Meat from storage to get items into storage if you are in Ronin or Hardcore.

r14408-14409: my_thunder(), my_rain(), my_lightning(), thunder_cost( skill ), rain_cost( skill ), lightning_cost( skill )

r14605: Add can_faxbot( monster ) ash command.

r14729: add fixedThreadPoolSize pref - diagnostic/fine tuning for limiting the threadpool size.

== 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).

r14389 adds:
boolean buy_using_storage( count, item )
int buy_using_storage( count, item, max_price )
which are like the equivalent buy() functions, but use Meat from storage to get items into storage if you are in Ronin or Hardcore.

== 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]]
[[Category:Contributing]]

Category:Contributing

2014-10-30T16:49:36Z

Ulti: Created page with "Pages related to contributing to the KoLmafia project Category:Categories"

Pages related to contributing to the KoLmafia project
[[Category:Categories]]

User:Ulti/sandbox

2014-10-30T16:42:59Z

Ulti:

{{User:Ulti/Nav|active=sandbox}}
<div style="clear:right;">

This page is a sandbox used for testing my code before putting it live elsewhere on the wiki

</div>
<div style="margin-bottom: .5em; float: left; padding: .5em 0 .8em 1.4em; background: none; width: auto;">__TOC__</div>
<div style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ececf7;padding: 1em;">
===migrating to ASH from PHP (work in progress)===
ASH is basically half-ass Java because of feature limitations made specific for interacting with KoL.<br>
<div style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ecfcf4;padding: 1em;">
====Default Function Parameters====
In PHP you can define default values for your arguments like so:
<pre>
function helloWorld($msg='Hello world!')
{
return $msg;
}
echo helloWorld();//prints "Hello world!" to the browser
</pre>
In ASH, default parameters is accomplished like so:
<pre>
string helloWorld(string msg)
{
return msg;
}
string hellowWorld()
{
string msg='Hello world!';
return helloWorld(msg);
}
print(helloWorld());//prints "Hello world!" to kolmafia's command line interface.
</pre>
====Simple For Loops====
In PHP, you write simple for loops like so:
<pre>
for($i=1;$i<=5;$i++)
{
echo "Loop $i";
}
</pre>
In Ash you write such loops like so:
<pre>
for i from 1 to 5
{
print('Loop '+i);
}
</pre>
</div>
</div>
<div style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ececf7;padding: 1em;">
===new main page for the wiki (work in progress)===
<pre style="clear: both;margin: 1em 0 0 0;border: 1px solid #aaa;background-color: #ecfcf4;padding: 1em;">New User Help
Installation
Kolmafia Guide
FAQ
How Does Kolmafia Help
Automation
Help with Quests
Basement Diving
Related Links
ASH Scripting
CLI
Language Conventions
Functions
Related Links
Contributing
Java
Compiling from Source
Mafia's Code
Making a patch
Wiki
Editing the Documentation
"To do" List</pre>
</div>

Help:To Do List

2014-10-30T15:44:19Z

Ulti: added a categories tag to make the page easier to find

Ash Functions

2014-10-23T14:00:08Z

Ulti: my_soulsauce

{{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|int|adv_cost|skill}}
{{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|faxbot|monster}}
{{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_soulsauce}}
{{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|soulsauce_cost|skill}}
{{Flink|int|spleen_limit}}
{{Flink|string [int]|split_string|string|{{opt|string}}}}
{{Flink|float|square_root|float}}
{{Flink|int|start|matcher|{{opt|int}}}}
{{Flink|int|stash_amount|item}}
{{Flink|stat|stat_bonus_today}}
{{Flink|stat|stat_bonus_tomorrow}}
{{Flink|stat|stat_modifier|effect|string}}
{{Flink|buffer|steal}}
{{Flink|int|stills_available}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|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}}

[[Category:Scripting]]

My soulsauce

2014-10-23T13:57:53Z

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

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

function_description=Returns your current Soulsauce as an int.|
see_also={{SeeAlso|Soulsauce_cost}}
}}

[[Category:Ash_Functions]]

Category:Categories

2014-10-19T17:17:55Z

Ulti:

A category containing all other categories to make navigation easier.<br>
For a full list of categories used on this wiki, refer to <span class="plainlinks">[{{fullurl:Special:AllPages|namespace=14}} Special:AllPages&namespace=14]</span>.

Category:Templates

2014-10-19T17:15:59Z

Ulti: added a link to the Special:AllPages page

A category containing all other template categories to make navigation easier.<br>
For a full list of templates used on this wiki, refer to <span class="plainlinks">[{{fullurl:Special:AllPages|namespace=10}} Special:AllPages&namespace=10]</span>.
[[Category:Categories]]

Category:Categories

2014-10-19T17:14:08Z

Ulti: added a link to the Special:AllPages page

Category:CLI Commands

2014-10-19T16:54:38Z

Ulti: Undo revision 11319 by Ulti (talk)

List of CLI Commands
[[Category:Categories]]
[[Category:Scripting]]

Category:CLI Commands

2014-10-19T16:49:55Z

Ulti: Undo revision 11318 by Ulti (talk)

List of CLI Commands
[[Category:Categories]]

Category:CLI Commands

2014-10-19T16:48:50Z

Ulti: added scripting category

List of CLI Commands
[[Category:Categories]]
[[Category:Scripting]]

Category:Scripting

2014-10-19T16:46:43Z

Ulti: added category

Helpful pages for scripting in ASH or CLI.
[[Category:Categories]]

Category:Templates

2014-10-19T16:45:07Z

Ulti: added category

A category containing all other template categories to make navigation easier.
[[Category:Categories]]

Category:HTMLform Templates

2014-10-19T16:43:44Z

Ulti: added category

These templates are for the [[htmlform]] page.
[[Category:Templates]]

Category:Formatting Templates

2014-10-19T16:42:21Z

Ulti: added category

Simple templates to format the wiki without needing to call long style definitions.
[[Category:Templates]]

Category:Notification Templates

2014-10-19T16:41:41Z

Ulti: added category

These templates are used on a page to help organize and track what information is needed to complete a page.
[[Category:Templates]]

Category:Basic Templates

2014-10-19T16:40:54Z

Ulti: added category

Basic Templates used on KoLmafia's wiki.
[[Category:Templates]]

Category:Templates

2014-10-19T16:40:00Z

Ulti: Created page with "A category containing all other template categories to make navigation easier."

A category containing all other template categories to make navigation easier.

Category:CLI Commands

2014-10-19T16:38:00Z

Ulti: added category

List of CLI Commands
[[Category:Categories]]

Category:Automation

2014-10-19T16:34:44Z

Ulti: added category

These pages give information about automating turns with mafia.
[[Category:Categories]]

Category:ASH Function Libraries

2014-10-19T16:33:55Z

Ulti:

Sometimes, it isn't worth doing absolutely everything from scratch, and that's what libraries are for. Here are a few of the more popular scripting libraries for KoLmafia.

[[Category:Categories]]

Category:ASH Function Libraries

2014-10-19T16:33:27Z

Ulti:

Sometimes, it isn't worth doing absolutely everything from scratch, and that's what libraries are for. Here are a few of the more popular scripting libraries for KoLmafia.

[[Category:Scripting]]

Category:Categories

2014-10-19T16:32:03Z

Ulti: Created page with "A category containing all other categories to make navigation easier."

A category containing all other categories to make navigation easier.

Template:Documentation

2014-10-19T15:30:30Z

Ulti: added category

<includeonly>{{{{SUBJECTPAGENAME}}/doc}}</includeonly><noinclude><pre><nowiki>{{{{SUBJECTPAGENAME}}/doc}}</nowiki></pre>[[Category:Basic Templates]]</noinclude>

Template:NavLink

2014-10-19T15:27:03Z

Ulti:

<includeonly>{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="{{{currentcss|background-color:#e9ebf5;}}}"| style="{{{css|background-color:white;}}}"}} |<nowiki>  </nowiki>[[{{{1}}}|<span style="font-weight:normal;">{{{2}}}</span>]]<nowiki>  </nowiki></includeonly><noinclude>{{Documentation}}[[Category:Basic Templates]]</noinclude>

Template:NavLink/doc

2014-10-19T15:22:21Z

Ulti: Created page with "{| class="wikitable" cellpadding="3" |- | {{NavLink|Template:NavLink|NavLink}} | {{NavLink|Template:NavLink/doc|NavLink/doc}} |} The above is an example which renders from: <p..."

Template:NavLink

2014-10-19T15:18:03Z

Ulti: added a documentation

Template:NavLink

2014-10-19T15:05:22Z

Ulti: added currentcss parameter

{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="{{{currentcss|background-color:#e9ebf5;}}}"| style="{{{css|background-color:white;}}}"}} |<nowiki>  </nowiki>[[{{{1}}}|<span style="font-weight:normal;">{{{2}}}</span>]]<nowiki>  </nowiki>

Template:NavLink

2014-10-19T14:49:45Z

Ulti: added optional css parameter

{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="{{{css|background-color:#e9ebf5;}}}"|}} |<nowiki>  </nowiki>[[{{{1}}}|<span style="font-weight:normal;">{{{2}}}</span>]]<nowiki>  </nowiki>

User:Ulti/sandbox

2014-10-19T14:45:35Z

Ulti: added a "for loops" section.

{{User:Ulti/Nav|active=sandbox}}

This page is a sandbox used for testing my code before putting it live elsewhere on the wiki

----

===migrating to ASH from PHP (work in progress)===
ASH is basically half-ass Java because of feature limitations made specific for interacting with KoL.<br>
==Default Function Parameters==
In PHP you can define default values for your arguments like so:
<pre>
function helloWorld($msg='Hello world!')
{
return $msg;
}
echo helloWorld();//prints "Hello world!" to the browser
</pre>
In ASH, default parameters is accomplished like so:
<pre>
string helloWorld(string msg)
{
return msg;
}
string hellowWorld()
{
string msg='Hello world!';
return helloWorld(msg);
}
print(helloWorld());//prints "Hello world!" to kolmafia's command line interface.
</pre>
==Simple For Loops==
In PHP, you write simple for loops like so:
<pre>
for($i=1;$i<=5;$i++)
{
echo "Loop $i";
}
</pre>
In Ash you write such loops like so:
<pre>
for i from 1 to 5
{
print('Loop '+i);
}
</pre>

User:Ulti/Nav

2014-10-19T14:31:17Z

Ulti:

{| class="wikitable" cellpadding="3"
|-
| {{NavLink|User:Ulti|{{User:Ulti/Colorify|U|l|t|i}}}}
| {{NavLink|User_talk:Ulti|{{User:Ulti/Colorify|T|a|l|k}}}}
| {{NavLink|User:Ulti/Contribs|{{User:Ulti/Colorify|M|y| C|o|n|t|r|i|b|u|t|i|o|n|s}}}}
| {{NavLink|User:Ulti/sandbox|{{User:Ulti/Colorify|M|y| S|a|n|d|b|o|x}}}}
| {{NavLink|User:Ulti/Nav|{{User:Ulti/Colorify|N|a|v| B|a|r}}}}
|}

Template:NavLink

2014-10-19T14:29:21Z

Ulti: Created page with "{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki><span style="font-weight:normal;">{{{2}}}</span><..."

{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[{{{1}}}|<span style="font-weight:normal;">{{{2}}}</span>]]<nowiki>  </nowiki>

User:Ulti/Nav

2014-10-19T14:24:53Z

Ulti:

{| class="wikitable" cellpadding="3"
|-
| {{User:Ulti/NavLink|User:Ulti|{{User:Ulti/Colorify|U|l|t|i}}}}
| {{User:Ulti/NavLink|User_talk:Ulti|{{User:Ulti/Colorify|T|a|l|k}}}}
| {{User:Ulti/NavLink|User:Ulti/Contribs|{{User:Ulti/Colorify|M|y| C|o|n|t|r|i|b|u|t|i|o|n|s}}}}
| {{User:Ulti/NavLink|User:Ulti/sandbox|{{User:Ulti/Colorify|M|y| S|a|n|d|b|o|x}}}}
| {{User:Ulti/NavLink|User:Ulti/Nav|{{User:Ulti/Colorify|N|a|v| B|a|r}}}}
|}

User:Ulti/NavLink

2014-10-19T14:19:22Z

Ulti: Created page with "{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki><span style="font-weight:normal;">{{{2}}}</span><..."

{{#ifeq: {{FULLPAGENAMEE}} | {{{1}}} | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[{{{1}}}|<span style="font-weight:normal;">{{{2}}}</span>]]<nowiki>  </nowiki>

Template:Nowrap/doc

2014-10-19T14:08:52Z

Ulti: Created page with "<pre><nowiki><span class="nowrap">{{{1}}}</span></nowiki></pre>"

Template:Anchor/doc

2014-10-19T14:05:13Z

Ulti: Created page with "Used for adding an '''id''' attribute to a pseudo-section so it can be linked to by a [http://en.wikipedia.org/wiki/Fragment_identifier hash]."

Used for adding an '''id''' attribute to a pseudo-section so it can be linked to by a [http://en.wikipedia.org/wiki/Fragment_identifier hash].

Template:Documentation

2014-10-19T13:56:10Z

Ulti: Created page with "<includeonly>{{{{SUBJECTPAGENAME}}/doc}}</includeonly><noinclude><pre><nowiki>{{{{SUBJECTPAGENAME}}/doc}}</nowiki></pre></noinclude>"

<includeonly>{{{{SUBJECTPAGENAME}}/doc}}</includeonly><noinclude><pre><nowiki>{{{{SUBJECTPAGENAME}}/doc}}</nowiki></pre></noinclude>

User:Ulti/Nav

2014-10-15T11:25:56Z

Ulti:

{| class="wikitable" cellpadding="3"
|-
| {{#ifeq: {{{active|none}}} | user | style="background-color:#e9ebf5;font-weight:normal;"|}} |<nowiki>   </nowiki>[[User:Ulti|<span style="font-weight:normal">{{User:Ulti/Colorify|U|l|t|i}}</span>]]<nowiki>  </nowiki>
| {{#ifeq: {{{active|none}}} | talk | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[User_talk:Ulti|<span style="font-weight:normal;">{{User:Ulti/Colorify|T|a|l|k}}</span>]]<nowiki>  </nowiki>
| {{#ifeq: {{{active|none}}} | contribs | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[User:Ulti/Contribs|<span style="font-weight:normal;">{{User:Ulti/Colorify|M|y| C|o|n|t|r|i|b|u|t|i|o|n|s}}</span>]]<nowiki>  </nowiki>
| {{#ifeq: {{{active|none}}} | sandbox | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[User:Ulti/sandbox|<span style="font-weight:normal;">{{User:Ulti/Colorify|M|y| S|a|n|d|b|o|x}}</span>]]<nowiki>  </nowiki>
| {{#ifeq: {{{active|none}}} | whatlinkshere | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki><span class="plainlinks">[{{fullurl:User:Ulti/Whatlinkshere|searchdata={{FULLPAGENAMEE}}}} <span style="font-weight:normal;">{{User:Ulti/Colorify|W|h|a|t| L|i|n|k|s| H|e|r|e}}</span>]</span><nowiki>  </nowiki>
| {{#ifeq: {{{active|none}}} | email | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[Special:Emailuser/Ulti|<span style="font-weight:normal;">{{User:Ulti/Colorify|E|m|a|i|l| M|e}}</span>]]<nowiki>  </nowiki>
| {{#ifeq: {{FULLPAGENAMEE}} | User:Ulti/Nav | style="background-color:#e9ebf5;"|}} |<nowiki>  </nowiki>[[User:Ulti/Nav|<span style="font-weight:normal;">{{User:Ulti/Colorify|N|a|v| B|a|r}}</span>]]<nowiki>  </nowiki>
|}