Kolmafia - User contributions [en]

Making a Patch

2022-09-25T09:14:26Z

Heeheehee: Add link to contributions guide.

{{Attention|This page is outdated as of the move to Github in Sep 2021. Check out [https://github.com/kolmafia/kolmafia/blob/main/CONTRIBUTING.md our contributions guide] for the latest details.}}

Once you have the source code for Mafia successfully downloaded as in the [[Compiling from Source]] page, you will then need to make a patch, as the dev's don't let just anyone update the program. Fortunately, this is very simple, and once you have the patch, post it on the KoLmafia Forums for acceptance.

==Windows==
# Right-click on the KoLmafia folder on your desktop (this assumes you are using Tortoise SVN), click on "TortoiseSVN" and then "Create Patch...".
# A new window then appears. Tick all the files you want to include in the patch (this is probably all of them), and click OK.
# Tortoise SVN then merges all your changes into a single .patch file, which you can then post on the forums.

==Linux==
# cd into the folder where you did your svn checkout
# run svn diff > /tmp/patchname.patch (a list of filenames can optionally be included after diff)
# post the file on the forums for review

==MacOS Terminal==
Use the Linux instructions
==IntelliJ==
There are a number of different ways to get to the Create Patch dialog. Use any method, including the steps below.
# From the VCS Menu select "Create Patch from Local Changes".
# In the Create Patch dialog, enter a short description in the "Commit Message" Text field.
# Review your changes and make sure they include what you want to have in the patch file and nothing unexpected.
# Select the "Apply Patch..." button.
# Review the suggested patch name.
# Select the "OK" button.
The patch file in the location listed in the Save dialog can be uploaded to the forum.

==Eclipse==
[[Category:Tech Support]]

Installation

2022-09-12T21:45:25Z

Heeheehee: /* Java 11 or better (Java 17 recommended) */ Reflect that Java 17 is required, not merely 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 17 or higher===
KoLmafia depends on Java 17 or higher 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-06T13:28:43Z

Heeheehee: Update Linux / Mac instructions to be more consistent about fetching updates from the remote repository.

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

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]]''

User:Heeheehee

2021-04-25T09:01:18Z

Heeheehee: /* Projects */ scrub broken link

==About Me==
Started playing KoL at the end of '04 (Wow, I feel old). Started scripting in ASH in the middle of '09. And started contributing to the Mafia wiki in the start of '10!
==Projects==
 Scripts I've published:
* [http://kolmafia.us/showthread.php?t=3248 Profit from Effects], a derivative of a derivative of Zarqon's profit.ash, although it now does so much more.
* [http://kolmafia.us/showthread.php?3549-manageprices.ash-Quick-mall-management! Various] [http://kolmafia.us/showthread.php?3922-pyramid.ash-Disable-links-in-the-pyramid-that-might-be-bad relay] [http://kolmafia.us/showthread.php?4081-ZLib-variable-editor-(relay_zlib.ash) override] [http://kolmafia.us/showthread.php?4137-clan_basement.ash-separate-hobopolis-and-slime-tube-loot scripts], that I find useful. Generally. (These get published if I think they're somewhat useful.)
I'm also the individual behind making the SyntaxHighlight extension ASH-compliant.

 Known issues present in the latest version:
* User-defined variables with the same name as ASH internal functions will be highlighted.
* Functions/Control structures are highlighted within datatype constants (e.g. $skill[The Ode to Booze]).
Since it works just fine otherwise, I'm not going to bother fixing these.

Ash Functions

2015-03-26T13:14:28Z

Heeheehee: Fix return type of get_chateau().

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

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

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

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

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

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

===g===
{{Flink|boolean|galaktik_cures_discounted}}
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|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|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|monster [int]|get_monsters|location}}
{{Flink|string [int]|get_moods}}
{{Flink|string [int]|get_outfits}}
{{Flink|string|get_path}}
{{Flink|string|get_path_full}}
{{Flink|string|get_path_variables}}
{{Flink|string|get_player_id|string}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string|get_version}}
{{flink|boolean|gnomads_available}}
{{flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|int|group_count|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_store_available}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Category:Scripting]]

Ash Functions

2015-03-26T13:11:14Z

Heeheehee: Add some more that the script missed, and remove functions that no longer exist. Also, amend edit to use opt template.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Category:Scripting]]

Ash Functions

2015-03-26T12:31:46Z

Heeheehee: Add new functions that never made there way here.

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

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

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

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

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

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

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

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

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

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

===k===
{{flink|boolean|knoll_available}}
===l===
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|string|limit_mode}}
{{Flink|int|lightning_cost}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}
===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|int|mmg_bet_amount|int}}
{{Flink|string|mmg_bet_owner|int}}
{{Flink|int|mmg_bet_owner_id|int}}
{{Flink|string|mmg_bet_taker}}
{{Flink|string|mmg_bet_taker_id}}
{{Flink|int|mmg_bet_winnings}}
{{Flink|int|mmg_make_bet|int|boolean}}
{{Flink|int [int]|mmg_my_bets}}
{{Flink|int [int]|mmg_offered_bets}}
{{Flink|boolean|mmg_retract_bet|int}}
{{Flink|void|mmg_search|int|int}}
{{Flink|int|mmg_take_bet|int|boolean}}
{{Flink|void|mmg_visit}}
{{Flink|int|mmg_wait_event|int}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|int|monster_initiative|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_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_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{flink|int|my_lightning}}
{{Flink|location|my_location}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxfury}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{Flink|stat|my_primestat}}
{{flink|int|my_rain}}
{{Flink|servant|my_servant|servant}}
{{flink|string|my_sign}}
{{flink|int|my_soulsauce}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{flink|thrall|my_thrall}}
{{flink|int|my_thunder}}
{{Flink|int|my_turncount}}

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

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

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}
===r===
{{Flink|int|random|int}}
{{Flink|int|rain_cost|skill}}
{{Flink|int|raw_damage_absorption}}
{{Flink|void|refresh_shop}}
{{Flink|void|refresh_stash}}
{{Flink|void|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_choice}}
{{Flink|buffer|run_combat}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

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

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

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

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

[[Category:Scripting]]

Use skill

2015-03-26T01:34:01Z

Heeheehee: Correct the claim that use_skill returns different things depending on calling context, as opposed to type of parameters passed.

There are two forms of this function. In a combat consult script, this returns a buffer, but otherwise it returns a boolean. Note both forms below.

{{
#vardefine:name|use_skill}}{{
#vardefine:return_type|boolean}}=Normal Use={{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|casts}}|
parameter2={{Param|skill|to_use}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|casts}}|
parameter2={{Param|skill|to_use}}|
parameter3={{Param|string|target}}|
p1desc={{Pspan|casts}} is the number of casts|
p2desc={{Pspan|to_use}} is the skill to use|
p3desc={{Pspan|target}} is the recipient (optional, for use with buffs only)|
}}|

function_description=Attempts to cast the skill {{pspan|to_use}} a number of times specified by {{pspan|casts}}, or once if not specified. Defaults to casting on yourself, but you can specify a {{pspan|target}} for buffs.|

code1={{CodeSample|
title=Code Sample|
description=This example will attempt to cast the specified skill as many times as it can with the MP the character has left.|
code=
<syntaxhighlight>
effect chosen = $effect[ Empathy ];
use_skill( my_mp() / mp_cost( to_skill(chosen) ) , to_skill(chosen) );
</syntaxhighlight>}}|

cli_equiv=The CLI command "cast" functions similarly to the normal version of this function (with similar parameters).|

}}=In-combat Consulting={{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=buffer|
return_also={{#var:return_also}}|
parameter1={{Param|skill|to_use}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_also={{#var:return_also}}|
parameter1={{Param|int|casts}}|
parameter2={{Param|skill|to_use}}|
p1desc={{Pspan|casts}} is the (optional) number of casts|
p2desc={{Pspan|to_use}} is the skill to use|
}}|

function_description=If the two-argument form is used in-combat, it will loop the specified number of {{pspan|casts}} using the specified skill {{pspan|to_use}}, never reconsulting the script until the loop is complete or the monster is defeated. The single-argument form will use the skill, then return the HTML response text. One exception: this will not work with Lasagna Bandages, since it tries to cast the out-of-combat version of the skill. Using {{f|visit_url}} is required for casting Lasagna Bandages in combat.|

}}

[[Category:Skills and Effects]][[Category:In-combat Consulting]]
{{RFI|Confirm: Is visit_url() still needed for Lasagna Bandages?}}

Data Types

2014-01-11T17:14:24Z

Heeheehee: /* Special Datatypes */ Add pasta thralls, supercold (element)

{{TOCright}}
==Primitive Datatypes==

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

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

===int===

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

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

===float===

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

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

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

===string===

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

===buffer===

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

==Special Datatypes==

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

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

===class===

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

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

===coinmaster===
All shops that deal with currency other than meat.

===effect===

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

Besides $element[ none ], there are six 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===

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

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

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

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

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

===phylum===

Each monster has a {{kolwiki|Phylum}}. There may be 23 phyla in KoL, but so far only 22 have been discovered and named by the playerbase. The possible values for this datatype are:

* beast
* bug
* constellation
* crimbo
* demihuman
* demon
* elemental
* fish
* goblin
* hippy
* hobo
* humanoid
* horror
* mer-kin
* object
* orc
* penguin
* pirate
* plant
* slime
* strange
* undead

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

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

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

===stat===

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

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

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

==aggregate==

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

==record==

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

==Plural Typed Constants==

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

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

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

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

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

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

==Custom==

===matcher===

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

[[Category:Scripting]]

Talk:Datatype Conversions

2014-01-11T17:07:13Z

Heeheehee: Page needs updating :|

This page probably needs some amount of editing, since datatype conversions have been tightened up a bit --- for instance, to_boolean($class[seal clubber]) is no longer valid. Also, we have a few new types (coinmaster, thrall, phylum, to name a few). --[[User:Heeheehee|Heeheehee]] ([[User talk:Heeheehee|talk]]) 17:07, 11 January 2014 (UTC)

Miscellaneous ASH Features

2014-01-11T17:00:13Z

Heeheehee: /* Chatbot (chatBotScript) */ Add channel data for events.

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

===Special Syntax Functions===

'''[[notify]]'''

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

'''[[import]]'''

Used to load an external script into your current one.

'''[[call]]'''

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

'''[[new]]'''

Constructor function used to populate a record.

===Comments===

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

==Errors==

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

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

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

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

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

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

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

==Additional Script Uses==

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

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

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

==== Before Adventure (betweenBattleScript) ====

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

=== Breaking the Prism (kingLiberatedScript) ===

: This will be executed after you break the Prism at the top of the Naughty Sorceress' Lair. This trigger is designed so that a character can be automatically prepared for aftercore. The kingLiberatedScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

=== Buy (buyScript) ===

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

=== Chatbot (chatBotScript) ===

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

=== Counters (counterScript) ===

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

=== Login (loginScript) ===

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

=== Logout (logoutScript) ===

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

=== Planting (plantingScript) ===

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

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

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

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

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

=== Recovery (recoveryScript) ===

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

==A little CLI help==

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

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

[[Category:Scripting]]

Talk:Modifier eval

2013-08-13T16:32:03Z

Heeheehee: Re: recent edit

I just removed "This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!" from pref(X), since I'm not sure what it's supposed to mean. pref(X) doesn't write to preferences, and it parses integer prefs just fine... does anyone care to explain? --[[User:Heeheehee|Heeheehee]] ([[User talk:Heeheehee|talk]]) 16:32, 13 August 2013 (UTC)

Modifier eval

2013-08-13T16:29:51Z

Heeheehee: Remove incorrect information.

{{
#vardefine:name|modifier_eval}}{{
#vardefine:return_type|float}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|expression}}|
p1desc={{pspan|expression}} is a mathematical expression to be solved.|
}}|

function_description= Evaluates an expression in the format used by variable modifiers:

* No spaces are allowed within the expression, except as part of a zone/location name.
* + - * / ( ) have their usual mathematical meaning and precedence.
* ^ is exponentiation, with the highest precedence.
* Functions available: ceil(x) floor(x) sqrt(x) min(x,y) max(x,y)
* Location functions: loc(text) zone(text)
** These have a value of 1 if the current adventure location or zone contains the specified text, 0 elsewhere.
* Familiar function: fam(text)
** This has a value of 1 if the player's familiar type contains the text, else 0.
* Preferences function: pref(text)
* There could be at most one of each text function in an expression.
** This is no longer the case however and multiple of the same text functions should now work properly.
* All upper-case letters are reserved for internally-used variables. The available variables are:
** A - number of Ascensions
** B - Blood of Wereseal effect
** C - Clancy's level
** D - Drunkenness
** E - active (nonintrinsic) Effects
** F - Fullness
** G - Grimace darkness (0..5)
** H - Hobo Power
** J - 1 on Festival of Jarlsberg, 0 otherwise
** L - player Level
** M - total Moonlight (0..9)
** R - Reagent potion duration
** S - Spleenness
** T - Turns remaining of this effect
** U - telescope Upgrades
** W - familiar Weight
** X - gender (-1=male, 1=female)
* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.
 |

code1={{CodeSample|
title=Code Sample|
description=This script expands modifier_eval() to include support for user-defined variables. It is extremely complex, but it is extremely useful to anyone who wants to use modifier_eval().|
code=
<syntaxhighlight>
float eval(string expr, float[string] vars) {
buffer b;
matcher m = create_matcher( "\\b[a-z_][a-zA-Z0-9_]*\\b", expr );
while (m.find()) {
string var = m.group(0);
if (vars contains var) {
m.append_replacement(b, vars[var].to_string());
}
// could implement functions, pref access, etc. here
}
m.append_tail(b);
return modifier_eval(b.to_string());
}

# Everything below this line shows how to make use of eval().
# TESTING:

float[string] v;
v["pi"] = 3.14159265;
v["ten"] = 10;
print(eval("2+3", v));
print(eval("max(pi^ten,ten^pi)", v));
print(eval("sqrt(pi)*L", v));
print(eval("undefined/2", v));

</syntaxhighlight>}}|
}}

[[Category:Math and Numbers]]

Modifier eval

2013-06-07T01:14:50Z

Heeheehee: "special" no longer true -- div-by-zero now throws an error instead of generating NaN (or possibly +/- infinity).

{{
#vardefine:name|modifier_eval}}{{
#vardefine:return_type|float}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|expression}}|
p1desc={{pspan|expression}} is a mathematical expression to be solved.|
}}|

function_description= Evaluates an expression in the format used by variable modifiers:

* No spaces are allowed within the expression, except as part of a zone/location name.
* + - * / ( ) have their usual mathematical meaning and precedence.
* ^ is exponentiation, with the highest precedence.
* Functions available: ceil(x) floor(x) sqrt(x) min(x,y) max(x,y)
* Location functions: loc(text) zone(text)
** These have a value of 1 if the current adventure location or zone contains the specified text, 0 elsewhere.
* Familiar function: fam(text)
** This has a value of 1 if the player's familiar type contains the text, else 0.
* Preferences function: pref(text)
** This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!
* There could be at most one of each text function in an expression.
** This is no longer the case however and multiple of the same text functions should now work properly.
* All upper-case letters are reserved for internally-used variables. The available variables are:
** A - number of Ascensions
** B - Blood of Wereseal effect
** C - Clancy's level
** D - Drunkenness
** E - active (nonintrinsic) Effects
** F - Fullness
** G - Grimace darkness (0..5)
** H - Hobo Power
** J - 1 on Festival of Jarlsberg, 0 otherwise
** L - player Level
** M - total Moonlight (0..9)
** R - Reagent potion duration
** S - Spleenness
** T - Turns remaining of this effect
** U - telescope Upgrades
** W - familiar Weight
** X - gender (-1=male, 1=female)
* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.
 |

code1={{CodeSample|
title=Code Sample|
description=This script expands modifier_eval() to include support for user-defined variables. It is extremely complex, but it is extremely useful to anyone who wants to use modifier_eval().|
code=
<syntaxhighlight>
float eval(string expr, float[string] vars) {
buffer b;
matcher m = create_matcher( "\\b[a-z_][a-zA-Z0-9_]*\\b", expr );
while (m.find()) {
string var = m.group(0);
if (vars contains var) {
m.append_replacement(b, vars[var].to_string());
}
// could implement functions, pref access, etc. here
}
m.append_tail(b);
return modifier_eval(b.to_string());
}

# Everything below this line shows how to make use of eval().
# TESTING:

float[string] v;
v["pi"] = 3.14159265;
v["ten"] = 10;
print(eval("2+3", v));
print(eval("max(pi^ten,ten^pi)", v));
print(eval("sqrt(pi)*L", v));
print(eval("undefined/2", v));

</syntaxhighlight>}}|
}}

[[Category:Math and Numbers]]

Have effect

2013-05-07T04:01:19Z

Heeheehee: Basis for RFI no longer valid, apparently.

{{
#vardefine:name|have_effect}}{{
#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|effect|have_effect}}|
p1desc={{pspan|have_effect}} is an effect to check for|
}}|

function_description=Returns the number of turns for which you currently {{pspan|have_effect}}. Returns 0 if you do not have any turns of {{pspan|have_effect}}. If the effect is an intrinsic that you currently have, this function returns 2147483547 (which is 100 less than a signed integer's upper limit).|

code1={{CodeSample|
title=Code Sample|
description=The following casts Disco Aerobics if you have less than 10 turns Disco State of Mind & have the skill.|
code=
<syntaxhighlight>
//This would normally be better handled with a mood, and is for illustration only
if ((have_effect($effect[Disco State of Mind]) < 10) && have_skill($skill[Disco Aerobics]))
use_skill(1 , $skill[Disco Aerobics]);
</syntaxhighlight>
}}|

see_also={{SeeAlso|have_skill|use_skill}}|
cli_equiv=The CLI command "effects" gives information on all of your current effect durations.|
special=Note that in KoL, having an effect from both an intrinsic and turn-limited source will only report the intrinsic (infinite) duration while active, and as such this function will return 2147483647 (Java's Integer.MAX_VALUE) when you are under an effect from both types of sources.
}}

[[Category:Skills and Effects]]

Ash Functions

2013-05-07T03:45:55Z

Heeheehee: Update list of ASH functions. Also, a few minor corrections.

{{TOCright}}
Master list of all ASH functions. All functions as of r8144 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|string|{{opt|string}}}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|boolean|buy|coinmaster|int|item}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buys_item|coinmaster|item}}
===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|chamber}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{Flink|boolean|cli_execute|string}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{Flink|boolean|contains_text|string|string}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|boolean|craft|string|int|item|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|boolean|create|int|item}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}

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

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

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

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

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

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

===k===
{{flink|boolean|knoll_available}}
===l===
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}
===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|int|mmg_bet_amount|int}}
{{Flink|string|mmg_bet_owner|int}}
{{Flink|int|mmg_bet_owner_id|int}}
{{Flink|string|mmg_bet_taker}}
{{Flink|string|mmg_bet_taker_id}}
{{Flink|int|mmg_bet_winnings}}
{{Flink|int|mmg_make_bet|int|boolean}}
{{Flink|int [int]|mmg_my_bets}}
{{Flink|int [int]|mmg_offered_bets}}
{{Flink|boolean|mmg_retract_bet|int}}
{{Flink|void|mmg_search|int|int}}
{{Flink|int|mmg_take_bet|int|boolean}}
{{Flink|void|mmg_visit}}
{{Flink|int|mmg_wait_event|int}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_basestat|stat}}
{{Flink|int|my_buffedstat|stat}}
{{Flink|class|my_class}}
{{Flink|int|my_closet_meat}}
{{Flink|string|my_companion}}
{{Flink|int|my_daycount|}}
{{Flink|familiar|my_effective_familiar}}
{{Flink|int [effect]|my_effects}}
{{Flink|familiar|my_enthroned_familiar}}
{{Flink|familiar|my_familiar}}
{{Flink|int|my_fullness}}
{{Flink|string|my_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{Flink|location|my_location}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{Flink|stat|my_primestat}}
{{flink|string|my_sign}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_turncount}}

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

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

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}
===r===
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|boolean|refresh_stash}}
{{Flink|boolean|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_combat}}
{{Flink|buffer|runaway}}

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

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

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

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

Can equip

2012-08-25T19:43:03Z

Heeheehee: Update can_equip to account for various updates to kolmafia.session.EquipmentManager.

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

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

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

function_description=Returns true if, based on your current stats, you are capable of equipping {{pspan|check_me}} on your character, false if you cannot. Note that this function doesn't check for whether or not you actually have the item; just whether you're capable of equipping it. |

code1={{CodeSample|
title=Code Sample|
description=Check to see if the character can equip a Hippo Poncho.|
code=
<syntaxhighlight>
if(!have_skill($skill[torso awaregness]))
print("Cannot equip a shirt if you don't know how to find your own torso!");
if(can_equip($item[hippo poncho]))
print("You're sexy enough to wear a hippo poncho.", "green");
else print("You're not sexy enough to wear a hippo poncho.", "red");
</syntaxhighlight>
}}|

see_also={{SeeAlso|have_equipped}}|
special= Note that this, for the most part, only checks for stat requirements to equip an item, so, for example, checking for a chefstaff will return true if you meet the stat requirements to equip it, even if you don't have Spirit of Rigatoni or a sauce glove. However, Torso Awareness is checked if applicable, as are ascension restrictions and, to some extent, familiar type.|
}}

[[Category:Equipment]]

Talk:Can equip

2012-08-25T19:34:14Z

Heeheehee: Torso now valid for can_equip()

(moved) by --[[User:StDoodle|StDoodle]] 18:08, 6 March 2010 (UTC)

Correct. Torso isn't taken into account, either. This may be a bug. --Heeheehee 17:46, 6 March 2010 (UTC)

From glancing at Mafia's code, it checks if you are in hardcore and if the item cannot be equipped in hardcore, then it simply checks you stats against the stat requirement. [[User:Slyz|Slyz]] 17:05, 3 April 2010 (UTC)

As of some time ago, evidently the code now checks for correct familiar type, Torso, Fistcore, and Axecore. However, it doesn't look like it takes hand/hatrack/scarecrow into account. --[[User:Heeheehee|Heeheehee]] 15:34, 25 August 2012 (EDT)

Data Structures

2011-04-17T23:08:43Z

Heeheehee: Answered the RFI: added comments about iteration. Also added stuff about arrays in ASH and time/space considerations.

{{TOCright}}

KoLmafia supports complex data structures such as maps and records made from simple [[Data Types|data types]].

== Maps ==
Most of this information was copied directly from ASH Maps Tutorial, by Veracity (http://kolmafia.sourceforge.net/advanced.html#maps)

A map is indexed by one data type (the key) and associates that key with another (or the same) data type (the value). The key can be any ASH simple data type: boolean, int, float, string, item, location, class, stat, skill, effect, familiar, slot, or monster. The value can be any ASH data type at all: a simple type, a record, or can be another map. This effectively allows multi-dimensional maps and. In fact, that's how the syntax we provide for multi-dimensional maps actually operate: maps of maps of maps ...

You can declare a map any time you can declare a variable: as a top level (global) variable, as a function parameter, or as a local variable in any scope.

You can fetch data from a map any time you can provide a data value: in an expression, as a function parameter, on the right side of an assignment statement, from a "return" statement, as so on. You can pass around entire maps, individual elements, or intermediate maps: "slices".

=== Declarations ===

The syntax for declaring the data type of a map:

<pre>
<data type> [ <key type>, ... ] <aggregate_name>
</pre>

For example:

{{CodeSample
|code=<syntaxhighlight>
string [item] map1;
float [class, string, int] another_map;
</syntaxhighlight>}}

=== Assignments ===

If you use a map on the left side of an assignment, you set the whole map at once to the new value.

{{CodeSample
|code=<syntaxhighlight>
int [item] my_pricelist;
int [item] new_pricelist;

/* Some code that updates new_pricelist */

my_pricelist = new_pricelist;
</syntaxhighlight>}}

If you specify a map and a complete set of indices (of the correct types) on the left side of an assignment statement, you set a single element.

{{CodeSample
|code=<syntaxhighlight>
int [item] my_pricelist;
my_pricelist[ $item[ pail ] ] = 1000;
</syntaxhighlight>}}

If you specify a map and a prefix of indices (of the correct type), you directly set one of the intermediate maps, a "slice".

{{CodeSample
|code=<syntaxhighlight>
float [string, int, string] my_map;
float [int, string] slice1;

/* Some code that fills slice1 */
my_map[ "slice1" ] = slice1;
</syntaxhighlight>}}

=== References ===

The syntax for referencing an element (or slice) of a map:

<pre>
<aggregate name>[ <key expression>, ... ]
</pre>

All the key expressions will be evaluated at run time. If you specify all the keys the map expects, you fetch data of the type specified by the map. If you specify fewer keys than the map expects, you get an intermediate map, a "slice".

As an example:
{{
CodeSample|
code=
<syntaxhighlight>
boolean [string, string] props;
</syntaxhighlight>}}

might be used to hold "properties" associated with names.
{{
CodeSample|
code=
<syntaxhighlight>
props[ "dog", "mammal" ] = true;
props[ "dog", "pet" ] = true;
props[ "dog", "fun" ] = false;
props[ "turtle", "mammal" ] = false;
props[ "turtle", "pet" ] = true;
props[ "turtle", "fun" ] = false;
props[ "aardvark", "mammal" ] = true;
props[ "aardvark", "pet" ] = false;
props[ "aardvark", "fun" ] = true;
</syntaxhighlight>}}

references:

<pre>
props[ "dog", "mammal"] => true
boolean [string] animal = props[ "turtle" ];
animal[ "fun" ] => false
</pre>

=== Contains ===

You can test the presence of a key in a map using the "contains" operator:

<pre>
<aggregate reference expression> contains <key expression>
</pre>

Where <aggregate reference expression> must evaluate at run time to a map or slice, and must evaluate at run time to a key of the appropriate type. (Note that that is enforced at parse time; ASH can tell the datatype any expression will produce).

<pre>
props contains "dog" => true
props contains "elephant" => false
props[ "aardvark" ] contains "fun" => true
animal contains "pet" => true
animal contains "favorite food" => false
</pre>

=== Remove ===

You can remove a key-value association from a map using the "remove" unary operator:

<pre>
remove <aggregate reference>
</pre>

For clarification, an aggregate reference is "<map name>[ <index 1> ... <index n> ]" where <map name>[ <index 1> ... <index n-1> ] specifies the "slice" and <index n> specifies the "key". Which is just what you expect, if you fully specify the indices; for a single dimensional map, "map[10]" -> "map" is the slice and 10 is the key. The "remove" operator removes the "key" from the "slice". For example:

{{CodeSample|code=<syntaxhighlight>
string [int] map1;
map1[5] = "foo";
print( count( map1 ) + " " + map1 contains 5 + " " + map1[5] );
print( "remove: " + remove map1[5] );
print( count( map1 ) + " " + map1 contains 5 + " " + map1[5] );
print( "remove: " + remove map1[5] );
int [string, string] map2;
map2["me","you"] = 17;
print( count( map2["me"] ) + " " + map2["me"] contains "you" + " " + map2["me","you"] );
print( "remove: " + remove map2["me", "you"] );
print( count( map2["me"] ) + " " + map2["me"] contains "you" + " " + map2["me","you"] );
print( "remove: " + remove map2["me", "you"] );
print( count( map2 ) + " " + map2["me"] );
print( "remove: " + remove map2["me"] );
print( count( map2 ) + " " + map2["me"] );
</syntaxhighlight>}}

yields:

<pre>
1 true foo
remove: foo
0 false
remove:
1 true 17
remove: 17
0 false 0
remove: 0
1 aggregate int [string]
remove: aggregate int [string]
0 aggregate int [string]
</pre>

=== Clear ===

You can remove all <code>key => value</code> entries from a map using the {{f|clear}} function:

{{CodeSample|code=<syntaxhighlight>clear( <aggregate> );</syntaxhighlight>}}

=== Sort ===

From http://kolmafia.us/showthread.php?t=1738

The syntax is:
{{CodeSample|code=<syntaxhighlight>sort aggregate by keyExpr;</syntaxhighlight>}}
<code>aggregate</code> is a reference to the object to be sorted - arrays are probably the most useful things to sort, but any mapping type can be used (even multidimensional maps, but note that you can only sort along a single dimension at a time). The reference must not be enclosed in parentheses, as that would look like a call to a function named <code>sort()</code> - which is still perfectly valid, "sort" has not become a [[Reserved Words|reserved word]].

<code>keyExpr</code> is an arbitrary expression that defines how the items should be ordered. It is evaluated once for every entry in the aggregate, in a scope with two additional variables implicitly defined: '<code>index</code>' and '<code>value</code>', holding the details of that entry. The value of the <code>keyExpr</code> is used as the sort key; typically it would be an <code>int</code> or <code>string</code>, but can be any ASH type that can be compared via "<" and the other relational operators.

The most basic form of sorting would therefore be "<code>sort ... by value</code>", but many useful things can be done with the use of a more complex <code>keyExpr</code> - the only real restriction is that the expression should not modify the object you're sorting. For example, if you had an array of items, you could sort it "<code>by autosell_price(value)</code>". An array of weapon items could be sorted "<code>by -get_power(value)</code>" to put it in decreasing order of power. If the elements of your aggregate are records, you'd need to use something like "<code>by value.fieldName</code>", since the records themselves can't be meaningfully compared.

After the sort statement, the aggregate will have exactly the same sets of keys and values as before (even if the keys weren't consecutive), and the iteration order of the keys will be the same, but the values will likely be associated with different keys. The sort is stable - in other words, elements with sort keys that compare as equal will remain in the same order. This means that you can sort on multiple criteria by simply performing separate sorts for each of the criteria, in increasing order of significance.

A few more examples of things you can do:
* "<code>by -value</code>" sorts integers in decreasing order (there's no similar trick for <code>string</code> values).
* "<code>by -index</code>" reverses the existing order of an array (or map with integer keys).
* "<code>by random(1000000)</code>" shuffles into a random order.
* "<code>by otherArray[index]</code>" uses values from a parallel array as the sort keys (you'd then need to do "<code>sort otherArray by value;</code>" if you wanted the two arrays to remain in sync).

===Iteration===
To iterate through a map, use the '''foreach''' operator. For instance, if you wanted to print out how many of each item you had, you could do something like the following:
{{CodeSample|code=<syntaxhighlight>
int[item] map = get_inventory();
foreach key in map {
print(key + " (" + map[key] + ")");
}
</syntaxhighlight>}}

Multidimensional maps are implemented as maps that map keys to maps. '''int[item][string]map''' is really a mapping of items to int[string] maps. Iteration, therefore, is as follows:
{{CodeSample|code=<syntaxhighlight>
int[item][string] map;
file_to_map("somefile.txt", map);
foreach k1 in map {
print(k1 + ": ");
foreach k2 in map[k1] {
print("\t" + k2 + ": " + map[k1][k2]);
}
}
</syntaxhighlight>}}

Two things to note: First, '''int[item][string]map''' is equivalent to '''int[item, string]map'''. This really comes down to author preference, although the second form is generally more common. Second, the two following foreach loops are equivalent:
{{CodeSample|code=<syntaxhighlight>
int[item][string] map;
foreach k1 in map {
foreach k2 in map[k1] {
func(map[k1][k2]);
}
}

foreach k1, k2 in map {
func(map[k1][k2]);
}
</syntaxhighlight>}}

Of course, the latter does not lend itself to, say, only printing the first key once, whereas the former can be used that way (see the preceding example).

===Implementation===
Maps in ASH are implemented internally as TreeMaps [http://download.oracle.com/javase/1.5.0/docs/api/java/util/TreeMap.html]. See below for some implications.

== Arrays ==
These look and behave like mappings of integers to values, where the keys only take values from 0 to n, but these are implemented as Java Arrays.

===Differences between arrays and maps===

'''item [12] array;'''

Can use keys 0 - 11. You get a runtime error if you use any other key. It always uses memory to hold 12 items, even if you only use a couple of them. But it's a constant time - O(1) - to access any element.

'''item [int] map;'''

Can use any int as a key. It has constant memory for the Java map, and additional memory for each element in the map, but is O( log n) to access any particular element.

If you are able to use (a fairly densely packed set of) integers as keys, your program will be faster and use (potentially) slightly more memory.

If you have a sparse set of integers, you can still use an array and get fast access, but you will waste a lot of memory.

If you can't use integers as keys or don't want to waste memory on a sparse array, you can have a slower but less memory consuming map.

[http://kolmafia.us/showthread.php?6425-Sorting-skills-by-mana-cost&p=48703&viewfull=1#post48703]

====Time considerations====
* Given '''if (a == item1 || a == item2 || a == item3)''' and '''if ($items[item1, item2, item3] contains a)''', which is faster?

This is going to depend on the number of items in the list, and which one happens to match; if 'a' is almost always item1, then the first form is likely to win on practical grounds, even though it's theoretically slower (O(n) vs. O(log n)).

The second form is a definite win assuming no such coincidences of the item chosen, a somewhat larger set of items, and that the code is executed more than once per run of the script. The first lookup in a plural constant actually builds an internal map that allows such queries to be efficiently done; this is deferred because typical use of a plural constant involves only iteration, not lookups.

There's always the "profile" command, if you really need to know which is more efficient in a given situation - although it's unlikely that either would have a noticeable effect on your script's performance.

[http://kolmafia.us/showthread.php?6425-Sorting-skills-by-mana-cost&p=48728&viewfull=1#post48728]

== Records ==

(copy-pasted from Veracity's post introducing the record [http://kolmafia.us/showthread.php?t=280])

Starting with SVN revision 1311 of KoLmafia, ASH now supports a new kind of structured data: the record. Here is a little example of how you declare a record and variables of the new type you've created by doing so.

{{CodeSample|code=<syntaxhighlight>
record my_type {
int ifield;
string sfield;
record {
int first;
int second;
} rfield;
int [int, int] mfield;
};

my_type rvar;
my_type [int] mrvar;
</syntaxhighlight>}}

What I've done with the above is declare a new data type which I've named "my_type". Having declared the new type, I can use it (almost) anywhere that I can use a built-in type name. I declared a variable, "rvar", of that type, and I defined a map, "mrvar", which maps keys of type integer to values of type my_type.

The new type, "my_type" is a "composite" type. It contains four fields. "ifield" is an integer. "sfield" is a string. "rfield" is another composite field: an anonymous record containing two integers named "first" and "second". Finally, "mfield" is a map from [int, int] to int.

As you can see, a record can combine data of all the types ASH supports: primitive, aggregate, and composite.

Having defined the new data type and several variables using it, here are some examples of how to access the fields.

{{CodeSample|code=<syntaxhighlight>
rvar.ifield = 10;
rvar.sfield = "secret";
rvar.rfield.first = 1000;
rvar.rfield.second = 2000;
rvar.mfield[ 2, 3 ] = 12;

mrvar[ 1 ] = rvar;

foreach key in mrvar
foreach key1, key2 in mrvar[key].mfield
print( "val = " + mrvar[key].mfield[key1,key2] );
</syntaxhighlight>}}

As you can see, if you have a variable that is a record, you access the fields of the record by following the variable name with ".<field name>". The resulting value will be of whatever type you declared in the definition of the record. If the value is a map, you can give a list of keys within [], just like any other map. If the value is another record, you can access the fields of the nested record by using another ".<field name>".

If you are familiar with Pascal "records" or C/C++ "structs", this should all be comfortably familiar.

Finally, if you create a map whose values is a record, the file_to_map and map_to_file built-in ASH functions will Do The Right Thing; they will efficiently and reliably save and restore your data.

[[Category:Scripting]]

Get related

2011-04-07T17:04:03Z

Heeheehee: Missed one, Z.

{{
#vardefine:name|get_related}}{{
#vardefine:aggregate|yes}}{{
#vardefine:return_type|int [item]}}{{

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|doodad}}|
parameter2={{Param|string|type}}|
p1desc={{Pspan|doodad}} is the item to check.|
p2desc={{Pspan|type}} is one of "zap", "fold", or "pulverize".
* "zap" returns the zap group that the item is part of. The integer values in the map are meaningless in this case, and the item itself isn't included.
* "fold" returns the fold group that the item is part of. The integer is the position in the fold sequence (1..N), and the item itself IS included, so you can determine its position.
* "pulverize" returns the average products of pulverizing one million of the given item. The scaling is needed to preserve accuracy for the elemental gems, which can be produced at rates as low as 1/1200.|}}|
function_description=Retrieves some variable-length internal data that isn't readily readable via [[file_to_map|file_to_map()]].|

code1={{CodeSample|
title=Simple Example|
description=If you need black pepper, this will try to zap something into it.|
code=
<syntaxhighlight>
if(item_amount($item[black pepper]) == 0)
// Here's the function! This will loop over every item that can be zapped into black pepper.
foreach thing in get_related($item[black pepper], "zap")
// It will now check if you have each thing that can zap into black pepper.
if(item_amount(thing)> 0) {
// zap the item and end the foreach loop.
cli_execute("zap "+thing);
break;
}
// Note: this simple example doesn't check your wand's state & is therefore not recommended for actual use.
</syntaxhighlight>}}
{{CodeSample|
title=Zap for stab bats!|
description=This small program will try to zap something into a tiny plastic stab bat and send it to zarqon.|
code=
<syntaxhighlight>
boolean stab_zap() {
int starting_stabbies = item_amount($item[tiny plastic stab bat]);
foreach doohicky in get_related($item[tiny plastic stab bat], "zap")
if(item_amount(doohicky) > 0) {
cli_execute("zap "+doohicky);
return item_amount($item[tiny plastic stab bat]) > starting_stabbies;
}
return false;
}

void main() {
if(stab_zap()) {
cli_execute("send 1 tiny plastic stab bat to zarqon | Something for your awesome bat collection!");
print("Sent a tiny plastic stab bat to zarqon.", "blue");
} else
print("Couldn't get a new tiny plastic stab bat today.", "olive");
}
</syntaxhighlight>}}

{{CodeSample|
title=Pulverization|
description=This function will detect if a pulverization has any affect on an item.|
code=
<syntaxhighlight>
boolean is_pulverizable(item it) {
int [item] pulvy = get_related(it, "pulverize");
if(pulvy contains $item[useless powder])
return false; // Let's not count useless powder...
if(count(pulvy) > 0)
return true; // Yay! Something useful!
// Powders and nuggets can be pulverized also!
if(it.to_int() >= 1438 && it.to_int() <=1449)
return true;
switch(it) {
case $item[sewer nugget]:
case $item[floaty pebbles]:
case $item[floaty gravel]:
// These things can be turned into wads!
return true;
}
return false;
}

</syntaxhighlight>}}|

see_also={{SeeAlso|file_to_map}}|
special=Specifying anything other than "zap", "fold", or "pulverize" for the second parameter will return an empty map.|
}}

[[Category:Item Management]]

Talk:CLI Reference

2011-04-03T21:19:54Z

Heeheehee: /* Remark */ provided link

should we add that Csend will add make it's own message to the recipient if it is not given?--[[User:Icon315|Icon315]] 21:47, 21 April 2010 (UTC)
:That's the kind of detail that should go on it's own page if the command is important enough to get its own page. --[[User:Bale|Bale]] 01:03, 22 April 2010 (UTC)

I agree with Bale. My thoughts so far on CLI commands;
* Obvious stuff that anyone can figure out by looking at this table doesn't warrant it's own page.
* Stuff that behaves ''exactly'' the same as an ASH command should probably say so and link to the function page
** If it isn't ''exactly'' the same, but close enough that a line or two of explanation will clarify the difference, still link to the function but edit the function's CLI section to explain the difference.
** Said functions don't need their own pages
* Stuff that has a similar or identically named ASH function, but behaves ''significantly'' differently on the CLI, should have it's own page (with the command as a link).
** If the command names are the same, the cli command should be "command (CLI)" (ie "eat (CLI)", if eat needed its own page)
** If the command has no ASH function with the same name, the "(CLI)" part can be omitted (we can always move a page later if an ASH equiv. is added)
* Create page names with alphanumeric characters when at all possible. Ie don't use "!" but rather "bang"

All additional thoughts on this are welcome. --[[User:StDoodle|StDoodle (#1059825)]] 03:17, 22 April 2010 (UTC)

: My thought is that you've covered everything perfectly. This should be our bible for CLI pages. --[[User:Bale|Bale]] 03:38, 22 April 2010 (UTC)

Bale recently explained a limitation with the acquire command that I was previously unaware of in [http://kolmafia.us/showthread.php?4575 this thread]. Perhaps acquire needs it's own page to account for this information? --[[User:That FN Ninja|That FN Ninja]] 16:10, 15 July 2010 (UTC)

* This is not a CLI issue. The exact same issue affects {{f|retrieve_item}}. It should probably be mentioned on that page. --[[User:Bale|Bale]] 20:37, 15 July 2010 (UTC)

==FYI==

You can't simply copypasta stuff into these wiki tables; remember, the pipe character (<nowiki>|</nowiki>) is treated special in templates! Use <nowiki>{{!}}</nowiki> instead, or <nowiki><nowiki></nowiki>''Stuff''<nowiki></</nowiki><nowiki>nowiki></nowiki> tags. (P.S. You should see the source for this fyi...) This, by the way, is the reason a lot of parameter options appear to be missing. --[[User:StDoodle|StDoodle (#1059825)]] 03:26, 22 April 2010 (UTC)

Ugh, what a mess. Sometimes, <nowiki>{{!}}</nowiki> results in a <nowiki><pre></nowiki> tag or something inside of wiki tables. On the other hand, similar FUBARS happen when using <nowiki>&#124;</nowiki> ''outside'' of tables on a wiki. Long story short; inside of a table, use <nowiki>&#124;</nowiki> for <nowiki>|</nowiki> and outside of a table use <nowiki>{{!}}</nowiki>. Messy enough for you? --[[User:StDoodle|StDoodle (#1059825)]] 03:59, 2 May 2010 (UTC)

==Remark==

While used intrinsically in the ASH examples, it seems that nowhere is it stated explicitly that to remark a line in either a CLI or ASH script to preface it with // [[User:Stanley|Stanley]] 14:28, 3 April 2011 (UTC)
:: [[Comments|Seriously? (this is a link. Click it!)]] --[[User:Heeheehee|Heeheehee]] 21:19, 3 April 2011 (UTC)

User talk:Bale

2011-03-04T06:00:41Z

Heeheehee:

Bale;

Sorry, I was called away & didn't get back till you were gone, so I thought I'd answer your questions here before I lost 'em.

RE: Consult Scripts. How many rounds does the consult script act for? Does a consult script keep running until combat is over? Just for rounds it's specifically called? I totally don't understand how that works...

RE: appearance_rates() & ultra-rares; when using said function on the treasury, it returned -42.5 for that UR monster. It just seems a point worth mentioning, in case anyone wants to parse UR availability by location; wouldn't want them to assume a STATIC negative number.

Thanks, --[[User:StDoodle|StDoodle]] 23:52, 4 March 2010 (UTC)

Note:

I've updated the front page (again); it now includes a link to [[Help:Editing]], where I will try to keep all relevant information on what needs work on the wiki. --[[User:StDoodle|StDoodle]] 13:32, 4 March 2010 (UTC)

Nice job on [[Custom Combat Script]]! I fixed two minor typos, but otherwise it looks great. There are a few things I'd like to flesh out eventually, such as formatting (make sure to have a space on each side of monster / location name), mention that locations are acceptable, how to specify 2nd funksling item, etc. But most of that is "Regular Mafia" stuff, which, while I intend to get to, is after ash on my to-do list.

For now, I'm ''trying'' to keep up with tagging articles that need specific help, so keep an eye on: 
* [[:Category:Request_For_Information]]
* [[:Category:Needs_Code_Sample]]
if you want to know where I need the most help.

Also, I want to eventually redo a lot of the regular-mafia stuff as well. I think it deserves its own section similar to "Quick Links for ASH Scripters" on the main page, with links to a page for each mafia tab / window. For page naming, I'd like to go with "Adventuring Tab," "Graphical CLI Tab," etc. to avoid any collision with function names. I imagine that a lot of the info on these pages will either be stolen from, or added in by Sally.

While in general this is a lower priority from my POV, I'd like to get the pages set up so that others can work on them.

If you want to tackle something more ASH-related, one thing that bugs me is the rather arbitrary (and in many cases outdated) categorization of ASH functions. If you'd like to go through the list & break them up more sensibly, that would be much appreciated!

Thanks! --[[User:StDoodle|StDoodle]] 14:56, 3 March 2010 (UTC)

As you may have noticed me mentioning on the forum, I've given you admin powers. Mostly, this makes it easier to quickly revert undesired changes, and to protect pages if needed. But also! you should no longer see nearly as many captcha's & such. --[[User:StDoodle|StDoodle (#1059825)]] 07:41, 22 April 2010 (UTC)

Regarding wiki-style lists (using * for bullet points): I generally find it easier to just add a non-breaking space (&nbsp;) on the line after the list rather than add in HTML (see the source of [[to_slot]] to see what I mean -- I can't really articulate these things too well) --[[User:Heeheehee|Heeheehee]] 06:10, 28 April 2010 (UTC)

drive-by. :P --[[User:StDoodle|StDoodle (#1059825)]] 04:30, 7 May 2010 (UTC)

Is this the right place to respond to your message to me here? If not, my apologies. In any event, yes, apparently I did have an account here and couldn't remember my password and had to get a temporary one sent to me. I'll probably forget the password that I changed it to if I get logged out of this and will have to get another temp password. I'm terrible like that lol. --[[User:Spiny Twizzler|Spiny Twizzler]] 04:49, 11 June 2010 (UTC)

You are now a Bureaucrat as well as an Administrator. I think this means you can now edit user permissions, but I was never just an admin, so I'm not sure. ;) Good luck! --[[User:StDoodle|StDoodle (#1059825)]] 07:30, 25 August 2010 (UTC)

=== Pipes ===

Just a quick heads up; the wiki automatically puts a pipe between each category, whether it's called directly on-page or from a template; putting a pipe in manually between categories means the pipe will show up ''after'' the categories on its own line. ;) --[[User:StDoodle|StDoodle (#1059825)]] 04:36, 1 March 2011 (UTC)

Yeah, I know. That's a mistake I made a long time ago before I understood. Hadn't noticed it on this page also. Sadly we're still cleaning up after that long gone error since I did it on too many pages. :( --[[User:Bale|Bale]] 05:30, 1 March 2011 (UTC)

=== Recent blocking ===
21:43, 3 March 2011 Bale (Talk | contribs | block) blocked Zanmatoer (Talk | contribs) with an expiry time of 6 months (account creation disabled) ‎ (Spamming links to external sites) (unblock | change block)

Was this accidental? As far as I can tell, that was a legitimate poster, so, uh, I guess I'll be unblocking him, unless you had some reason for doing so, in which case I'll reverse the unblocking. --[[User:Heeheehee|Heeheehee]] 06:00, 4 March 2011 (UTC)

Talk:Data Types

2011-02-20T08:51:25Z

Heeheehee: /* Re: rollback */

=Note=

This page copied from the deletion-in-progress Datatype Constants discussion page.

=Old Discussion=

Yes, this page should be renamed & such. It's another artifact of the way things were when I started working on the wiki, that unfortunately became a "hub" of sorts without being properly changed. However, since HUNDREDS of pages link here, we really need to be a bit more careful before moving this page. It should probably be done by a mod (to avoid automatic redirect creation) AFTER various prerequisites are taken care of. --[[User:StDoodle|StDoodle (#1059825)]] 04:29, 21 June 2010 (UTC)

*Thanks for clarification, and sorry about not discussing it first. --[[User:PhilmASTErpLus|PhilmASTErpLus]]

Ugh. It's worse than I thought; when templates are nested, it takes a while for the "what links here" pages to get updated. I've started the process of transitioning from "Datatype Constantes" to "Data Types," but it may be a while before it's complete. Warning: please leave this project alone, I've got a handle on it & don't want confilcts. Thanks. --[[User:StDoodle|StDoodle (#1059825)]] 04:52, 14 July 2010 (UTC)

Yeah, uh, finger slipped. Oops. (Undone now, don't worry about it.) --[[User:Heeheehee|Heeheehee]] 12:09, 22 June 2010 (UTC)

It's all yours. Good luck with it. --[[User:Bale|Bale]] 05:17, 14 July 2010 (UTC)

Gee that was fun (not). But I think it's done; KoLmafia wiki, now 50% less untechnically accurate! --[[User:StDoodle|StDoodle (#1059825)]] 05:38, 14 July 2010 (UTC)

== Call by value or call by reference? ==

I actually wrote a simple script to see how it works. Apparently all the primitive data types are called by value when passed to a function, whereas maps and records are called by reference (with smart garbage collection!). I presume this is the same for substitution(<code>=</code>), and that buffers are called by reference, though I haven't tried either. Could someone high up there please verify this information before I add it? --[[User:PhilmASTErpLus|PhilmASTErpLus]] 07:14, 23 June 2010 (UTC)

= Re: rollback =

I'm not using the very latest daily, I know, but on r9045 it DOESN'T change the result if you JUST change the 2 to 2.0. I get 0.0 as my result. Can you double-check that this has changed? --[[User:StDoodle|StDoodle (#1059825)]] 03:34, 18 February 2011 (UTC)

Er, edit to clarify; could someone verify that this is INTENDED, and thus safe advice, vs. just being a side-effect of some other change, and subject to revert to the behavior I'm seeing. --[[User:StDoodle|StDoodle (#1059825)]] 03:36, 18 February 2011 (UTC)

You're right. My bad. Of course the division happens before the multiplication so I'm sure it was never supposed to work that way I suggested. Thanks for correcting me. :( --[[User:Bale|Bale]] 05:52, 18 February 2011 (UTC)

Y'know, if you were to move the 2 to the front, and change it to a 2.0... Do we want to bother trying to explain this? --[[User:Heeheehee|Heeheehee]] 08:51, 20 February 2011 (UTC)

Reserved Words

2011-02-14T15:41:11Z

Heeheehee: Added try/finally, added link to relevant file in source code.

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

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

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

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

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

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

==More Information==
[http://kolmafia.svn.sourceforge.net/viewvc/kolmafia/src/net/sourceforge/kolmafia/textui/Parser.java?view=markup This particular page] contains the most up-to-date version of this list around line 272.
[[Category:Scripting]]

Operators

2011-01-20T18:36:07Z

Heeheehee: /* Bitwise Operators */ Fixed a few more formatting issues. This'll next be updated when ^ starts meaning XOR in ASH.

{{TOCright}}
==Mathematical Operators==

The following mathematical operators are used in KoLmafia:
{{
eztable|
{{eztr|{{eztd| + |Addition|Performs addition and string concatenation}}}}
{{eztr|{{eztd| - |Subtraction|Performs subtraction}}}}
{{eztr|{{eztd| * |Multiplication|Performs multiplication}}}}
{{eztr|{{eztd| / |Division|Performs division}}}}
{{eztr|{{eztd| % |Modulo|Returns the remainder after division}}}}
{{eztr|{{eztd| ** |Exponent|Performs exponentiation}}}}
}}
Note that, with the exception of using <nowiki>"+"</nowiki> for string concatenation, these operators can only be used on int or float datatypes.

==Assignment Operators==
The following assignment operators are used in KoLmafia (let a = left operand, b = right operand):
{{
eztable|
{{eztr|{{eztd| <nowiki>=</nowiki> |<nowiki>a = b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>+=</nowiki> |<nowiki>a = a + b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>-=</nowiki> |<nowiki>a = a - b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>*=</nowiki> |<nowiki>a = a * b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>/=</nowiki> |<nowiki>a = a / b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>%=</nowiki> |<nowiki>a = a % b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>**=</nowiki> |<nowiki>a = a ** b</nowiki>}}}}
}}
Of these, only += and = are usable for strings. See [[Operators#Mathematical Operators|Mathematical Operators]] for information regarding the basic Mathematical Operators.

==Relational Operators==

To follow these examples, a basic understanding of the concepts found on [[Control Structures]] would be helpful.

In order to create more complex if statements, we need to understand the basic relational operators:
{{
eztable|
{{eztr|{{eztd| <nowiki>==</nowiki> |equal to}}}}
{{eztr|{{eztd| <nowiki>!=</nowiki> |not equal to}}}}
{{eztr|{{eztd| <nowiki><</nowiki> |less than}}}}
{{eztr|{{eztd| <nowiki>></nowiki> |greater than}}}}
{{eztr|{{eztd| <nowiki><=</nowiki> |less than or equal to}}}}
{{eztr|{{eztd| <nowiki>>=</nowiki> |greater than or equal to}}}}
}}
Note that you cannot mix datatypes within a comparison or KoLmafia will abort with an error, with the exception of mixing types int and float, where KoLmafia will do a transparent type conversion behind-the-scenes. If you need to compare different datatypes, use one or more of the [[Datatype Conversions|Datatype Conversion]] functions. Also, == is case-insensitive with respect to strings.

{{
CodeSample|
code=
<syntaxhighlight>
if ( true == true )
{
print( "This line DOES get printed." );
}
if ( true == false )
{
print( "This line does NOT get printed." );
}
if ( 1 == 1.0 )
{
print( "This line DOES get printed." );
}
if ( 1 == 2 )
{
print( "This line does NOT get printed." );
}
if ( "Hello" == "hello" )
{
print( "This line DOES get printed." );
}
</syntaxhighlight>}}
==Boolean Operators==
{{
eztable|
{{eztr|{{eztd| <nowiki>&&</nowiki> |and}}}}
{{eztr|{{eztd| <nowiki>||</nowiki> |or}}}}
{{eztr|{{eztd| <nowiki>!</nowiki> |not}}}}
}}
Note that the above operators only work with boolean values & datatypes. To make use of them with other datatypes, you will either need to first perform a [[Datatype Conversions|Datatype Conversion]], or you will need to nest your operations such that a boolean value is used with the boolean operators.
{{
CodeSample|
code=
<syntaxhighlight>
if ( true && true )
{
print( "This line DOES get printed (both possibilities proved true)." );
}
if ( true && false )
{
print( "This line does NOT get printed (only one possibility proved true)." );
}
if ( true || false )
{
print( "This line DOES get printed (since at least one of the possibilities proved true)." );
}
if ( ! false )
{
print( "This line DOES get printed (since the not operator converted false to true)." );
}
</syntaxhighlight>}}
We also need to understand operator precedence. Statements inside a () pair are always evaluated first, then from left to right.
{{
CodeSample|
code=
<syntaxhighlight>
if ( true || true && false )
{
print( "This line DOES get printed." );
// evaluated left-to-right
// true or (true && false) returns true
}
if ( true && ( true && false ) )
{
print( "This line does NOT get printed." );
// ( true && false ) is evaluated first since it is inside of parentheses
// so we end up evaluating ( true && false ) which returns false
}
if ( true && ! ( true && false ) )
{
print( "This line DOES get printed." );
// ( true && false ) is evaluated first since it is inside of parentheses
// the ! operator converts the false from ( true && false ) to true
// ( true && true ) returns true
}
</syntaxhighlight>}}

==Bitwise Operators==

The following mathematical operators are used for operating on the bits of integers. The operands must be integers; no coercion is allowed:
{{
eztable|
{{eztr|{{eztd| <nowiki>&</nowiki> |and|a & b}}}}
{{eztr|{{eztd| <nowiki>|</nowiki> |or|a <nowiki>|</nowiki> b}}}}
{{eztr|{{eztd| ~ |not|~a}}}}
{{eztr|{{eztd| << |left shift|a << b}}}}
{{eztr|{{eztd| >> |right shift|a >> b}}}}
{{eztr|{{eztd| <nowiki>&=</nowiki> |and|<nowiki>a &= b --> a = a & b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>|=</nowiki> |or|<nowiki>a |= b --> a = a | b</nowiki>}}}}
{{eztr|{{eztd| >>> |unsigned right shift|a >>> b}}}}
{{eztr|{{eztd| <nowiki>>>=</nowiki> |right shift|<nowiki>a >>= b --> a = a >> b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>>>>=</nowiki> |unsigned right shift|<nowiki>a >>>= b -> a = >>> b</nowiki>}}}}
}}

[[Category:Scripting]]

Help:Frequently Asked Questions

2011-01-20T00:34:01Z

Heeheehee: /* Interface */ Added info about Jason's breakable equip fine-tuning script.

{{TOCright}}
==Running Mafia==
;What / where are daily builds?
:Daily builds are revisions of KoLMafia that are released for testing new features and/or bugfixes. They can be found at http://builds.kolmafia.us/. These builds adapt to changes in KoL faster than the official release and are often preferred for that reason.
;These daily builds are .jar files! They don't run in my OS!
:Yes they do, [http://www.wikihow.com/Run-a-.Jar-Java-File lookit].
;I found a bug! What should I do?
:Please double-check for user-error first. (No offense intended, but it happens a lot.) If you're fairly sure that you have a "real" Mafia bug (reproducible, describable, undesired, and not a script error), please post it in the [http://kolmafia.us/forumdisplay.php?24-Bug-Reports Bug Report Forum]. Make sure to list which version of KoLmafia you are using (which you can see by selecting the Help (menu) -> Copyright Notice). Also, list the operating system you are using, and a description of what to do to reproduce the bug, and any other helpful information.
;How can I synchronize Mafia across multiple computers using the same counters, scripts, builds, etc?
:The two most popular methods are to run it from a flash drive or use [http://www.dropbox.com/ Dropbox]. Please see our page about [[Dropbox]].

==Interface==
;How do I apply stickers?
:Go to the Gear Changer tab in the main interface. See those bottom three dropdown menus?
;How do I get mafia to reapply stickers automatically when they wear out?
:Put it in your mood as described below, changing "''stickers unicorn, unicorn, unicorn''" to indicate whichever stickers you want to keep active. The "stickers" command will apply stickers if they are missing, but won't try to do anything if there are already stickers active.
:[[File:FAQstickers.png]]
;Can I get Mafia to do something other than abort when my sugar equipment breaks?
:Go to the Adventure tab in the main interface. At the bottom are some more tabs. Click on the Choice Advs tab. Now click on the Item tab on the left hand side. Change the Breakable Equipment setting as desired.
:[[Image:Breakable equipment.jpg]]
:If you want to fine-tune handling of breakable equipment (i.e. set different settings for different items), jasonharper has provided [http://kolmafia.us/showthread.php?3769-Breakable-equipment-fine-tuning this script].
;Is there a way to get mafia to stop auto-adventuring when a counter expires?
:Mafia will stop automating on most counters. Note that purely informational counters like he-boulder rays and hippy windchimes will not stop automation.
;Is there a way to get mafia to stop auto-adventuring when a hobo code or demon name is found?
:KoLmafia [[auto-stops]] on these adventures whenever you do not have any conditions set. Just adventure in the zone without conditions and those hobo codes or demon names become your condition. Easy-peasy.

==Scripts==
;What do I do with a script?
:Download the ASH file to your [[mafia directories|/scripts directory]]. Either start mafia, or in the scripts menu at the top of the interface, click "refresh menu". Then select the script from the scripts menu.
;How do I edit/create an ASH script?
:Use a nonformatting text editor such as [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] -- word processors like Microsoft Word will not work. When finished, save the file with the extension *.ash.
;Where are these mafia directories to which I need to download scripts? They have names like /scripts and /data .
:This varies depending on your operating system. Look for your system at [[mafia directories]].
;I get an error when I try to run a script!
:Nine times out of ten the problem is having an outdated version of something. If a script that you downloaded won't run, have a look at this handy list:
: 1) [http://builds.kolmafia.us/ Check that your version of mafia is current]. This doesn't mean "version X.X", it means "rXXXX" (that's a daily build, read above). If you use Windows, [http://kolmafia.us/showthread.php?2856 this tool] will automatically keep your version of mafia cutting-edge current.
: 2) Check that you have the latest released version of the script you're trying to run (and whatever support scripts it includes). Note that even scripts with version-checking can ''not'' notify you about updates if the error happens before the script starts to run.
: 3) Check that you don't have outdated data files (from using the "update data" command, which no one should ever use). Type "update clear" to eliminate old data files.
: 4) Check the [[ASH Errors]] page for a description of your error and possible solutions.
: 5) If none of these solutions fix it -- ''then'' please report the error to the script author in the script thread. The script author should be able to determine whether this is a script error or a mafia error, and deal with it appropriately.
;Help, my script aborts whenever [some function] returns false!
:By default, whenever an ASH function returns false, everything will abort ''unless'' you somehow capture the return value (i.e. assigning it to a variable or enclosing it in a control structure). For examples of how to do this, see [[Tips, Tricks and Workarounds#Capturing an Abort|Tips, Tricks and Workarounds]].

[[Category:New User Help]]

Talk:Tips, Tricks and Workarounds

2011-01-13T02:43:55Z

Heeheehee: Don't think "Testing Scripts Offline" section is necessary. Discuss?

__TOC__

== Discussion Recap ==

=== Discussion from [[Talk:Storage amount]] ===

Can anyone else verify, before I edit it in, that this function doesn't work on free pulls? --[[User:StDoodle|StDoodle (#1059825)]] 11:45, 21 September 2010 (UTC)

Verified. I believe that this was reported as a bug once. (Back when we had that awesome bug tracker.) However this behavior was clarified to be working as intended and hence, not a bug. The fact that an itemd doesn't require a pulls means that it is supposed to be treated differently. Use {{f|available_amount}} minus {{f|item_amount}} to verify presence of free pulls in Hangks. Then get them into inventory with {{f|retrieve_item}} instead of with {{f|take_storage}}. You're right that info should probably be on all relevant pages. --[[User:Bale|Bale]] 05:17, 22 September 2010 (UTC)

Perhaps we should start a special "caveats" page, and link to subheadings on it, for such info; it seems a bit much may be required to explain the situation to include it on every page. It would also be a good place to put info on things like Between Battle Scripts and adventure count in automation, etc. Thoughts? --[[User:StDoodle|StDoodle (#1059825)]] 15:10, 22 September 2010 (UTC)

I favor a caveats page. Or perhaps we could call it Tricks & Tips. We should add [[User:PhilmASTErpLus#ASH_Quirks_and_Hacks|THIS]] there also. --[[User:Bale|Bale]] 22:22, 22 September 2010 (UTC)

Tips, Tricks and Workarounds* sounds good to me. I agree that those items philmaterplus points out should go there. Also, we should clean up the FAQ to only include one example of non-aborting booleans, and move the full list to this new page, I think (with a link of course). Perhaps this would even be a good page to put a dedicated file link to the syntax highlighting scheme for Notepadd++ (I favor having it on the wiki, so when it's updated with new ash functions, it's... you know, updated). I'll come up with other ideas, too, and leave them on the talk page when it's there. --[[User:StDoodle|StDoodle (#1059825)]] 17:04, 23 September 2010 (UTC)

*Actually it doesn't sound perfect, which is why I'm not making it yet... hrmph.

Moving Discussion to [[Talk: Tips, Tricks and Workarounds]]. Since there may be a bit of discussion about the page before it gets created properly. We can always move the talk page if we change our minds about what it should be called. --[[User:Bale|Bale]] 21:18, 23 September 2010 (UTC)

=== Quirks & Hacks from [[User:PhilmASTErpLus|PhilmASTErpLus]] ===

*{{f|print}} displays a blank line when given a string starting with a slash (<code>/</code>). To prevent this, the text color must be explicitly given. Easy to bypass, but weird.
*"Anonymous" closures: ASH does not seem to accept anonymous closures by default.
{{CodeSample|code=<syntaxhighlight>
int var1;
/* Do stuff */
{
int var1;
call_some_function();
/* Do other stuff */
}
</syntaxhighlight>}}
However, you can use a workaround with a if-clause.
{{CodeSample|code=<syntaxhighlight>
int var1;
/* Do stuff */
if (true)
{
int var1;
/* Do other stuff */
}
</syntaxhighlight>}}
As for where stuff like this could be used...I'm using it for initializing ASH scripts without creating any unnecessary functions or variables in the "namespace".

:Great work so far, guys. One nitpick, though: I think the tip about using print() should be put in {{print|the appropriate function page}}, instead. I'll add it there ASAP. --[[User:PhilmASTErpLus|PhilmASTErpLus]] 12:18, 26 September 2010 (UTC)

== New Discussion ==

Ugh, sorry. Can't think of the best way to fix that ATM, it was half a joke. (Note to self; don't edit wiki drunk.) --[[User:StDoodle|StDoodle (#1059825)]] 06:32, 24 September 2010 (UTC)

==Testing Scripts Offline==
Is this section really necessary? I mean, there's a "validate scriptname" command available in the CLI. --[[User:Heeheehee|Heeheehee]] 02:43, 13 January 2011 (UTC)

Operators

2011-01-13T02:40:03Z

Heeheehee: /* Bitwise Operators */ Added nowiki tags so stuff actually displays properly.

{{TOCright}}
==Mathematical Operators==

The following mathematical operators are used in KoLmafia:
{{
eztable|
{{eztr|{{eztd| + |Addition|Performs addition and string concatenation}}}}
{{eztr|{{eztd| - |Subtraction|Performs subtraction}}}}
{{eztr|{{eztd| * |Multiplication|Performs multiplication}}}}
{{eztr|{{eztd| / |Division|Performs division}}}}
{{eztr|{{eztd| % |Modulo|Returns the remainder after division}}}}
{{eztr|{{eztd| ^ |Exponent|Performs exponentiation}}}}
}}
Note that, with the exception of using <nowiki>"+"</nowiki> for string concatenation, these operators can only be used on int or float datatypes.

==Assignment Operators==
The following assignment operators are used in KoLmafia (let a = left operand, b = right operand):
{{
eztable|
{{eztr|{{eztd| <nowiki>=</nowiki> |<nowiki>a = b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>+=</nowiki> |<nowiki>a = a + b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>-=</nowiki> |<nowiki>a = a - b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>*=</nowiki> |<nowiki>a = a * b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>/=</nowiki> |<nowiki>a = a / b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>%=</nowiki> |<nowiki>a = a % b</nowiki>}}}}
}}
Of these, only += and = are usable for strings. See [[Operators#Mathematical Operators|Mathematical Operators]] for information regarding the basic Mathematical Operators.

==Relational Operators==

To follow these examples, a basic understanding of the concepts found on [[Control Structures]] would be helpful.

In order to create more complex if statements, we need to understand the basic relational operators:
{{
eztable|
{{eztr|{{eztd| <nowiki>==</nowiki> |equal to}}}}
{{eztr|{{eztd| <nowiki>!=</nowiki> |not equal to}}}}
{{eztr|{{eztd| <nowiki><</nowiki> |less than}}}}
{{eztr|{{eztd| <nowiki>></nowiki> |greater than}}}}
{{eztr|{{eztd| <nowiki><=</nowiki> |less than or equal to}}}}
{{eztr|{{eztd| <nowiki>>=</nowiki> |greater than or equal to}}}}
}}
Note that you cannot mix datatypes within a comparison or KoLmafia will abort with an error, with the exception of mixing types int and float, where KoLmafia will do a transparent type conversion behind-the-scenes. If you need to compare different datatypes, use one or more of the [[Datatype Conversions|Datatype Conversion]] functions. Also, == is case-insensitive with respect to strings.

{{
CodeSample|
code=
<syntaxhighlight>
if ( true == true )
{
print( "This line DOES get printed." );
}
if ( true == false )
{
print( "This line does NOT get printed." );
}
if ( 1 == 1.0 )
{
print( "This line DOES get printed." );
}
if ( 1 == 2 )
{
print( "This line does NOT get printed." );
}
if ( "Hello" == "hello" )
{
print( "This line DOES get printed." );
}
</syntaxhighlight>}}
==Boolean Operators==
{{
eztable|
{{eztr|{{eztd| <nowiki>&&</nowiki> |and}}}}
{{eztr|{{eztd| <nowiki>||</nowiki> |or}}}}
{{eztr|{{eztd| <nowiki>!</nowiki> |not}}}}
}}
Note that the above operators only work with boolean values & datatypes. To make use of them with other datatypes, you will either need to first perform a [[Datatype Conversions|Datatype Conversion]], or you will need to nest your operations such that a boolean value is used with the boolean operators.
{{
CodeSample|
code=
<syntaxhighlight>
if ( true && true )
{
print( "This line DOES get printed (both possibilities proved true)." );
}
if ( true && false )
{
print( "This line does NOT get printed (only one possibility proved true)." );
}
if ( true || false )
{
print( "This line DOES get printed (since at least one of the possibilities proved true)." );
}
if ( ! false )
{
print( "This line DOES get printed (since the not operator converted false to true)." );
}
</syntaxhighlight>}}
We also need to understand operator precedence. Statements inside a () pair are always evaluated first, then from left to right.
{{
CodeSample|
code=
<syntaxhighlight>
if ( true || true && false )
{
print( "This line DOES get printed." );
// evaluated left-to-right
// true or (true && false) returns true
}
if ( true && ( true && false ) )
{
print( "This line does NOT get printed." );
// ( true && false ) is evaluated first since it is inside of parentheses
// so we end up evaluating ( true && false ) which returns false
}
if ( true && ! ( true && false ) )
{
print( "This line DOES get printed." );
// ( true && false ) is evaluated first since it is inside of parentheses
// the ! operator converts the false from ( true && false ) to true
// ( true && true ) returns true
}
</syntaxhighlight>}}

==Bitwise Operators==

The following mathematical operators are used for operating on the bits of integers. The operands must be integers; no coercion is allowed:
{{
eztable|
{{eztr|{{eztd| & |and|a & b}}}}
{{eztr|{{eztd| | |or|a <nowiki>|</nowiki> b}}}}
{{eztr|{{eztd| ~ |not|Performs multiplication}}}}
{{eztr|{{eztd| << |left shift|a << b}}}}
{{eztr|{{eztd| >> |right shift|a >> b}}}}
{{eztr|{{eztd| <nowiki>&=</nowiki> |and|<nowiki>a &= b --> a = a & b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>|=</nowiki> |or|<nowiki>a |= b --> a = a | b</nowiki>}}}}
{{eztr|{{eztd| >>> |unsigned right shift|a >>> b}}}}
{{eztr|{{eztd| <nowiki>>>=</nowiki> |right shift|<nowiki>a >>= b --> a = a >> b</nowiki>}}}}
{{eztr|{{eztd| <nowiki>>>>=</nowiki> |unsigned right shift|<nowiki>a >>>= b -> a = >>> b</nowiki>}}}}
}}

[[Category:Scripting]]

Talk:KoLmafia Properties

2011-01-10T00:41:47Z

Heeheehee: Preference-checker alias.

This should be rewritten as it's outdated of course. :P Here are new choice adventures (listed by number).

'''[blah blah blah list of choice adventures - snipped because it was taking up space --[[User:Heeheehee|Heeheehee]] 04:15, 26 April 2010 (UTC)]'''

I also recommend putting links to KoLwiki on those choice adventures. --[[User:MagiNinjA|MagiNinjA]] 18:30, 4 May 2007 (CDT) ------ EDIT: hit the edit button to see a NEAT list. I'm still a n00b so I don't know how to work this, but the list SHOULD look like a real list if you're editing it. I don't feel like adding line breaks here. :) --[[User:MagiNinjA|MagiNinjA]] 18:31, 4 May 2007 (CDT)

This says, "Part 11". What were parts 1-10? Is this part of something or just an orphaned page? Should it be kept or cut to pieces and split up into other topics? --[[User:Bale|Bale]] 08:30, 25 April 2010 (UTC)

That's from when this was all part of the ASHRM thingy, which itself was moved here from somewhere else. I left this for reference on the talk page, but it doesn't look like we need it. Feel free to look it over, and if you don't find anything useful, nuke away. --[[User:StDoodle|StDoodle (#1059825)]] 20:35, 25 April 2010 (UTC)

* If nobody says anything in the next couple of days I'm gonna nuke it. It'll be gone from the front page and everything. --[[User:Bale|Bale]] 20:17, 7 May 2010 (UTC)

Hmm... we also have [[List of KoLmafia Properties]]. Ideally, I'd like one of the two to remain. Probably move that page here (maybe a redirect for preferences as well, or rename willy-nilly). Front page should point at whatever actual page we stick with. I would like to do the following;
* For choice adventures, point to the main wiki, and give a desc. of how they operate which I believe is
** 0 = show in browser
** 1-# of choices in KoL = nth choice button
** N+1 = complete outfit or mainstat
* There may be other condensable & wiki-pointable lists, I'm not sure; if so similar to above
* I'd really like more info on the rest; a lot are pretty obscure. In fact, I'd mark this a high-priority task

Thoughts, suggestions? --[[User:StDoodle|StDoodle (#1059825)]] 21:41, 7 May 2010 (UTC)

Okay, stage 1 is complete; no more duplicates, this page should cover everything. Of course, it needs a lot more info before it becomes useful, but at least it won't be scattered in several locations, now. --[[User:StDoodle|StDoodle (#1059825)]] 02:09, 9 May 2010 (UTC)

By a lot more info, would you want something like what I did with [[Modifiers]]? (I'm not saying I have time for this, just that if this is the case, anyone who wanted to tackle this has a point of reference.) --[[User:Heeheehee|Heeheehee]] 04:45, 9 May 2010 (UTC)

One quick question -- for autoAbortThreshold, would any negative number mean "if autorecovery fails", or just -0.05? I'd think it's any negative number, because it makes more sense intuitively. --[[User:Heeheehee|Heeheehee]] 22:16, 11 May 2010 (UTC)

* That's almost certainly true. I just know that kolMafia uses -0.05 and never bothered to find out differently. --[[User:Bale|Bale]] 23:05, 11 May 2010 (UTC)

While knowledge of properties can be quite useful for ASH, I'm not sure I see the logic behind adding this page to said category. If ASH were the only way to change most of these preferences, it would be more understandable, but it isn't even the primary way for most of them. Thoughts? --[[User:StDoodle|StDoodle (#1059825)]] 09:47, 14 July 2010 (UTC)

* Mostly properties are used in ash scripting, but I see you point. What category do you think it would be better suited for? Should we create a new one? I like for pages to belong to some category. --[[User:Bale|Bale]] 10:17, 14 July 2010 (UTC)

Heh, define "mostly." A good chunk of the properties are choice adventure settings that I'd bet are set 90% of the time through the GUI (mostly 'cause the majority of KoLmafia users are much lighter on their ASH usage than our crowd). Anyway, CLI Commands should definitely get moved out of the ASH section on the main page as well, and these both fall under the ominous "how the heck to we organize the non-ASH portions of KoLmafia" project. I agree it's nice to have categories for as much as possible, and this would definitely qualify. But what should these categories be? Initially I thought of organizing by menu / windows / etc., but a lot of core functionality is accessed multiple ways, so this doesn't really work. This particular one would probably go in a "Settings" category, though I'm not sure what else would be in it. Probably a page for the preference manager, choice adventure tabs, etc. What other categories, though? "Adventuring" should probably apply to a good deal beyond the current ASH functions; no need to break them up, either, as far as I can see. "Communications" perhaps, for kmail / chat stuff. Feel free to add on; and we should probably start some official page for tracking this... hmm... --[[User:StDoodle|StDoodle (#1059825)]] 11:57, 14 July 2010 (UTC)

Shortcut for checking all the preferences that aren't here (generates wiki code for you, sorted into global and user preferences:
<div style="word-wrap:break-word;">
alias wikiPrefs => ashq buffer page; <nowiki>page.append(visit_url("http://wiki.kolmafia.us/index.php?title=KoLmafia_Properties")); string[string, string] map; file_to_map("defaults.txt", map); foreach i in map {print_html(""+i+":"); foreach j,k in map[i] if(!j.contains_text("choiceAdv") && !page.contains_text(j)) print_html("|- | "+j+" "+"| "+k+" |"); print_html(" ");</nowiki>}
</div>
: Combing through the results, looks like certain things like badMoonEncounters and sugarCounters and manaBurn preferences would all take up lots of space, but should probably get a mention. Not sure, someone else can play around with the above alias and figure out how to deal with those. --[[User:Heeheehee|Heeheehee]] 00:41, 10 January 2011 (UTC)

Using

2010-12-07T08:31:52Z

Heeheehee: Three equal signs is a bit excessive, no?

{{DISPLAYTITLE:using (CLI)}}
===using===
Adds the following script's functions to the namespace. In other words, it makes the script's functions available as CLI commands.

===namespace===
Contains a list of all user-created functions available for use as CLI commands. Note that KoLmafia is ''always'' "using" ASH, and so all ASH commands are available in this format. For instance, "<nowiki>> print_html hello</nowiki>" will print hello to the CLI, then return void.

===== Clearing the namespace =====
To remove scripts from the namespace you need to clear the property commandLineNamespace. The command is this:
<pre>
set commandLineNamespace =
</pre>

[[Category:CLI Commands]]

Helpful Scripts

2010-11-29T04:09:26Z

Heeheehee: /* User Interface Scripts */ Added WOSSMAN.

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KoLmafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjunction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation when you need the the forged documents 'cause it sucks to accidently lose those 3 adventures.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as the moons' effects on various modifiers, current stat day and Daily Dungeon rooms.

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Adapted from Alhifar's Slime Tube Adventuring Script; does everything the original script does.
* Adds a UI to enable the user to easily configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* This script provides a more user-friendly interface for modifying [http://kolmafia.us/showthread.php?2072 ZLib] variables. Deprecated by zarqon's WOSSMAN.

'''WOSSMAN''' - ([http://kolmafia.us/showthread.php?2072-ZLib-Zarqon-s-useful-function-library&p=38185&viewfull=1#post38185 download here] '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Zarqon's Wikified Online Script Settings Manager. Provides a more convenient method for editing ZLib variables. Since this script was released by the author of ZLib, this is essentially the official ZLib variable editor.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasis monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and ends stasis.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essences in Seaside Megalopolis, learning rave dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Gets a buff from a buffbot without needing to know the bot's name or pricelist.

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Executes between battles in automatic adventuring.
* Adjusts choice adventures, adjusts MCD for current moxie, auto-tames turtles.

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hops over the clan Bonus Adventures from Hell to get something from their VIP Lounge, then it hops back to your regular clan.
* Enables access to all VIP Lounge amenities and the ballpit without needing to spend time in BaFH.
* If you don't have a membership in Bonus Adventures from Hell, it submits a request to join the clan so that you can get access to a fully stocked VIP Lounge for free.

==Item Handling Scripts==

'''Misshappen Animal Skeleton Familiar/Checker/Buyer''' - ([http://kolmafia.us/showthread.php?p=30995 download here]) '''Author:''' [http://kolmafia.us/member.php?1789-eitak eitak]
* This script uses framework from Spiny Twizzler's Tiny Plastic Series 1 & 2 Checker script and facilitates the automated acquisition of the Misshapen Animal Skeleton. There are some settings you can tweak within the script itself to suit your needs.

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Automates simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?4202-The-Unofficial-Ascend.ash-support-thread.&p=30725&viewfull=1#post30725 best download here]) - ([http://kolmafia.us/showthread.php?1519 outdated official thread here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=fronobulax fronobulax]
* Tries to find an optimal diet for a given value of an adventure.
* Can be run in simulation mode, just to see what it would do.
* Since dj_d is taking a leave of absence, fronobulax has temporarily taken up maintenance of this script.

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
* Tracks all events that have limited uses, from pool table to pasta summoning.

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the {{kolwiki|Color Wheel of Yuck}} trophy by checking your discoveries list and mixing the vials in your inventory to create slime potions you do not know.

'''Tiny Plastic Series 1 & 2 Checker''' - ([http://kolmafia.us/showthread.php?goto=newpost&t=2587 download here]) '''Author:''' [http://kolmafia.us/member.php?1897-Spiny Spiny Twizzler]
* Its default behaviour is informational to help you acquire your Tiny Plastic Trophy and/or Two-Tiered Tiny Plastic Trophy. You may optionally edit the preferences in the script to shop for missing trophies for you with a budget that you set yourself.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''[[htmlform|HTMLform]]''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''[[zlib|ZLib]]''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many scripts require this.''

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

[[Category:New User Help]][[Category:Scripting]]

Talk:Zlib

2010-11-29T04:04:30Z

Heeheehee: re: issues

Just getting started, but hopefully this will serve as a good guideline for library pages. --[[User:StDoodle|StDoodle (#1059825)]] 23:18, 28 November 2010 (UTC)

Oh yeah; please chime in with any format requests / criticisms / suggestions. I'd like to nail down a standard format for such pages before adding htmlform's page and any others that may be justified. --[[User:StDoodle|StDoodle (#1059825)]] 23:20, 28 November 2010 (UTC)

Ok, here's the to-do list: 1) finish up the rest of the functions using what's there as a guide. 2) Bring in the external info (such as for eval()). 3) Proof, check format, etc. 4) Come up with a way to link to each function's section via "search"; may need to make redirects (ugh). --[[User:StDoodle|StDoodle (#1059825)]] 00:51, 29 November 2010 (UTC)

4 is really pissing me off... ideally, I'd like table of contents info & search results for each function, without adding extra headings (since they'd either look bad w/o parentheses after function names or require the parentheses in search). Ugh! Halp! --[[User:StDoodle|StDoodle (#1059825)]] 02:46, 29 November 2010 (UTC)

:: Looks good so far. For concern #4, I want to say redirects are probably the best way to go. Might have to add anchors physically (i.e. via HTML), then have the redirects point to the proper locations on the page. You might want to also add in the function tocs in the same manner -- you can probably use the HTML as a point of reference. --[[User:Heeheehee|Heeheehee]] 04:04, 29 November 2010 (UTC)

Zlib

2010-11-29T01:44:43Z

Heeheehee: Fixed misspelling of "function".

{{TOCright}}{{DISPLAYTITLE:ZLib (zlib.ash)}}
== About Zarqon's Useful Function Library ==
Behold, a single function library containing most of zarqon's most useful functions, which will be used by most of his scripts. He grew tired of tweaking a function that was in multiple scripts and making sure he had changed them all. ''It would be nice'', he thought in his customary italics, ''to have it in just one place''.

In choosing which functions to include, he have tried to select only those functions which are a) super useful, or 2) needed by another of the included functions. It's a bit less efficient in terms of individual scripts, but in terms of repeated code across a family of scripts it is far simpler.

== Functions ==

{{HideLink|excise}}{{Function|
name=excise|
return_type=string|
parameter1={{Param|string|source}}|
parameter2={{Param|string|start}}|
parameter3={{Param|string|end}}|
p1desc=The original {{pspan|source}} string|
p2desc={{pspan|start}} after this string|
p3desc={{pspan|end}} before this string|
}}
This function returns a portion of the {{pspan|source}} string, from after the first occurrence of {{pspan|start}} to just before the first occurrence of {{pspan|end}}. If either {{pspan|start}} or {{pspan|end}} are missing, it will return an empty string. You can also supply either {{pspan|start}} or {{pspan|end}} as blank strings to specify the actual start or end of the {{pspan|source}} string.

{{HideLink|normalized}}{{Function|
name=normalized|
return_type=string|
parameter1={{Param|string|mixvar}}|
parameter2={{Param|string|type}}|
p1desc={{pspan|mixvar}} is the string to normalize|
p2desc={{pspan|type}} is the datatype to normalize to|
}}
Returns {{pspan|mixvar}}, normalized to the specified mafia {{pspan|type}}, which can be any primitive type or ASH datatype constant. For example, normalized("badger", "familiar") would return "Astral Badger".

{{HideLink|rnum}}{{Function|
name=rnum|
return_type=string|
parameter1={{Param|int|n}}|
}}
{{Function|
name=rnum|
return_type=string|
parameter1={{Param|float|n}}|
}}
{{Function|
name=rnum|
return_type=string|
parameter1={{Param|float|n}}|
parameter2={{Param|int|place}}|
p1desc={{pspan|n}} is a number|
p2desc={{pspan|place}} is the number of decimal places to round to|
}}
Returns your number {{pspan|n}} as a human-readable string. For ints, this means it adds commas where appropriate. For floats, it also rounds to the nearest {{pspan|place}} after the decimal. Default {{pspan|place}} for the float-only version is 2, although it may display fewer digits if they are 0's. Examples: rnum(12580) => "12,580", rnum(3.14152964,3) => "3.142", rnum(4.00008) => "4", rnum(123456789.87654321) => "123,456,789.88". Recommended as a substitute for to_string().

{{HideLink|set_avg}}{{Function|
name=set_avg|
return_type=void|
parameter1={{Param|float|to_add}}|
parameter2={{Param|string|which_prop}}|
p1desc={{pspan|to_add}} is the data point to add|
p2desc={{pspan|which_prop}} is the property to add data to|
}}
Useful for adding spading to scripts. Adds one more statistic to an average value being stored in a property. For example, calling this script three times with the values 2, 4, and 6 for {{pspan|to_add}} would result in the property {{pspan|which_prop}} containing "4.0:3", with 4.0 being the average of the three numbers added and 3 being the amount of numbers averaged.

{{HideLink|get_avg}}{{Function|
name=get_avg|
return_type=float|
parameter1={{Param|string|which_prop}}|
p1desc={{pspan|which_prop}} is the property to access|
}}
Returns an average value set by set_avg().

{{HideLink|eval}}{{Function|
name=eval|
return_type=vfloat|
parameter1={{Param|string|expression}}|
parameter2={{Param|float [string]|values|ag=t}}|
p1desc={{pspan|expression}} is the base expression|
p2desc={{pspan|values}} is a map of values to replace|
}}
By Jason Harper. Evaluates {{pspan|expression}} as a math expression, and allows you to substitute {{pspan|values}} for variables, as described in much greater detail here. A brief version of this documentation is also included in ZLib. (NB: This section needs more infoz.)

boolean vprint(string message, string color, int level)
boolean vprint(string message, int level)
Wrapper for print() and abort(), prints message depending on vars["verbosity"] setting. It has a boolean return value so it can replace { print(message); return t/f; }
if level == 0: abort with message
if level > 0: prints message if verbosity >= level, returns true
if level < 0: prints message if verbosity >= abs(level), returns false
More detailed explanation here.

boolean vprint_html(string message, int level)
Same as above, but wraps print_html().

int abs(int n)
float abs(float n)
Returns the absolute value of n.

float minmax(float a, float min, float max)
Returns a, but no less than min and no more than max.

string check_version(string soft, string prop, string thisver, int thread)
Server-friendly once-daily version-checking. (Also hyphen-friendly.) If the user hasn't checked yet today, visits the specified thread in this forum to find the current version of your script. The thread must include "soft version" for the version info to be successfully parsed. Optionally, you may include "[requires revision XXXX]" in the post if you want to indicate a required minimum revision of mafia. If a new version is available, alerts the user in large text and provides an update link, then waits for a sufficiently annoying interval in case the user wishes to abort operation to go update the script. The return value is a blank string unless an update is found, in which case it is a <div id='versioninfo'> containing the update message. This allows this function to work equally well for relay scripts. The current version is stored to a daily property, standardized to "_version_"+prop. Example:
Code:

check_version("Hardcore Checklist","checklist","1.2.7",1045);

boolean load_current_map(string fname, aggregate dest)
Allows scripts to automatically update data files. Loads a map named fname.txt, either from disk or from the Map Manager if an update is available. (Yes, this means you shouldn't include ".txt" in the parameter.) The first time you try to load a given map on a given day, it checks if your version is current. If so, it merely loads it from disk. If not, it overwrites your local map with the map stored on the Map Manager.

int setvar(string varname, mixed dfault)
Allows you to define a per-character script setting to be used across all scripts that use ZLib. The first time the script is run, the variable will be set to dfault. To reference this setting, use vars[varname] in any script that includes ZLib, keeping in mind that this will always be a string. Detailed information posted here.

int have_item(string tolookup)
A residual function, used by the following and probably in several other scripts. Returns the amount of an item you have both in your inventory and equipped.

float has_goal(item whatsit)
Returns the chance that an item is or results in a goal. If is_goal(item) == true or it's a bounty item, returns 1.0. Otherwise, returns the chance that you would get a goal from using the item. For example, with a goal of black pepper, has_goal($item[black picnic basket]) would return 0.58. Many thanks to aqualectrix for creating and sharing the container items results map.

float has_goal(monster m)
Making use of the above function, returns the percent chance that encountering a given monster will result in a goal, taking into account +items, pickpocket availability (and +pickpocket), and Torso. For instance, with no +item and black pepper as a goal, has_goal($monster[black widow]) would return 0.087 (0.58 basket contains pepper * 0.15 basket drop rate). Also note that it will add multiple goals together, so with white pixels as a goal, a Blooper would return 2.1.

float has_goal(location l)
Returns the chance that adventuring at a given location will yield a goal. For our black pepper example, has_goal($location[black forest]) would return 0.0174 (0.2 black widow appearance rate * 0.087 chance that a widow has black pepper). Presently this accounts for combat frequency modifiers but not Olfaction, and it will be off for areas with noncombats that grant goals, because it assumes that all noncombats do not yield items.

boolean obtain(int n, string cond, location locale)
Attempts to get n (-existing) of cond, either by purchasing (if you have the mafia preference set), pulling from Hangk's, or adventuring at locale. It also works with choiceadvs.

boolean use_upto(int n, item doodad, boolean purchase)
Gets (if purchase is true) and uses n doodads if possible. Otherwise, uses as many as you have up to n.

boolean resist(element req, boolean reallydoit)
Returns whether you are able to resist a given element, or if reallydoit is true, attempts to actually achieve that resistance (casting buffs, changing gear, or equipping your Exotic Parrot), and returns its success.

int my_defstat()
Returns the value of your buffed defense stat, taking into account Hero of the Half-Shell.

int get_safemox(location wear)
Using mafia's location/monster data, returns the safe moxie of a given zone.

boolean auto_mcd(int safemox)
boolean auto_mcd(monster mob)
boolean auto_mcd(location place)
If your automcd setting is true, automatically adjusts your mind-control device for maximum stat gains based on safemox (or the safe moxie for place or mob) and your threshold setting. Does not adjust for MCD-sensitive areas (certain bosses, Slime Tube), or areas with no known combats.

familiar best_fam(string ftype)
Returns your heaviest familiar of a given type (currently possible: items, meat, produce, stat, delevel). If your is_100_run setting is anything other than $familiar[none], returns that familiar (so you don't have to make the check in your script).

boolean send_gift(string to, string message, int meat, int[item] goodies, string insidenote)
boolean send_gift(string to, string message, int meat, int[item] goodies)
Self-explanatory, really. Sends a gift to a player, able to split large amounts of items, useful return value.

boolean kmail(string to, string message, int meat, int[item] goodies, string insidenote)
boolean kmail(string to, string message, int meat, int[item] goodies)
boolean kmail(string to, string message, int meat)
Sends a kmail to a player, returning true if the kmail is successfully sent. Handles splitting the message into multiple messages if the number of item types is too large. Returns the result of send_gift() if the intended recipient is unable to receive the message due to being in HC or somesuch. Note that you can also specify the message to be used inside gifts in that case. Use "\n" to specify a new line in the message.

== Making use of Zlib ==
To include this library in your script, simply add the following towards the top of your script:
{{CodeSample|
code=
<syntaxhighlight>
import "zlib.ash";
</syntaxhighlight>}}
Then all these functions will be available in your script. Have fun!

== More Information ==
See the thread for ZLib on the mafia forum [http://kolmafia.us/showthread.php?2072 here].

[[Category:Scripting]][[Category:ASH Function Libraries]]

Modifier Maximizer

2010-11-21T20:17:41Z

Heeheehee: Superfluous '+' removed.

{{TOCright}}

=Usage=
==General==
The specification of what attributes to maximize is made by a comma-separated list of keywords, each possibly preceded by a numeric weight. Commas can be omitted if the next item starts with a +, -, or digit. Using just a +, or omitting the weight entirely, is equivalent to a weight of 1. Likewise, using just a - is equivalent to a weight of -1. Non-integer weights can be used, but may not be meaningful with all keywords.

Numeric weights determine how much an individual keyword will be counted toward the score that Mafia assigns to each combination. For instance, "2 item drop" will force item drop to contribute four times as much as, say, ".5 meat drop" in the expression "maximize 2 item drop, meat drop". The weights are simply multiplied with the corresponding modifier, so in the preceding expression, a natty blue ascot would contribute 20*.5 = 10 to your score, while a lucky rabbit's foot would contribute 2*7 + .5*7 = 17.5 to your score.

==Numeric Modifiers==
The full name of any numeric modifier (as shown by the '''modref''' CLI command) is a valid keyword, requesting that its value be maximized. If multiple modifiers are given, their weights specify their relative importance. Negative weights mean that smaller values are more desirable for that modifier.

Shorter forms are allowed for many commonly used modifiers. They can be abbreviated down to just the bold letters:
 '''mus''', '''mys''', '''mox''', '''main'''stat, '''HP''', '''MP''', '''ML''', '''DA''', '''DR''', '''com'''bat rate, '''item''' drop, '''meat''' drop, '''exp'''erience, '''adv'''entures
 Also, resistance (of any type) can be abbreviated as '''res''', and damage can be abbreviated as '''dmg'''. '''all res'''istance is a shortcut for giving the same weight to all five basic elements. Likewise, '''elemental dmg''' is a shortcut for the five elemental damage types.

Note that many modifiers come in pairs: a base value, plus a percentage boost (such as Moxie and Moxie Percent), or a penalty value. In general, you only need to specify the base modifier, and any related modifiers will automatically be taken into account.

==Limits==
Any numeric modifier keyword can be followed by one or both of these special keywords:
 '''min''' - The weight specifies the minimum acceptable value for the preceding modifier. If the value is lower, the results will be flagged as a failure.
 '''max''' - The weight specifies the largest useful value for the preceding modifier. Larger values will be ignored in the score calculation, allowing other specified modifiers to be boosted instead.
 Note that the limit keywords won't quite work as expected for a modifier that you're trying to minimize.
 If '''min''' or '''max''' is specified at the start of the expression, it applies to the total score (the sum of each modifier value times its weight). A global '''max''' may allow equipment maximization to finish faster, since no further combinations will be considered once the specified value is reached.+
==Other Modifiers==
Boolean modifiers can also be used as keywords. With positive weight, the modifier is required to be true; with negative weight, it is required to be false. There is one shortcut available: '''sea''' requires both Adventure Underwater and Underwater Familiar to be true.

The only bitmap modifiers that currently appear useful for maximization are Clownosity and Raveosity, so they are allowed as a special case. The weight specifies the required minimum value; only one value is actually meaningful for each keyword, so '''4 clownosity''' and '''7 raveosity''' are the only useful forms.

String modifiers are not currently meaningful for maximization.
==Equipment==
Slot names can be used as keywords:
 '''hat''', '''weapon''', '''offhand''', '''shirt''', '''pants''', '''acc1''', '''acc2''', '''acc3''', '''familiar''' (stickers and fake hands are not currently planned.)
 With positive weights, only the specified slots will be considered for maximization. With negative weights, all but the specified slots will be considered.
 '''empty''' - With positive weight, consider only slots that are currently empty; with negative weight, only those that aren't empty. Either way, '''+''slot''''' and '''-''slot''''' can be used to further refine the selected slots.
 '''hand'''ed - With a weight of 1, only 1-handed weapons will be considered. With a larger weight, only weapons with at least that handedness will be considered.
 '''melee''' - With positive weight, only melee weapons will be considered. With negative weight, only ranged weapons will be considered.
 '''type ''text''''' - Only weapons with a type containing ''text'' are considered; for example, '''type club''' if you plan to do some Seal Clubbing.
 '''shield''' - With positive weight, only shields will be considered for your off-hand. Implies '''1 handed'''.
 '''equip ''item''''' - The specified item is required (positive weight) or forbidden (negative weight). Multiple uses of '''+equip''' require all of the items to be equipped.
 '''outfit ''name''''' - The specified standard outfit is required or forbidden. If the name is omitted, the currently equipped outfit is used. Multiple uses of '''+outfit''' are satisfied by any one of the outfits (since you can't be wearing more than one at a time).
 If both '''+equip''' and '''+outfit''' are used together, either one will satisfy the condition - all of the items, or one of the outfits. This special case is needed to be able to specify the conditions for adventuring in the Pirate Cove.
 '''tie'''breaker - With negative weight, disables the use of a tiebreaker function that tries to choose equipment with generally beneficial attributes, even if not explicitly requested. There are only a few cases where this would be desirable: maximizing '''+combat''' or '''-combat''' (since there's usually only one item that can help), '''adv''' and/or '''PvP fights''' at rollover, and '''familiar weight''' when facing the Naughty Sorceress familiars.
==Familiars==
By default, the Modifier Maximizer does not recommend familiars, since there are many possible factors in choosing one beyond those that can be expressed via modifiers. However, you can request that specific familiars be compared with your current one:
 '''switch ''familiar''''' - With positive weight, the familiar is added to the list to be considered (unless the player lacks that familiar, or is already using it, in which case there is no effect). With negative weight, the familiar is added to the list only if the player lacks the previously specified familiar. For example, '''switch hobo monkey, -switch leprechaun''' will only consider the leprechaun if the player doesn't have the monkey.
==Assumptions==
All suggestions are based on the assumption that you will be adventuring in the currently selected location, with all your current effects, prior to the next rollover (since some things depend on the moon phases). For best results, make sure the proper location is selected before maximizing. This is especially true in The Sea and clan dungeons, which have many location-specific modifiers.

Among effects, stat equalizer potions have a major effect on the suggested boosts, since they change the relative importance of additive and percentage stat boosts. Likewise, elemental phials make certain resistance boosts pointless. If you plan to use an equalizer or phial while adventuring, please use them first so that the suggestions take them into account.
==GUI Use==
If the Max Price field is zero or blank, the limit will be the smaller of your available meat, or your autoBuyPriceLimit (default 20,000). The other options should be self-explanatory.

You can select multiple boosts, and the title of the list will indicate the net effect of applying them all - note that this isn't always just the sum of their individual effects.
==CLI Use==
The Modifier Maximizer can be invoked from the gCLI or a script via '''maximize ''expression''''', and will behave as if you'd selected Equipment: on-hand only, Max Price: don't check, and turned off the Include option. The best equipment will automatically be equipped (unless you invoked the command as '''maximize? ''expression'''''), but you'll still need to visit the GUI to apply effect boosts - there are too many factors in choosing between the available boosts for that to be safely automated. An error will be generated if the equipment changes weren't sufficient to fulfill all '''min''' keywords in the expression.
==Limitations & Bugs==
This is still a work-in-progress, so don't expect everything to work perfectly at the moment. However, here are some details that are especially broken:
* Items that can be installed at your campground for a bonus (such as Hobopolis bedding) aren't considered.
* Your song limit isn't considered when recommending buffs, nor are any daily casting limits.
* Mutually exclusive effects aren't handled properly.
* Weapon Damage, Ranged Damage, and Spell Damage are calculated assuming 100 points of base damage - in other words, additive and percentage boosts are considered to have exactly equal worth. It's possible that Weapon and Ranged damage might use a better estimate of the base damage in the future, but for Spell Damage, the proper base depends on which spell you end up using.
* Effects which vary in power based on how many turns are left (love songs, Mallowed Out, etc.) are handled poorly. If you don't have the effect, they'll be suggested based on the results you'd get from having a single turn of it. If you have the effect already, extending it to raise the power won't even be considered. Similar problems occur with effects that are based on how full or drunk you currently are.

=Useful Expressions=
'''MP regen''': .5 mp regen max, .5 mp regen min

'''Pirates''': mainstat, +outfit swashbuckling

'''War''': mainstat, +outfit frat warrior

'''Shieldbutting''': muscle, +shield

=More Information=

Here is the expression used as '''tie'''breaker:

:"1 familiar weight, 1 familiar experience, 1 initiative, 5 exp, 1 item, 1 meat, 0.1 DA 1000 max, 1 DR, 0.5 all res, -10 mana cost, 1.0 mus, 0.5 mys, 1.0 mox, 1.5 mainstat, 1 HP, 1 MP, 1 weapon damage, 1 ranged damage, 1 spell damage, 1 cold damage, 1 hot damage, 1 sleaze damage, 1 spooky damage, 1 stench damage, 1 cold spell damage, 1 hot spell damage, 1 sleaze spell damage, 1 spooky spell damage, 1 stench spell damage, 1 critical, -1 fumble, 1 HP regen max, 3 MP regen max, 1 critical hit percent, 0.1 food drop, 0.1 booze drop, 0.1 hat drop, 0.1 weapon drop, 0.1 offhand drop, 0.1 shirt drop, 0.1 pants drop, 0.1 accessory drop, 1 DB combat damage";

See [http://kolmafia.us/showthread.php?4274 this thread] for details.
<h2>See Also</h2><div style="border: dashed 1px green; margin: 0.2em; padding: 1em; width=75%; background-color: #fff8dc;"><center>[[Modifiers]]</center></div>
[[Category:Automation]]

Modifier Maximizer

2010-11-15T19:56:18Z

Heeheehee: /* General */ I guess that's enough explanation for weighting? Someone else can handle formatting, for now, I guess.

{{RFI}}

=Usage=
==General==
The specification of what attributes to maximize is made by a comma-separated list of keywords, each possibly preceded by a numeric weight. Commas can be omitted if the next item starts with a +, -, or digit. Using just a +, or omitting the weight entirely, is equivalent to a weight of 1. Likewise, using just a - is equivalent to a weight of -1. Non-integer weights can be used, but may not be meaningful with all keywords.

Numeric weights determine how much an individual keyword will be counted toward the score that Mafia assigns to each combination. For instance, "2 item drop" will force item drop to contribute four times as much as, say, ".5 meat drop" in the expression "maximize 2 item drop, meat drop". The weights are simply multiplied with the corresponding modifier, so in the preceding expression, a natty blue ascot would contribute 20*.5 = 10 to your score, while a lucky rabbit's foot would contribute 2*7 + .5*7 = 17.5 to your score.

==Numeric Modifiers==
The full name of any numeric modifier (as shown by the '''modref''' CLI command) is a valid keyword, requesting that its value be maximized. If multiple modifiers are given, their weights specify their relative importance. Negative weights mean that smaller values are more desirable for that modifier.

Shorter forms are allowed for many commonly used modifiers. They can be abbreviated down to just the bold letters:
 '''mus''', '''mys''', '''mox''', '''main'''stat, '''HP''', '''MP''', '''ML''', '''DA''', '''DR''', '''com'''bat rate, '''item''' drop, '''meat''' drop, '''exp'''erience, '''adv'''entures
 Also, resistance (of any type) can be abbreviated as '''res''', and damage can be abbreviated as '''dmg'''. '''all res'''istance is a shortcut for giving the same weight to all five basic elements. Likewise, '''elemental dmg''' is a shortcut for the five elemental damage types.

Note that many modifiers come in pairs: a base value, plus a percentage boost (such as Moxie and Moxie Percent), or a penalty value. In general, you only need to specify the base modifier, and any related modifiers will automatically be taken into account.

==Limits==
Any numeric modifier keyword can be followed by one or both of these special keywords:
 '''min''' - The weight specifies the minimum acceptable value for the preceding modifier. If the value is lower, the results will be flagged as a failure.+
 '''max''' - The weight specifies the largest useful value for the preceding modifier. Larger values will be ignored in the score calculation, allowing other specified modifiers to be boosted instead.
 Note that the limit keywords won't quite work as expected for a modifier that you're trying to minimize.
 If '''min''' or '''max''' is specified at the start of the expression, it applies to the total score (the sum of each modifier value times its weight). A global '''max''' may allow equipment maximization to finish faster, since no further combinations will be considered once the specified value is reached.+
==Other Modifiers==
Boolean modifiers can also be used as keywords. With positive weight, the modifier is required to be true; with negative weight, it is required to be false. There is one shortcut available: '''sea''' requires both Adventure Underwater and Underwater Familiar to be true.

The only bitmap modifiers that currently appear useful for maximization are Clownosity and Raveosity, so they are allowed as a special case. The weight specifies the required minimum value; only one value is actually meaningful for each keyword, so '''4 clownosity''' and '''7 raveosity''' are the only useful forms.

String modifiers are not currently meaningful for maximization.
==Equipment==
Slot names can be used as keywords:
 '''hat''', '''weapon''', '''offhand''', '''shirt''', '''pants''', '''acc1''', '''acc2''', '''acc3''', '''familiar''' (stickers and fake hands are not currently planned.)
 With positive weights, only the specified slots will be considered for maximization. With negative weights, all but the specified slots will be considered.
 '''empty''' - With positive weight, consider only slots that are currently empty; with negative weight, only those that aren't empty. Either way, '''+''slot''''' and '''-''slot''''' can be used to further refine the selected slots.
 '''hand'''ed - With a weight of 1, only 1-handed weapons will be considered. With a larger weight, only weapons with at least that handedness will be considered.
 '''melee''' - With positive weight, only melee weapons will be considered. With negative weight, only ranged weapons will be considered.
 '''type ''text''''' - Only weapons with a type containing ''text'' are considered; for example, '''type club''' if you plan to do some Seal Clubbing.
 '''shield''' - With positive weight, only shields will be considered for your off-hand. Implies '''1 handed'''.
 '''equip ''item''''' - The specified item is required (positive weight) or forbidden (negative weight). Multiple uses of '''+equip''' require all of the items to be equipped.
 '''outfit ''name''''' - The specified standard outfit is required or forbidden. If the name is omitted, the currently equipped outfit is used. Multiple uses of '''+outfit''' are satisfied by any one of the outfits (since you can't be wearing more than one at a time).
 If both '''+equip''' and '''+outfit''' are used together, either one will satisfy the condition - all of the items, or one of the outfits. This special case is needed to be able to specify the conditions for adventuring in the Pirate Cove.
 '''tie'''breaker - With negative weight, disables the use of a tiebreaker function that tries to choose equipment with generally beneficial attributes, even if not explicitly requested. There are only a few cases where this would be desirable: maximizing '''+combat''' or '''-combat''' (since there's usually only one item that can help), '''adv''' and/or '''PvP fights''' at rollover, and '''familiar weight''' when facing the Naughty Sorceress familiars.
==Familiars==
By default, the Modifier Maximizer does not recommend familiars, since there are many possible factors in choosing one beyond those that can be expressed via modifiers. However, you can request that specific familiars be compared with your current one:
 '''switch ''familiar''''' - With positive weight, the familiar is added to the list to be considered (unless the player lacks that familiar, or is already using it, in which case there is no effect). With negative weight, the familiar is added to the list only if the player lacks the previously specified familiar. For example, '''switch hobo monkey, -switch leprechaun''' will only consider the leprechaun if the player doesn't have the monkey.
==Assumptions==
All suggestions are based on the assumption that you will be adventuring in the currently selected location, with all your current effects, prior to the next rollover (since some things depend on the moon phases). For best results, make sure the proper location is selected before maximizing. This is especially true in The Sea and clan dungeons, which have many location-specific modifiers.

Among effects, stat equalizer potions have a major effect on the suggested boosts, since they change the relative importance of additive and percentage stat boosts. Likewise, elemental phials make certain resistance boosts pointless. If you plan to use an equalizer or phial while adventuring, please use them first so that the suggestions take them into account.
==GUI Use==
If the Max Price field is zero or blank, the limit will be the smaller of your available meat, or your autoBuyPriceLimit (default 20,000). The other options should be self-explanatory.

You can select multiple boosts, and the title of the list will indicate the net effect of applying them all - note that this isn't always just the sum of their individual effects.
==CLI Use==
The Modifier Maximizer can be invoked from the gCLI or a script via '''maximize ''expression''''', and will behave as if you'd selected Equipment: on-hand only, Max Price: don't check, and turned off the Include option. The best equipment will automatically be equipped (unless you invoked the command as '''maximize? ''expression'''''), but you'll still need to visit the GUI to apply effect boosts - there are too many factors in choosing between the available boosts for that to be safely automated. An error will be generated if the equipment changes weren't sufficient to fulfill all '''min''' keywords in the expression.
==Limitations & Bugs==
This is still a work-in-progress, so don't expect everything to work perfectly at the moment. However, here are some details that are especially broken:
* Items that can be installed at your campground for a bonus (such as Hobopolis bedding) aren't considered.
* Your song limit isn't considered when recommending buffs, nor are any daily casting limits.
* Mutually exclusive effects aren't handled properly.
* Weapon Damage, Ranged Damage, and Spell Damage are calculated assuming 100 points of base damage - in other words, additive and percentage boosts are considered to have exactly equal worth. It's possible that Weapon and Ranged damage might use a better estimate of the base damage in the future, but for Spell Damage, the proper base depends on which spell you end up using.
* Effects which vary in power based on how many turns are left (love songs, Mallowed Out, etc.) are handled poorly. If you don't have the effect, they'll be suggested based on the results you'd get from having a single turn of it. If you have the effect already, extending it to raise the power won't even be considered. Similar problems occur with effects that are based on how full or drunk you currently are.

=Useful Expressions=
'''MP regen''': .5 mp regen max, .5 mp regen min

'''Pirates''': mainstat, +outfit swashbuckling

'''War''': mainstat, +outfit frat warrior

'''Shieldbutting''': muscle, +shield

=More Information=

Here is the expression used as '''tie'''breaker:

:"1 familiar weight, 1 familiar experience, 1 initiative, 5 exp, 1 item, 1 meat, 0.1 DA 1000 max, 1 DR, 0.5 all res, -10 mana cost, 1.0 mus, 0.5 mys, 1.0 mox, 1.5 mainstat, 1 HP, 1 MP, 1 weapon damage, 1 ranged damage, 1 spell damage, 1 cold damage, 1 hot damage, 1 sleaze damage, 1 spooky damage, 1 stench damage, 1 cold spell damage, 1 hot spell damage, 1 sleaze spell damage, 1 spooky spell damage, 1 stench spell damage, 1 critical, -1 fumble, 1 HP regen max, 3 MP regen max, 1 critical hit percent, 0.1 food drop, 0.1 booze drop, 0.1 hat drop, 0.1 weapon drop, 0.1 offhand drop, 0.1 shirt drop, 0.1 pants drop, 0.1 accessory drop, 1 DB combat damage";

See [http://kolmafia.us/showthread.php?4274 this thread] for details.
<h2>See Also</h2><div style="border: dashed 1px green; margin: 0.2em; padding: 1em; width=75%; background-color: #fff8dc;"><center>[[Modifiers]]</center></div>
[[Category:Automation]]

Talk:ASH For Beginners

2010-11-11T21:08:40Z

Heeheehee:

Holy Moley! You actually started it, StDoodle! Way to GO! --[[User:Bale|Bale]] 22:43, 28 April 2010 (UTC)

Your recent edit is completely wrong; I would have reverted it, except that the reason field wasn't big enough to explain just how it was wrong.

ALL values in ASH are passed and assigned in a completely uniform manner, regardless of type. That manner could either be referred to as "call by value" or "call by reference"; the two concepts aren't distinct here, since all ASH values are references to some object. No copying is ever done, except as part of an implicit type conversion.

You appear to be confusing the concepts of call type and mutability. There's no difference in how (for example) a map and an int value are passed; the observed differences in behavior are entirely due to the fact that there are ways to modify the contents of a map (with it still remaining the same map), yet no ways of modifying the value of an integer. The closest you can come is to produce a new integer value, and assign it to the same variable that formerly held the old value; it is the variable that is changing, not the value. --[[User:Jasonharper|Jasonharper]] 05:49, 27 July 2010 (UTC)

First, for Jasonharper: Don't hesitate to make such changes when they're wrong. If more explanation is needed, the discussion page for the relevant page is a good place. If you don't have time / energy for explanations, feel free to just say "will explain later" and that's good. Hell, you don't even need reasons; you and V are considered the finall authorities on mafia, as you're the most active in, you know, making it exist. This isn't the guideline for most users, but you & V have a special place in the hierarchy. Since fewyn provides hosting, anything that affects his ability to keep this site going is priority #1. After that, all factual information given by you or V is simply not up for dispute. (Well, discussion on talk pages is welcome, but I won't tolerate edit / revert wars; if one of you says something isn't correct / needs changing, that's how it is.) Then come admins, then everyone else, as far as editing priority goes. The long and short is that the official policy is that if you or V says something needs to be changed, or you actually make said change, you don't have to worry about reverts; even if you don't have time to explain the reasoning at the moment.

Also, regarding the information that was edited: Even had it been correct, it's really beyond the scope of a "for beginners" page, IMO. I'm all for adding an "Advanced ASH Language Specifications" page or similar, for those behind-the-scenes, nitty-gritty details as to how ASH works, but I don't think the beginner's page is the best place for said info. However, if anyone would like to make said advanced-info page, please feel free.

Also, just to be clear; this is a wiki, so don't feel bad about things changing and getting changed back, etc. ad nauseum. Unless you're a spam-bot. ;) --[[User:StDoodle|StDoodle (#1059825)]] 11:26, 27 July 2010 (UTC)

Is there a syntax highlighting language model for BBEdit/TextWrangler for the Mac? Does anyone want one? They're pretty simple to make...--[[User:Mcroft|Mcroft]] 20:37, 11 November 2010 (UTC)

There's [http://kolmafia.us/showthread.php?4185-syntax-highlighting-for-TextWrangler this] one, but it's kinda out of date. You'd basically just have to manually edit in a few functions. --[[User:Heeheehee|Heeheehee]] 21:08, 11 November 2010 (UTC)

CLI Reference

2010-11-08T06:16:49Z

Heeheehee: /* Mafia */ Yes, uh, a pipe should've been HTML-encoded. :P

The KoLmafia Graphical CLI is one of the most helpful features Mafia has. This page is intended to provide information on the commands available.

=How to use these commands=

Square brackets [ ] enclose optional elements of commands. In command descriptions, they may also enclose the effects of using those optional elements.

Vertical bars | separate alternative elements - choose any one. (But note that || is an actual part of a few commands.)

An ellipsis ... after an element means that it can be repeated as many times as needed.

Elements in italics are placeholders - replace them with an actual name you want the command to operate on.

Commands with an asterisk * after the name are abbreviations - you can type them in a longer form if desired.

Some command names can be followed by a question mark (shown as [?] ), in which case the command will just display what it would do, rather than actually doing it.

When adventuring, or using an item or skill, the name can be preceded by a number specifying how many times to do it. An asterisk in place of this number means "as many as possible" or "the current quantity in inventory", depending on context. Negative numbers mean to do that many less than the maximum.

Usually, multiple commands can be given on the same line, separated by semicolons. The exceptions (alias, ash, ashq, cheapest, expensive, fecho, fprint, get, set, speculate, whatif, later) treat the entire remainder of the line as a parameter.

A few commands (elseif, else, if, try, while) treat at least one following command as a block that is executed conditionally or repetitively. The block consists of the remainder of the line, or the entire next line if that's empty. The block is extended by additional lines if it would otherwise end with one of these special commands.

===Quantity Parameter===
Any place that a number can be used to define a quantity, such as <code>autosell 5 heavy D</code>, you can use one of the following to indicate a variable quantity:
* <nowiki>*</nowiki> is used to indicate all items in inventory.
: <code>autosell * heavy D</code>
* 0 is also used to indicate all items in inventory.
: <code>autosell 0 heavy D</code>
* a negative number means sell off all items except for the number listed. For example, -5 means keep 5 and sell the rest.
: <code>autosell -5 heavy D</code>

===Item Parameter===
There are two ways to provide an item. By name or number.
* An item's name can be used in the obvious way, however this may sometimes fail because some items have numbers as part of their names. KoL's fuzzy matching will sometimes make a mistake such as interpreting {{Pspan|1 WA}} as a {{Pspan|100-watt light bulb}}.

* An item's ID number can be used to avoid any possibility of ambiguity. This also allows names with commas to be passed as parameters to functions that contain comma separated lists. To do this the item needs to be prefaced by a [http://en.wikipedia.org/wiki/Pilcrow pilcrow]. The character: ¶, is also known as a paragraph mark. It can be typed from your keyboard with a bit of know-how or included in an ash script as "\u00B6".
: <code>send 1 ¶4358 to Bale|Thanks for being awesome</code>
: is a way to send {{Pspan|A Crimbo Carol, Ch. 5}} to Bale despite the comma in the item's name.

=Commands=
==Equipment, Inventory and Consumption Management==
{| class="wikitable" border="1"
|-
! Command
! Arguments
! Description
|-
| *brewery*[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| *kitchen*[?]
| item
| consumes item at Hell's Kitchen, if available.
|-
| acquire
| item
| ensure that you have item, creating or buying it if needed.
|-
| bake
| [ item... ]
| list creatables, or create specified items.
|-
| chew[?]
| [either] item [, item]...
| use/consume items
|-
| cleanup
|
| use, pulverize, or autosell your junk items.
|-
| closet
| list filter | put item... | take item...
| list or manipulate your closet.
|-
| create
| [ item... ]
| list creatables, or create specified items.
|-
| display
| [filter] | put item... | take item...
| list or manipulate your display case.
|-
| eat[?]
| [either] item [, item]...
| use/consume items
|-
| equip
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| find
| item
| ensure that you have item, creating or buying it if needed.
|-
| fold[?]
| item
| produce item by using another form, repeated as needed.
|-
| ghost[?]
| [either] item [, item]...
| use/consume items
|-
| hagnk
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| hermit[?]
| [item]
| get clover status, or trade for item.
|-
| hobo[?]
| [either] item [, item]...
| use/consume items
|-
| inv*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| junk
|
| use, pulverize, or autosell your junk items.
|-
| make
| [ item... ]
| list creatables, or create specified items.
|-
| maximize[?]
| [+|-|weight] keyword, ...
| run the [[Modifier Maximizer]].
|-
| mix
| [ item... ]
| list creatables, or create specified items.
|-
| modifies
| filter
| list all possible sources of modifiers matching filter.
|-
| [[Modifiers|modref]]
| [object]
| list all modifiers, show values for player [and object].
|-
| modtrace
| filter
| list everything that adds to modifiers matching filter.
|-
| outfit
| [list filter] | save name | checkpoint | name
| list, save, restore, or change outfits.
|-
| overdrink[?]
| [either] item [, item]...
| use/consume items
|-
| ply
| [ item... ]
| list creatables, or create specified items.
|-
| pull
| outfit name | item [, item]...
| pull items from Hagnk's storage.
|-
| pulverize
| item [, item]...
| pulverize specified items
|-
| quark[?]
| [itemList...]
| gain MP by pasting unstable quark with best item from itemList (or your junk list).
|-
| remove
| slot | name
| remove equipment in slot, or that matches name
|-
| restaurant[?]
| [ daily special | item ]
| show daily special [or consume it or other restaurant item].
|-
| retrieve
| item
| ensure that you have item, creating or buying it if needed.
|-
| slimeling[?]
| [either] item [, item]...
| use/consume items
|-
| smash
| item [, item]...
| pulverize specified items
|-
| smith
| [ item... ]
| list creatables, or create specified items.
|-
| [[speculate]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| squeeze[?]
| item
| produce item by using another form, repeated as needed.
|-
| stash
| [put] item... | take item...
| exchange items with clan stash
|-
| sticker*
| sticker1 [, sticker2 [, sticker3]]
| replace worn stickers.
|-
| storage
| [param]
| list indicated type of data, possibly filtered by param.
|-
| tinker
| [ item... ]
| list creatables, or create specified items.
|-
| wear
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| [[whatif]]
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...]
| predict modifiers.
|-
| wield
| [list filter] | [slot] item
| show equipment, or equip item [in slot].
|-
| zap
| item [, item]...
| transform items with your wand.
|}

==Quests==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| !
|
| list the Dungeons of Doom potions you've identified.
|-
| bang
|
| list the Dungeons of Doom potions you've identified.
|-
| chamber
|
| automatically complete quest.
|-
| council
|
| visit the Council to advance quest progress.
|-
| dusty
|
| list the dusty bottles of wine you've identified.
|-
| entryway
| [clover]
| automatically complete quest [using a clover].
|-
| factory
| report digits
| Given a string of 7 dwarven digits, report on factory.
|-
| gourd
|
| automatically complete quest.
|-
| grandpa
| query
| Ask Grandpa about something.
|-
| guardians
|
| automatically complete quest.
|-
| guild
|
| automatically complete quest.
|-
| hedge*
|
| automatically complete quest.
|-
| insults
|
| list the pirate insult comebacks you know.
|-
| leaflet
| [nomagic] | location | command
| complete leaflet quest [without using magic words].
|-
| maze
|
| automatically complete quest.
|-
| nemesis
|
| automatically complete quest.
|-
| tavern
|
| automatically complete quest.
|-
| telescope
| [look] high | low
| get daily buff, or Lair hints from your telescope.
|-
| tower
|
| automatically complete quest.
|}

==Capitalism==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| automall
|
| dump all profitable, non-memento items into the Mall.
|-
| autosell
| item [, item]...
| autosell items.
|-
| buy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| cheapest[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| expensive[?]
| [+]item [,[-]item]... [; cmds]
| compare prices, do cmds with "it" replaced with best.
|-
| mallbuy
| item [@ limit] [, another]...
| buy from NPC store or the Mall.
|-
| mallsell
| item [[@] price [[limit] num]] [, another]...
| sell in Mall.
|-
| reprice
|
| price all max-priced items at or below current Mall minimum price.
|-
| searchmall
| item [ with limit number ]
| search the Mall.
|-
| sell
| item [, item]...
| autosell items.
|-
| undercut
|
| price all max-priced items at or below current Mall minimum price.
|-
| untinker
| [ item... ]
| complete quest, or untinker items.
|-
| use[?]
| [either] item [, item]...
| use/consume items
|}

==Mafia==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| adv*[?]
| last | [count] location
| spend your turns.
|-
| abort
| [message]
| stop current script or automated task.
|-
| [[alias]]
| [ word => expansion ]
| list or create CLI abbreviations.
|-
| [[ash (CLI)|ash]]
| statement
| test a line of ASH code without having to edit a script.
|-
| [[ash (CLI)|asq]]
| statement
| Like ash, but does not display the return value.
|-
| ashref
| [filter]
| summarize ASH built-in functions [matching filter].
|-
| backtrace
| text | off
| dump stack when a gCLI message or page URL matches text (case-sensitive).
|-
| breakfast
|
| perform start-of-day activities.
|-
| budget
| [number]
| show [or set] the number of budgeted Hagnk's pulls.
|-
| buffbot
| number
| run buffbot for number iterations.
|-
| call
| [numberx] filename | function [parameters]
| check/run script.
|-
| ccs
| [script]
| show [or select] Custom Combat Script in use.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| chat
|
| switch to tab or open window
|-
| check
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| checkpoint
|
| remembers current equipment, use "outfit checkpoint" to restore.
|-
| clear
|
| clear CLI window.
|-
| cls
|
| clear CLI window.
|-
| [[condition]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| condref
|
| list conditions usable with if/while commands.
|-
| [[counters]]
| [ clear | add number [title img] ]
| show, clear, or add to current turn counters.
|-
| debug
| [on] | off
| start or stop logging of debugging data.
|-
| disable
| all | command [, command]...
| allow/deny CLI commands.
|-
| events
| [clear]
| clear or show recent events.
|-
| exec*
| [numberx] filename | function [parameters]
| check/run script.
|-
| exit
|
| logout and exit KoLmafia.
|-
| gc
|
| force Java garbage collection.
|-
| gear
|
| switch to tab or open window
|-
| get
| preference [ = value ]
| show/change preference settings
|-
| [[goal]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| hatter
|
| List effects you can get by wearing available hats at the hatter's tea party.
|-
| help
| [filter]
| list CLI commands [that match filter].
|-
| item
|
| switch to tab or open window
|-
| later
| commands
| adds a button to do commands to the Daily Deeds list.
|-
| load
| [numberx] filename | function [parameters]
| check/run script.
|-
| log
| [status],[equipment],[effects],[etc.]
| record data, "log snapshot" for all common data.
|-
| logecho
| timestamp | text
| include timestamp or text in the session log only.
|-
| login
| username
| logout then log back in as username.
|-
| logout
|
| logout and return to login window.
|-
| logprint
| timestamp | text
| include timestamp or text in the session log only.
|-
| mail
|
| switch to tab or open window
|-
| mood*
| clear | autofill | execute | repeat [numTimes] | moodName [numTimes]
| mood management.
|-
| [[objective]]*
| clear | check | add condition | set condition
| modify your adventuring goals.
|-
| opt*
|
| switch to tab or open window
|-
| print
| timestamp | text
| include timestamp or text in the session log.
|-
| priphea
|
| launch KoLmafia GUI.
|-
| quit
|
| logout and exit KoLmafia.
|-
| radio
|
| switch to tab or open window
|-
| relay
|
| open the relay browser.
|-
| refresh
| all | status | equip | inv | storage | familiar | stickers
| resynchronize with KoL.
|-
| repeat
| [number]
| repeat previous line [number times].
|-
| run
| [numberx] filename | function [parameters]
| check/run script.
|-
| save
| as mood
| add your current effects to the mood.
|-
| session
| [param]
| list indicated type of data, possibly filtered by param.
|-
| set
| preference [ = value ]
| show/change preference settings
|-
| start
| [numberx] filename | function [parameters]
| check/run script.
|-
| [[trigger]]*
| clear | autofill | [type,] effect [, action]
| edit current mood. Options for type are gain_effect, lose_effect, unconditional
|-
| unalias
| word
| remove a CLI abbreviation.
|-
| update
| data | clear | prices URL or filename
| download most recent data files, or revert to built-in data.
|-
| validate
| [numberx] filename | function [parameters]
| check/run script.
|-
| verify
| [numberx] filename | function [parameters]
| check/run script.
|-
| version
|
| display KoLmafia version.
|}

==Scripting==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| <inline-ash-script>
|
| embed an ASH script in a CLI script.
|-
| cecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| colorecho
| color text
| show text using color (specified by name or #RRGGBB).
|-
| echo
| timestamp | text
| include timestamp or text in the session log.
|-
| else
| ; commands
| do commands if preceding if/while/try didn't execute.
|-
| elseif
| condition; commands
| do if condition is true but preceding condition was false.
|-
| if
| condition; commands
| do commands once if condition is true (see condref).
|-
| [[using|namespace]]
| [filter]
| list namespace scripts and the functions they define.
|-
| pause
| [seconds]
| pause script execution (default 1 second).
|-
| try
| ; commands
| do commands, and continue even if an error occurs.
|-
| [[using]]
| filename
| add ASH script to namespace.
|-
| wait
| [seconds]
| pause script execution (default 1 second).
|-
| while
| condition; commands
| do commands repeatedly while condition is true.
|}

==Other==
{| class="wikitable" border="1"
|-
! Command Name
! Arguments
! Description
|-
| *.php*
|
| visit URL without showing results.
|-
| *mirror*
| [filename]
| stop [or start] logging to an additional file.
|-
| aa
| skill
| set default attack method.
|-
| attack
| [ target [, target]... ]
| PvP for dignity or flowers
|-
| autoattack
| skill
| set default attack method.
|-
| ballpit
|
| jump in your clan's awesome ball pit.
|-
| basement
|
| check Fernswarthy's Basement status.
|-
| burn
| extra | * | num | -num
| use excess/all/specified/all but specified MP for buff extension and summons.
|-
| camp*
| rest | etc. [numTimes]
| perform campground actions.
|-
| cast[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| chips
| type [,type [,type]]
| buy chips from your clan's snack machine: radium, ennui, wintergreen
|-
| clan
| [ snapshot | stashlog ]
| clan management.
|-
| csend
| item [, item]... to recipient [ || message ]
| send kmail
|-
| demons
|
| list the demon names you know.
|-
| donate
| boris | mus | jarl | mys | pete | mox amount
| donate in Hall of Legends.
|-
| drink[?]
| [either] item [, item]...
| use/consume items
|-
| effects
| [param]
| list indicated type of data, possibly filtered by param.
|-
| enable
| all | command [, command]...
| allow/deny CLI commands.
|-
| encounters
| [param]
| list indicated type of data, possibly filtered by param.
|-
| entity
|
| give details of your current pastamancer combat entity.
|-
| [[enthrone (CLI)|enthrone]][?]
| species
| place a familiar in the Crown of Thrones.
|-
| familiar[?]
| [list filter] | lock | unlock | species | none
| list or change familiar types
|-
| field
| [ plant square type | pick square | harvest ]
| view or use your mushroom plot
|-
| flowers
|
| commit random acts of PvP.
|-
| forum*
|
| visit the official KoL forums.
|-
| friars
| [blessing] food | familiar | booze
| get daily blessing.
|-
| galaktik
| (hp | mp) [amount]
| restore amount or all hp or mp
|-
| hiddencity
| square [temple | altar item]
| set Hidden City square [and perform an action there].
|-
| [[holiday]]
| HolidayName
| enable special processing for unpredicted holidays.
|-
| hottub
|
| soak in your clan's hot tub
|-
| http:*
|
| visit URL without showing results.
|-
| kmail
| item [, item]... to recipient [ || message ]
| send kmail
|-
| locations
| [param]
| list indicated type of data, possibly filtered by param.
|-
| lookup
| item | effect
| go to appropriate KoL Wiki page.
|-
| mcd
| number
| set mind control device (or equivalent) to new value.
|-
| mind-control
| number
| set mind control device (or equivalent) to new value.
|-
| moleref
|
| Path of the Mole spoilers.
|-
| monsters
| location
| show combat details for the specified area.
|-
| moon*
| [param]
| list indicated type of data, possibly filtered by param.
|-
| mpitems
|
| counts MP restoratives in inventory.
|-
| nuns
| [mp]
| visit the Nunnery for restoration [but only if MP is restored].
|-
| olfact*
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| putty
| ( none | monster name | [item] list | goals ) [abort]
| tag next monster [that drops all items in list, or your goals].
|-
| pvp
| [ target [, target]... ]
| PvP for dignity or flowers
|-
| pvplog*
|
| summarize PvP results.
|-
| raffle
| ticketsToBuy [ inventory | storage ]
| buy raffle tickets
|-
| recover*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| remedy[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| restore*
| hp | health | mp | mana | both
| attempt to regain some HP or MP.
|-
| safe
| location
| show summary data for the specified area.
|-
| send
| item [, item]... to recipient [ || message ]
| send kmail
|-
| shrug[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| skill[?]
| [ [count] skill [on player] ]
| list spells, or use one.
|-
| skills
| [param]
| list indicated type of data, possibly filtered by param.
|-
| sleep
| number
| rest on your clan sofa for number turns.
|-
| soak
|
| soak in your clan's hot tub
|-
| sofa
| number
| rest on your clan sofa for number turns.
|-
| spade
| [prices URL]
| submit automatically gathered data.
|-
| status
| [param]
| list indicated type of data, possibly filtered by param.
|-
| styx
| muscle | mysticality | moxie
| get daily Styx Pixie buff.
|-
| summary
| [param]
| list indicated type of data, possibly filtered by param.
|-
| summon
| demonName | effect | location | number
| use the Summoning Chamber.
|-
| text
| URL
| show text results from visiting URL.
|-
| train
| base weight | buffed weight | turns number
| train familiar.
|-
| uneffect[?]
| effect [, effect]...
| remove effects using appropriate means.
|-
| unequip
| slot | name
| remove equipment in slot, or that matches name
|-
| up?
| effect [, effect]...
| extend duration of effects.
|-
| wiki
| searchText
| perform search on KoL Wiki.
|-
| win
| game
| I'm as surprised as you! I didn't think it was possible.
|}

[[Category:CLI Commands]]

Alias

2010-10-24T17:15:19Z

Heeheehee: Added wordwrapping to <pre> tags, added a missing "alias".

{{DISPLAYTITLE:alias}}
Creates a new alias in the KoLmafia CLI or displays the list of registered aliases.
An alias is a shortcut for complex CLI command(s) that are too long to type every time you want to. To create a new alias, type
alias ''[alias_name]'' => ''[actual_command]''
into the CLI, where <code>''[alias_name]''</code> and <code>''[alias_command]''</code> are replaced with the shortcut string you want to use and the actual command string. For example, to create an alias "f" for the <code>[[familiar]]</code> CLI command, type:
<pre>alias f => familiar</pre>
Now, instead of typing <code>familiar pixie</code> or <code>familiar sandworm</code>, you can just type <code>f pixie</code> or <code>f sandworm</code>.

To see the list of aliases that you have created so far, type <code>alias</code> into the CLI without any arguments.

Aliases are preserved across multiple characters. You can remove existing aliases by using the <code>[[unalias]]</code> command.

== Complex Examples ==
=== Automatically Getting Dentures ===
<pre style="white-space:pre-wrap;">alias dentures => checkpoint; equip frilly skirt; ash visit_url("inv_use.php?which=3&whichitem=2951&pwd"); visit_url("choice.php?whichchoice=188&option=3&choiceform3=Catburgle&pwd"); cli_execute("outfit checkpoint");</pre>

This equips a frilly skirt, chooses the right choice in the Orcish Frat House Blueprints adventure, and then re-equips whatever pants you had on when you type ''dentures'' into the CLI.

=== See How many charges left on Bartender/Chef ===
<pre style="white-space:pre-wrap;">alias boxen => ashq if(have_chef()) print("Chef turns used: "+get_property("chefTurnsUsed"),"green"); else print("No chef-in-a-box","gray"); if(have_bartender()) print("Bartender turns used: "+get_property("bartenderTurnsUsed"),"green"); else print("No bartender-in-a-box","gray");</pre>

This prints something similar to:
<pre>> boxen

Chef turns used: 5
Bartender turns used: 10</pre>

=== See How Many Substats we need to Level ===
<pre style="white-space:pre-wrap;">alias level => ashq stat s; switch(my_primestat()){case $stat[muscle]:s=$stat[submuscle];break;case $stat[mysticality]:s=$stat[submysticality];break;case $stat[moxie]:s=$stat[submoxie];break;default: } int s_left =(my_level()^2+4)^2 - my_basestat(s);print("Missing "+s_left+" substat for level "+(my_level()+1));</pre>

Prints something similar to:
<pre>> level

Missing 2839 substat for level 12</pre>

[[Category:CLI Commands]]

Miscellaneous ASH Features

2010-10-17T03:19:06Z

Heeheehee: Added info for plantingScript, added section for secret Mafia features (link to hola's thread).

{{TOCright}}
==Special Syntax Functions==

'''[[notify]]'''

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

'''[[import]]'''

Used to load an external script into your current one.

'''[[call]]'''

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

'''[[new]]'''

Constructor function used to populate a record.

==Comments==

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

==Errors==

For help when things go wrong, please see the page on [[ASH Errors]].

==Additional Script Uses==

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

'''Between Battle (betweenBattleScript)'''
*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
*Does not require any special main() declaration.
*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]

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

'''Chatbot (chatbotScript)'''
*Will execute whenever a private message is received
*Requires a special main declaration void main(string sender, string message)
**'sender' is the name of the player who sent the message
**'message' is the message that was sent

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

'''Login (loginScript)'''
:This script is immediately executed once your character is logged in. Requires no special main() declaration.

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

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

'''Post-Ascension (postAscensionScript)'''
:Executed at once when your character starts a new ascension. (Example: Bales's [http://kolmafia.us/showthread.php?t=2769 newLife])

'''Pre-Ascension (preAscensionScript)'''
:Executed right before entering Valhalla.

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

==A little CLI help==

Two CLI commands are of great use to ASH scripters:
* [[ashref]] allows one to get a list of ASH functions
* [[ash (CLI)|ash]] or [[ash (CLI)|ashq]] allows one to run ASH directly on the CLI.

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

[[Category:Scripting]]

Monster element

2010-10-04T05:07:49Z

Heeheehee: $elements[] will return an array, not $element[].

{{
#vardefine:name|monster_element}}{{
#vardefine:return_type|element}}{{

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

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

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|monster|check_me}}|
p1desc={{Pspan|check_me}} is the (optional) monster to get the elemental alignment of|
}}|
function_description=Returns the elemental alignment of the specified monster {{pspan|check_me}}. If {{pspan|check_me}} is not specified, it defaults to the last monster you encountered.
This function can be used from within an [[In-combat Consulting]] script to help determine your fight strategy. When used this way, it isn't necessary to specify a monster, as the function will default to the one currently being fought.|

code1={{CodeSample|
title=Sample Code|
description=This example attempts to find element(s) that the monster being fought right now is weak against.|
code=<syntaxhighlight>
boolean [element] weak_elements;

switch (monster_element())
{
case $element[cold]: weak_elements = $elements[spooky, hot]; break;
case $element[spooky]: weak_elements = $elements[hot, stench]; break;
case $element[hot]: weak_elements = $elements[stench, sleaze]; break;
case $element[stench]: weak_elements = $elements[sleaze, cold]; break;
case $element[sleaze]: weak_elements = $elements[cold, spooky]; break;
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|monster_attack|monster_defense|monster_hp}}|
special=If no monster is specified and no monster has been fought in this session, this function returns $element[none]. This is because mafia forgets the value of [[last_monster|last_monster()]] when it logs out.|
}}

[[Category:Adventuring]]|[[Category:In-combat Consulting]]

Helpful Scripts

2010-10-04T05:06:08Z

Heeheehee: /* Informational Scripts */ KoLwiki link modded to use template.

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KoLmafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjunction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation when you need the the forged documents 'cause it sucks to accidently lose those 3 adventures.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as the moons' effects on various modifiers, current stat day and Daily Dungeon rooms.

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Adapted from Alhifar's Slime Tube Adventuring Script; does everything the original script does.
* Adds a UI to enable the user to easily configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
*This script provides a more user-friendly interface for modifying [http://kolmafia.us/showthread.php?2072 ZLib] variables.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasis monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and ends stasis.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essences in Seaside Megalopolis, learning rave dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Gets a buff from a buffbot without needing to know the bot's name or pricelist.

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Executes between battles in automatic adventuring.
* Adjusts choice adventures, adjusts MCD for current moxie, auto-tames turtles.

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hops over the clan Bonus Adventures from Hell to get something from their VIP Lounge, then it hops back to your regular clan.
* Enables access to all VIP Lounge amenities and the ballpit without needing to spend time in BaFH.
* If you don't have a membership in Bonus Adventures from Hell, it submits a request to join the clan so that you can get access to a fully stocked VIP Lounge for free.

==Item Handling Scripts==

'''Misshappen Animal Skeleton Familiar/Checker/Buyer''' - ([http://kolmafia.us/showthread.php?p=30995 download here]) '''Author:''' [http://kolmafia.us/member.php?1789-eitak eitak]
* This script uses framework from Spiny Twizzler's Tiny Plastic Series 1 & 2 Checker script and facilitates the automated acquisition of the Misshapen Animal Skeleton. There are some settings you can tweak within the script itself to suit your needs.

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Automates simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?4202-The-Unofficial-Ascend.ash-support-thread.&p=30725&viewfull=1#post30725 best download here]) - ([http://kolmafia.us/showthread.php?1519 outdated official thread here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=fronobulax fronobulax]
* Tries to find an optimal diet for a given value of an adventure.
* Can be run in simulation mode, just to see what it would do.
* Since dj_d is taking a leave of absence, fronobulax has temporarily taken up maintenance of this script.

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
* Tracks all events that have limited uses, from pool table to pasta summoning.

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the {{kolwiki|Color Wheel of Yuck}} trophy by checking your discoveries list and mixing the vials in your inventory to create slime potions you do not know.

'''Tiny Plastic Series 1 & 2 Checker''' - ([http://kolmafia.us/showthread.php?goto=newpost&t=2587 download here]) '''Author:''' [http://kolmafia.us/member.php?1897-Spiny Spiny Twizzler]
* Its default behaviour is informational to help you acquire your Tiny Plastic Trophy and/or Two-Tiered Tiny Plastic Trophy. You may optionally edit the preferences in the script to shop for missing trophies for you with a budget that you set yourself.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''HTMLform''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''ZLib''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many scripts require this.''

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

[[Category:New User Help]][[Category:Scripting]]

Talk:Use familiar

2010-09-26T22:10:38Z

Heeheehee:

This always seems to return false for me, can anyone confirm? 
--[[User:Slyz|Slyz]] 20:56, 9 April 2010 (UTC)

: > ash use_familiar($familiar[sandworm])

: Putting Mexicana the Hovering Sombrero back into terrarium... 
: Taking Hecho en Mexico the Baby Sandworm out of terrarium... 
: Returned: true 
I assume that the ash command should be enough to check return value; correct me if I'm wrong. --[[User:Heeheehee|Heeheehee]] 21:03, 9 April 2010 (UTC)

I'll have to recheck after RO, but here is what I was getting (doing things slightly differently):

: > ash print( use_familiar($familiar[slimeling]) )

: Putting Dusty the Baby Sandworm back into terrarium... 
: Taking Yuk the Slimeling out of terrarium... 
: false 
: Returned: void 
--[[User:Slyz|Slyz]] 03:33, 10 April 2010 (UTC)

Huh. Using that method, I get:
: > ash print( use_familiar($familiar[sombrero]) )

: Putting Hecho en Mexico the Baby Sandworm back into terrarium... 
: Taking Mexicana the Hovering Sombrero out of terrarium... 
: true 
: Returned: void
--[[User:Heeheehee|Heeheehee]] 07:51, 10 April 2010 (UTC)

I'm also seeing expected behavior; true most of the time, false if I try a familiar I don't have.
--[[User:StDoodle|StDoodle (#1059825)]] 14:52, 10 April 2010 (UTC)

I find the syntax as described on this page confusing. With other functions I do not have to specify the datatype, for example: 
outfit($string[Backup]); 
outfit("Backup"); 
both work identically. However, use_familiar("hobo"); 
returns the error "Function 'use_familiar( string )' undefined..." 
This just happened to be the first function I looked up on this wiki, and if the discussion with examples had not been here, I don't think I would have worked it out at all.--[[User:RogerMexico|RogerMexico]] 12:04, 25 September 2010 (UTC)

By default, supplying something inside of quotes is considered of the "string" datatype. So, $string[hello] is the same as "hello". However, use_familiar() needs the familiar datatype. You can't just supply a string (ie "hobo"); you need to supply a familiar. Since datatypes like familiar, element, etc. aren't "normal" datatypes used in programming, we have to use an explicit datatype constant call (the dollar-sign thing) or a function that converts from a string to that datatype. --[[User:StDoodle|StDoodle (#1059825)]] 18:42, 25 September 2010 (UTC)

I've done some further reading on this wiki (which is absolutely superb documentation by the way) and came to understand ''why'' it is that way. But for non-programmers like myself who are looking for a quick answer, I think an example on the page would help. I'll try adding one, hope I don't screw it up :) Oh, and is there a page that discusses syntax in general? The whole reason I went and looked at the outfit() function was to try and understand the syntax of the function (specifically, why is the word familiar inside the parentheses there?).The datatype page was helpful, I think something like that on syntax would be nice. --[[User:RogerMexico|RogerMexico]] 13:26, 26 September 2010 (UTC)

: The word "familiar" inside the parentheses indicates the type of argument that this function accepts. An additional note: the functions for [[Datatype Conversions]] might help.
: Also, [[ASH For Beginners|this page]] might be what you're looking for; I dunno. --[[User:Heeheehee|Heeheehee]] 22:10, 26 September 2010 (UTC)

Kolmafia:Spam

2010-09-10T23:22:55Z

Heeheehee: Sneaky OCD capitalization!

{{DISPLAYTITLE:KoLmafia:Spam}}

Whenever we have an anonymous bot spamming us we ban the IP address from posting for 6 months, but do not prevent that address from creating an account

== The Chronicle of KoLmafia's spam problem. ==

Our spam problem was originally confined to a page titled [[Talk:(ASHRM) String Handling Routines]]. That page was deleted since it is no longer relevant to our wiki. However the spambot kept re-recreating it. Endlessly. Finally the page was protected to see what would happen.

Discussion about this problem was conducted on [[User talk:Heeheehee#(ASHRM) String Handling Routines|User talk:Heeheehee]]

After that a spambot created spam on [[File talk:Breakable equipment.jpg]].

Finally we restricted anonymous IPs from editing out wiki in an attempt to stop the problem. We await the outcome of this experiment.

The current spam discussion is on [[File talk:Breakable equipment.jpg]] where we restore it every time the spambot messes it up. We also keep a spam count on that page.

Condition

2010-09-06T01:06:24Z

Heeheehee: Formatted CLI bits; do we want to keep this, or should some additional distinction be made? (I'm thinking a possible template at some point.)

{{DISPLAYTITLE:condition (CLI)}}

help condition offers the following: 
condition* clear | check | add condition | set condition - modify your adventuring goals. 
goal* clear | check | add condition | set condition - modify your adventuring goals. 
objective* clear | check | add condition | set condition - modify your adventuring goals. 

[[Category:CLI Commands]]

Kolmafia talk:Spam

2010-09-01T17:14:57Z

Heeheehee: Created page with 'I'm just slightly sad that I can't move this page to "KoLmafia:Spam" (gogo ocd capitalization!). But more relevantly, basically the spambots have two options: start registering a…'

I'm just slightly sad that I can't move this page to "KoLmafia:Spam" (gogo ocd capitalization!). But more relevantly, basically the spambots have two options: start registering accounts or pick on some other wiki. If the former is the case, then we have a problem. Hopefully that's too much effort (although it can be done simply enough). If the latter, we're safe. I guess we should give it a few weeks, at the very least. --[[User:Heeheehee|Heeheehee]] 17:14, 1 September 2010 (UTC)

File talk:Breakable equipment.jpg

2010-08-29T04:40:06Z

Heeheehee:

Times this page has been spammed: 3

Now we know what happens when we protect the page that spambots like. This seems to be the new spambot page. ;) --Bale 21:29, 17 August 2010 (UTC)

Times this page has been spammed: 5 --[[User:Bale|Bale]] 06:56, 18 August 2010 (UTC)

Times this page has been spammed: 7 --[[User:Heeheehee|Heeheehee]] 23:54, 20 August 2010 (UTC)

Times this page has been spammed: 9 --[[User:Bale|Bale]] 19:14, 21 August 2010 (UTC)

Times this page has been spammed: 10 --[[User:Heeheehee|Heeheehee]] 04:13, 22 August 2010 (UTC)

Times this page has been spammed: 11 (That's ridiculous. It's not even funny. Seriously it isn't)----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 23:22, 23 August 2010 (UTC)

* You're right that it really isn't funny, but thanks to your "seriously it isn't" comment, I spit tea out my nose. So I guess it was funny after all. Either that or I just have a bad case of reverse-schadenfreude where I take delight in my own misery. --[[User:Bale|Bale]] 23:31, 23 August 2010 (UTC)

Times this page has been spammed: 12. Ok first of all, why would you spam here? Secondly, should we block this page?----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 19:54, 24 August 2010 (UTC)

* NO! We should not block this page. There was another page on this wiki (whose name escapes me since it was weird) which was spammed exclusively. We didn't use that page for anything, so we deleted it every time the spambot created it. We finally decided to protect that page 3 days before this page became the new spam lightening rod. If we protected this page, the new spambot favorite page might be one that actually gets used. That would be BAD! --[[User:Bale|Bale]] 20:53, 24 August 2010 (UTC)
** '''(ASHRM) String Handling Routines''' or something like that? But yeah, I had originally protected the page but was convinced to unprotect it because of the cool analogy (lightning rod!). It was eventually StD who reprotected it because he got sick of the spam problem. But since it's resurfaced, we really should learn to stop protecting pages. If it spreads to a new page while this one's still unprotected, then we might consider protecting pages en masse (alternative solution, pester Fewyn to restrict editing to logged-in users only, but we'd have to wait for him to respond). But okay, it's been hit 12 times in a row without any other targets coming into sight. Guess we'll have to wait another 25 before being really sure that spambots won't target any other pages. --[[User:Heeheehee|Heeheehee]] 21:23, 24 August 2010 (UTC)
***Isn't there a way to make it so that only registered users can edit pages? That would keep away lots of spam bots----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 22:00, 24 August 2010 (UTC)
***It seems that only fewyn can change [[Special:ListGroupRights|permissions]]. --[[User:Bale|Bale]] 23:49, 24 August 2010 (UTC)
*** Yep. "(alternative solution, pester Fewyn to restrict editing to logged-in users only, but we'd have to wait for him to respond)" --[[User:Heeheehee|Heeheehee]] 05:56, 25 August 2010 (UTC)
*** We try not to bother fewyn about the wiki as much as we can get away with. Not making fewyn work except for something important is one of our guiding principles. However I think that this may be important. But what does StDoodle think? --[[User:Bale|Bale]] 07:07, 25 August 2010 (UTC)

Sorry guys, been busy lately. Here's my take:
# The original "protect this page" was equal parts frustration & experiment. The experiment was fruitful, in that we learned something, but unfortunately not what we wanted to. IE it didn't stop the spam, it just moved it. So unless anyone can think of something useful to add to that process, we should think carefully about that option. (Note: this does NOT apply if the spam moves on its own to a useful page).
# As mentioned above, this page isn't all that useful. I mean, yeah, kinda, but it's easy to make a new one for the content, and just leave this one here as a spam honeypot. (Plus, it's name isn't one that represents what I was trying to move the wiki away from, as the ASHRM one did.)
# Long-term solution would be to bug fewyn to make the changes mentioned above. I think I'm going to go ahead and do that, since we all seem to agree that it's the best idea. But I'm not going to pressure him to hurry; it looks like you guys have stayed on top of things fairly well, so no major need to have it done RIGHT NAOO.
# I'm likely to be busy for the near-to-mid future with personal junk. (Possible divorce, ew.) From this point on, I'd like to designate Bale as being officially, 100% in charge of day-to-day operations (fewyn of course keeping the "final say," when he wants it). Thanks for all of your efforts!
-- [[User:StDoodle|StDoodle]] 07:27, 25 August 2010 (UTC)

== oqNpkWoecHwzmsh ==

Isn't this cute? The spambot has created a new section with a nonsense name so that our discussion wasn't deleted. I don't know what to make of it. I'm leaving the section header here just 'cause I'm curious if future spambots will use it or create their own nonsense sections. I suspect the later.

Times this page has been spammed: 13 --[[User:Bale|Bale]] 20:12, 25 August 2010 (UTC)
: Times this page has been spammed: 14. Also, uh, what was up with the latest spam hit? --[[User:Heeheehee|Heeheehee]] 23:53, 25 August 2010 (UTC)

Okay, that ''WAS'' weird. It never crossed my mind that it might over-write only the first section, leaving this one untouched. Just puzzling. --[[User:Bale|Bale]] 00:39, 26 August 2010 (UTC)

Times this page has been spammed: 15. Ridiculous. Just Ridiculous ----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 02:12, 26 August 2010 (UTC)

Times this page has been spammed: 16 --[[User:Bale|Bale]] 07:19, 28 August 2010 (UTC)

Times this page has been spammed: 17 ----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 13:08, 28 August 2010 (UTC)

Times this page has been spammed: 18 ----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 20:50, 28 August 2010 (UTC)

19! Fun! --[[User:Heeheehee|Heeheehee]] 04:40, 29 August 2010 (UTC)

File talk:Breakable equipment.jpg

2010-08-29T04:39:06Z

Heeheehee: Reverted edits by 217.6.171.194 (Talk) to last revision by Icon315

ASH Errors

2010-08-26T13:27:58Z

Heeheehee: /* Map modified within foreach */ Elaborated on this bit.

{{TOCright}}
Errors happen. When they do, it helps to have some idea of what what wrong.

===Abort===

Whenever a script runs the [[abort|abort()]] function, this error is generated.

{{CodeSample|
description=The zero-parameter form:|
code=
<syntaxhighlight>
abort();
</syntaxhighlight>}}
will stop the execution and print: KoLmafia declares world peace. Note that this message may also appear as a result of pressing Esc in the Main Interface or hitting "stop now" in the Adventure tab.

{{CodeSample|
description=The one-parameter form:|
code=
<syntaxhighlight>
abort("Aborting script...");
</syntaxhighlight>}}
will stop the execution and print: Aborting script...

===Cannot initialize parameter [parameter]===

This error is created when an assignment is attempted inside a function declaration.
The following code results in an error.

{{CodeSample|
code=
<syntaxhighlight>
/* test.ash */

void my_function( string myvar = "value" )
{
/* Do something */
}
</syntaxhighlight>}}
will halt the script and print: Cannot initialize parameter myvar (test.ash, line X)

===Cannot return [datatype] from [datatype] function===

This indicates that the return value does not match the function's type.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int stuff(){
return "4";
}
</syntaxhighlight>}}
will cause this error: Cannot return string value from int function (test.ash, line 2)

{{CodeSample|
description=Similarly, for void functions:|
code=
<syntaxhighlight>
void stuff(){
return 4;
}
</syntaxhighlight>}}
will cause this error: Cannot return a value from a void function (test.ash, line 2)

===Encountered '[break|continue]' outside loop===

This indicates that the control structure in question was not in a loop.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
continue;
</syntaxhighlight>}}
will cause this error: Encountered 'continue' outside of loop (test.ash, line 1)

===Expected===

This generally indicates a syntax problem (missing ending semi-colon, unmatched braces, unmatched parenthesis etc...).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int a = 1
print(a);
</syntaxhighlight>}}
will cause this error: Expected ;, found print (test.ash, line 2)

===Function defined multiple times===

This indicates that the function in question has already been defined.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int abs(int a){
return a*((a>0).to_int()*2 - 1);
}
int abs(int a){
if(a<0) a = -a;
return a;
}
</syntaxhighlight>}}
will cause this error: Function <nowiki>'abs( int )'</nowiki> defined multiple times (test.ash, line 4)

==="if" requires a boolean conditional expression ===

This indicates that the condition inside an if statement is not a boolean.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
if(42) {
print("Don't panic.");
}
</syntaxhighlight>}}
will cause this error: "if" requires a boolean conditional expression (test.ash, line 1)

===Index type is not a primitive type===

This indicates that the map's index is not a standard datatype (float, int, string, etc.).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
record alpha{
int a;
int b;
};
int[alpha] map;
</syntaxhighlight>}}
will cause this error: Index type 'alpha' is not a primitive type (test.ash, line 5)

===Invalid field name===

This indicates that the record does not contain the field in question.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
record my_record {
string a;
string b;
};

my_record [int] my_map;
my_map[1].c = "hello";
</syntaxhighlight>}}
will cause this error: Invalid field name 'c' (test.ash, line 7)

Note that this error may also be encountered when neglecting to name a field.
{{CodeSample|
description= For instance:|
code=
<syntaxhighlight>
record my_record {
string;
};
</syntaxhighlight>}}
will cause this error: Invalid field name ';' (test.ash, line 2)

===Invalid type name===

This indicates that the specified type is not recognized by Mafia.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int[fruit] map;
</syntaxhighlight>}}
will cause this error: Invalid type name 'fruit' (test.ash, line 1)

===Main method must appear at top level===

This indicates that the script's main method is inside another method, for some reason. This is usually caused by a missing brace.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
void stuff() {
// stuff happens here

void main() {
stuff();
}
</syntaxhighlight>}}
will cause this error: main method must appear at top level (test.ash, line 6)

===Map modified within foreach===

You cannot add or remove new entries into a map within a <code>[[foreach]]</code> loop, with the exception of removing the current key. This can happen if you accidentally wrap the name of a string variable with double-quotes for referencing a map entry.

{{CodeSample|
description=For example, the following code:|
code=
<syntaxhighlight>
/* test.ash */
item [string] my_map;
/* Populate my_map with several entries */
foreach str in my_map
print( str + " => " + my_map[ "str" ] );
</syntaxhighlight>}}
Yields: Map modified within foreach (test.ash, line X)

===Missing return value===

The last line of a user-defined function has to be "return <value>;" (although the [[Control_Structures#return|return]] command can be used before too).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int my_function( int a, int b ) {
if ( a > b ) return a ;
else return b ;
}
</syntaxhighlight>}}
will cause this error: Missing return value (test.ash, line 4)

===No closing found===

This can be caused by forgetting to put a '''"''' or a ''']''' at the end of an argument

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
buy(1000 , $item[disco ball, 225);
</syntaxhighlight>}}
will cause this error: No closing ] found (testing.ash, line 1)

===Record expected===

This indicates that an unrecognized record was found. This often appears when you forget to append "()" to a function name.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
print(4.to_string);
</syntaxhighlight>}}
will cause this error: Record expected (test.ash, line 2)

===Record name is already defined===

This indicates that the record name has already been defined, and so cannot be reused. The solution is to change the record name.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
record str {
string a;
string b;
};
record str {
int a;
int b;
};
</syntaxhighlight>}}
will cause this error: Record name 'str' is already defined (test.ash, line 5)

===Return needs [datatype] value===

This indicates that the return value is void when the function is not.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int stuff() {
return;
}
</syntaxhighlight>}}
will cause this error: Return needs int value (test.ash, line 2)

===Reserved word cannot be a [function|record|variable] name===

This indicates that the desired name has been [[Reserved Words|reserved]], and so cannot be used. The solution is to use a different name.

{{CodeSample|
description=An invalid name:|
code=
<syntaxhighlight>
int float(float a) {
return round(a);
}
</syntaxhighlight>}}
will cause this error: Reserved word 'float' cannot be used as a function name (test.ash, line 1)

An interesting point to note is that ASH functions take precedent over identically named custom functions rather than throw an exception.

{{CodeSample|
description=An invalid record name:|
code=
<syntaxhighlight>
record string {
string a;
string b;
};
</syntaxhighlight>}}
will cause this error: Reserved word 'string' cannot be a record name (test.ash, line 1)

{{CodeSample|
description=An invalid variable name:|
code=
<syntaxhighlight>
string item = "bottle of gin";
</syntaxhighlight>}}
will cause this error: Reserved word 'item' cannot be a variable name (test.ash, line 1)

===Script parsing error===

This generally indicates a syntax problem, as in having an excess amount of braces or a variable/function/record name that starts with an invalid character.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
put_shop(0 ,0 ,$item[wolf mask]);
put_shop(0 ,0 ,$item[rave whistle]);
put_shop(0 ,0 ,$item[giant needle]);
cli_execute ("undercut");
}
</syntaxhighlight>}}
will cause this error: Script parsing error (test.ash, line 5)

===Variable is already defined===

This indicates that the same variable has been declared twice.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int Drops ;
int Meat ;
int Drops = numeric_modifier("Item Drop");
</syntaxhighlight>}}
will cause this error: Variable Drops is already defined (test.ash, line 3)

{{RFI|Obviously, a lot more info is needed here.}}

[[Category:Scripting]]

Regular Expressions

2010-08-26T13:25:24Z

Heeheehee: Special groups! Okay, that might be a bit too complicated. =P

{{TOCright}}

== Introduction ==

Regular expressions, (commonly shortened to regex), are a language designed to enable creating very explicit patterns for searching strings. The regex language has wildcards for virtually every possible pattern of characters you might want to search for. Only some of the generally most common forms of regexes will be described on this page. For more details you are advised to search the internet where you will find many detailed resources on the subject. This writer will point the student at [http://www.regular-expressions.info/tutorial.html this tutorial] in particular.

== Commonly used Regular Expressions ==

===Literal Characters===
A character will match the first instance of itself in a string.

*E.g. {{Pspan|a}} will match the first a in "J{{Pspan|a}}ck is a dull boy."
*E.g. {{Pspan|cat}} is a set of three literal character which will find a match in "about {{Pspan|cat}}s and dogs."

===Special Characters===
It's often more interesting to search for less specific patterns than literal characters. There are a number of characters reserved for this purpose. These special characters are often called "metacharacters". If you want to use any of these characters as a literal in a regex, you need to escape them with a backslash.

* Backslash '''\'''
*: Used to grant special meaning to a normally literal character or employ a special character as a literal.
*: E.g. If you want to find the beginning of a word, the combination {{Pspan|\b}} will match a word's boundary.
*: E.g. to match "1+1=2", the correct regex is 1\+1=2. Otherwise, the plus sign will have a special meaning.
* Question mark '''?'''
*: The question mark makes the preceding token in the regular expression optional.
*: E.g. {{Pspan|colou?r}} matches both "colour" and "color".
* Asterisk or star '''*'''
*: The asterisk attempts to match the preceding token zero or more times.
* Plus sign '''+'''
*: The plus attempts to match the preceding token once or more.
* Period or dot '''.'''
*: Matches any character except for line breaks.
* Caret '''^'''
*: Matches the beginning of the string only.
*: E.g. {{Pspan|^the}} will match only the first word in "{{Pspan|the}} way of the world."
* Dollar sign '''$'''
*: Matches the end of the string only.
*: E.g. {{Pspan|dog$}} will match only the last word in "dog eat {{Pspan|dog}}".
* Opening and closing round brackets '''(''' and ''')'''
*: Used for grouping allowing a regex operator (like +) to be applied to the entire group. It also creates a capturing group for storing the match.
* Opening and closing square bracket '''[''' and ''']'''
*: Used to create "character sets" to match only one of several characters. Inside these brackets different rules apply to several characters: ^-
*: E.g. {{Pspan|gr[ae]y}} will match either "gray" or "grey", but it will not match "graey".
* Opening and closing braces '''{''' and '''}'''
*: This is a limited repetition operator matching only {min,max} of what preceeds it.
*: E.g. {{Pspan|\b[1-9][0-9]{2,4}\b}} matches a number between 100 and 99999. (\b matches a word boundry.)
* Vertical bar or pipe symbol '''|'''
*: This is an "or" operator to match one of several possibilities.
*: E.g. \b(cat|dog|fish)\b will match either "cat", "dog" or "fish".

===Other Common Matchers===
{|
| \w
| Matches any word character (alphanumeric & underscore).
|-
| \W
| Matches any character that is not a word character (alphanumeric & underscore).
|-
| \d
| Matches any digit character (0-9).
|-
| \D
| Matches any character that is not a digit character (0-9).
|-
| \s
| Matches any whitespace character (spaces, tabs, line breaks).
|-
| \S
| Matches any character that is not a whitespace character (spaces, tabs, line breaks).
|-
| \n
| Line break character.
|-
| \t
| Tab character.
|-
| \b
| Matches a word boundary position such as whitespace or the beginning or end of the string.
|-
| \B
| Matches any position that is not a word boundary.
|-
| [A-Za-z]
| Matches any single character in the range a-z or A-Z.
|-
| [^A-Za-z]
| Matches any single character, except for the range a-z or A-Z.
|}

===Greedy vs Lazy Matching===
Beware greedy matching! Matchers that can match multiple tokens will attempt to match as much as possible.
: E.g. {{Pspan|<.+>}} will match "This is a {{Pspan|<nowiki>test</nowiki>}}." instead of matching '''only''' the html tag as you might have expected.

To fix this, you can make the match lazy, by adding a ? after the greedy character.
: E.g. {{Pspan|<.+?>}} will match "This is a {{Pspan|<nowiki></nowiki>}}test<nowiki></nowiki>." so that you can pick out html tags.

===Special Groups===
These are special types of groups that can allow you to do more advanced things with regex. For the most part, they can be declared by adding a question mark to the beginning of a special group.

Noncapturing groups are declared by adding a colon after the question mark.
: E.g. {{Pspan|(?:hello)}} will match "{{Pspan|hello}}world" without actually creating a new capturing group.

Special quantifiers can be used in a standalone special group that has a length of 0.
: E.g. {{Pspan|(?i)hello)}} will match "{{Pspan|HELLO}}", since {{Pspan|(?i)}} tells the regex to ignore case.

Negative/positive lookahead/lookbehind can help you finetune your regex by restricting what can appear without capturing more of the target string
: E.g. {{Pspan|(?<!\\S)([\\d]+)(?!\\S)}} uses negative lookahead and negative lookbehind, and so it will only match a series of digits not bounded by non-space characters, which is to say, a series of digits bounded by spaces. Presumably it would be functionally identical to {{Pspan|<nowiki>(?<=\\s)([\\d]+)(?=\\s)</nowiki>}}.

Since ASH's regular expressions are directly passed to Java, ASH does not support named groups.

===Testing Resources===
If you're not sure if your regex will work, try testing it with one of these resources:
* [http://gskinner.com/RegExr/ gskinner.com]
* [http://www.regexplanet.com/simple/ regexplanet.com]

==Using Regexes in KoLmafia==
Regular expressions in ASH are wrappers for the Java java.util.regex package. You can find detailed information about that in this [http://java.sun.com/docs/books/tutorial/essential/regex/index.html Java Tutorial]. Only the highlights will be described in this section.

Using regular expressions in ash follows this basic formula:
#First a regular expression needs to be defined with the [[matcher]] datatype. Defining a matcher also requires the use of the [[create_matcher|create_matcher()]] function.
#:'''Important''': in ash backslashes have special meaning inside a string, so any backslashes need to be backslashed or else ash will interpret them differently.
#Then the matcher can be operated upon by the various [[String Handling Routines#Regular Expressions|regex functions]], notably [[find|find()]].
#Finally, if there were capturing groups in the matcher, they can be checked using the [[group|group()]] function.

{{CodeSample|
description=This example will use a regular expression to determine how many chamois are left in the slime tube's bucket.|
code=
<syntaxhighlight>
// Visit the bucket to get the page's text
string page = visit_url("clan_slimetube.php?action=bucket");

// In the following matcher: (is|are) will match either word
// (\\d+) will match and capture 1 or more digits. Note the double-backslash!
matcher cham_left = create_matcher("(There (is|are) (\\d+) chamoi(s|x))( in the bucket.)" , page);

// Then you use find to capture patterns with the parenthesis.
if(cham_left.find()) {

// Finally group() is used to reference the patterns that were captured.
print(cham_left.group(1)+ " left"+ cham_left.group(5), "blue");
} else
print("The bucket is empty.", "blue");
</syntaxhighlight>}}

[[Category:String Handling Routines]][[Category:Scripting]]

File talk:Breakable equipment.jpg

2010-08-25T23:53:34Z

Heeheehee: Uhh... what?!

== THIS! IS! SPAMBOT! ==

Times this page has been spammed: 3

Now we know what happens when we protect the page that spambots like. This seems to be the new spambot page. ;) --Bale 21:29, 17 August 2010 (UTC)

Times this page has been spammed: 5 --[[User:Bale|Bale]] 06:56, 18 August 2010 (UTC)

Times this page has been spammed: 7 --[[User:Heeheehee|Heeheehee]] 23:54, 20 August 2010 (UTC)

Times this page has been spammed: 9 --[[User:Bale|Bale]] 19:14, 21 August 2010 (UTC)

Times this page has been spammed: 10 --[[User:Heeheehee|Heeheehee]] 04:13, 22 August 2010 (UTC)

Times this page has been spammed: 11 (That's ridiculous. It's not even funny. Seriously it isn't)----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 23:22, 23 August 2010 (UTC)

* You're right that it really isn't funny, but thanks to your "seriously it isn't" comment, I spit tea out my nose. So I guess it was funny after all. Either that or I just have a bad case of reverse-schadenfreude where I take delight in my own misery. --[[User:Bale|Bale]] 23:31, 23 August 2010 (UTC)

Times this page has been spammed: 12. Ok first of all, why would you spam here? Secondly, should we block this page?----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 19:54, 24 August 2010 (UTC)

* NO! We should not block this page. There was another page on this wiki (whose name escapes me since it was weird) which was spammed exclusively. We didn't use that page for anything, so we deleted it every time the spambot created it. We finally decided to protect that page 3 days before this page became the new spam lightening rod. If we protected this page, the new spambot favorite page might be one that actually gets used. That would be BAD! --[[User:Bale|Bale]] 20:53, 24 August 2010 (UTC)
** '''(ASHRM) String Handling Routines''' or something like that? But yeah, I had originally protected the page but was convinced to unprotect it because of the cool analogy (lightning rod!). It was eventually StD who reprotected it because he got sick of the spam problem. But since it's resurfaced, we really should learn to stop protecting pages. If it spreads to a new page while this one's still unprotected, then we might consider protecting pages en masse (alternative solution, pester Fewyn to restrict editing to logged-in users only, but we'd have to wait for him to respond). But okay, it's been hit 12 times in a row without any other targets coming into sight. Guess we'll have to wait another 25 before being really sure that spambots won't target any other pages. --[[User:Heeheehee|Heeheehee]] 21:23, 24 August 2010 (UTC)
***Isn't there a way to make it so that only registered users can edit pages? That would keep away lots of spam bots----[[User:Icon315|Icon315♕]] ([[User talk:Icon315|☎]]|[[Special:Contributions/Icon315|♤]]) 22:00, 24 August 2010 (UTC)
***It seems that only fewyn can change [[Special:ListGroupRights|permissions]]. --[[User:Bale|Bale]] 23:49, 24 August 2010 (UTC)
*** Yep. "(alternative solution, pester Fewyn to restrict editing to logged-in users only, but we'd have to wait for him to respond)" --[[User:Heeheehee|Heeheehee]] 05:56, 25 August 2010 (UTC)
*** We try not to bother fewyn about the wiki as much as we can get away with. Not making fewyn work except for something important is one of our guiding principles. However I think that this may be important. But what does StDoodle think? --[[User:Bale|Bale]] 07:07, 25 August 2010 (UTC)

Sorry guys, been busy lately. Here's my take:
# The original "protect this page" was equal parts frustration & experiment. The experiment was fruitful, in that we learned something, but unfortunately not what we wanted to. IE it didn't stop the spam, it just moved it. So unless anyone can think of something useful to add to that process, we should think carefully about that option. (Note: this does NOT apply if the spam moves on its own to a useful page).
# As mentioned above, this page isn't all that useful. I mean, yeah, kinda, but it's easy to make a new one for the content, and just leave this one here as a spam honeypot. (Plus, it's name isn't one that represents what I was trying to move the wiki away from, as the ASHRM one did.)
# Long-term solution would be to bug fewyn to make the changes mentioned above. I think I'm going to go ahead and do that, since we all seem to agree that it's the best idea. But I'm not going to pressure him to hurry; it looks like you guys have stayed on top of things fairly well, so no major need to have it done RIGHT NAOO.
# I'm likely to be busy for the near-to-mid future with personal junk. (Possible divorce, ew.) From this point on, I'd like to designate Bale as being officially, 100% in charge of day-to-day operations (fewyn of course keeping the "final say," when he wants it). Thanks for all of your efforts!
-- [[User:StDoodle|StDoodle]] 07:27, 25 August 2010 (UTC)

== oqNpkWoecHwzmsh ==

Isn't this cute? The spambot has created a new section with a nonsense name so that our discussion wasn't deleted. I don't know what to make of it. I'm leaving the section header here just 'cause I'm curious if future spambots will use it or create their own nonsense sections. I suspect the later.

Times this page has been spammed: 13 --[[User:Bale|Bale]] 20:12, 25 August 2010 (UTC)
: Times this page has been spammed: 14. Also, uh, what was up with the latest spam hit? --[[User:Heeheehee|Heeheehee]] 23:53, 25 August 2010 (UTC)