Kolmafia - User contributions [en]

Compiling from Source

2014-08-20T12:45:14Z

Winterbay: /* MacOSX */

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

==Windows==
# Download and install the Java Development Kit, available here: http://java.sun.com/javase/downloads/index.jsp
# Download and install Subversion, available here: http://www.collab.net/downloads/subversion/
# Download and install Tortoise SVN (or of course, another SVN program), available here: http://tortoisesvn.tigris.org/
# Download and install WinAnt, available here: http://code.google.com/p/winant/
# Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
# Copy C:/Program Files/WinAnt/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up WinAnt correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.

==Linux==

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

==MacOSX==

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

[[Category:Tech Support]]

Trigger

2012-09-29T15:04:31Z

Winterbay: Fix formatting

{{DISPLAYTITLE:trigger (CLI)}}
This is a CLI command to add triggers to your mood, or remove all triggers.

* '''trigger clear''' will remove all triggers from your mood
* '''trigger autofill''' will add triggers for all your buffing skills. This could be troublesome if you have Flavour of Magic since it will add triggers for all 5 elemental types.
* Parameters for adding a trigger are: [type,] effect [, action]
** Possible types are gain_effect, lose_effect, unconditional
** For an unconditional trigger, the effect is ignored and may be left blank, but you still need commas around that place-holder, see below.
** action is CLI command to be executed when that condition is fulfilled

For example, you can tell your mood to auto-olfact Goth Giants whenever you lose the effect "On the Trail", like this:
:<pre>trigger lose_effect, On the Trail, olfact monster Goth Giant</pre>

Example of an unconditional trigger to abort adventuring when a hunter brain has been found that you can eat:
:<pre>trigger unconditional, , ashq if(item_amount($item[hunter brain]) > 0 && my_fullness() < fullness_limit()) {abort();}</pre>

There can be no other command following trigger on a line. This is so that you can use a semi-colon to enable a multiple actions with a trigger like this:
:<pre>trigger lose_effect, Form of...Bird!, gong bird;use 5 yummy death watch beetle</pre>

[[Category:CLI Commands]]

Trigger

2012-09-29T15:04:03Z

Winterbay: Add example of unconditional trigger to make the extra comma more obvious

{{DISPLAYTITLE:trigger (CLI)}}
This is a CLI command to add triggers to your mood, or remove all triggers.

* '''trigger clear''' will remove all triggers from your mood
* '''trigger autofill''' will add triggers for all your buffing skills. This could be troublesome if you have Flavour of Magic since it will add triggers for all 5 elemental types.
* Parameters for adding a trigger are: [type,] effect [, action]
** Possible types are gain_effect, lose_effect, unconditional
** For an unconditional trigger, the effect is ignored and may be left blank, but you still need commas around that place-holder, see below.
** action is CLI command to be executed when that condition is fulfilled

For example, you can tell your mood to auto-olfact Goth Giants whenever you lose the effect "On the Trail", like this:
:<pre>trigger lose_effect, On the Trail, olfact monster Goth Giant</pre>

Example of an unconditional trigger to abort adventuring when a hunter brain has been found that you can eat:
:<pre>trigger unconditional, , ashq if(item_amount($item[hunter brain]) > 0 && my_fullness() < fullness_limit()) {abort();}

There can be no other command following trigger on a line. This is so that you can use a semi-colon to enable a multiple actions with a trigger like this:
:<pre>trigger lose_effect, Form of...Bird!, gong bird;use 5 yummy death watch beetle</pre>

[[Category:CLI Commands]]

Zlib

2012-05-09T19:27:25Z

Winterbay: /* Adventuring Functions */ Fix layout of tower_items-function

{{TOCright}}{{DISPLAYTITLE:ZLib (zlib.ash)}}
{{Attention|
This page details the use of functions in a script library. The information here is only useful to those who have followed the included steps to make use of these functions; they are not built-in to KoLmafia.
}}
== About ZLib ==
ZLib is a function library intended to make life easier for both script authors and script users. A more detailed introduction, as well as the current version and instructions on installing it, can be found in the [http://kolmafia.us/showthread.php?2072 ZLib thread].

== String 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|equals}}{{Function|
name=equals|
return_type=boolean|
parameter1={{Param|string|s1}}|
parameter2={{Param|string|s2}}|
p1desc=The first string.|
p2desc=The string to compare with s1.|
}}
Since string comparisons in ASH using == and != are case-insensitive, this function allows you to strictly compare two strings, including case sensitivity.

{{HideLink|vprint}}{{Function|
name=vprint|
return_type=boolean|
parameter1={{Param|string|message}}|
parameter2={{Param|int|level}}|
}}
{{Function|
name=vprint|
return_type=boolean|
parameter1={{Param|string|message}}|
parameter2={{Param|string|color}}|
parameter3={{Param|int|level}}|
p1desc={{pspan|message}} and {{pspan|color}} are used as in the function {{f|print}}|
p2desc={{pspan|level}} controls the return value and specifies the verbosity level of the message|
}}
This function is an enhanced version of the ASH function {{f|print}}. The {{pspan|message}} and optional {{pspan|color}} parameters are exactly like in print(), but the {{pspan|level}} parameter gives you a lot of additional control. Specifically, it allows you to control the return value, specify the verbosity level of the output, and maybe even abort the script.

First, the return value. If level is positive, it returns true. If negative, it returns false. If level is 0, vprint() will abort with the specified message. You can see now that vprint effectively replaces both {{f|abort}} and print. I recommend it as your go-to function anytime you need to show anything in the CLI, for any reason.

Having a boolean return value (as opposed to ASH's print returning void) allows you to include helpful information in your script easily, without needing to significantly edit your code. For example:
{{CodeSample|
code=
<syntaxhighlight>
// add debugging info to an if check:
if (somevar == 2 && vprint("somevar equals 2",10)) dosomething();
// add additional info to a return true/false:
if (everythingsgreat) return vprint("Everything's great!",7);
else return vprint("Everything is not great.",-7);
</syntaxhighlight>}}

Secondly, level represents the verbosity of the message. ZLib includes a script setting called "verbosity". Users can adjust this value to specify how verbose they want scripts to be. If they set it to 1, they want the script to print almost nothing -- only the most important messages. If they set it to 10, they want it to print a lot of details. The level of each vprint command thus determines whether or not the message will actually be printed. If the absolute value of level is more than verbosity, the message will not be printed. For example, a user with the default verbosity of 3 would not see any of the example messages given above. This allows users to control the chattiness of scripts, and allows authors to include helpful debugging print statements which can be shown by setting verbosity high.

'''Recommendations for Verbosity Levels in vprint()'''

0: abort error

+/- 1: absolutely essential (and non-cluttering) information -- use very sparingly, since a verbosity of 1 is basically "silent mode"

+/- 2: important and useful info -- this should generally be your base level for your most important messages

+/- 4: interesting but non-essential information

+/- 6: info which an overly curious person might like to see on their CLI

+/- 10: details which are only helpful for debugging, such as "begin/end functionname()" or "current value of variable: value"

This will allow users who want extra levels of detail printed to see that detail without cluttering the CLI for users who don't prefer to see all the details. In addition, it allows users to specify a verbosity of 0 to see ONLY mafia output (no script output at all), which could prove handy.

The color parameter is optional. If you omit it, the default color is black for positive values of level, and red for negative values. Usually, you won't be calling vprint() with the color parameter, unless you want to specify a different color or override the default colors.

{{HideLink|vprint_html}}{{Function|
name=vprint_html|
return_type=boolean|
parameter1={{Param|string|message}}|
parameter2={{Param|int|level}}|
p1desc={{pspan|message}} is used as in the function {{f|print_html}}|
p2desc={{pspan|level}} is a verbosity reference|
}}
Same as vprint() above, but wraps {{f|print_html}}.

{{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, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.|
}}
Returns {{pspan|mixvar}}, normalized to the specified KoLmafia {{pspan|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".

{{HideLink|join}}{{Function|
name=join|
return_type=string|
parameter1={{Param|string [int]|pieces|ag=t}}|
parameter2={{Param|string|glue}}|
p1desc={{pspan|pieces}} is a map of strings which you want to join into a single string.|
p2desc={{pspan|glue}} is the string to put between the pieces.|
}}
This function is the opposite of the ASH function {{f|split_string}}. It joins {{pspan|pieces}}together, inserting {{pspan|glue}} between each piece, and returns the assembly as a single string. Useful for working with comma-delimited lists (or anything-delimited lists, actually).

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

== Number Functions ==

{{HideLink|abs}}{{Function|
name=abs|
return_type=float|
parameter1={{Param|float|n}}|
p1desc={{pspan|n}} is any number.|
}}
Returns the absolute value of the number {{pspan|n}}. Don't worry if you are working with integers, it will still work just fine. This function already exists in many programming languages; ZLib makes it handily available in ASH.

{{HideLink|minmax}}{{Function|
name=minmax|
return_type=float|
parameter1={{Param|float|a}}|
parameter2={{Param|float|min}}|
parameter3={{Param|float|max}}|
p1desc={{pspan|a}} is the original number|
p2desc={{pspan|min}} is the minimum return value|
p3desc={{pspan|max}} is the maximum return value|
}}
Returns {{pspan|a}}, but no less than {{pspan|min}} and no more than {{pspan|max}}. Another function common to many languages.

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

== Script Functions ==

{{HideLink|check_version}}{{Function|
name=check_version|
return_type=string|
parameter1={{Param|string|software}}|
parameter2={{Param|string|property}}|
parameter3={{Param|string|this_version}}|
parameter4={{Param|int|thread}}|
p1desc={{pspan|software}} is the script name, which must match the page source of the {{pspan|thread}} being parsed|
p2desc={{pspan|property}} is used as part of the name of the property saved to user preferences|
p3desc={{pspan|this_version}} is the version of the script currently running|
p4desc={{pspan|thread}} is the script's thread-number on kolmafia.us|
}}
Server-friendly once-daily version-checking. If the user hasn't checked yet today, visits the specified {{pspan|thread}} on the kolmafia.us forums to find the current version of your script. The thread must include <nowiki>"</nowiki>{{pspan|software}} {{pspan|version}}<nowiki>"</nowiki> for the version info to be successfully parsed. Optionally, you may include <nowiki>"[requires revision XXXX]"</nowiki> somewhere in your post if you want to indicate a required minimum revision of mafia. If a new version is available, it alerts the user in large text and provides an update link. The return value is a blank string unless an update is found, in which case it is a <nowiki><div class='versioninfo'></nowiki> containing the update message. This allows this function to work equally well for relay scripts. The current version (and the last date checked) is stored in a data file "zversions.txt". Example:
{{CodeSample|
code=
<syntaxhighlight>
check_version("Hardcore Checklist","checklist","1.2.7",1045);
</syntaxhighlight>}}

{{HideLink|load_current_map}}{{Function|
name=load_current_map|
return_type=boolean|
parameter1={{Param|string|map_name}}|
parameter2={{Param|aggregate|destination}}|
p1desc={{pspan|map_name}} is the name of the map, without the file extension|
p2desc={{pspan|destination}} is a previously-declared map to load with data|
}}
Acts as a wrapper for the built-in {{f|file_to_map}} with automatic update capability. The first time the function is called for a given map each day, it will check [http://zachbardon.com/mafiatools/autoupdate.php Zarqon's Map Manager] to see if an update for the given {{pspan|map_name}} is available, and if so will load from there. Otherwise, it merely loads it from disk. (Note: you should not include a file extension, such as ".txt" in the {{pspan|map_name}} parameter.)

{{HideLink|setvar}}{{Function|
name=setvar|
return_type=void|
parameter1={{Param|string|name}}|
parameter2={{Param|mixed|dfault}}|
p1desc={{pspan|name}} is the name of the setting|
p1desc={{pspan|dfault}} can be any primitive or ASH type (e.g. item, effect, coinmaster, etc.), but not an array, map, or record.|
}}
This function ensures that a ZLib script setting called {{pspan|name}} exists. If not, it creates it and sets it to {{pspan|default}}. If the setting already exists, it does nothing. Note that this function does not edit existing settings. That is done by calling ZLib in the CLI.

==== For Users ====

* Script settings are now all saved in one place, separate from mafia properties. I've read more than one post wishing that script-defined settings and mafia properties would be separate. This provides a solution.
* Script settings are independent from scripts. This means that you will no longer need to edit scripts to adjust your settings. Further, when you download a script update, the script will still use your saved settings and you won't need to reset them!
* To see all of your current settings, type "zlib vars" in the CLI. You can also type "zlib <whatever>" to see a list of current settings and values containing <whatever>. To change a setting, type "zlib settingname = value". If you're adjusting threshold, you can use "up" or "down" as the value to adjust your threshold relatively. This is almost exactly as convenient as mafia settings (possibly more so since you don't need to open a text file to find setting names!).
* If for some reason you prefer to open a text file, ZLib settings are stored in a file called vars_myname.txt in your data directory.
* Scripts that use Zlib script settings will only create these settings when you run them for the first time. Attempting to edit a nonexisting setting won't work, so you'll need to run a script once (then, usually, mash the ESC key before it actually does anything) before you can configure it. Script documentation should tell you which settings to change to get your desired behavior.

==== For Script Authors ====

* Script settings may now be used across scripts, in exactly the same way that mafia properties are. Basically, this works almost exactly like mafia properties, except that new settings can only be created by setvar() or manually editing the file ("zlib nonexistentsetting = value" will fail).
* Settings are only stored if you run a script that defines/uses them. So your settings file will not contain any extraneous unused settings.
* Script authors can now test for a setting's existence, which means you can check to see if a user has used a given script. It's almost as good as a script_exists() function. This can allow scripts to work together with other scripts, if they exist!
* Scripts with overlapping or related functionality can be designed to access a single shared setting, in much the same way that my scripts have until now all shared a "threshold" mafia setting. Changing a single setting can now change the behavior of every script that accesses that setting.

==== Functional Details ====

When importing ZLib, it loads a map of your script settings from vars_myname.txt. It is a basic string[string] map called vars. To access a script setting within an ASH script, use vars[varname]. To check if a setting exists you can simply use if (vars contains varname).

When a script calls setvar("threshold",4), ZLib checks to see if a variable called "threshold" already exists in vars. If so, since dfault is an integer, it ensures that the value is an integer using normalize() (saving changes if necessary), but unless normalization changed the value, nothing else happens. If "threshold" does not exist in vars, it creates it, sets it to 4, and saves the updated map back to vars_myname.txt.

==== Choosing Setting Names ====

The file of script settings will contain all script settings, sorted alphabetically. Also, there is no way to detect if a setting is unused, so if you decide to change the name, the old setting will never be deleted. '''Please think carefully about your setting names.''' If you have a setting named "setting1", a user will probably not have a clue which script that is for or what it does. True, this can be overcome with documentation, but it is far better to have settings that make sense just by looking at them.

'''Recommendations:'''

1. Use a name that clearly identifies what the setting is/does.

2. Prefix your setting names with a script identifier. For example, here are some of my One-Click Wossname script settings:

{{CodeSample|
code=
<syntaxhighlight>
setvar("ocw_warplan","optimal");
setvar("ocw_change_to_meat",true);
setvar("ocw_nunspeed",false);
setvar("defaultoutfit","current");
setvar("ocw_f_default","zombie");
setvar("ocw_m_default","");
</syntaxhighlight>}}
Those settings which are specific to OCW are prefixed with "ocw_" so as to be found together in the settings file. However, some of the settings are usable across scripts, and are not so prefixed. For example, the "defaultoutfit" will be used by nearly all of my adventuring scripts that swap outfits, so no prefix is given.

== Adventuring Functions ==

{{HideLink|be_good}}{{Function|
name=be_good|
return_type=boolean|
parameter1={{Param|string|johnny}}|
p1desc={{pspan|johnny}} is the thing you want to check -- usually an item or familiar|
}}
This function, originally created to check whether items were allowed in the Bees Hate You path, has been expanded to an all-purpose check to see whether something is acceptable in your current path. For example, in a Trendy path, outdated items would not be_good. Likewise, during Bees Hate You, a familiar containing a 'b' would not be_good. In Fistcore, anything you hold in your hands is not allowed. And so forth.

{{HideLink|tower_items}}{{Function|
name=tower_items|
aggregate=true|
return_type=boolean [string]|
}}
{{Function|
name=tower_items|
aggregate=true|
return_type=boolean [string]|
parameter1={{Param|boolean|combat_safe}}|
p1desc={{pspan|combat_safe}} is optional. Supply it as true if you are in combat.|
}}
This handy function returns a map of the items you definitely need (value: true) or might need (value: false) to climb the tower. You can check (tower_items() contains X) to determine whether an item has a nonzero chance of being required for the tower, or check tower_items(X) to determine whether an item has a 100% chance of being needed (i.e. it was indicated necessary by your telescope). If you haven't yet checked your telescope yet this run, it will also do that to populate the relevant mafia properties, unless you have supplied the optional {{pspan|combat_safe}} parameter as true (you can't access your telescope during combat).

{{HideLink|have_item}}{{Function|
name=have_item|
return_type=int|
parameter1={{Param|string|to_lookup}}|
p1desc={{pspan|to_lookup}} is the item to count|
}}
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. Similar but not equivalent to the ASH function {{f|available_amount}}, since this function completely ignores your closet and storage.

{{HideLink|isxpartof}}{{Function|
name=isxpartof|
return_type=float|
parameter1={{Param|item|child}}|
parameter2={{Param|item|ancestor}}|
p1desc={{pspan|child}} is the ingredient/component you want to check.|
p2desc={{pspan|ancestor}} is the concoction you want to check.|
}}
In the sentence "child is X part of ancestor", this function returns X. It assumes the minimum amount of other ingredients necessary. For example, isxpartof($item[white pixel], $item[digital key]) returns 0.033333335 (1/30), since 30 white pixels are needed. However, isxpartof($item[red pixel], $item[digital key]) returns 0.03125 (1/32), assuming 1 each of green and blue pixels and 29 other white pixels (rather than 30 each RGB pixels -- 1/90). This function is used by has_goal(item) but may have uses in your own script.

{{HideLink|has_goal}}{{Function|
name=has_goal|
return_type=float|
parameter1={{Param|item|check_me}}|
}}
{{Function|
name=has_goal|
return_type=float|
parameter1={{Param|monster|check_me}}|
}}
{{Function|
name=has_goal|
return_type=float|
parameter1={{Param|location|check_me}}|
p1desc={{pspan|check_me}} is the item, monster or locationto check|
}}
At the base of this function is the item parameter version, which returns the chance that the item {{pspan|check_me}} is or results in a goal. If the item is itself a goal or it's your current bounty item, returns 1.0. Otherwise, returns what percentage of a goal the item is, which could be nonzero in two cases: 1) you could get a goal by using the item (returns the chance of success), or 2) the item is an ingredient of a goal. For example, with a goal of black pepper, has_goal($item[black picnic basket]) would return 0.58.

When supplied a monster as the parameter for {{pspan|check_me}}, returns the percent chance that encountering the 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.

When supplied a location as the parameter for {{pspan|check_me}}, 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.

These functions also have an optional boolean parameter, usespec. If supplied as true, these functions will use speculative values. (See "whatif")

{{HideLink|obtain}}{{Function|
name=obtain|
return_type=boolean|
parameter1={{Param|int|qty}}|
parameter2={{Param|string|condition}}|
parameter3={{Param|location|place}}|
}}
{{Function|
name=obtain|
return_type=boolean|
parameter1={{Param|int|qty}}|
parameter2={{Param|string|condition}}|
parameter3={{Param|location|place}}|
parameter4={{Param|string|filter}}|
p1desc={{pspan|qty}} is the quantity of the item or choice adventure desired|
p2desc={{pspan|condition}} is the item or choice adventure to use as a goal|
p3desc={{pspan|location}} is the place to adventure to obtain your goal|
p4desc={{pspan|filter}} is an optional combat filter used the same as in {{f|adventure}}|
}}
Attempts to get {{pspan|qty}} (minus existing) of {{pspan|condition}}, either by purchasing (if you have the KoLmafia preference set), pulling from Hangk's, or adventuring at the specified {{pspan|place}}. It also works with choice adventures.

{{HideLink|use_upto}}{{Function|
name=use_upto|
return_type=boolean|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|thing}}|
parameter3={{Param|boolean|purchase}}|
p1desc={{pspan|qty}} is the quantity to use|
p2desc={{pspan|thing}} is the item to use|
p3desc={{pspan|purchase}} is true if KoLmafia should purchase extras if you don't already have {{pspan|qty}}|
}}
Gets (if purchase is true) and uses {{pspan|qty}} of the item(s) {{pspan|thing}} if possible. Otherwise, uses as many as you have up to {{pspan|qty}}.

{{HideLink|resist}}{{Function|
name=resist|
return_type=boolean|
parameter1={{Param|element|resist_it}}|
parameter2={{Param|boolean|really}}|
p1desc={{pspan|resist_it}} is the element to resist|
p2desc={{pspan|really}} is true to actually attemp resistance, false to check only|
}}
Returns whether you are able to resist a given element {{pspan|resist_it}}, or if {{pspan|really}} is true, attempts to actually achieve that resistance (casting buffs, changing gear, or equipping your Exotic Parrot) and returns its success.

{{HideLink|my_defstat}}{{Function|
name=my_defstat|
return_type=int|
parameter1={{Param|boolean|usespec}}|
p1desc={{pspan|usespec}} is optional. If true, uses speculative values rather than real values.|
}}
Returns the value of your buffed defense stat, taking into account Hero of the Half-Shell.

{{HideLink|get_safemox}}{{Function|
name=get_safemox|
return_type=int|
parameter1={{Param|location|where}}|
p1desc={{pspan|where}} is the location to check for safe moxie|
}}
Using mafia's location/monster data, returns the safe moxie of a given zone {{pspan|where}}.

{{HideLink|auto_mcd}}{{Function|
name=auto_mcd|
return_type=boolean|
parameter1={{Param|int|check_me}}|
}}
{{Function|
name=auto_mcd|
return_type=boolean|
parameter1={{Param|monster|check_me}}|
}}
{{Function|
name=auto_mcd|
return_type=boolean|
parameter1={{Param|location|check_me}}|
p1desc={{pspan|check_me}} is the int, monster or location to check|
}}
If your ZLib setting "automcd" is true, automatically adjusts your mind-control device for maximum stat gains based on safe moxie and your ZLib "threshold" setting. Does not adjust for MCD-sensitive areas (certain bosses, Slime Tube), or areas with no known combats. Returns true unless KoLmafia is unable to do so, even though the script thinks it should be capable (still returns true if you can't currently access an mcd-changing device).

{{HideLink|best_fam}}{{Function|
name=best_fam|
return_type=familiar|
parameter1={{Param|string|type}}|
p1desc={{pspan|type}} is the type of familiar ability to check for|
}}
Returns your heaviest familiar of a given type (currently possible: items, meat, produce, stat, delevel). If your ZLib "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).

== Kmail Functions ==

{{HideLink|load_kmail}}{{Function|
name=load_kmail|
return_type=void|
parameter1={{Param|string|calledby}}|
p1desc={{pspan|calledby}} is optional and allows you to specify the name of the script calling this function, which will be submitted when the script visits api.php. The default value is "ZLib-powered-script".|
}}
This function parses your kmail inbox in a single server hit and loads it into the global variable "mail", which is of type kmessage[int]. A kmessage is a record type, with the following fields:
{{CodeSample|
code=
<syntaxhighlight>
record kmessage {
int id; // message id
string type; // possible values observed thus far: normal, giftshop
int fromid; // sender's playerid (0 for npc's)
int azunixtime; // KoL server's unix timestamp
string message; // message (not including items/meat)
int[item] items; // items included in the message
int meat; // meat included in the message
string fromname; // sender's playername
string localtime; // your local time according to your KoL account, human-readable string
};
</syntaxhighlight>}}

Thus, after calling this function your inbox is very easy to work with. You can foreach over each message if you like, accessing the fields for details.

{{HideLink|process_kmail}}{{Function|
name=process_kmail|
return_type=void|
parameter1={{Param|string|functionname}}|
p1desc={{pspan|functionname}} specifies the name of a function designed to parse kmail.|
}}
If you liked load_kmail(), you'll like this even better. First off, this function loads your kmail into the mail variable if you haven't already done so. Next, it calls a function named {{pspan|functionname}} on each kmail message. The function must be at top level, accept a single kmessage parameter, and return a boolean. For each kmail in your inbox, if the called function returns true, that message will be deleted once all messages have been processed.

Here's a simple example which will delete all messages from your lovely Pen Pal:
{{CodeSample|
code=
<syntaxhighlight>
boolean no_penpal(kmessage m) {
if (m.fromname == "Your Pen Pal") return true;
return false;
}
process_kmail("no_penpal");
</syntaxhighlight>}}

{{HideLink|send_gift}}{{Function|
name=send_gift|
return_type=boolean|
parameter1={{Param|string|recipient}}|
parameter2={{Param|string|message}}|
parameter3={{Param|int_meat}}|
parameter4={{Param|int [item]|goodies|ag=t}}|
}}
{{Function|
name=send_gift|
return_type=boolean|
parameter1={{Param|string|recipient}}|
parameter2={{Param|string|message}}|
parameter3={{Param|int|meat}}|
parameter4={{Param|int [item]|goodies|ag=t}}|
parameter5={{Param|string|inside_note}}|
p1desc={{pspan|recipient}} is the player to send to|
p2desc={{pspan|message}} is the outside message|
p3desc={{pspan|meat}} is the amount of meat to send|
p4desc={{pspan|goodies}} is a map of items & amounts to send|
p5desc={{pspan|inside_note}} is an optional inside message|
}}
Sends a gift to a player. Able to split large amounts of items. Returns true if the package is sent and false if not. See kmail() below.

{{HideLink|kmail}}{{Function|
name=kmail|
return_type=boolean|
parameter1={{Param|string|recipient}}|
parameter2={{Param|string|message}}|
parameter3={{Param|int_meat}}|
}}
{{Function|
name=kmail|
return_type=boolean|
parameter1={{Param|string|recipient}}|
parameter2={{Param|string|message}}|
parameter3={{Param|int_meat}}|
parameter4={{Param|int [item]|goodies|ag=t}}|
}}
{{Function|
name=kmail|
return_type=boolean|
parameter1={{Param|string|recipient}}|
parameter2={{Param|string|message}}|
parameter3={{Param|int|meat}}|
parameter4={{Param|int [item]|goodies|ag=t}}|
parameter5={{Param|string|inside_note}}|
p1desc={{pspan|recipient}} is the player to send to|
p2desc={{pspan|message}} is the outside message|
p3desc={{pspan|meat}} is the amount of meat to send|
p4desc={{pspan|goodies}} is an optional map of items & amounts to send|
p5desc={{pspan|inside_note}} is an optional inside message if sent as a gift|
}}
{{Function|
name=kmail|
return_type=boolean|
parameter1={{Param|kmessage|km}}|
p1desc={{pspan|km}} allows you to send a kmail supplied in kmessage format. The only thing unusual here is that the "fromname" field will be used as the recipient. The other fields will be used appropriately to call the above kmail function.|
}}
Sends a kmail to player {{pspan|recipient}}, returning true if the kmail is successfully sent. Handles splitting the {{pspan|message}} into multiple messages if the number of item types in {{pspan|goodies}} is too large. Returns the result of send_gift() if the intended {{pspan|recipient}} is unable to receive the {{pspan|message}} due to being in HC or somesuch. Note that you can also specify the {{pspan|inside_note}} to be used inside gifts in that case. Use "\n" to specify a new line in the {{pspan|message}}.

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

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

Auto-stops

2011-07-21T12:17:15Z

Winterbay: Adding missing auto-stop

Auto-stops are places where mafia's automation will automatically stop, just as the name suggests. Except for the Ultra-Rare monsters, these are all KoL non-combats. If mafia detects one of these auto-stop non-combats then automation will cease immediately after the encounter.

There is just one trick to using auto-stops: mafia will only auto-stop when there are no conditions set (although it will always auto-stop on Ultra-Rare monsters). If conditions are set then mafia will continue automation until it reaches those conditions and stop normally. This is to prevent auto-stops from interfering with regular automation.

* Sleazy Back Alley: {{kolwiki|Under the Knife}} (only if the corresponding choice adventure setting is set to "switch genders".)
* The Haunted Pantry: {{kolwiki|The Manor in Which You're Accustomed}}
* The Ruins of Fernswarthy's Tower: {{kolwiki|Take a Dusty Look!}}
* Misspelled Cemetary: {{kolwiki|A Grave Situation}}
* Haunted Library: {{kolwiki|Take a Look, it's in a Book! (Rise)|Rise}} and {{kolwiki|Take a Look, it's in a Book! (Fall)|Fall}} of Take a Look, it's in a Book!
* Whitey's Grove: {{kolwiki|It's A Sign!}}
* Teleportitis: {{kolwiki|The Oracle Will See You Now}}
* Barrrney's Barrr:
*# {{kolwiki|This Adventure Bites}}
*# {{kolwiki|Step Up to the Table, Put the Ball in Play}}
* The Poop Deck: {{kolwiki|It's Always Swordfish}}
* The Palindome: {{kolwiki|Drawn Onward}}
* The Laboratory: {{kolwiki|Mr. Alarm}}
* The Haunted Ballroom: {{kolwiki|We'll All Be Flat}}
* Arid, Extra-Dry Desert: Auto-stops every time you need to start adventuring at the Oasis or if you need to get an item:
*# {{kolwiki|Let's Make a Deal!}} (Before you find the Oasis and get Ultrahydrated.)
*# {{kolwiki|A Sietch in Time}}
*# {{kolwiki|No Colors Anymore}} (without can of black paint). With paint, adventuring continues to Walk Without Rhythm.
*# {{kolwiki|Walk Without Rhythm}}
*# {{kolwiki|Walk Without Rhythm 2}} (Only occurs if you didn't have a drum machine at previous auto-stop.)
*# {{kolwiki|The Sleeper Has Awakened}}
* Orcish Frat House: {{kolwiki|I Just Wanna Fly}}
* The Orcish Frat House (Bombed Back to the Stone Age): {{kolwiki|Me Just Want Fly}}
* The Mer-Kin Outpost: {{kolwiki| Granny, Does Your Dogfish Bite?}}
* Anemone Mine: {{kolwiki| Not a Micro Fish}}
* '''Bad Moon''': All special Bad Moon adventures {{kolwiki|Bad_Moon|listed here|#Special_Adventures}}.
* Agua de vida: Auto-stop when a bottle is consumed.
* Auto-stop when a demon name is learned and opens mini-browser to display it.
* Auto-stop when a hobo code is learned and opens mini-browser to display it.
* Auto-stop when an Ultra Rare adventure is encountered and opens mini-browser to display it.

{{CodeSample|description=Unlocking the White Citadel can make use of the auto-stop to be this simple.|
code=<syntaxhighlight>
adventure( my_adventures(), $location[whitey's grove] );
adventure( my_adventures(), $location[white citadel );
</syntaxhighlight>}}
{{CodeSample|description=Unlocking the Pyramid, using the magic of auto-stops. Note that this assumes you have enough adventures to complete it. A better script would check the questlog to verify current quest progress before beginning adventuring.|
code=<syntaxhighlight>
cli_execute("condition clear"); # conditions must be clear or stops won't be automatic.
# Adventure until: A Sietch in Time
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
cli_execute("condition set 1 stone rose, 1 drum machine");
adventure( my_adventures(), $location[Oasis] );
# Adventure until: Walk Without Rhythm
retrieve_item(1, $item[can of black paint]);
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
cli_execute("condition set worm-riding manual pages 3-15");
adventure( my_adventures(), $location[Oasis] );
# Adventure until: The Sleeper Has Awakened
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
# Equip wormhooks, use drum machine and then re-equip original weapon.
cli_execute("checkpoint; equip worm hooks; use drum machine; outfit checkpoint");
</syntaxhighlight>}}

[[Category:Automation]]

Last index of

2011-07-06T21:53:04Z

Winterbay: Adding three parameter version

{{
#vardefine:name|last_index_of}}{{
#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|string|search}}|
parameter2={{Param|string|find}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|search}}|
parameter2={{Param|string|find}}|
parameter3={{Param|int|end}}|
p1desc={{Pspan|search}} in the string to search in|
p2desc={{Pspan|find}} is the string you're trying to find|
p3desc={{Pspan|end}} is the (optional) ending position (i.e. where the string is truncated before the search is performed)|
}}|

function_description=This function searches through the string {{pspan|search}}, looking for the string {{pspan|find}}. This function returns the position where {{pspan|find}} last occurs in {{pspan|search}}. This function returns a 0-indexed value, meaning that the first character of {{pspan|search}} counts as 0.|

code1={{CodeSample|
title=Code Sample|
description=Returns the last instance of the phrase "la" in the following phrase.|
code=
<syntaxhighlight>
last_index_of( "I'm not listening, la la la la" , "la" );
</syntaxhighlight>|
moreinfo=
Would result in:
<pre>Returned: 28</pre>
}}|

code2={{CodeSample|
description=Returns the last instance of the phrase "la", ignoring the last three characters.|
code=
<syntaxhighlight>
string example = "I'm not listening, la la la la";
last_index_of( example , "la" , length(example) - 3 );
</syntaxhighlight>|
moreinfo=
Would result in:
<pre>
Returned: 25
</pre>}}|

see_also={{SeeAlso|index_of}}|
special=If {{pspan|find}} does not occur in {{pspan|search}}, this function returns -1.|
}}

[[Category:String Handling Routines]]

KoLmafia Properties

2011-01-27T10:31:52Z

Winterbay: /* Per-Account Variables */ I doubt that the default value for _gapBuffs is "Greatest American Pants buffs"...

{{TOCright}}
Inside your KoLmafia "settings" directory, you should find several files. KoLmafia properties are stored in the files that end with "_prefs.txt". One of these files will start with "GLOBAL"; the settings inside are shared by all characters using the program (and some of these properties are needed by KoLmafia even when no character is logged in). The other files ending with "_prefs.txt" will start with the name of a character, one for each who has been logged in to date. (Note: the names will all be converted to lowercase.)

==Choice Adventures==
A large number of the preferences saved by KoLmafia are used to determine the default behavior when a choice adventure is automated (either through auto-adventuring or use of the "auto" button in the relay browser). The number of choice adventures in KoL is too large and too often updated to list each individual preference here. Please consult the main wiki's [http://kol.coldfront.net/thekolwiki/index.php/Choice_Adventures_by_Number Choice Adventures by Number] page for a comprehensive list. Note that each preference follows the same numbering scheme as KoL itself. For example, the adventure "Minnesota Incorporeals" is number 77 in KoL, and its KoLmafia preference is "choiceAdventure77".

Each choiceAdventure is set to a number, which corresponds to which choice you want to make from the available options in KoL (or in the GUI, in the case that mafia provides more options than KoL). According to Holatuwol ([http://kolmafia.us/index.php/topic,1155.0.html here]), the settings map to "X=pick the Xth Option" and "X+1=pick an item you don't have" (i.e., complete the outfit). Many preferences also have a "Show in [Mini] Browser" option, which corresponds to a setting of 0.

This is a list of all the Property variables included in KoLmafia. It was automatically generated from r7582. Note that, however, the latest (and most up-to-date) data is located in Mafia's internally-stored datafile defaults.txt (available for viewing at [https://kolmafia.svn.sourceforge.net/svnroot/kolmafia/src/data/defaults.txt the SourceForge page]).

==Global Variables==
{| class="wikitable" border="1"
|-
! Variable Name
! scope="col" width="300" | Default Value
! Notes
|-
| addChatCommandLine
| false
|
|-
| addCreationQueue
| true
|
|-
| addStatusBarToFrames
| false
|
|-
| allowCloseableDesktopTabs
| false
|
|-
| allowNegativeTally
| true
|
|-
| allowNonMoodBurning
| true
|
|-
| alwaysGetBreakfast
| false
|
|-
| autoLogin
|
|
|-
| allowSocketTimeout
| true
|
|-
| autoHighlightOnFocus
| true
|
|-
| autoPlantHardcore
| false
|
|-
| autoPlantSoftcore
| false
|
|-
| autoSatisfyWithCloset
| true
|
|-
| autoSatisfyWithMall
| true
|
|-
| autoSatisfyWithNPCs
| true
|
|-
| autoSatisfyWithStash
| false
|
|-
| breakfastHardcore
| Advanced Saucecrafting,Pastamastery,Advanced Cocktailcrafting
|
|-
| breakfastSoftcore
| Advanced Saucecrafting,Pastamastery,Advanced Cocktailcrafting
|
|-
| browserBookmarks
|
|
|-
| cacheMallSearches
| false
|
|-
| charsheetDropdown
| 1
|
|-
| chatBeep
| false
| Beep on private message in chat
|-
| chatFontSize
|
|
|-
| chatLinksUseRelay
| false
|
|-
| chatStyle
| 0
|
|-
| cloverProtectActive
| true
|
|-
| combatHotkey0
|
|
|-
| combatHotkey1
|
|
|-
| combatHotkey2
|
|
|-
| combatHotkey3
|
|
|-
| combatHotkey4
|
|
|-
| combatHotkey5
|
|
|-
| combatHotkey6
|
|
|-
| combatHotkey7
|
|
|-
| combatHotkey8
|
|
|-
| combatHotkey9
|
|
|-
| commandLineNamespace
|
|
|-
| connectViaAddress
| false
|
|-
| cookies.inventory
|
|
|-
| copyAsHTML
| false
|
|-
| createHackerSummons
| true
|
|-
| customizedTabs
| false
|
|-
| debugPathnames
| true
|
|-
| defaultBorderColor
| blue
|
|-
| defaultDropdown1
| 0
|
|-
| defaultDropdown2
| 1
|
|-
| defaultDropdownSplit
| 0
|
|-
| defaultLimit
| 5
|
|-
| defaultLoginServer
| 1
|
|-
| displayName
|
|
|-
| eSoluScriptType
| 0
|
|-
| getBreakfast
|
|
|-
| grabCloversHardcore
| false
|
|-
| grabCloversSoftcore
| true
|
|-
| greenScreenProtection
| false
|
|-
| grimoireSkillsHardcore
| none
|
|-
| grimoireSkillsSoftcore
| Summon Hilarious Objects
|
|-
| guiUsesOneWindow
| false
|
|-
| harvestGardenHardcore
| none
| The crop that breakfast will harvest, if in your garden.
|-
| harvestGardenSoftcore
| none
| The crop that breakfast will harvest, if in your garden.
|-
| hideServerDebugText
| false
|
|-
| highlightList
|
|
|-
| http.proxyHost
|
|
|-
| http.proxyPassword
|
|
|-
| http.proxyPort
|
|
|-
| http.proxyUser
|
|
|-
| initialDesktop
| AdventureFrame,CommandDisplayFrame, MallSearchFrame,GearChangeFrame,SkillBuffFrame
| starting tab configuration
|-
| initialFrames
| RecentEventsFrame
|
|-
| innerChatColor
| #ffa98c
|
|-
| innerTabColor
| #8ca9ff
|
|-
| itemManagerIndex
| 0
|
|-
| lastBuffRequestType
| 0
|
|-
| lastRelayUpdate
|
|
|-
| lastRssUpdate
| 0
|
|-
| lastRssVersion
|
|
|-
| lastUserAgent
|
|
|-
| lastUsername
|
|
|-
| libramSkillsHardcore
| none
|
|-
| libramSkillsSoftcore
| none
|
|-
| logAcquiredItems
| true
|
|-
| logBattleAction
| true
|
|-
| logBrowserInteractions
| false
|
|-
| logChatMessages
| true
|
|-
| logDecoratedResponses
| false
|
|-
| logFamiliarActions
| false
|
|-
| logGainMessages
| true
|
|-
| logReadableHTML
| false
|
|-
| loginRecoveryHardcore
| false
|
|-
| loginRecoverySoftcore
| true
|
|-
| loginScript
|
|
|-
| loginServerName
|
|
|-
| loginWindowLogo
| lantern.jpg
|
|-
| logMonsterHealth
| false
|
|-
| logoutScript
|
|
|-
| logReverseOrder
| false
|
|-
| logStatGains
| true
|
|-
| logStatusEffects
| false
|
|-
| logStatusOnLogin
| false
|
|-
| mementoListActive
| false
|
|-
| mergeHobopolisChat
| false
|
|-
| outerChatColor
| #b4460f
|
|-
| outerTabColor
| #0f46b4
|
|-
| pathedSummonsHardcore
| true
|
|-
| pathedSummonsSoftcore
| false
|
|-
| preferredWebBrowser
|
|
|-
| previousNotifyList
| <>
|
|-
| previousUpdateVersion
|
|
|-
| protectAgainstOverdrink
| true
|
|-
| proxySet
| false
|
|-
| readManualHardcore
| true
|
|-
| readManualSoftcore
| true
|
|-
| relayAddsCustomCombat
| true
|
|-
| relayAddsGraphicalCLI
| false
|
|-
| relayAddsKoLSimulator
| false
|
|-
| relayAddsQuickScripts
| false
|
|-
| relayAddsRestoreLinks
| true
|
|-
| relayAddsRoundNumber
| false
|
|-
| relayAddsUpArrowLinks
| true
|
|-
| relayAddsUseLinks
| true
|
|-
| relayAddsWikiLinks
| false
|
|-
| relayAllowsOverrides
| false
|
|-
| relayBrowserOnly
| false
|
|-
| relayBrowserOnly
| false
|
|-
| relayFormatsChatText
| true
|
|-
| relayHidesJunkMallItems
| true
|
|-
| relayMaintainsEffects
| false
|
|-
| relayMaintainsHealth
| true
|
|-
| relayMaintainsMana
| false
|
|-
| relayTextualizesEffects
| false
|
|-
| relayTrimsZapList
| true
|
|-
| relayUsesCachedImages
| false
|
|-
| relayUsesInlineLinks
| false
|
|-
| relayUsesIntegratedChat
| false
|
|-
| relayViewsCustomItems
| false
|
|-
| removeMalignantEffects
| true
|
|-
| saveSettingsOnSet
| true
|
|-
| saveState
|
|
|-
| saveStateActive
|
|
|-
| scriptButtonPosition
| 0
|
|-
| scriptList
| restore hp | restore mp
|
|-
| showAllRequests
| false
|
|-
| stealthLogin
| true
|
|-
| swingLookAndFeel
|
|
|-
| switchEquipmentForBuffs
| true
|
|-
| tomeSkillsHardcore
| Summon Snowcone
|
|-
| tomeSkillsSoftcore
| Summon Snowcone
|
|-
| toolbarPosition
| 1
|
|-
| useChatMonitor
| false
|
|-
| useChatToolbar
| true
|
|-
| useContactsFrame
| true
|
|-
| useCrimboToysHardcore
| false
|
|-
| useCrimboToysSoftcore
| true
|
|-
| useDecoratedTabs
|
|
|-
| useLastUserAgent
| false
|
|-
| useSeparateChannels
| true
|
|-
| useShinyTabbedChat
| true
|
|-
| useSystemTrayIcon
| false
|
|-
| useTabbedChatFrame
| true
|
|-
| useToolbars
| true
|
|-
| useZoneComboBox
| false
|
|-
| userAgent
|
|
|-
| visitLoungeHardcore
| true
|
|-
| visitLoungeSoftcore
| true
|
|-
| visitRumpusHardcore
| true
|
|-
| visitRumpusSoftcore
| true
|
|}

==Per-Account Variables==
Choice adventure preferences have been omitted (see above).
{| class="wikitable" border="1"
|-
! Variable Name
! scope="col" width="300" | Default Value
! Notes
|-
| autoAbortThreshold
| -0.05
| Abort adventuring at this percentage of HP. (-0.05 means if HP restoration failed)
|-
| autoAntidote
| 0
| Use antidotes in combat
|-
| autoBuyPriceLimit
| 20000
| Don't auto purchase anything that costs more than this
|-
| autoEntangle
| false
| Use Entangling Noodles at the beginning of combat
|-
| autoManaRestore
| true
| Restore MP in combat
|-
| autoOlfact
|
| Automatically cast Olfaction
|-
| autoPotionID
| false
| Attempt to ID ! potions in combat
|-
| autoPutty
|
| Automatically use Spooky Putty
|-
| autoRepairBoxServants
| true
| Create in-a-boxen before cooking or mixing
|-
| autoSphereID
| false
| Attempt to ID spheres from the Hidden City
|-
| autoSteal
| true
| Attempt to pickpocket in combat
|-
| autostartGalaktikQuest
| true
| Get Doc Galaktik's Quest at the start of ascension
|-
| availableDimes
| 0
|
|-
| availableLucre
| 0
|
|-
| availableQuarters
| 0
|
|-
| availableSandDollars
| 0
|
|-
| barrelGoal
| 1
|
|-
| barrelLayout
| ?????????
|
|-
| basementMallPrices
| 1
|
|-
| battleAction
| attack with weapon
|
|-
| betweenBattleScript
|
|
|-
| birdformCold
| 0
|
|-
| birdformHot
| 0
|
|-
| birdformRoc
| 0
|
|-
| birdformSleaze
| 0
|
|-
| birdformSpooky
| 0
|
|-
| birdformStench
| 0
|
|-
| blackPuddingsDefeated
| 0
|
|-
| blankOutUsed
| 0
| Tracks current amount of active Blank-out
|-
| breakfastCompleted
| false
|
|-
| buffBotCasting
|
|
|-
| buffBotMessageDisposal
| 0
|
|-
| buffBotPhilanthropyType
| 1
|
|-
| burrowgrubHiveUsed
| false
|
|-
| burrowgrubSummonsRemaining
| 0
|
|-
| buyScript
|
|
|-
| cameraMonster
|
|
|-
| cellarLayout
| 0
|
|-
| chatbotScript
|
|
|-
| chatbotScriptExecuted
| false
|
|-
| chosenTrip
|
|
|-
| clanAttacksEnabled
| false
|
|-
| cocktailSummons
| 0
|
|-
| concertVisited
| false
|
|-
| currentBountyItem
| 0
|
|-
| currentFullness
| 0
|
|-
| currentHippyStore
| none
|
|-
| currentJunkyardTool
|
|
|-
| currentJunkyardLocation
|
|
|-
| currentMojoFilters
| 0
|
|-
| currentMood
| default
|
|-
| currentNunneryMeat
| 0
|
|-
| currentPvpVictories
|
|
|-
| currentSpleenUse
| 0
|
|-
| currentWheelPosition
| muscle
|
|-
| customCombatScript
| default
|
|-
| dailyDungeonDone
| false
|
|-
| defaultAutoAttack
| 0
|
|-
| defaultFlowerLossMessage
|
|
|-
| defaultFlowerWinMessage
|
|
|-
| demonName1
|
| Name of demon that gives pies
|-
| demonName2
|
| Name of demon that gives Preternatural Greed
|-
| demonName3
|
| Name of demon that gives Fit To Be Tide
|-
| demonName4
|
| Name of demon that gives Big Flaming Whip
|-
| demonName5
|
| Name of demon that gives Demonic Taint
|-
| demonName6
| Tatter
| Name of demon that gives pile of smoking rags
|-
| demonName7
| Ak'gyxoth
| Name of demon that gives drinks
|-
| demonName8
|
| Name of demon found in the Nemesis' Lair
|-
| demonName9
|
| Name of demon that gives Burning, Man
|-
| demonSummoned
| false
|
|-
| expressCardUsed
| false
|
|-
| extraRolloverAdventures
| 0
|
|-
| flyeredML
| 0
|
|-
| fossilB
| 0
| Number of bat teeth on the fossilized necklace
|-
| fossilD
| 0
| Number of demon teeth on the fossilized necklace
|-
| fossilN
| 0
| Number of baboon teeth on the fossilized necklace
|-
| fossilP
| 0
| Number of spider teeth on the fossilized necklace
|-
| fossilS
| 0
| Number of serpent teeth on the fossilized necklace
|-
| fossilW
| 0
| Number of wyrm teeth on the fossilized necklace
|-
| fratboysDefeated
| 0
|
|-
| friarsBlessingReceived
| false
|
|-
| gongPath
| 0
|
|-
| gourdItemCount
| 5
|
|-
| grimoire1Summons
| 0
|
|-
| grimoire2Summons
| 0
|
|-
| guardTurtlesFreed
| 0
| Number of times that [http://kol.coldfront.net/thekolwiki/index.php/Cold-Blooded_Warm_Fuzzies guard turtles have been freed] this ascension.
|-
| guyMadeOfBeesCount
| 0
|
|-
| guyMadeOfBeesDefeated
| false
|
|-
| heroDonationBoris
| 0
| Meat donated to Boris
|-
| heroDonationJarlsberg
| 0
| Meat donated to Jarlsberg
|-
| heroDonationSneakyPete
| 0
| Meat donated to Sneaky Pete
|-
| hiddenCityLayout
| 0000000000000000000000000
|
|-
| hiddenCitySquare
| 0
|
|-
| hippiesDefeated
| 0
|
|-
| hpAutoRecovery
| -0.05
|
|-
| hpAutoRecoveryItems
| cannelloni cocoon;scroll of drastic healing;tongue of the walrus;lasagna bandages;doc galaktik's ailment ointment
|
|-
| hpAutoRecoveryTarget
| 1.0
|
|-
| invalidBuffMessage
| You sent an amount which does not correspond to a valid buff amount.
|
|-
| kingLiberated
| false
|
|-
| knownAscensions
| -1
|
|-
| lastAdventure
|
|
|-
| lastBarrelSmashed
| 0
|
|-
| lastBangPotion819
|
|
|-
| lastBangPotion820
|
|
|-
| lastBangPotion821
|
|
|-
| lastBangPotion822
|
|
|-
| lastBangPotion823
|
|
|-
| lastBangPotion824
|
|
|-
| lastBangPotion825
|
|
|-
| lastBangPotion826
|
|
|-
| lastBangPotion827
|
|
|-
| lastBangPotionReset
| -1
|
|-
| lastBarrelSmashed
| 0
|
|-
| lastBattlefieldReset
| -1
|
|-
| lastBreakfast
| -1
|
|-
| lastCellarReset
| -1
|
|-
| lastChanceBurn
|
| CLI command executed at lastChanceThreshold ("#" is replaced by the amount of MP to burn)
|-
| lastChanceThreshold
| 100
| amount of unburned MP at which alternatives to extending existing buffs will be considered
|-
| lastCouncilVisit
| 0
|
|-
| lastCounterDay
| -1
|
|-
| lastDustyBottle2271
|
|
|-
| lastDustyBottle2272
|
|
|-
| lastDustyBottle2273
|
|
|-
| lastDustyBottle2274
|
|
|-
| lastDustyBottle2275
|
|
|-
| lastDustyBottle2276
|
|
|-
| lastDustyBottleReset
| -1
|
|-
| lastDwarfDiceRolls
|
|
|-
| lastDwarfDigitRunes
| -------
|
|-
| lastDwarfEquipmentRunes
|
|
|-
| lastDwarfFactoryItem118
|
|
|-
| lastDwarfFactoryItem119
|
|
|-
| lastDwarfFactoryItem120
|
|
|-
| lastDwarfFactoryItem360
|
|
|-
| lastDwarfFactoryItem361
|
|
|-
| lastDwarfFactoryItem362
|
|
|-
| lastDwarfFactoryItem363
|
|
|-
| lastDwarfFactoryItem364
|
|
|-
| lastDwarfFactoryItem365
|
|
|-
| lastDwarfFactoryItem910
|
|
|-
| lastDwarfFactoryItem3199
|
|
|-
| lastDwarfOfficeItem3208
|
|
|-
| lastDwarfOfficeItem3209
|
|
|-
| lastDwarfOfficeItem3210
|
|
|-
| lastDwarfOfficeItem3211
|
|
|-
| lastDwarfOfficeItem3212
|
|
|-
| lastDwarfOfficeItem3213
|
|
|-
| lastDwarfOfficeItem3214
|
|
|-
| lastDwarfOreRunes
|
|
|-
| lastDwarfFactoryReset
| -1
|
|-
| lastDwarfHopper1
|
|
|-
| lastDwarfHopper2
|
|
|-
| lastDwarfHopper3
|
|
|-
| lastDwarfHopper4
|
|
|-
| lastEVHelmetValue
| 0
|
|-
| lastEVHelmetReset
| -1
|
|-
| lastEmptiedStorage
| -1
| Number of the last ascension that Hangk's storage was emptied.
|-
| lastFilthClearance
| -1
|
|-
| lastGalleryUnlock
| -1
|
|-
| lastGuildStoreOpen
| -1
|
|-
| lastGuyMadeOfBeesReset
| -1
|
|-
| lastHiddenCityAscension
| 0
|
|-
| lastFratboyCall
| -1
|
|-
| lastHippyCall
| -1
|
|-
| lastKingLiberation
| -1
|
|-
| lastLouvreMap
| 0
|
|-
| lastMessageId
|
|
|-
| lastMiningReset
| -1
|
|-
| lastPaperStripReset
| -1
|
|-
| lastPaperStrip3144
|
|
|-
| lastPaperStrip4138
|
|
|-
| lastPaperStrip4139
|
|
|-
| lastPaperStrip4140
|
|
|-
| lastPaperStrip4141
|
|
|-
| lastPaperStrip4142
|
|
|-
| lastPaperStrip4143
|
|
|-
| lastPaperStrip4144
|
|
|-
| lastPastamancerGhostReset
| -1
|
|-
| lastPirateEphemera
|
|
|-
| lastPirateEphemeraReset
| -1
|
|-
| lastPirateInsult1
| false
|
|-
| lastPirateInsult2
| false
|
|-
| lastPirateInsult3
| false
|
|-
| lastPirateInsult4
| false
|
|-
| lastPirateInsult5
| false
|
|-
| lastPirateInsult6
| false
|
|-
| lastPirateInsult7
| false
|
|-
| lastPirateInsult8
| false
|
|-
| lastPirateInsultReset
| -1
|
|-
| lastPyramidReset
| -1
|
|-
| lastQuartetAscension
| -1
|
|-
| lastQuartetRequest
| 0
|
|-
| lastSecondFloorUnlock
| -1
|
|-
| lastSemirareReset
| -1
|
|-
| lastStoneSphere2174
|
|
|-
| lastStoneSphere2175
|
|
|-
| lastStoneSphere2176
|
|
|-
| lastStoneSphere2177
|
|
|-
| lastStoneSphereReset
| -1
|
|-
| lastTavernAscension
| 0
|
|-
| lastTavernSquare
| 0
|
|-
| lastTelescopeReset
| -1
|
|-
| lastTowerClimb
| -1
|
|-
| lastVioletFogMap
| 0
|
|-
| lastZapperWand
| 0
|
|-
| libramSummons
| 0
|
|-
| libraryCardUsed
| false
|
|-
| louvreDesiredGoal
| 7
|
|-
| louvreGoal
| 0
|
|-
| louvreLayout
|
|
|-
| louvreOverride
|
|
|-
| luckySewerAdventure
| stolen accordion
|
|-
| manaBurnSummonThreshold
| 10
|
|-
| manaBurningThreshold
| -0.05
|
|-
| maxManaBurn
| 1000
|
|-
| mayflyExperience
| 0
| Uses of mayfly bait necklace. Reset each ascension.
|-
| mineLayout1
|
|
|-
| mineLayout2
|
|
|-
| mineLayout3
|
|
|-
| moleTunnelLevel
| 0
|
|-
| mpAutoRecovery
| 0.0
|
|-
| mpAutoRecoveryItems
| phonics down;knob goblin superseltzer;mountain stream soda;magical mystery juice;knob goblin seltzer;cherry cloaca cola;soda water
|
|-
| mpAutoRecoveryTarget
| 0.3
|
|-
| munchiesPillsUsed
| 0
|
|-
| noodleSummons
| 0
|
|-
| nunsVisits
| 0
|
|-
| oceanAction
| savecontinue
|
|-
| oceanDestination
| manual
|
|-
| olfactedMonster
| unknown
|
|-
| oscusSodaUsed
| false
|
|-
| outrageousSombreroUsed
| false
|
|-
| pastamancerGhostExperience
| 0
|
|-
| pastamancerGhostName
|
|
|-
| pastamancerGhostSummons
| 0
|
|-
| pastamancerGhostType
|
|
|-
| plantingDate
|
|
|-
| plantingDay
| -1
|
|-
| plantingLength
|
|
|-
| plantingScript
|
|
|-
| postAscensionScript
|
|
|-
| preAscensionScript
|
|
|-
| preBlackbirdFamiliar
|
|
|-
| prismaticSummons
| 0
|
|-
| pyramidPosition
| 0
|
|-
| pyramidBombUsed
| false
|
|-
| rageGlandVented
| false
|
|-
| reagentSummons
| 0
|
|-
| recentLocations
| 5
|
|-
| recoveryScript
|
|
|-
| relayCounters
|
|
|-
| requireBoxServants
| false
|
|-
| requireSewerTestItems
| false
|
|-
| retrieveContacts
| true
|
|-
| seaodesFound
| 0
|
|-
| semirareCounter
| 0
|
|-
| semirareLocation
|
|
|-
| serverAddsCustomCombat
| false
|
|-
| setAutoAttack
| true
|
|-
| showGainsPerUnit
| false
|
|-
| sideDefeated
| neither
|
|-
| sidequestArenaCompleted
| none
|
|-
| sidequestFarmCompleted
| none
|
|-
| sidequestJunkyardCompleted
| none
|
|-
| sidequestLighthouseCompleted
| none
|
|-
| sidequestNunsCompleted
| none
|
|-
| sidequestOrchardCompleted
| none
|
|-
| skillLevel46
| 2
|
|-
| skillLevel47
| 1
|
|-
| skillLevel48
| 2
|
|-
| slimelingFullness
| 0
|
|-
| sortByRoom
| true
|
|-
| spadingData
|
|
|-
| spiceMelangeUsed
| false
|
|-
| spookyPuttyCopiesMade
| 0
|
|-
| spookyPuttyMonster
|
|
|-
| stationaryButton1
|
|
|-
| stationaryButton2
|
|
|-
| stationaryButton3
|
|
|-
| stationaryButton4
|
|
|-
| stationaryButton5
|
|
|-
| styxPixieVisited
| false
|
|-
| tavernLayout
| 0000000000000000000000000
|
|-
| telescope1
|
|
|-
| telescope2
|
|
|-
| telescope3
|
|
|-
| telescope4
|
|
|-
| telescope5
|
|
|-
| telescope6
|
|
|-
| telescope7
|
|
|-
| telescopeLookedHigh
| false
|
|-
| telescopeUpgrades
| 0
|
|-
| tempuraSummons
| 0
|
|-
| thanksMessage
| Thank you for the donation!
|
|-
| timesRested
| 99
|
|-
| tomeSummons
| 0
|
|-
| trapperOre
| chrome ore
|
|-
| usable1HWeapons
| 3
|
|-
| usable1xAccs
| 1
|
|-
| usable2HWeapons
| 1
|
|-
| usable3HWeapons
| 1
|
|-
| usableAccessories
| 3
|
|-
| usableHats
| 2
|
|-
| usableOffhands
| 1
|
|-
| usableOther
| 1
|
|-
| usablePants
| 1
|
|-
| usableShirts
| 1
|
|-
| violetFogGoal
| 0
|
|-
| violetFogLayout
|
|
|-
| warProgress
| unstarted
|
|-
| welcomeBackAdv
| 0
|
|-
| _absintheDrops
| 0
|
|-
| _aguaDrops
| 0
|
|-
| _astralDrops
| 0
|
|-
| _bagOfCandy
| false
|
|-
| _bagOTricksUsed
| false
| Has the Bag of Tricks been used today?
|-
| _ballpit
| false
|
|-
| _banderRunaways
| 0
|
|-
| _brickoFights
| Number of times Bricko monsters have been fought today
|
|-
| _cameraUsed
| false
|
|-
| _candySummons
| 0
|
|-
| _chipBags
| 0
|
|-
| _crimboTree
| false
|
|-
| _deluxeKlawSummons
| 0
|
|-
| _gapBuffs
| 0
| Greatest American Pants buffs
|-
| _gibbererAdv
| 0
|
|-
| _gongDrops
| 0
|
|-
| _hotTubSoaks
| 0
|
|-
| _ironicMoustache
| false
|
|-
| _klawSummons
| 0
|
|-
| _lastZomboEye
| 0
|
|-
| _leafblowerML
| 1
|
|-
| _legendaryBeat
| false
|
|-
| _lookingGlass
| false
|
|-
| _lunchBreak
| false
| Has the Lunch Break skill been used?
|-
| _mayflySummons
| 0
| Mayfly summonings today
|-
| _navelRunaways
| 0
|
|-
| _photocopyUsed
| false
|
|-
| _pieDrops
| 0
| Number of pies made by Knob Goblin Organ Grinder
|-
| _piePartsCount
| 0
| Number of organs collected by Organ Grinder for the next pie
|-
| _poolGames
| 0
|
|-
| _riftletAdv
| 0
|
|-
| _sealFigurineUses
| 0
|
|-
| _sealsSummoned
| 0
|
|-
| _skateBuff1
| false
| lutz
|-
| _skateBuff2
| false
| comet
|-
| _skateBuff3
| false
| band shell
|-
| _skateBuff4
| false
| skate eels
|-
| _skateBuff5
| false
| merry-go-round
|-
| _userMods
|
|
|-
| unknownRecipe3542
| true
|
|-
| unknownRecipe3543
| true
|
|-
| unknownRecipe3544
| true
|
|-
| unknownRecipe3545
| true
|
|-
| unknownRecipe3546
| true
|
|-
| unknownRecipe3547
| true
|
|-
| unknownRecipe3548
| true
|
|-
| unknownRecipe3749
| true
|
|-
| unknownRecipe3751
| true
|
|-
| unknownRecipe4172
| true
|
|-
| unknownRecipe4173
| true
|
|-
| unknownRecipe4174
| true
|
|}

==User-defined variables==
In addition to setting the variables that KoLmafia predefines, you can also create any others to cover any information you wish. As you do so, keep in mind that while you can clear a variable’s value to the null string, there is currently no way to delete a key (aside from editing the .txt file in the text processor of your choice and deleting the line that contains the key).
{{SeeAlso|get_property|set_property}}

[[Category:Scripting]]

Talk:Alias

2010-06-07T15:38:15Z

Winterbay: Removing an alias?

A question: How do you anti-assign an alias? "alias =>" does not work... [[User:Winterbay|Winterbay]] 15:38, 7 June 2010 (UTC)

Item drops array

2010-05-16T10:12:05Z

Winterbay: Added missing } in the example code

{{
#vardefine:name|item_drops_array}}{{
#vardefine:return_type|record [int]}}{{
#vardefine:aggregate|yes}}{{

FunctionPage|
name={{#var:name}}|
function_category=Item Management|

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 check.|
}}|

function_description=Returns an array of records with three fields:
<syntaxhighlight>
record {
item drop;
int rate;
string type;
};
</syntaxhighlight>

The 'type' field has these currently possible values:
* "" - normal item drop, base drop rate in the 'rate' field.
* "0" - no drop rate information available, 'rate' will be zero.
* "n" - not pickpocketable, but otherwise drops according to 'rate'.
* "c" - conditional drop.
* "p" - pickpocket-only.
* "b" - bounty item, 'rate' is meaningless.

Since this is the first function to return a record, it cannot be stored to a variable, and thus the only way to access the data is by iterating over the elements in the array.|

code1={{CodeSample|
title=Code Samples|
description=Prints all information Mafia has regarding the item drops of a certain monster.|
code=
<syntaxhighlight>
void drops(monster mob){
print("Monster: " + mob);
foreach index, rec in item_drops_array(mob)
print("item: "+rec.drop+", drop rate: "+rec.rate+", type: "+rec.type);
}
</syntaxhighlight>
}}
{{CodeSample|
description=Saves item drop information in a custom-defined map for later usage.|
code=
<syntaxhighlight>
void main() {
record dropdata {
item drop;
int rate;
string type;
};
dropdata [int] loc_mon_it;
dropdata [monster][int] all_mon_drops;
foreach i1, mob in get_monsters($location[Orc Chasm])
foreach index, rec in item_drops_array(mob) {
all_mon_drops [mob][index].drop = rec.drop;
all_mon_drops [mob][index].rate = rec.rate;
all_mon_drops [mob][index].type = rec.type;
}

foreach mob, index, data in all_mon_drops {
string rate = data.rate + "%";
if(data.type == "0")
rate = "unknown rate";
if(data.type != "p" && data.type != "b")
print(mob+", drops "+data.drop+" @ "+rate);
}
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|meat_drop|item_drops}}|
special=The zero-parameter form returns the last monster encountered (the current one, if used in combat).|
more_info=see [http://kolmafia.us/showthread.php?3866 this thread].|
}}