Kolmafia - User contributions [en]

IntelliJ Setup

2023-12-05T01:09:20Z

Mcroft: /* KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. */

==== KoLmafia has migrated to the GitHub with gradle builds. ====

[https://www.jetbrains.com/idea/ IntelliJ IDEA] is an IDE for developing Java applications. This guide assumes that you have a recent enough version of Java JDK, Ant, and IntelliJ IDEA. Completing [[Compiling from Source]] is a requirement for this guide, although experienced developers can skip to whatever step is appropriate.

The following instructions are based on IntelliJ IDEA 2021.2 Community Edition. Instructions for other versions/editions of IntelliJ may be slightly different. The latest version is recommended.

== Create a Project ==
=== Create a new project ===
# Start IntelliJ IDEA. In the ''Welcome to IntelliJ IDEA'' dialog, click '''Get from VCS'''. [[File:Intellij-setup-c2021.2-welcome.png|300px]]
# In the ''Get from Version Control'' dialog, select the '''Repository URL''' tab.
## In ''Version control'', select '''GitHub'''. [[File:Intellij-setup-c2021.2-get-from-vcs.png|300px]]
## Add a new repository location. To do so, click the '''+''' button next to ''Repositories''. [[File:Intellij-setup-c2021.2-get-from-vcs-subversion.png|300px]]
## In the ''New Repository Location'' popup, enter the URL to KoLmafia's GitHub repository. If you have a GitHub account and a Personal Access Token, use git@github.com:kolmafia/kolmafia.git If you do not have a GitHub account, use https://github.com/kolmafia/kolmafia.git [[File:Intellij-setup-c2021.2-new-repository-location.png|200px]]
## Click '''OK''' to close the popup.
## Once the repository has been added, '''click the repository URL to highlight it''', then click '''Check Out'''. [[File:Intellij-setup-c2021.2-get-from-vcs-check-out.png|300px]]
# If the ''Destination Directory'' popup appears, choose a directory to check out the working copy. ''Caution'': Don't choose a common directory like <samp>C:\Users\<username>\Documents</samp>. Instead, create a new directory under it (by clicking the folder icon) and give it an appropriate name (e.g. <samp>kolmafia</samp>). [[File:Intellij-setup-c2021.2-choose-working-copy-dir.png|200px]] Click '''OK''' to continue.
# IntelliJ will generate a new project. If it asks you whether to add <code>kolmafia.iml</code> to Subversion, you may click '''Cancel''' to skip it

=== Add the Gradle Build File ===
# Open the Gradle Toolbar Item (typically on the right side, and not very large)
# Click the '''+''' button to add a build file
# Choose build.gradle from the file selector and press Open
#Run Configurations should contain <code>kolmafia [runShadow]</code>. If it does not, continue to the next steps.
#In the Gradle Toolbar click on the elephant to Execute Gradle Task
#A window titled ''Run Anything'' will popup. Search for <code>runShadow</code> and select it

===How to build and run/debug===
#Click the drop down in the top right and select the desired option
##<code>kolmafia [runShadow]</code> is the application itself
##<code>Tests in 'KoLMafia'</code> are the unit tests
#Click the play button to build and run
#Or click the bug button to build and debug

Development Environment Setup

2023-12-05T01:08:01Z

Mcroft: /* KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. */

== KoLmafia has migrated to GitHub with gradle builds. ==
Links below this section may be obsolete and should be verified before relying on them.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

After succeeding at [[Compiling from Source]] for your platform, you can add set up your KoLMafia source in an Integrated Development Environment (IDE) of your choice. It is entirely possible to build and change KoLMafia without and IDE and some of the developers do just that.
====Platform-specific Development Tools====
;''Apple's OS X notes on development for Java, including the XCode Tools setup, can make command line work easier.''
::[https://developer.apple.com/library/archive/documentation/Java/Conceptual/Java14Development/02-JavaDevTools/JavaDevTools.html Apple Developer Tools for Java]
====Developer Text Editors====
Choose your favorite, or add your favorite.
;[http://www.barebones.com BBEdit]
:: Mac OS X based text editor
;[https://macromates.com TextMate]
::Another Mac based editor
;[https://www.ultraedit.com Ultra Edit]
::cross-platform text editor

====IDEs====
This list will be out of date shortly after it's written, but can be updated as newer tools and versions are released.
;[https://www.jetbrains.com/idea/download/ IntelliJ IDEA]
::[[IntelliJ Setup]]
;[http://www.eclipse.org Eclipse]
::[[eclipse Setup]]
;[https://code.visualstudio.com/ VS Code]
::[[VS Code Setup]]
;[https://www.jetbrains.com/idea/download/ NetBeans]
::[[NetBeans Setup]]
;[http://developer.apple.com/tools/xcode/) Xcode] (Mac only)
::[[XCode Setup]]

====Source Control Management tools====
;[http://path/to/something/ TortoiseSVN]
::[[Tortoise Setup]]

Compiling from Source

2023-12-05T01:00:28Z

Mcroft: /* Optional */

== News ==
''Once great and big, now secondhand news...''

===KoLmafia has migrated to the GitHub, GIT and gradle.===
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the [[Development Environment Setup|IDE setup]] is a lot easier. The bad news is you'll need to take some steps to build anything.

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

====Windows====
# Download Tools
## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the *Recommended Java* version on the [https://kolmafia.us KoLmafia Forums] to be up to date].
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

===== Optional =====
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
====Linux====

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

====macOS====
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 17... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2023-12-05T00:59:38Z

Mcroft: Organiazation

== News ==
''Once great and big, now secondhand news...''

===KoLmafia has migrated to the GitHub, GIT and gradle.===
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the [[Development Environment Setup|IDE setup]] is a lot easier. The bad news is you'll need to take some steps to build anything.

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

====Windows====
# Download Tools
## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the *Recommended Java* version on the [https://kolmafia.us KoLmafia Forums] to be up to date].
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
====Linux====

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

====macOS====
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 17... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2023-12-05T00:57:23Z

Mcroft: /* News (once great and big, now secondhand news) */

=== News ===
''Once great and big, now secondhand news...''

==KoLmafia has migrated to the GitHub, GIT and gradle.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the [[Development Environment Setup|IDE setup]] is a lot easier. The bad news is you'll need to take some steps to build anything.

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

==Windows==
# Download Tools
## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the *Recommended Java* version on the [https://kolmafia.us KoLmafia Forums] to be up to date].
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==macOS==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 17... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2023-12-05T00:56:05Z

Mcroft:

=== News (once great and big, now secondhand news) ===

==KoLmafia has migrated to the GitHub, GIT and gradle.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the [[Development Environment Setup|IDE setup]] is a lot easier. The bad news is you'll need to take some steps to build anything.

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

==Windows==
# Download Tools
## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the *Recommended Java* version on the [https://kolmafia.us KoLmafia Forums] to be up to date].
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==macOS==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 17... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Talk:Data Structures

2023-07-04T21:40:24Z

Mcroft:

==To Do==
We really should consider moving things like Veracity's guide to Maps either to the wiki or to GitHub.
--[[User:Mcroft|Mcroft]] ([[User talk:Mcroft|talk]]) 21:40, 4 July 2023 (UTC)
==Records==
I thought that the Records section would've been helpful in figuring out multidimensional maps -- maybe not; Veracity might've gone a bit too far with that example (which I understand, as she was trying to cover all her bases with one single unifying example). --[[User:Heeheehee|Heeheehee]] 06:42, 10 March 2010 (UTC)

==An attempt at explaining maps==
(by [[User:Grotfang|Grotfang]])

A map consists of two types of component.
* The key
* The value
A normal map (without using a record) can have multiple keys, but only one value. A map is formed by specifying a normal datatype for the value and including a key, then giving the map a name:

<pre>datatype [key] name;</pre>

Eg.
<pre>string [int] message;</pre>

This in itself is a useful feature, but there are many situations where you may wish to associate two values. For example, in the message map above, I may wish to specify both a message and a name to send it to. There are two ways I could deal with this problem. The first would be to create a second map with a corresponding key. I could then assume that message[key] should be send to recipient[key]. While this works, it is inefficient and untidy, as well as inflexible.

Mafia supports the ability to customise maps using record. Record tells mafia what each entry in a map means, thereby enabling us to have more than one value to the map. The best way to visualise maps is to see a row on a page:

<pre>key value</pre>

We can extend our keys already by specifying multiples:

<pre>value [key1 , key2] name;</pre>

Produces:

<pre>key1 key2 value</pre>

What record lets us do is add more values:

<pre>key value1 value2</pre>

Each line in a record is the next value and has to include the datatype of that value. Before we specified the value's datatype when we named the map (since there was only one value to assign a datatype to). Now we have to make a record of ALL the datatypes that will come up, and then when we make our map we will use the record name in place of a single datatype:

<pre>record kmailer{
string message;
string recipient;
}
kmailer [int] my_messages;</pre>

The example above creates the following map:

<pre>key value1 value2
int message recipient</pre>

So far, so simple. The next bit is where it gets interesting. We can no longer assign a value to the map as a whole. Without a record, we can do the following:

<pre>string [int] message;
message[1] = "Hi there!";</pre>

This makes the string "Hi there!" our value for key = 1:

<pre>key value
1 Hi there!</pre>

With a record, we can no longer assign a value to a key alone; we have more than one value and we need to specify which one it is we want to assign something to. So using the record above, to assign a message we would have to do the following:

<pre>record kmailer{
string message;
string recipient;
}
kmailer [int] my_messages;
my_messages[1].message = "Hi there!";
my_messages[1].recipient = "Grotfang";</pre>

Both values are assigned to our "1" key, but we must specify the value we are assigning. The following details what is going on in the map:

<pre>key value1 value2
int message recipient
1 Hi there! Grotfang</pre>

===Multiple Keys===

This is more complex. Maps with single keys are easy to understand how they will return - specify the map and key and you return the value (you need to specify which value you want if you use a record, but the principle is the same).

More than one key is where maps get truly interesting. To all extents and purposes, multiple keys tend to be a way to categorise data into groups and subgroups. The return values get more complicated, though.

Whenever you add a value to a map, all keys MUST be specified. However, when you are retrieving data this is not the case. This works best with an example:

<pre>string [string , string] my_map;
my_map["a","b"] = "ab";
print(my_map["a","b"]);</pre>

This returns:

<pre>ab</pre>

The map setup is:

<pre>key1 key2 value
a b ab</pre>

As you might expect. Here we specified a map with two keys and one value. We assigned a value "ab" to the combination of key1 ("a") and key2 ("b"). When we retrieved the value for that combination, we got "ab". So far, so unsurprising.

However, the natural question arises, what if we try to retrieve a value while only specifying one of the keys? The answer is that we need to change our perspective of the map to what I suggested earlier - that of groups and sub-groups.

The way I visualise this is to imaging key1 represents a group and key2 is a subgroup. If two map entries have the same key1, then you should perceive them as having some commonality. What happens when you retrieve using key1 only is that you return a map of all the map entries that have the specified value of key1. This means (as you are returning an aggregate) you need to specify a new map for the values to be placed in. The following example illustrates this:

<pre>string [string , string] my_map;
my_map["a","b"] = "ab";
my_map["b","c"] = "bc";
my_map["b","d"] = "bd";
my_map["c","d"] = "cd";
my_map["e","f"] = "ef";

string [string] my_map2 = my_map["b"];

foreach x in my_map2 {
print( my_map2[x] );
}</pre>

The output is:

<pre>bc
bd</pre>

The setup for my_map is:

<pre>key1 key2 value
a b ab
b c bc
b d bd
c d cd
e f ef</pre>

The setup for my_map2 (containing only entries that have "b" as key1) is:

<pre>key value
c bc
d bd</pre>

As you can see, my_map["a","b"], which has "b" as key2 is NOT included in the aggregate return. The more keys, the more level of control you have, but you cannot return (I don't think) a map of key1 that shares key2. It's a one-way structure. Of course, you could work around this with a new map that had the keys in reverse.

Ash Functions

2023-04-27T05:41:58Z

Mcroft:

{{TOCright}}
Master list of all ASH functions. All functions as of r20745 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
The CLI command "[[ashref]]" shows every implemented ash function for your mafia version.

The list is being updated to 27335! I finished A-G...
===a===
{{FunctionEmbed|abort|format=signature}}
{{Flink|boolean [monster]|absorbed_monsters}}
{{FunctionEmbed|add_item_condition|format=signature}}
{{Flink|boolean|adv1|location|{{opt|int}}|{{opt|string}}}}
{{Flink|int|adv_cost|skill}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|boolean|adventure|location|int|{{opt|string}}}}
{{FunctionEmbed|all_monsters_with_id|format=signature}}
{{Flink|string [int]|all_normal_outfits}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|boolean|autosell|item|int}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
{{FunctionEmbed|available_choice_options}}
{{FunctionEmbed|available_choice_select_inputs}}
{{Flink|string [string]|available_choice_text_inputs|int}}
{{Flink|int|available_pocket|monster}}
{{Flink|int|available_pocket|effect}}
{{Flink|int|available_pocket|item}}
{{Flink|int|available_pocket|stat}}

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|int|daycount}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

===e===
{{FunctionEmbed|eat|format=signature}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eatsilent|item|{{opt|int}}}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|boolean [int]|effect_pockets}}
{{Flink|int|eight_bit_points|location}}
{{Flink|int|eight_bit_points |location,string,float}}
{{Flink|float|elemental_resistance|{{opt|element}}}}
{{Flink|float|elemental_resistance|monster}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{FunctionEmbed|ends_with|format=signature}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|item|{{opt|slot}}}}
{{Flink|boolean|equip|slot|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|item|eudora_item}}
{{Flink|string|every_card_name|strict_string}}
{{Flink|item [string]|expected_cold_medicine_cabinet}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval|string}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|location[int]|get_autumnaton_locations}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|int|get_counter|string|int|int}}
{{Flink|string|get_counters|string}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|int [item]|get_display}}
{{Flink|item|get_dwelling}}
{{Flink|location [string]|get_fishing_locations}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|boolean [monster]|get_locket_monsters}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|boolean [skill]|get_permed_skills}}
{{Flink|string|get_player_id|string}}
{{Flink|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|item|get_workshed}}
{{Flink|item|get_zap_wand}}
{{Flink|boolean|git_at_head|string}}
{{Flink|boolean|git_exists|string}}
{{Flink|string string string string string|git_info| string}}
{{Flink|string[0]|git_list}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T05:39:26Z

Mcroft: /* g */

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

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|int|daycount}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

===e===
{{FunctionEmbed|eat|format=signature}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eatsilent|item|{{opt|int}}}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|boolean [int]|effect_pockets}}
{{Flink|int|eight_bit_points|location}}
{{Flink|int|eight_bit_points |location,string,float}}
{{Flink|float|elemental_resistance|{{opt|element}}}}
{{Flink|float|elemental_resistance|monster}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{FunctionEmbed|ends_with|format=signature}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|item|{{opt|slot}}}}
{{Flink|boolean|equip|slot|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|item|eudora_item}}
{{Flink|string|every_card_name|strict_string}}
{{Flink|item [string]|expected_cold_medicine_cabinet}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval|string}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|location[int]|get_autumnaton_locations}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|int|get_counter|string|int|int}}
{{Flink|string|get_counters|string}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|int [item]|get_display}}
{{Flink|item|get_dwelling}}
{{Flink|location [string]|get_fishing_locations}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|boolean [monster]|get_locket_monsters}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|boolean [skill]|get_permed_skills}}
{{Flink|string|get_player_id|string}}
{{Flink|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|item|get_workshed}}
{{Flink|item|get_zap_wand}}
{{Flink|boolean|git_at_head|string}}
{{Flink|boolean|git_exists|string}}
{{Flink|string string string string string|git_info| string}}
{{Flink|string[0]|git_list}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T05:33:41Z

Mcroft: /* g */

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

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|int|daycount}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

===e===
{{FunctionEmbed|eat|format=signature}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eatsilent|item|{{opt|int}}}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|boolean [int]|effect_pockets}}
{{Flink|int|eight_bit_points|location}}
{{Flink|int|eight_bit_points |location,string,float}}
{{Flink|float|elemental_resistance|{{opt|element}}}}
{{Flink|float|elemental_resistance|monster}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{FunctionEmbed|ends_with|format=signature}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|item|{{opt|slot}}}}
{{Flink|boolean|equip|slot|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|item|eudora_item}}
{{Flink|string|every_card_name|strict_string}}
{{Flink|item [string]|expected_cold_medicine_cabinet}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval|string}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|int|get_counter|string|int|int}}
{{Flink|string|get_counters|string}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|int [item]|get_display}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|boolean [monster]|get_locket_monsters}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|boolean [skill]|get_permed_skills}}
{{Flink|string|get_player_id|string}}
{{Flink|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|item|get_workshed}}
{{Flink|item|get_zap_wand}}
{{Flink|boolean|git_at_head|string}}
{{Flink|boolean|git_exists|string}}
{{Flink|string string string string string|git_info| string}}
{{Flink|string[0]|git_list}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T05:01:25Z

Mcroft: /* g */

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

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|int|daycount}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

===e===
{{FunctionEmbed|eat|format=signature}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eatsilent|item|{{opt|int}}}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|boolean [int]|effect_pockets}}
{{Flink|int|eight_bit_points|location}}
{{Flink|int|eight_bit_points |location,string,float}}
{{Flink|float|elemental_resistance|{{opt|element}}}}
{{Flink|float|elemental_resistance|monster}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{FunctionEmbed|ends_with|format=signature}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|item|{{opt|slot}}}}
{{Flink|boolean|equip|slot|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|item|eudora_item}}
{{Flink|string|every_card_name|strict_string}}
{{Flink|item [string]|expected_cold_medicine_cabinet}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval|string}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|int|get_counter|string|int|int}}
{{Flink|string|get_counters|string}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|string|get_workshed}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T04:59:00Z

Mcroft: /* e */

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

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|int|daycount}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

===e===
{{FunctionEmbed|eat|format=signature}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eatsilent|item|{{opt|int}}}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|boolean [int]|effect_pockets}}
{{Flink|int|eight_bit_points|location}}
{{Flink|int|eight_bit_points |location,string,float}}
{{Flink|float|elemental_resistance|{{opt|element}}}}
{{Flink|float|elemental_resistance|monster}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{FunctionEmbed|ends_with|format=signature}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|item|{{opt|slot}}}}
{{Flink|boolean|equip|slot|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|item|eudora_item}}
{{Flink|string|every_card_name|strict_string}}
{{Flink|item [string]|expected_cold_medicine_cabinet}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval|string}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|string|get_workshed}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T04:55:02Z

Mcroft: /* d */

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

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|int|daycount}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

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

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|string|get_workshed}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T04:53:41Z

Mcroft: /* c */

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

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

===c===
{{Flink|boolean|can_adventure|location}}
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

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

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|string|get_workshed}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T04:49:50Z

Mcroft: /* a */ updated

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

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

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

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

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|string|get_workshed}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Ash Functions

2023-04-27T04:37:43Z

Mcroft: adding zap...

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

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

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|familiar|{{opt|item}}}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{Flink|boolean|can_still_steal}}
{{Flink|boolean|canadia_available}}
{{Flink|item [0]|candy_for_tier|int|{{opt|int}}}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|boolean|chew|item|{{opt|int}}}}
{{Flink|boolean|choice_follows_fight}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{FunctionEmbed|clear_booze_helper|format=signature}}
{{FunctionEmbed|clear_food_helper|format=signature}}
{{FunctionEmbed|cli_execute|format=signature}}
{{FunctionEmbed|cli_execute_output|format=signature}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{FunctionEmbed|contains_text|format=signature}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|int|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|item|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|boolean|create|item|{{opt|int}}}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}
{{Flink|int [string]|current_pvp_stances}}
{{Flink|int|current_rad_sickness}}
{{Flink|int|current_round}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|int|date_to_timestamp|string|string}}
{{Flink|void|debugprint|string}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|effect|desc_to_effect|string}}
{{Flink|item|desc_to_item|string}}
{{Flink|void|disable|string}}
{{Flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{FunctionEmbed|drink|format=signature}}
{{Flink|boolean|drinksilent|int|item}}
{{Flink|boolean|drinksilent|item|{{opt|int}}}}
{{Flink|void|dump|any|{{opt|string}}}}

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

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster|{{opt|string}}}}
{{Flink|boolean|fight_follows_choice}}
{{FunctionEmbed|file_to_array|format=signature}}
{{FunctionEmbed|file_to_buffer|format=signature}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|boolean|flush_monster_manuel_cache}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fuel_cost|skill}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|int [string]|get_clan_rumpus}}
{{Flink|int [item]|get_closet}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|int [item]|get_free_pulls}}
{{Flink|int|get_fuel}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|boolean [monster]|get_location_monsters|location}}
{{Flink|monster [monster]|get_monster_mapping|{{opt|string}}}}
{{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|string|get_player_name|int}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string [0]|get_shop_log}}
{{Flink|string string int [0]|get_stack_trace}}
{{Flink|int [item]|get_stash}}
{{Flink|int [item]|get_storage}}
{{Flink|string|get_version}}
{{Flink|string|get_workshed}}
{{Flink|boolean|gnomads_available}}
{{Flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|string|group|matcher|string}}
{{Flink|int|group_count|matcher}}
{{Flink|boolean [string]|group_names|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_available}}
{{Flink|boolean|guild_store_available}}

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

===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_multi_fight}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{FunctionEmbed|index_of|format=signature}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{FunctionEmbed|is_dark_mode}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|item int string [int]|item_drops_array|{{opt|monster}}}}
{{Flink|boolean [int]|item_pockets}}
{{Flink|string|item_type|item}}

===j===
{{Flink|boolean [int]|joke_pockets}}
{{Flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{Flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{Flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_decision}}
{{FunctionEmbed|last_index_of|format=signature}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|string|leetify|string}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost|skill}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|float|log_n|float|{{opt|float}}}}
{{Flink|void|logprint|string}}

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

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

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

===p===
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}
{{Flink|boolean|pick_pocket|monster}}
{{Flink|int [effect]|pick_pocket|effect}}
{{Flink|int [item]|pick_pocket|item}}
{{Flink|int [stat]|pick_pocket|stat}}
{{Flink|boolean|pick_pocket|int}}
{{Flink|boolean [int]|picked_pockets}}
{{Flink|boolean [int]|picked_scraps}}
{{Flink|int [effect]|pocket_effects|int}}
{{Flink|int [item]|pocket_items|int}}
{{Flink|string|pocket_joke|int}}
{{Flink|string [int]|pocket_meat|int}}
{{Flink|monster|pocket_monster|int}}
{{Flink|string [int]|pocket_poem|int}}
{{Flink|string [int]|pocket_scrap|int}}
{{Flink|int [stat]|pocket_stats|int}}
{{Flink|int [int]|poem_pockets}}
{{Flink|int [int]|potential_pockets|effect/item/monster/stat}}
{{Flink|void|print|{{opt|string}}|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{FunctionEmbed|property_default_value|format=signature}}
{{FunctionEmbed|property_exists|format=signature}}
{{FunctionEmbed|property_has_default|format=signature}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_closet|item|{{opt|int}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_display|item|int}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_shop_using_storage|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|put_stash|item|int}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_shop}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_item_condition|item|int}}
{{FunctionEmbed|remove_property|format=signature}}
{{FunctionEmbed|rename_property|format=signature}}
{{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|boolean|reprice_shop|int|{{opt|int}}|item}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean [int]|restoration_pockets}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|boolean|retrieve_item|item|{{opt|int}}}}
{{Flink|int [int]|reverse_numberology|{{opt|int|int}}}}
{{Flink|int|rollover}}
{{Flink|int|round|float}}
{{FunctionEmbed|run_choice|format=signature}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|int [int]|scrap_pockets}}
{{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}}|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int/string}}
{{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_limit|item}}
{{Flink|int|shop_price|item}}
{{Flink|skill|skill_modifier|item|string}}
{{Flink|skill|skill_modifier|string|string}}
{{Flink|int|slash_count|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}}}}
{{FunctionEmbed|starts_with|format=signature}}
{{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|void|stop_counter|string}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|{string int string int string}|svn_info|string}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|int|effect|{{opt|int}}}}
{{Flink|boolean|sweet_synthesis|{{opt|int}}|item|item}}
{{Flink|item [0]|sweet_synthesis_pair|effect|{{opt|item}}|{{opt|int}}}}
{{Flink|effect|sweet_synthesis_result|item|item}}

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

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

===v===
{{Flink|boolean|visit|coinmaster}}
{{FunctionEmbed|visit_url}}
{{Flink|boolean [string]|voting_booth_initiatives|class|int|int}}
{{Flink|boolean [string]|voting_booth_initiatives|int|int|int}}

===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}}

===x===
{{Flink|string[int]|xpath|string|string}}
===z===
{{Flink|item|zap|item}}

[[Category:Scripting]]

Retrieve price

2023-04-25T04:07:29Z

Mcroft:

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

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

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

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

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

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

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

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

If an item is not buyable, this function will return MAXINT, or 2^63-1.
|

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

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

[[Category:Item Management]]

Data Types

2023-03-02T03:15:45Z

Mcroft: /* float */

{{TOCright}}
==Primitive Datatypes==

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

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

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 64-bit signed int, meaning it has a maximum value of 9,223,372,036,854,775,807 and a minimum value of -9,223,372,036,854,775,808. The default value of a integer variable is 0.

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

===float===

The float data type is a double-precision 64-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [hhttps://docs.oracle.com/javase/specs/jls/se17/html/jls-4.html#jls-4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

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

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

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

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

==Special Datatypes==

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

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

===bounty===

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

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

===class===

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

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

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

===coinmaster===

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

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

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

===effect===

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

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

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

===element===

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

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

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

===familiar===

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

Any familiar available in KoL is valid for this datatype.

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

===item===

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

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

===location===

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

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

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

===monster===

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

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

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

===path===

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

Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].

The full range, besides $path[ none ], is too much to list and keep up with here. See {{kolwiki|Ascension#Paths}} for more information.

===phylum===

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

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

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

===servant===

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

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

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

===skill===

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

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

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

===slot===

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

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

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

===stat===

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

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

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

===thrall===

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

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

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

==aggregate==

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

==record==

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

==Plural Typed Constants==

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

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

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

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

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

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

==Custom==

===matcher===

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

==Notes==

Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.

[[Category:Scripting]]

Data Types

2023-03-02T03:13:23Z

Mcroft: size of int pool...

{{TOCright}}
==Primitive Datatypes==

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

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

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 64-bit signed int, meaning it has a maximum value of 9,223,372,036,854,775,807 and a minimum value of -9,223,372,036,854,775,808. The default value of a integer variable is 0.

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

===float===

The float data type is a double-precision 64-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

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

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

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

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

==Special Datatypes==

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

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

===bounty===

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

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

===class===

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

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

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

===coinmaster===

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

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

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

===effect===

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

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

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

===element===

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

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

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

===familiar===

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

Any familiar available in KoL is valid for this datatype.

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

===item===

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

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

===location===

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

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

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

===monster===

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

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

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

===path===

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

Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].

The full range, besides $path[ none ], is too much to list and keep up with here. See {{kolwiki|Ascension#Paths}} for more information.

===phylum===

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

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

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

===servant===

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

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

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

===skill===

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

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

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

===slot===

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

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

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

===stat===

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

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

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

===thrall===

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

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

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

==aggregate==

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

==record==

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

==Plural Typed Constants==

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

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

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

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

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

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

==Custom==

===matcher===

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

==Notes==

Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.

[[Category:Scripting]]

Data Types

2023-03-02T03:08:27Z

Mcroft: /* float */

{{TOCright}}
==Primitive Datatypes==

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

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

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 64-bit signed int, meaning it has a maximum value of 9,223,372,036,854,775,807 and a minimum value of -9,223,372,036,854,775,808. The default value of a integer variable is 0.

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

===float===

The float data type is a double-precision 64-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

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

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

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

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

==Special Datatypes==

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

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

===bounty===

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

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

===class===

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

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

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

===coinmaster===

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

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

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

===effect===

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

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

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

===element===

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

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

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

===familiar===

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

Any familiar available in KoL is valid for this datatype.

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

===item===

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

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

===location===

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

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

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

===monster===

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

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

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

===path===

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

Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].

The full range, besides $path[ none ], is too much to list and keep up with here. See {{kolwiki|Ascension#Paths}} for more information.

===phylum===

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

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

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

===servant===

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

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

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

===skill===

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

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

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

===slot===

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

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

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

===stat===

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

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

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

===thrall===

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

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

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

==aggregate==

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

==record==

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

==Plural Typed Constants==

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

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

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

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

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

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

==Custom==

===matcher===

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

==Notes==

Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.

[[Category:Scripting]]

Data Types

2023-03-02T03:07:06Z

Mcroft: /* int */ is 64 bit

{{TOCright}}
==Primitive Datatypes==

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

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

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 64-bit signed int, meaning it has a maximum value of 9,223,372,036,854,775,807 and a minimum value of -9,223,372,036,854,775,808. The default value of a integer variable is 0.

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

===float===

The float data type is a single-precision 32-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

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

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

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

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

==Special Datatypes==

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

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

===bounty===

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

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

===class===

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

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

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

===coinmaster===

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

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

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

===effect===

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

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

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

===element===

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

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

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

===familiar===

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

Any familiar available in KoL is valid for this datatype.

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

===item===

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

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

===location===

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

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

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

===monster===

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

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

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

===path===

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

Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].

The full range, besides $path[ none ], is too much to list and keep up with here. See {{kolwiki|Ascension#Paths}} for more information.

===phylum===

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

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

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

===servant===

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

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

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

===skill===

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

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

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

===slot===

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

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

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

===stat===

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

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

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

===thrall===

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

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

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

==aggregate==

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

==record==

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

==Plural Typed Constants==

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

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

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

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

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

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

==Custom==

===matcher===

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

==Notes==

Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.

[[Category:Scripting]]

User:Mcroft

2023-02-25T03:59:04Z

Mcroft: Undo revision 9183 by Mcroft (talk)

My KoL main character is "Darwinlet".

In 2005, I was really active in early development of KoLmafia, but it's been a long time...

User:Mcroft

2023-02-25T03:57:12Z

Mcroft:

My KoL main character is "Darwinlet".

In 2005, I was really active in early development of KoLmafia, but it's been a long time...

<details>
<summary>I am a closed section.</summary>
This is the details of the closed section</details>

Rollover

2023-01-31T05:49:29Z

Mcroft: added missing rollover function to wiki

{{
#vardefine:name|rollover}}{{
#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 the unix epoch time of the next rollover.|

code1={{CodeSample|
title=Code Sample|
description=The following tells you how long until rollover.|
code=
<syntaxhighlight>
if (rollover() - now_to_int() > 0) {
print("There are " + (rollover() - now_to_int()) + " seconds until rollover.");
} else {
print("Rollover is now.");
}
</syntaxhighlight>}}|
}}

{{SeeAlso|gameday_to_string|gameday_to_int|now_to_int|now_to_string|time_to_string|timestamp_to_date|date_to_timestamp}}

[[Category:Miscellaneous Functions]]

Talk:Installation

2021-12-30T20:45:15Z

Mcroft: removed note to update to current standards, which I did immediately after writing a note.

KoLmafia Guide: Preface

2021-12-28T18:23:17Z

Mcroft: remove SourceForge

== How I Teach & Requirements ==

I have only played KoL for 3 months. (well, more like 7 now!) I am hoping this means that I will not take stuff for-granted like year-long players. I can actually address more advanced stuff now that I know how clan dungeons work, the Sea, and so forth. ;-)

I assume that you have played KoL for at least a few weeks before reading this guide. This is simply so I can reference examples while teaching. This is not a strict requirement though... it just means that you might not catch some of my examples.

Finally, you need to be able to '''play''' while reading this guide! Learning while trying to break a speed ascension record or something is probably not the best way to go. 50 turns should be enough to get through most of the lessons.

My main goal is to start out playing KoL using KoLmafia's 'Relay Browser', which is basically identical to normal browser play. Then, each short lesson will progressively give you a new 'trick' that you can use. This lets you learn at your own pace.

Continue working through the guide by doing 'Lessons' until you have learned as much as you want. The lessons are roughly in the order of importance, or more honestly, the order in which I figured the stuff out. :-) There is tons of stuff that I probably won't cover, but by the time you are done with the lessons, you will have the hang of it.

== What About Greasemonkey? ==

Greasemonkey is another scripting tool that can be used for Kingdom of Loathing. Please skip this section if you don't know or care about Greasemonkey.

I tried Greasemonkey scripts. They are nice, but have four major disadvantages:

* CodeRot - Many scripts are outdated and their functionality continues to break due to new content, changes, etc.

* Out of Date - A script is typically written by the author who uses it, posts it, then it is forgotten. People quit KoL all the time for varying reasons. Hence, scripts are very likely to be outdated by the time you find them.

* Version Overload - On the other hand, there can be too many versions of a popular script, all written by different people who baselined off of someone else's version and so forth. Certain versions incorporate particular fixes and updates, but might be lacking updates and rewrites by someone else. It can be difficult to find the latest, most correct version of a particular script.

* Security Issues - Greasemonkey by itself doesn't do anything. All functionality comes from the actual scripts, which coupled with many versions/updates and the fact that scripts are scattered all over the internet makes executing them more of a security risk.

I decided to try KoLmafia which has these advantages:

* More Secure - It comes from ONE open-source website and its base version includes plenty of functionality. This makes it much safer to use out of the box.

* Easier to Install - No digging around and searching forums for hours to find the right script. (At least not until you have mastered Mafia and go looking for Mafia-specific scripts...)

* Easier to Customize - Not much of an issue at first, but writing a new Greasemonkey script is relatively hard. Modifying KoLmafia behavior can be a lot easier for certain aspects.

* Consolidated Updates - All KoLmafia work occurs at its GitHub website. Versions are numbered and under version-control. This means you can easily find the most up-to-date version and no intermediate fixes were skipped.

* Easier to Figure Out - While the documentation for KoLmafia is not amazing, you will have a lot more luck finding help documents (like this one!) for Mafia, as opposed to documentation for random Greasemonkey scripts.

== Links ==

You need to have this post handy, '''while playing''' I will guide you through each lesson, but you have to be reading it while using KoLmafia for it to really make any sense. Printing it or having it on a second monitor is helpful.

First, here's a list of various websites that I may refer to during the guide. You do not need to worry about them now!

*KoLmafia on GitHub: https://github.com/kolmafia/kolmafia 
*KoLmafia forum: http://kolmafia.us/ 
*KolMafia Wiki: http://wiki.kolmafia.us/index.php?title=Main_Page 
*A Previously Existing Guide: http://forums.kingdomofloathing.com/vb/showthread.php?t=140340 
*List of CLI Commands http://kolmafia.sourceforge.net/scripting.html 
*List of all KoLmafia global variables (more for scripting): http://wiki.kolmafia.us/index.php?title=List_of_KoLmafia_Properties 

== Getting Started ==

We are now officially starting your KoLmafia lessons!

# Download the latest build from [https://ci.kolmafia.us KoLmafia's Build Server]
# By default it picks the appropriate package for you. All you need is '''your''' system's file. As a windows user, I download the 3 Meg executable. Mac users download theirs. Linux, etc. If all else fails, use the java Jar file.
# Move the file somewhere handy. Note that KoLmafia can be downloaded as an executable. However, it does '''not install''' per se. Instead, I like to say that it 'roots'. When executed, '''will create quite a few subfolders''' to store its settings. Therefore, I extremely highly recommend placing it in its own folder. Once moved, make a link to it on your desktop so you can easily execute it. . You just run the file to run KoLmafia. No further setup is needed.
# If the file doesn't run, you need the 1.6 or better Java Runtime Environment. This is not particularly hard and many will likely already have it. The KoLmafia website given above, has a 'Getting Started' section that you can refer to in case of such issues.
# When you first run it, '''two''' windows pop up. Ignore the complicated looking frame, and look at the one with the login fields. Type in your login info (make sure you don't have KoL running elsewhere obviously), then click the '''LOGIN''' button. Ignore the RELAY button for now. Keep the other options unchecked, including breakfast. We will discuss this stuff later.
# The Login frame goes away and now you have the main box, which I will call the KoLmafia Frame. I don't have a place to store an up to date picture, but the whole thing is kind-of intimidating. You are probably ready to quit, but ''stick in there!''' We will make this easy by doing things step-by-step. I'm a noob, remember? I got your back! ;-)
# Note that is possible that KoLmafia '''may pop up an events logger window'''. This occurrs if you were attacked, received a message, or whatever other event type stuff might happen. Just close that small window if you encounter it.

'''Continue''' to [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]

[[Category:KoLmafia Guide]][[Category:New User Help]]

KoLmafia Guide: Preface

2021-12-28T18:20:32Z

Mcroft: /* Links */ i don't want to change this, but I don't want anyone finding SourceForge...

== How I Teach & Requirements ==

I have only played KoL for 3 months. (well, more like 7 now!) I am hoping this means that I will not take stuff for-granted like year-long players. I can actually address more advanced stuff now that I know how clan dungeons work, the Sea, and so forth. ;-)

I assume that you have played KoL for at least a few weeks before reading this guide. This is simply so I can reference examples while teaching. This is not a strict requirement though... it just means that you might not catch some of my examples.

Finally, you need to be able to '''play''' while reading this guide! Learning while trying to break a speed ascension record or something is probably not the best way to go. 50 turns should be enough to get through most of the lessons.

My main goal is to start out playing KoL using KoLmafia's 'Relay Browser', which is basically identical to normal browser play. Then, each short lesson will progressively give you a new 'trick' that you can use. This lets you learn at your own pace.

Continue working through the guide by doing 'Lessons' until you have learned as much as you want. The lessons are roughly in the order of importance, or more honestly, the order in which I figured the stuff out. :-) There is tons of stuff that I probably won't cover, but by the time you are done with the lessons, you will have the hang of it.

== What About Greasemonkey? ==

Greasemonkey is another scripting tool that can be used for Kingdom of Loathing. Please skip this section if you don't know or care about Greasemonkey.

I tried Greasemonkey scripts. They are nice, but have four major disadvantages:

* CodeRot - Many scripts are outdated and their functionality continues to break due to new content, changes, etc.

* Out of Date - A script is typically written by the author who uses it, posts it, then it is forgotten. People quit KoL all the time for varying reasons. Hence, scripts are very likely to be outdated by the time you find them.

* Version Overload - On the other hand, there can be too many versions of a popular script, all written by different people who baselined off of someone else's version and so forth. Certain versions incorporate particular fixes and updates, but might be lacking updates and rewrites by someone else. It can be difficult to find the latest, most correct version of a particular script.

* Security Issues - Greasemonkey by itself doesn't do anything. All functionality comes from the actual scripts, which coupled with many versions/updates and the fact that scripts are scattered all over the internet makes executing them more of a security risk.

I decided to try KoLmafia which has these advantages:

* More Secure - It comes from ONE open-source website and its base version includes plenty of functionality. This makes it much safer to use out of the box.

* Easier to Install - No digging around and searching forums for hours to find the right script. (At least not until you have mastered Mafia and go looking for Mafia-specific scripts...)

* Easier to Customize - Not much of an issue at first, but writing a new Greasemonkey script is relatively hard. Modifying KoLmafia behavior can be a lot easier for certain aspects.

* Consolidated Updates - All KoLmafia work occurs at its sourceforge website. Versions are numbered and under version-control. This means you can easily find the most up-to-date version and no intermediate fixes were skipped.

* Easier to Figure Out - While the documentation for KoLmafia is not amazing, you will have a lot more luck finding help documents (like this one!) for Mafia, as opposed to documentation for random Greasemonkey scripts.

== Links ==

You need to have this post handy, '''while playing''' I will guide you through each lesson, but you have to be reading it while using KoLmafia for it to really make any sense. Printing it or having it on a second monitor is helpful.

First, here's a list of various websites that I may refer to during the guide. You do not need to worry about them now!

*KoLmafia on GitHub: https://github.com/kolmafia/kolmafia 
*KoLmafia forum: http://kolmafia.us/ 
*KolMafia Wiki: http://wiki.kolmafia.us/index.php?title=Main_Page 
*A Previously Existing Guide: http://forums.kingdomofloathing.com/vb/showthread.php?t=140340 
*List of CLI Commands http://kolmafia.sourceforge.net/scripting.html 
*List of all KoLmafia global variables (more for scripting): http://wiki.kolmafia.us/index.php?title=List_of_KoLmafia_Properties 

== Getting Started ==

We are now officially starting your KoLmafia lessons!

# Download the latest build from [https://ci.kolmafia.us KoLmafia's Build Server]
# By default it picks the appropriate package for you. All you need is '''your''' system's file. As a windows user, I download the 3 Meg executable. Mac users download theirs. Linux, etc. If all else fails, use the java Jar file.
# Move the file somewhere handy. Note that KoLmafia can be downloaded as an executable. However, it does '''not install''' per se. Instead, I like to say that it 'roots'. When executed, '''will create quite a few subfolders''' to store its settings. Therefore, I extremely highly recommend placing it in its own folder. Once moved, make a link to it on your desktop so you can easily execute it. . You just run the file to run KoLmafia. No further setup is needed.
# If the file doesn't run, you need the 1.6 or better Java Runtime Environment. This is not particularly hard and many will likely already have it. The KoLmafia website given above, has a 'Getting Started' section that you can refer to in case of such issues.
# When you first run it, '''two''' windows pop up. Ignore the complicated looking frame, and look at the one with the login fields. Type in your login info (make sure you don't have KoL running elsewhere obviously), then click the '''LOGIN''' button. Ignore the RELAY button for now. Keep the other options unchecked, including breakfast. We will discuss this stuff later.
# The Login frame goes away and now you have the main box, which I will call the KoLmafia Frame. I don't have a place to store an up to date picture, but the whole thing is kind-of intimidating. You are probably ready to quit, but ''stick in there!''' We will make this easy by doing things step-by-step. I'm a noob, remember? I got your back! ;-)
# Note that is possible that KoLmafia '''may pop up an events logger window'''. This occurrs if you were attacked, received a message, or whatever other event type stuff might happen. Just close that small window if you encounter it.

'''Continue''' to [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]

[[Category:KoLmafia Guide]][[Category:New User Help]]

KoLmafia Guide: Preface

2021-12-28T18:17:06Z

Mcroft: rooting out all "sourceforge" references...

== How I Teach & Requirements ==

I have only played KoL for 3 months. (well, more like 7 now!) I am hoping this means that I will not take stuff for-granted like year-long players. I can actually address more advanced stuff now that I know how clan dungeons work, the Sea, and so forth. ;-)

I assume that you have played KoL for at least a few weeks before reading this guide. This is simply so I can reference examples while teaching. This is not a strict requirement though... it just means that you might not catch some of my examples.

Finally, you need to be able to '''play''' while reading this guide! Learning while trying to break a speed ascension record or something is probably not the best way to go. 50 turns should be enough to get through most of the lessons.

My main goal is to start out playing KoL using KoLmafia's 'Relay Browser', which is basically identical to normal browser play. Then, each short lesson will progressively give you a new 'trick' that you can use. This lets you learn at your own pace.

Continue working through the guide by doing 'Lessons' until you have learned as much as you want. The lessons are roughly in the order of importance, or more honestly, the order in which I figured the stuff out. :-) There is tons of stuff that I probably won't cover, but by the time you are done with the lessons, you will have the hang of it.

== What About Greasemonkey? ==

Greasemonkey is another scripting tool that can be used for Kingdom of Loathing. Please skip this section if you don't know or care about Greasemonkey.

I tried Greasemonkey scripts. They are nice, but have four major disadvantages:

* CodeRot - Many scripts are outdated and their functionality continues to break due to new content, changes, etc.

* Out of Date - A script is typically written by the author who uses it, posts it, then it is forgotten. People quit KoL all the time for varying reasons. Hence, scripts are very likely to be outdated by the time you find them.

* Version Overload - On the other hand, there can be too many versions of a popular script, all written by different people who baselined off of someone else's version and so forth. Certain versions incorporate particular fixes and updates, but might be lacking updates and rewrites by someone else. It can be difficult to find the latest, most correct version of a particular script.

* Security Issues - Greasemonkey by itself doesn't do anything. All functionality comes from the actual scripts, which coupled with many versions/updates and the fact that scripts are scattered all over the internet makes executing them more of a security risk.

I decided to try KoLmafia which has these advantages:

* More Secure - It comes from ONE open-source website and its base version includes plenty of functionality. This makes it much safer to use out of the box.

* Easier to Install - No digging around and searching forums for hours to find the right script. (At least not until you have mastered Mafia and go looking for Mafia-specific scripts...)

* Easier to Customize - Not much of an issue at first, but writing a new Greasemonkey script is relatively hard. Modifying KoLmafia behavior can be a lot easier for certain aspects.

* Consolidated Updates - All KoLmafia work occurs at its sourceforge website. Versions are numbered and under version-control. This means you can easily find the most up-to-date version and no intermediate fixes were skipped.

* Easier to Figure Out - While the documentation for KoLmafia is not amazing, you will have a lot more luck finding help documents (like this one!) for Mafia, as opposed to documentation for random Greasemonkey scripts.

== Links ==

You need to have this post handy, '''while playing''' I will guide you through each lesson, but you have to be reading it while using KoLmafia for it to really make any sense. Printing it or having it on a second monitor is helpful.

First, here's a list of various websites that I may refer to during the guide. You do not need to worry about them now!

*KoLmafia's website: http://kolmafia.sourceforge.net/ 
*KoLmafia forum: http://kolmafia.us/ 
*KolMafia Wiki: http://wiki.kolmafia.us/index.php?title=Main_Page 
*A Previously Existing Guide: http://forums.kingdomofloathing.com/vb/showthread.php?t=140340 
*List of CLI Commands http://kolmafia.sourceforge.net/scripting.html 
*List of all KoLmafia global variables (more for scripting): http://wiki.kolmafia.us/index.php?title=List_of_KoLmafia_Properties 

== Getting Started ==

We are now officially starting your KoLmafia lessons!

# Go to KoLmafia's website (listed above). The download link is not really obvious; it's a small link at the top left somewhere. Click it to go here: https://sourceforge.net/project/showfiles.php?group_id=126572
# By default it picks the appropriate package for you. All you need is '''your''' system's file. As a windows user, I download the 3 Meg executable. Mac users download theirs. Linux, etc. If all else fails, use the java Jar file.
# Move the file somewhere handy. Note that KoLmafia can be downloaded as an executable. However, it does '''not install''' per se. Instead, I like to say that it 'roots'. When executed, '''will create quite a few subfolders''' to store its settings. Therefore, I extremely highly recommend placing it in its own folder. Once moved, make a link to it on your desktop so you can easily execute it. . You just run the file to run KoLmafia. No further setup is needed.
# If the file doesn't run, you need the 1.6 or better Java Runtime Environment. This is not particularly hard and many will likely already have it. The KoLmafia website given above, has a 'Getting Started' section that you can refer to in case of such issues.
# When you first run it, '''two''' windows pop up. Ignore the complicated looking frame, and look at the one with the login fields. Type in your login info (make sure you don't have KoL running elsewhere obviously), then click the '''LOGIN''' button. Ignore the RELAY button for now. Keep the other options unchecked, including breakfast. We will discuss this stuff later.
# The Login frame goes away and now you have the main box, which I will call the KoLmafia Frame. I don't have a place to store an up to date picture, but the whole thing is kind-of intimidating. You are probably ready to quit, but ''stick in there!''' We will make this easy by doing things step-by-step. I'm a noob, remember? I got your back! ;-)
# Note that is possible that KoLmafia '''may pop up an events logger window'''. This occurrs if you were attacked, received a message, or whatever other event type stuff might happen. Just close that small window if you encounter it.

'''Continue''' to [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]

[[Category:KoLmafia Guide]][[Category:New User Help]]

Reporting a Bug/Requesting a Feature

2021-12-28T18:13:52Z

Mcroft:

A '''Bug Report''' is submitted when KoLmafia is doing the wrong thing because of a coding error, design flaw or some other oversight on the part of a developer.

A '''Feature Request''' is submitted when KoLmafia is functioning as designed but a user would like it to so something different.

'''New Content''' is reported when something is added to or changed in KoL itself and KoLmafia could/should be changed to support that.

A Bug Report, Feature Request or New Content notification can be made by starting a new thread at http://kolmafia.us/forumdisplay.php?24-Bug-Reports

There are several prefixes appended to threads in that section. Non-Moderators should only use Bug, Feature or New Content. The Moderators will change the prefix to indicate status.

*Bug - Confirmed indicates that someone other than the original reporter has been able to reproduce the bug.

*Bug - Not a Bug indicates that the behavior described as a Bug is actually what KoLmafia is supposed to be doing.

*Bug - Won't Fix indicates that bug exists but no changes will be made to fix it.

*Bug - Fixed indicates that code to fix the bug has been written, checked in to GitHub and pulled to main, thus making it part of the next build.

*Bug - Cannot Reproduce indicates that no one besides the original reporter knows how to make the bug happen.

*Bug - Waiting for Info indicates that a developer has asked questions about the report and is waiting for the reporter to answer.

For both Feature and New Content

*Implemented means that KoLmafia has been changed in response.

*Rejected means that no code has been changed and none is likely to do so.

*Features are often rejected if it is something that can easily be done or has already been done, in a script.

The prefixes and the implied workflow are sometimes to developer's looking for tasks and developers planning releases.

It is worth reading http://kolmafia.us/showthread.php?5934-Bug-Report-Procedures-(please-read-me) before submitting reports.

This thread http://kolmafia.us/showthread.php?4326-Show-Estimated-Damage contains some discussion which led to the creation of this page.

Installation

2021-12-28T18:05:41Z

Mcroft: /* Scaling support on HiDPI Monitors */

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 11 or better (Java 17 recommended)===
KoLmafia depends on finding Java 11 or better. The recommended version is linked at the top of every page of kolmafia.us. If you are executing KoLmafia from a jarfile, you will need to install Java first.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 17].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "16.0.1" 2021-04-20 OpenJDK Runtime Environment Zulu16.30+15-CA (build 16.0.1+9) OpenJDK 64-Bit Server VM Zulu16.30+15-CA (build 16.0.1+9, mixed mode, sharing)</code>
== Troubleshooting Runtime Issues==
=== Java Errors===
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===Scaling support on HiDPI Monitors===

If the KoLmafia application is unexpectedly small on a [https://techterms.com/definition/hidpi HiDPI]/Retina Display monitor, then support for HiDPI should enabled. This should only be required on Linux, since HiDPI support is enabled automatically on Windows and MacOS.

On Linux, using HiDPI with a Java Swing application (such as KoLmafia) requires that you execute the '.jar' file with an option set as follows: <code>java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile></code>

Depending on the screen size, a multiplier of 1.6 or 2.0 may be appropriate. You may need to experiment to find the ideal scaling multiplier for your screens.

[[Category:Tech Support]]
[[Category:New User Help]]

Compiling from Source

2021-12-28T17:44:52Z

Mcroft: /* KoLmafia has migrated to the GitHub, GIT and gradle. */

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub, GIT and gradle.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the [[Development Environment Setup|IDE setup]] is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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

==Windows==
# Download Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==macOS==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Installation

2021-12-28T17:38:37Z

Mcroft: /* Scaling support on HiDPI Monitors */ removed outdated instructions

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 11 or better (Java 17 recommended)===
KoLmafia depends on finding Java 11 or better. The recommended version is linked at the top of every page of kolmafia.us. If you are executing KoLmafia from a jarfile, you will need to install Java first.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 17].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "16.0.1" 2021-04-20 OpenJDK Runtime Environment Zulu16.30+15-CA (build 16.0.1+9) OpenJDK 64-Bit Server VM Zulu16.30+15-CA (build 16.0.1+9, mixed mode, sharing)</code>
== Troubleshooting Runtime Issues==
=== Java Errors===
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===Scaling support on HiDPI Monitors===

The default builds target Java and use Java Swing to provide its user interface. Java Swing support for HiDPI on Linux requires that you execute the '.jar' file with an option set as follows: <code>java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile></code> ;e.g. in my case, '<multiplier>' should be '2'.

[[Category:Tech Support]]
[[Category:New User Help]]

Installation

2021-12-28T17:17:49Z

Mcroft: Restructured a bit.

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 11 or better (Java 17 recommended)===
KoLmafia depends on finding Java 11 or better. The recommended version is linked at the top of every page of kolmafia.us. If you are executing KoLmafia from a jarfile, you will need to install Java first.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 17].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "16.0.1" 2021-04-20 OpenJDK Runtime Environment Zulu16.30+15-CA (build 16.0.1+9) OpenJDK 64-Bit Server VM Zulu16.30+15-CA (build 16.0.1+9, mixed mode, sharing)</code>
== Troubleshooting Runtime Issues==
=== Java Errors===
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===Scaling support on HiDPI Monitors===

The default builds target Java and use Java Swing to provide its user interface. This means that Java Swing support for HiDPI on Linux is not present. Java 9's Swing includes support for HiDPI. Thus to have HiDPI support one needs to compile it targeting Java 9. To do so, checkout the source from the sourceforge repository using subversion. Ensure that you have some version of JDK 9 installed and configured on your computer as the default java compiler, and also an up-to-date version of Apache Ant. Change the line in 'build.properties' from 'target="1.6"' to 'target="1.9"'. This compiles the source into a version that has support for HiDPI; the built jar will be located at the 'dist' folder. Finally, execute the '.jar' file with an option set as follows: <code>java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile></code> ;e.g. in my case, '<multiplier>' should be '2'.

[[Category:Tech Support]]
[[Category:New User Help]]

Installation

2021-12-28T17:14:59Z

Mcroft: /* Java 11 or better (Java 17 recommended) */

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 11 or better (Java 17 recommended)===
KoLmafia depends on finding Java 11 or better. The recommended version is linked at the top of every page of kolmafia.us. If you are executing KoLmafia from a jarfile, you will need to install Java first.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 17].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "16.0.1" 2021-04-20 OpenJDK Runtime Environment Zulu16.30+15-CA (build 16.0.1+9) OpenJDK 64-Bit Server VM Zulu16.30+15-CA (build 16.0.1+9, mixed mode, sharing)</code>
==== Troubleshooting Java====
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===HiDPI Support===

The default builds target Java and use Java Swing to provide its user interface. This means that Java Swing support for HiDPI on Linux is not present. Java 9's Swing includes support for HiDPI. Thus to have HiDPI support one needs to compile it targeting Java 9. To do so, checkout the source from the sourceforge repository using subversion. Ensure that you have some version of JDK 9 installed and configured on your computer as the default java compiler, and also an up-to-date version of Apache Ant. Change the line in 'build.properties' from 'target="1.6"' to 'target="1.9"'. This compiles the source into a version that has support for HiDPI; the built jar will be located at the 'dist' folder. Finally, execute the '.jar' file with an option set as follows: 'java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile>'; e.g. in my case, '<multiplier>' should be '2'.

[[Category:Tech Support]]
[[Category:New User Help]]

Installation

2021-12-28T17:14:06Z

Mcroft:

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 11 or better (Java 17 recommended)===
KoLmafia depends on finding Java 11 or better. The recommended version is linked at the top of every page of kolmafia.us.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 17].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "16.0.1" 2021-04-20 OpenJDK Runtime Environment Zulu16.30+15-CA (build 16.0.1+9) OpenJDK 64-Bit Server VM Zulu16.30+15-CA (build 16.0.1+9, mixed mode, sharing)</code>
==== Troubleshooting Java====
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===HiDPI Support===

The default builds target Java and use Java Swing to provide its user interface. This means that Java Swing support for HiDPI on Linux is not present. Java 9's Swing includes support for HiDPI. Thus to have HiDPI support one needs to compile it targeting Java 9. To do so, checkout the source from the sourceforge repository using subversion. Ensure that you have some version of JDK 9 installed and configured on your computer as the default java compiler, and also an up-to-date version of Apache Ant. Change the line in 'build.properties' from 'target="1.6"' to 'target="1.9"'. This compiles the source into a version that has support for HiDPI; the built jar will be located at the 'dist' folder. Finally, execute the '.jar' file with an option set as follows: 'java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile>'; e.g. in my case, '<multiplier>' should be '2'.

[[Category:Tech Support]]
[[Category:New User Help]]

Installation

2021-12-28T17:12:10Z

Mcroft: Total rewrite for Java 11+ codebase

{{TOCright}}
The latest source build can be downloaded from [http://builds.kolmafia.us/ builds.kolmafia.us] or the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 11 or better (Java 17 recommended)===
KoLmafia depends on finding Java 11 or better. The recommended version is linked at the top of every page of kolmafia.us.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 17].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "16.0.1" 2021-04-20 OpenJDK Runtime Environment Zulu16.30+15-CA (build 16.0.1+9) OpenJDK 64-Bit Server VM Zulu16.30+15-CA (build 16.0.1+9, mixed mode, sharing)</code>
==== Troubleshooting Java====
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===HiDPI Support===

The default builds target Java and use Java Swing to provide its user interface. This means that Java Swing support for HiDPI on Linux is not present. Java 9's Swing includes support for HiDPI. Thus to have HiDPI support one needs to compile it targeting Java 9. To do so, checkout the source from the sourceforge repository using subversion. Ensure that you have some version of JDK 9 installed and configured on your computer as the default java compiler, and also an up-to-date version of Apache Ant. Change the line in 'build.properties' from 'target="1.6"' to 'target="1.9"'. This compiles the source into a version that has support for HiDPI; the built jar will be located at the 'dist' folder. Finally, execute the '.jar' file with an option set as follows: 'java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile>'; e.g. in my case, '<multiplier>' should be '2'.

[[Category:Tech Support]]
[[Category:New User Help]]

Compiling from Source

2021-12-28T17:11:13Z

Mcroft: /* KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. */ --just fixing the ToC entry

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub, GIT and gradle.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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

==Windows==
# Download Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==macOS==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2021-12-28T17:09:51Z

Mcroft: /* macOS */

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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

==Windows==
# Download Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Build the new jar: <pre>./gradlew clean shadowJar</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==macOS==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>

Do every session:

# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Talk:Installation

2021-12-28T16:39:45Z

Mcroft:

Note to self: this is out of date. Fix it.

--[[User:Mcroft|Mcroft]] ([[User talk:Mcroft|talk]]) 16:39, 28 December 2021 (UTC)

Talk:Installation

2021-12-28T16:39:17Z

Mcroft: Created page with "Goodness, this is out of date."

Goodness, this is out of date.

Compiling from Source

2021-12-05T06:01:23Z

Mcroft: /* MacOSX (updated for Git/Gradle) */

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre>

Actually compile:<pre>cd /where/you/cloned/kolmafia</pre>
<pre>./gradlew clean shadowJar</pre>

Get new updates with <pre>git pull</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && ./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2021-12-05T06:00:40Z

Mcroft: /* GREAT BIG NEWS */

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre>

Actually compile:<pre>cd /where/you/cloned/kolmafia</pre>
<pre>./gradlew clean shadowJar</pre>

Get new updates with <pre>git pull</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX (updated for Git/Gradle)==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && ./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Talk:Compiling from Source

2021-12-05T05:59:05Z

Mcroft:

sun-java6-jdk is no longer available past squeeze and has been replaced by openjdk. Could someone test if the openjdk package can be used to compile kolmafia properly and replace the info in the page? Thanks - PASTA_KING99

===TODO===
test and fix Windows instructions.

Compiling from Source

2021-12-05T05:58:38Z

Mcroft: /* Windows */ untested!

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
The Windows section of this page is currently out of date. The Linux and macOS ones have been updated.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.

==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre>

Actually compile:<pre>cd /where/you/cloned/kolmafia</pre>
<pre>./gradlew clean shadowJar</pre>

Get new updates with <pre>git pull</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX (updated for Git/Gradle)==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && ./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2021-12-05T05:53:59Z

Mcroft: /* Windows */ draft

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
The Windows section of this page is currently out of date. The Linux and macOS ones have been updated.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/installation.html Adoption]. The current recommended version is Java 17.
## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit JAVA_HOME, and PATH variables ''PATH should include JAVA_HOME''If the JAVA installer has already set these variables, they can be updated or left alone.
# Get Source and Build
## Connect to the Gi 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 %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT 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.

==Linux==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre>

Actually compile:<pre>cd /where/you/cloned/kolmafia</pre>
<pre>./gradlew clean shadowJar</pre>

Get new updates with <pre>git pull</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX (updated for Git/Gradle)==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && ./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2021-12-05T05:31:43Z

Mcroft: Copied git vs. http instructions from Linux section

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
The Windows section of this page is currently out of date. The Linux and macOS ones have been updated.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit ANT_HOME, JAVA_HOME, and PATH variables ''PATH should include ANT_HOME/bin and JAVA_HOME''If ANT or JAVA installers have already set these variables, they can be updated or left alone.
# Get Source and Build
## 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 %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT 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===
====Double-Clicking ''ant.bat''====
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat dailyant -projecthelp'' will list all main targets
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you. When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
<blockquote>Example of a very simple MyWrapper.bat file<pre>
# This is a wrapper batch file
# First it runs ant
call ant.bat daily
# Then it pauses
pause</pre></blockquote>

====''tools.jar'' not found====
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). 
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==

Do once:
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
# Clone the repo:
## If you have a github account:<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>

Do every session:
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre>

Actually compile:<pre>cd /where/you/cloned/kolmafia</pre>
<pre>./gradlew clean shadowJar</pre>

Get new updates with <pre>git pull</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX (updated for Git/Gradle)==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. 
##''If you have a github account:''<syntaxhighlight lang="bash">
git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && ./gradlew runShadow</syntaxhighlight>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

IntelliJ Setup

2021-10-29T03:39:13Z

Mcroft: /* Updated for GitHub

==== KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. ====

[https://www.jetbrains.com/idea/ IntelliJ IDEA] is an IDE for developing Java applications. This guide assumes that you have a recent enough version of Java JDK, Ant, and IntelliJ IDEA. Completing [[Compiling from Source]] is a requirement for this guide, although experienced developers can skip to whatever step is appropriate.

The following instructions are based on IntelliJ IDEA 2021.2 Community Edition. Instructions for other versions/editions of IntelliJ may be slightly different.

== Create a Project ==
=== Create a new project ===
# Start IntelliJ IDEA. In the ''Welcome to IntelliJ IDEA'' dialog, click '''Get from VCS'''. [[File:Intellij-setup-c2021.2-welcome.png|300px]]
# In the ''Get from Version Control'' dialog, select the '''Repository URL''' tab.
## In ''Version control'', select '''GitHub'''. [[File:Intellij-setup-c2021.2-get-from-vcs.png|300px]]
## Add a new repository location. To do so, click the '''+''' button next to ''Repositories''. [[File:Intellij-setup-c2021.2-get-from-vcs-subversion.png|300px]]
## In the ''New Repository Location'' popup, enter the URL to KoLmafia's GitHub repository. If you have a GitHub account and a Personal Access Token, use git@github.com:kolmafia/kolmafia.git If you do not have a GitHub account, use https://github.com/kolmafia/kolmafia.git [[File:Intellij-setup-c2021.2-new-repository-location.png|200px]]
## Click '''OK''' to close the popup.
## Once the repository has been added, '''click the repository URL to highlight it''', then click '''Check Out'''. [[File:Intellij-setup-c2021.2-get-from-vcs-check-out.png|300px]]
# If the ''Destination Directory'' popup appears, choose a directory to check out the working copy. ''Caution'': Don't choose a common directory like <samp>C:\Users\<username>\Documents</samp>. Instead, create a new directory under it (by clicking the folder icon) and give it an appropriate name (e.g. <samp>kolmafia</samp>). [[File:Intellij-setup-c2021.2-choose-working-copy-dir.png|200px]] Click '''OK''' to continue.
# IntelliJ will generate a new project. If it asks you whether to add <code>kolmafia.iml</code> to Subversion, you may click '''Cancel''' to skip it

=== Add the Gradle Build File ===
# Open the Gradle Toolbar Item (typically on the right side, and not very large)
# Click the '''+''' button to add a build file
# Choose build.gradle from the file selector and press Open

=== From the Gradle Menu, select Applications>run ===

Development Environment Setup

2021-10-29T00:23:02Z

Mcroft: /* KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. */

== KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. ==
Links below this section may be obsolete and should be verified before relying on them.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

After succeeding at [[Compiling from Source]] for your platform, you can add set up your KoLMafia source in an Integrated Development Environment (IDE) of your choice. It is entirely possible to build and change KoLMafia without and IDE and some of the developers do just that.
====Platform-specific Development Tools====
;''Apple's OS X notes on development for Java, including the XCode Tools setup, can make command line work easier.''
::[https://developer.apple.com/library/archive/documentation/Java/Conceptual/Java14Development/02-JavaDevTools/JavaDevTools.html Apple Developer Tools for Java]
====Developer Text Editors====
Choose your favorite, or add your favorite.
;[http://www.barebones.com BBEdit]
:: Mac OS X based text editor
;[https://macromates.com TextMate]
::Another Mac based editor
;[https://www.ultraedit.com Ultra Edit]
::cross-platform text editor

====IDEs====
This list will be out of date shortly after it's written, but can be updated as newer tools and versions are released.
;[https://www.jetbrains.com/idea/download/ IntelliJ IDEA]
::[[IntelliJ Setup]]
;[http://www.eclipse.org Eclipse]
::[[eclipse Setup]]
;[https://code.visualstudio.com/ VS Code]
::[[VS Code Setup]]
;[https://www.jetbrains.com/idea/download/ NetBeans]
::[[NetBeans Setup]]
;[http://developer.apple.com/tools/xcode/) Xcode] (Mac only)
::[[XCode Setup]]

====Source Control Management tools====
;[http://path/to/something/ TortoiseSVN]
::[[Tortoise Setup]]

Compiling from Source

2021-10-29T00:21:20Z

Mcroft: /* MacOSX (updated for GIT/Gradle) */

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit ANT_HOME, JAVA_HOME, and PATH variables ''PATH should include ANT_HOME/bin and JAVA_HOME''If ANT or JAVA installers have already set these variables, they can be updated or left alone.
# Get Source and Build
## 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 %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT 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===
====Double-Clicking ''ant.bat''====
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat dailyant -projecthelp'' will list all main targets
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you. When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
<blockquote>Example of a very simple MyWrapper.bat file<pre>
# This is a wrapper batch file
# First it runs ant
call ant.bat daily
# Then it pauses
pause</pre></blockquote>

====''tools.jar'' not found====
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). 
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 )

'''Above may be out of date.''' As of the move to github the following commands were successful to build from source on Ubuntu 20.04.1 LTS. You will still have to have a jdk installed.<pre>git clone https://github.com/kolmafia/kolmafia.git
cd kolmafia
./gradlew clean shadowJar</pre>
===Fedora (or probably other RPM systems)===

# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre>
# Install Java JDK: <pre>sudo yum install java-latest-openjdk-devel</pre>
# Install Ant: <pre>sudo yum install ant</pre>
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre>
# Build: <pre>cd kolmafia && ant</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX (updated for Git/Gradle)==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. ''<code>git clone git@github.com:kolmafia/kolmafia.git</code>''
# Compile KoLmafia with the Gradle wrapper ''<code>cd kolmafia && ./gradlew runShadow</code>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''

Compiling from Source

2021-10-29T00:20:58Z

Mcroft: /* MacOSX */ update for Git and Gradle

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

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 Tools
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit ANT_HOME, JAVA_HOME, and PATH variables ''PATH should include ANT_HOME/bin and JAVA_HOME''If ANT or JAVA installers have already set these variables, they can be updated or left alone.
# Get Source and Build
## 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 %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT 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===
====Double-Clicking ''ant.bat''====
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat dailyant -projecthelp'' will list all main targets
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you. When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
<blockquote>Example of a very simple MyWrapper.bat file<pre>
# This is a wrapper batch file
# First it runs ant
call ant.bat daily
# Then it pauses
pause</pre></blockquote>

====''tools.jar'' not found====
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). 
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 )

'''Above may be out of date.''' As of the move to github the following commands were successful to build from source on Ubuntu 20.04.1 LTS. You will still have to have a jdk installed.<pre>git clone https://github.com/kolmafia/kolmafia.git
cd kolmafia
./gradlew clean shadowJar</pre>
===Fedora (or probably other RPM systems)===

# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre>
# Install Java JDK: <pre>sudo yum install java-latest-openjdk-devel</pre>
# Install Ant: <pre>sudo yum install ant</pre>
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre>
# Build: <pre>cd kolmafia && ant</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX (updated for GIT/Gradle)==
# Verify required packages
## <code>''java --version''</code>
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
## <code>''git --version''</code>
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environment Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home. If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)
# Clone the source code for the KoLmafia Project. ''<code>git clone git@github.com:kolmafia/kolmafia.git</code>''
# Compile KoLmafia with the Gradle wrapper ''<code>cd kolmafia && ./gradlew runShadow</code>''

=== Optional ===
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
''[[Category:Tech Support]]''