Kolmafia - User contributions [en]

File talk:Breakable equipment.jpg

2010-08-28T20:50:28Z

Icon315:

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)

File talk:Breakable equipment.jpg

2010-08-28T20:48:31Z

Icon315: Reverted edits by 60.217.232.36 (Talk) to last revision by Icon315

User confirm

2010-08-28T19:20:53Z

Icon315: Reverted edits by Icon315 (Talk) to last revision by Bale

{{
#vardefine:name|user_confirm}}{{
#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|string|message}}|
p1desc={{pspan|message}} is the text to display in the confirmation pop-up|
}}|

function_description=Presents the user with a pop-up dialog box with the text in {{pspan|message}} (can use escaped characters, such as "<nowiki>\n</nowiki>" for a newline); returns true if the user selects "Yes" and false if the user selects "No."
Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.|

code1={{CodeSample|
title=Code Sample|
description=A check to see if the user truly wants to execute a script.|
code=
<syntaxhighlight>
if (!user_confirm("Are you sure you want to proceed with executing this script?") )
{
abort("Script execution canceled by user.");
}
</syntaxhighlight>}}|

}}

[[Category:Miscellaneous Functions]]

User confirm

2010-08-28T19:19:40Z

Icon315: Ok now it makes sense

{{
#vardefine:name|user_confirm}}{{
#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|string|message}}|
p1desc={{pspan|message}} is the text to display in the confirmation pop-up|
}}|

function_description=Presents the user with a pop-up dialog box with the text in {{pspan|message}} (can use escaped characters, such as "<nowiki>\n</nowiki>" for a newline); returns true if the user selects "Yes" and false if the user selects "No."
Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.|

code1={{CodeSample|
title=Code Sample|
description=A check to see if the user truly wants to execute a script.|
code=
<syntaxhighlight>
if (user_confirm("Are you sure you want to proceed with executing this script?") )
{
abort("Script execution canceled by user.");
}
</syntaxhighlight>}}|

}}

[[Category:Miscellaneous Functions]]

File talk:Breakable equipment.jpg

2010-08-28T13:08:35Z

Icon315:

File talk:Breakable equipment.jpg

2010-08-28T13:07:56Z

Icon315: Reverted edits by 184.72.254.238 (Talk) to last revision by Bale

File talk:Breakable equipment.jpg

2010-08-26T02:12:44Z

Icon315:

File talk:Breakable equipment.jpg

2010-08-26T02:11:05Z

Icon315: Reverted edits by 75.125.238.66 (Talk) to last revision by Bale

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

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)

File talk:Breakable equipment.jpg

2010-08-24T22:00:06Z

Icon315:

File talk:Breakable equipment.jpg

2010-08-24T19:54:42Z

Icon315:

File talk:Breakable equipment.jpg

2010-08-24T19:53:23Z

Icon315: Reverted edits by 41.190.16.17 (Talk) to last revision by Bale

File talk:Breakable equipment.jpg

2010-08-23T23:22:13Z

Icon315:

File talk:Breakable equipment.jpg

2010-08-23T23:17:56Z

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

Mana cost modifier

2010-08-05T21:46:40Z

Icon315:

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

FunctionPage|

name={{#var:name}}|

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

function_description=Returns the total amount of passive MP cost reduction available. This includes all modifiers such as Festival of Jarlsberg.|

needscode=yes|

cli_equiv=The CLI command "modtrace mana cost" provides a more detailed display.|
special=Most equipment and effects only allow up to -3 MP total, so the sum of your current effects may not match the actual amount of MP reduction (and therefore the value of this function).|
more_info=See {{kolwiki|Skill_MP_Cost_Modifiers|Skill MP Cost Modifiers}} for further info on how MP reducers stack.|
}}

[[Category:Skills and Effects]]

Item type

2010-08-05T21:45:08Z

Icon315:

{{
#vardefine:name|item_type}}{{
#vardefine:return_type|string}}{{

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 the type of item that {{pspan|check_me}} is categorized as by KoLmafia. Possible values are all equipment types (see {{kolwiki|Category:Weapons}} on Coldfront) or other types (such as hp restore, mp restore, hp+mp restore, food, booze, drink helper, food helper, and familiar larva) that KoLmafia has a programmed action that the item is associated with.|

code1={{CodeSample|
title=Simple Example|
description=A universal consume function.|
code=
<syntaxhighlight>
if(item_type(it)=="food") eat(qty,it);
else if(item_type(it)=="booze") drink(qty,it);
else use(qty,it);
// Note: this example doesn't check your drunkenness, so it isn't practical for normal use.
</syntaxhighlight>}}|

special= For items that KoLmafia doesn't have a programmed function for, this function returns an empty string.|
}}

[[Category:Item Management]]

Get ingredients

2010-08-05T21:44:16Z

Icon315:

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|parse_me}}|
p1desc={{Pspan|parse_me}} is the creatable item to list the ingredients for|
}}|

function_description=Returns a map keyed by item names with the values equal to the quantity of each ingredient required to make {{pspan|parse_me}}. Note that for multi-stage crafting (where you combine several items to get intermediate items, and then combine those for the final result), only the last stage of requirements is listed. This function will parse items that can be created through multi-use of items as well as "traditional" creation methods such as cooking, cocktailcrafting, and smithing.|

code1={{CodeSample|
title=Code Sample|
description=Check to see if the character can equip a Hippo Poncho.|
code=
<syntaxhighlight>
int [item] reqd = get_ingredients($item[SOMETHING]);
foreach i in reqd {
if (item_amount(i) < reqd[i]) print("You don't have enough: " + i.to_string());
}
</syntaxhighlight>
}}|

more_info=See the {{kolwiki|Discoveries}} for more information.|
special= Returns an empty map for items that cannot be created at the moment, taking into account gender, skills, adventures remaining, tools in inventory, current date, and access to certain forms of crafting (e.g. Crimbo Town).|
}}

[[Category:Item Management]]

Helpful Links

2010-08-05T21:43:19Z

Icon315: /* Coldfront */

{{TOCright}}
The following links lead to web sites that may be of interest for those who use KoLmafia.

== KoLmafia ==

*[http://kolmafia.sourceforge.net Download KoLmafia]

*[http://kolmafia.sourceforge.net/manual.html KoLmafia Documentation]

*[http://kolmafia.sourceforge.net/scripting.html CLI Scripting Manual]

*[http://kolmafia.sourceforge.net/advanced.html ASH Scripting Manual]

*[http://kolmafia.sourceforge.net/combat.html Custom Combat Scripting Manual]

*[http://kolmafia.us The KoLmafia Script Repository]

*[http://forums.kingdomofloathing.com/viewtopic.php?t=19779 The KoLmafia thread on the KoL Forums]

*[http://builds.kolmafia.us/ Daily builds of KoLmafia]

== Kingdom of Loathing ==

*[http://www.kingdomofloathing.com/ The Kingdom of Loathing]

*[http://forums.kingdomofloathing.com/ KoL Forums]

== Coldfront ==

*[http://kol.coldfront.net Coldfront fan site]

*{{kolwiki|Main_Page|KoL Wiki (spoilers)}}

== ASH Scripting Resources ==

* [http://zachbardon.com/mafiatools/ Zarqon's KoLmafia Script Registry]

[[Category:New User Help]]

Data Types

2010-08-05T21:40:44Z

Icon315: template usage

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

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

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

===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|Monster Compendium}} page for more information.

===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 13 possible values for this datatype.

* hat
* 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

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

User:Icon315/Template:test

2010-08-02T00:26:18Z

Icon315: Forgot something

<includeonly>{{{1}}} , (test.ash, line {{{2}}})</includeonly>
<noinclude>

For testing purposes only
<code><nowiki>{{User:Icon315/Template:test|Expected ;, found print|6}}</nowiki></code> produces this: {{User:Icon315/Template:test|Expected ;, found print|6}}.

Yay it works

</noinclude>

User:Icon315/Template:test

2010-08-02T00:25:49Z

Icon315: Reverting

<includeonly>{{{1}}} , (test.ash, line {{{2}}})</includeonly>
<noinclude>

For testing purposes only
<code><nowiki>{{User:Icon315/Template:test|Expected ;, found print}}</nowiki></code> produces this: {{User:Icon315/Template:test|Expected ;, found print|6}}.

Yay it works

</noinclude>

User:Icon315/Template:test

2010-08-02T00:23:38Z

Icon315:

<includeonly>{{{1}}}{{#if: , (test.ash, line {{{2}}})})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-02T00:21:21Z

Icon315:

<includeonly>{{{1}}}{{ , (test.ash, line {{{2}}})})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print}}
</noinclude>

User:Icon315/Template:test

2010-08-02T00:18:50Z

Icon315: Made this, just because...we could use it

<includeonly>{{{1|}}}{{ , (test.ash, line {{{2}}})})</includeonly>
<noinclude>

For testing purposes only

</noinclude>

User:Icon315/Template:test

2010-08-02T00:05:45Z

Icon315:

<includeonly>{{{1}}} , (test.ash, line {{{2}}})</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print|4}}
</noinclude>

User:Icon315/Template:test

2010-08-02T00:05:00Z

Icon315:

<includeonly>{{{1}}}{{!}} , (test.ash, line {{{2}}}</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print|4}}
</noinclude>

User:Icon315/Template:test

2010-08-02T00:00:59Z

Icon315:

<includeonly>{{{1}}} , (test.ash, line {{{|3}}}</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print|4}}
</noinclude>

User:Icon315/Template:test

2010-08-02T00:00:35Z

Icon315:

<includeonly>{{{1|}}} , (test.ash, line {{{3}}}</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print|4}}
</noinclude>

User:Icon315/Template:test

2010-08-02T00:00:11Z

Icon315:

<includeonly>{{{1|}}} , (test.ash, line {{{3|}}}</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:59:22Z

Icon315:

<includeonly>{{{{{1|}}} , (test.ash, line {{{3|}}}}}</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:58:37Z

Icon315:

<includeonly>{{{{{1|}}} , (test.ash, line {{{3}}}}}</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:57:59Z

Icon315:

User:Icon315/Template:test

2010-08-01T23:57:09Z

Icon315:

<includeonly>{{{1|}}} , (test.ash, line {{{2}})</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:56:40Z

Icon315:

<includeonly>{{{1}}} , (test.ash, line {{{2}})</includeonly>
<noinclude>

For testing purposes only

{{User:Icon315/Template:test|Expected ;, found print}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:55:20Z

Icon315:

<includeonly>{{{{{1}}} , (test.ash, line {{{2|}})})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:54:23Z

Icon315:

<includeonly>{{{1}}} , (test.ash, line {{{2|}})})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:51:26Z

Icon315:

<includeonly>{{{1|}}} , (test.ash, line {{{2}})})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:50:35Z

Icon315:

<includeonly>{{{1}}} , (test.ash, line {{{2}})})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:49:35Z

Icon315:

<includeonly>{{{1}}} , (test.ash, line {{{2}})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:48:52Z

Icon315:

<includeonly>{{{1}} , (test.ash, line {{2}})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:46:57Z

Icon315: hmm

<includeonly>{{{1|}} , (test.ash, line {{2}})</includeonly>
<noinclude>

For testing purposes only
{{User:Icon315/Template:test|Expected ;, found print|2}}
</noinclude>

User:Icon315/Template:test

2010-08-01T23:41:30Z

Icon315: Testing

<includeonly>{{{{{1}}}}}</includeonly>
<noinclude>

For testing purposes only

</noinclude>

Talk:Get version

2010-08-01T23:35:58Z

Icon315: Undo revision 9533 by Icon315 (Talk)Crap, missclick, sorry

The code sample on this page should be redone, as that functionality is already built into KoLmafia. --[[User:StDoodle|StDoodle (#1059825)]] 16:52, 29 July 2010 (UTC)

Yeah i know, i couldn't think of anything else, i can't think of any other reason for this function--[[User:Icon315|Icon315]] 21:51, 29 July 2010 (UTC)

Since the function returns a string, and get_revision returns an int, it seems like any situation in which you'd like to check compatibility or anything else would be much safer to implement with get_revision. After all, there's no real guarantee that the current version format will be stuck to. (I guess nothing is written in stone, but at least it's fairly unlikely that a check versus an int would completely bork things.) I don't want to complain too much, as I've been wanting get_revision for so very long. But yeah... can't think of anything either. --[[User:StDoodle|StDoodle (#1059825)]] 06:02, 30 July 2010 (UTC)
: What I'd want for this function to get any action would be a void header() or something that'd run before checking the rest of the script. Of course, this'd go along with having undefined functions return something specific and a way to capture that, but meh. We'd probably also need some way to jump around a script (to skip defining some functions that are either already defined or implemented into ASH). Wayyyy too many changes to ASH needed for this to be of much use, I'm afraid. And the benefit wouldn't really be worth it, even. --[[User:Heeheehee|Heeheehee]] 15:01, 30 July 2010 (UTC)
: Regarding the most recent code sample: the scriptwriter would have to be '''absolutely sure''' to use "item_name".to_item(), as opposed to $item[item_name], as the latter would result in Bad item value: "item_name" (). --[[User:Heeheehee|Heeheehee]] 15:14, 30 July 2010 (UTC)

Talk:Get version

2010-08-01T23:34:54Z

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

Talk:Get version

2010-07-29T21:51:41Z

Icon315:

Get version

2010-07-29T05:32:37Z

Icon315: Created page with '{{ #vardefine:name|get_version}}{{ #vardefine:return_type|string}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| r…'

{{
#vardefine:name|get_version}}{{
#vardefine:return_type|string}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|
code1={{CodeSample|
title=Code Sample|
description=Will tell you when there is a new version of mafia|
code=
<syntaxhighlight>
string vers = get_version();
string page = visit_url("http://sourceforge.net/projects/kolmafia/files/");
string current = substring ( page, index_of ( page , "Download Now" ) , last_index_of ( page , "View all files" ) );
if (!contains_text( current , vers ))
print ("There is a new version. Go get it here http://sourceforge.net/projects/kolmafia/files/", "red");
else print ("There is not a newer version.", "blue");
</syntaxhighlight>
}}|

function_description=Returns the version of mafia you are currently using.|
|

see_also={{SeeAlso|get_revision}}|
}}

Get revision

2010-07-29T04:42:51Z

Icon315: Created page with '{{ #vardefine:name|get_revision}}{{ #vardefine:return_type|int}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| ret…'

{{
#vardefine:name|get_revision}}{{
#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}}
}}|
code1={{CodeSample|
title=Code Sample|
description=Will tell you when there is a new mafia build|
code=
<syntaxhighlight>
int Build = get_revision();
string page = visit_url("http://builds.kolmafia.us/");
string current = substring ( page, index_of ( page , "(Built Once An Hour)" ) , index_of ( page , ".jar</a>" ) );
if (!contains_text( current , Build ))
print ("There is a new build. Go get it here http://builds.kolmafia.us/", "red");
else print ("There is not a newer build.", "blue");
</syntaxhighlight>
}}|

function_description=Returns the build of mafia you are currently using.|
|

see_also={{SeeAlso|get_version}}|
}}

User talk:StDoodle

2010-07-21T22:43:11Z

Icon315: /* Permissions */

==Please let me know what's on your mind!==

Any suggestions or comments are welcome, folks. Just leave them here, and please sign your posts.

Also; if you don't have anything on your user page, please leave contact info or check back here for a reply.

Wrote up some information about [[Custom Combat Script]], including consult scripts for you. I think it is pretty good, but feel free to do anything with it that you like. You can move it to the [[In-combat Consulting]] page or whatever. If I left out anything of importance or I need to add more detail to some part, let me know. --[[User:Bale|Bale]] 10:21, 3 March 2010 (UTC)

Added combat filter information and examples to [[adventure]](). What is my next assignment? :) --[[User:Bale|Bale]] 11:03, 3 March 2010 (UTC)

Triple equal sign means "exactly equal to" (value & type). Same result, anyways. --[[User:Heeheehee|Heeheehee]] 19:42, 7 March 2010 (UTC)
Apparently Mafia doesn't recognize the triple-equals sign, though. Huh. (That bit of code was copy-pasted from the seltzer example, then modified slightly) --[[User:Heeheehee|Heeheehee]] 02:25, 8 March 2010 (UTC)

Hey! why was this: "KoLmafia Guide: Scripting for Dummies" deleted? It was helpful -[[User:Yag|Yag]] 19:15, 20 March 2010 (UTC)

Hey do you think you should add a link to Notepad ++? also to Bale's [http://kolmafia.us/showthread.php?3770-Write-mafia-code-prettily!&p=26376&viewfull=1#post26376 coloring ] of notepad ++. Also '''Category:Needs Code Sample''' Seems to have some stuff listed that do have code samples --[[User:Icon315|Icon315]] 04:05, 9 April 2010 (UTC)

==for Grotfang==
<syntaxhighlight>
int clan_id() {
string x = visit_url( "showplayer.php?who=" + my_id().to_string() );
string clan_num = "";

if( contains_text( x , "showclan.php?whichclan=" ) ) {
matcher mat = create_matcher("whichclan\=(\\d+)",x);
if(find(mat)) clan_num = group(mat,1);
}
return clan_num.to_int();
}
</syntaxhighlight>

I saw your note on my talk page, and I'm curious as to the reasoning behind the deletes. Are these pages you think need to be rewritten, or pages you think just don't need to be there at all?
-Metraxis 15:05, 15 March 2010 (UTC)

== Awww... ==

Your little history seems somewhat familiar. (minus the leaving and coming back part)
I, however, clearly did not go as far in restructuring as you did. I am a little sad to see the few pages I wrote rewritten, but glad to know that someone is making a concentrated effort to make things even more clearer.

===test fake CLI===
<div style="background-color: #e0e0e0; padding: 4px; margin: 0;">
<pre style="margin: 0; padding: 4px; font-family: Helvetica; font-size: 11pt; line-height: 16pt; border: solid 1px gray;">
hello
print goto sub har har
</pre>
</div>

== Permissions ==

How does one become an administrator? i would like to be one, that way i can delete/block spammers when you guys are not here--[[User:Icon315|Icon315]] 20:58, 21 July 2010 (UTC)

* Spammers aren't a huge problem, they're just annoying. Mostly because they only seem to cause their problems at intervals rather than flooding many pages until finally stopped, so there isn't a lot of immanency to it. I'm not sure we really need more admins for this tiny wiki. However, if StDoodle disagrees he'll do something about it.

* The way to become an admin is StDoodle decides to do it. He's about 90% in charge of everything here since he served as the guiding light showing this wiki its way to relevancy. If he thinks someone is a good candidate AND he thinks we need more help, he'd ask them.

* --[[User:Bale|Bale]] 21:42, 21 July 2010 (UTC)

Pretty much true, but on the other hand, there are a few permissions issues (such as external links & images) that allow "red tape removal" when you're an admin. I'll make you one if you can agree to the following guidelines:
* fewyn's sanity comes first; as the provider of our hosting, we need to avoid causing problems. Shouldn't really ever be an issue, but it does need to be mentioned.
* Don't start revert wars or the like. Don't delete or move pages except in cases of obvious spam. If you find factual information that you are 100% sure is wrong, change it. Otherwise, I prefer to allow what's been added to stay unless there is some discussion (usually on a talk page) first. Likewise, page moves & deletion should be discussed first in 99% of non-spam cases. This doesn't apply nearly as strictly to new information, but rather for changing someone else's edits / work.
* The guide belongs to Sally (and the images are mostly from Bale). Anything that isn't a 100% "the facts are wrong" change should really go through her (or Bale for image additions, to keep a consistent look, unless your screenshots look nearly identical). This may change if she ever abandons the project, but while she remains active in it, she has final say on most of its content.
* Learn & follow established standards. Mostly, this involves using the templates in existence when appropriate, and adding <nowiki>{{TOCright}}</nowiki> to pages with a table of contents. Do NOT make edits to templates without REALLY GOOD REASON or discussion.
Beyond that, I have no issue making anyone who has shown an interest & involvement in KoLmafia & this wiki into an admin. If these conditions are acceptable, just let me know and you can join the ranks. --[[User:StDoodle|StDoodle (#1059825)]] 21:54, 21 July 2010 (UTC)
**I am somewhat new to the KoLMafia community, but i am very interested in becoming way better in these sort of things. I am no where near as good as scripting as the rest of you, but i do wish to be. So yes i have read through the guidelines and i do not have any problem with them, and i promise not to do anything against them. Signed--[[User:Icon315|Icon315]] 22:43, 21 July 2010 (UTC)

User talk:StDoodle

2010-07-21T20:58:29Z

Icon315: /* Permissions */ new section

Modifiers

2010-07-19T20:25:46Z

Icon315: /* Numeric Modifiers */ sortable ftw

{{TOCright}}
Here is a comprehensive list of modifiers calculated by KoLmafia. Note that these are also available as ASH functions -- the first form, which takes one parameter, provides information about your character's current state; the second form, which takes two parameters, information about the object in question.

To view this list of modifiers as it pertains to your character [and a specified ''object''], use the CLI command "modref [''object'']". To see what affects a certain modifier (or modifiers), use "modtrace ''filter''". For a list of all items that modify ''modifier'', use "modifies ''modifier''".

More specific information regarding these modifiers is available in modifiers.txt, one of KoLmafia's internally-stored datafiles.

A list of the functions used to access these modifiers can be found at [[Modifier Functions]].

==Numeric Modifiers==
Note that although some of these functions have an ASH derivative that may be easier to use, the two-parameter form is still relevant and rather useful when obtaining information about a particular object, rather than your current state.

When not logged in, these all return 0 for the 1-parameter form of [[numeric_modifier|numeric_modifier()]].
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Related ASH function / Notes
|-
| Familiar Weight
| [[weight_adjustment| weight_adjustment()]]
|-
| Monster Level
| [[monster_level_adjustment| monster_level_adjustment()]]
|-
| Combat Rate
| [[combat_rate_modifier| combat_rate_modifier()]]
|-
| Initiative
| [[initiative_modifier| initiative_modifier()]]
|-
| Experience
| [[experience_bonus| experience_bonus()]]
|-
| Item Drop
| [[item_drop_modifier| item_drop_modifier()]]
|-
| Meat Drop
| [[meat_drop_modifier| meat_drop_modifier()]]
|-
| Damage Absorption
| [[raw_damage_absorption| raw_damage_absorption()]]
|-
| Damage Reduction
| [[damage_reduction|damage_reduction()]]
|-
| Cold Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[cold] )]], but returns the level of resistance.
|-
| Hot Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[hot] )]], but returns the level of resistance.
|-
| Sleaze Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[sleaze] )]], but returns the level of resistance.
|-
| Spooky Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[spooky] )]], but returns the level of resistance.
|-
| Stench Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[stench] )]], but returns the level of resistance.
|-
| Mana Cost
| Similar to [[mana_cost_modifier|mana_cost_modifier()]] -- only counts up to the -3 cap.
|-
| Moxie
| Sum of all absolute moxie modifiers.
|-
| Moxie Percent
| Sum of all percentage-based moxie modifiers.
|-
| Muscle
| Sum of all absolute muscle modifiers.
|-
| Muscle Percent
| Sum of all percentage-based muscle modifiers.
|-
| Mysticality
| Sum of all absolute mysticality modifiers.
|-
| Mysticality Percent
| Sum of all percentage-based mysticality modifiers.
|-
| Maximum HP
| Sum of all absolute HP modifiers.
|-
| Maximum HP Percent
| Sum of all percentage-based HP modifiers.
|-
| Maximum MP
| Sum of all absolute MP modifiers.
|-
| Maximum MP Percent
| Sum of all percentage-based MP modifiers.
|-
| Weapon Damage
| Sum of all absolute weapon damage modifiers.
|-
| Ranged Damage
| Sum of all absolute ranged damage modifiers.
|-
| Spell Damage
| Sum of all absolute spell damage modifiers.
|-
| Spell Damage Percent
| Sum of all percentage-based spell damage modifiers.
|-
| Cold Damage
| Total cold damage.
|-
| Hot Damage
| Total hot damage.
|-
| Sleaze Damage
| Total sleaze damage.
|-
| Spooky Damage
| Total spooky damage.
|-
| Stench Damage
| Total stench damage.
|-
| Cold Spell Damage
| Total cold spell damage.
|-
| Hot Spell Damage
| Total hot spell damage.
|-
| Sleaze Spell Damage
| Total sleaze spell damage.
|-
| Spooky Spell Damage
| Total spooky spell damage.
|-
| Stench Spell Damage
| Total stench spell damage.
|-
| Critical
| Critical multiplier.
|-
| Fumble
| Fumble multiplier.
|-
| HP Regen Min
| Lower bound of all HP-regenerating effects/equipment.
|-
| HP Regen Max
| Upper bound of all HP-regenerating effects/equipment.
|-
| MP Regen Min
| Lower bound of all MP-regenerating effects/equipment.
|-
| MP Regen Max
| Upper bound of all MP-regenerating effects/equipment.
|-
| Adventures
| Bonus Rollover adventures
|-
| Familiar Weight Percent
| Percentage modifier of Familiar Weight (from Bad Moon effects; always <= 0)
|-
| Weapon Damage Percent
| Sum of all percentage-based weapon damage modifiers.
|-
| Ranged Damage Percent
| Sum of all percentage-based ranged damage modifiers.
|-
| Stackable Mana Cost
| Similar to [[mana_cost_modifier|mana_cost_modifier()]] -- all other MP cost modifiers.
|-
| Hobo Power
| Hobo Power from equipment and effects (effect, technically).
|-
| Base Resting HP
| Average HP gained from resting.
|-
| Resting HP Percent
| Percentage modifier to HP gained from resting (e.g. from Pagoda).
|-
| Bonus Resting HP
| Absolute modifier to HP gained from resting (e.g. from Gauze hammock).
|-
| Base Resting MP
| MP gained from resting.
|-
| Resting MP Percent
| Percentage modifier to HP gained from resting (e.g. Pagoda).
|-
| Bonus Resting MP
| Absolute modifier to HP gained from resting (e.g. from Beanbag chair).
|-
| Critical Hit Percent
| Percentage modifiers to critical hits (e.g. Depleted Grimacite Kneecapping stick).
|-
| PvP Fights
| Bonus PvP fights upon Rollover.
|-
| Volleyball
| Only for use with multiple parameters (e.g. Llama returns .5, metallic foil radar dish returns -1).
|-
| Sombrero
| Only for use with multiple parameters (e.g. Baby Sandworm returns 1, metallic foil radar dish returns 1).
|-
| Leprechaun
| Only for use with multiple parameters (e.g. Hobo monkey returns 1.25).
|-
| Fairy
| Only for use with multiple parameters (e.g. Hound dog returns 1.25).
|-
| Meat Drop Penalty
| Penalty to Meat Drops; result of having an Underwater location selected as your current location.
|-
| Hidden Familiar Weight
| Bonus familiar weight that does not show up on the character pane (e.g. from Temporary Teardrop Tattoo).
|-
| Item Drop Penalty
| Penalty to Item Drops; result of having an Underwater location selected as your current location.
|-
| Initiative Penalty
| Penalty to Initiative Drops; result of having an Underwater location selected as your current location.
|-
| Food Drop
| Exclusive bonus to food drops (e.g. Brother Flying Burrito's Blessing).
|-
| Booze Drop
| Exclusive bonus to booze drops (e.g. Brother Smother's Blessing).
|-
| Hat Drop
| Exclusive bonus to hat drops (e.g. velcro broadsword).
|-
| Weapon Drop
| Exclusive bonus to weapon drops (e.g. pilgrim shield).
|-
| Offhand Drop
| Exclusive bonus to offhand drops (None at the moment; placeholder).
|-
| Shirt Drop
| Exclusive bonus to shirt drops (None at the moment; placeholder).
|-
| Pants Drop
| Exclusive bonus to pants drops (e.g. baneful bandolier).
|-
| Accessory Drop
| Exclusive bonus to accessory drops (e.g. velcro paddle ball).
|-
| Volleyball Effectiveness
| Exclusive to the Baby Mutant Rattlesnake; evaluates an expression that factors in the current moon phase.
|-
| Sombrero Effectiveness
| Currently only returns 0; placeholder.
|-
| Leprechaun Effectiveness
| Exclusive to the Mutant Cactus Bud; evaluates an expression that factors in the current moon phase.
|-
| Fairy Effectiveness
| Exclusive to the Mutant Fire Ant; evaluates an expression that factors in the current moon phase.
|-
| Familiar Weight Cap
| Relevant only to the Mad Hatrack; returns maximum base weight based on equipment.
|-
| Slime Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[slime] )]], but returns the level of resistance.
|-
| Slime Hates It
| Number of Slime Hates It active, as taken from equipment and effects.
|-
| Maximum HP Nonmultiplied
| Bonus to HP from Slimy Sinews since it is not affected by HP multipliers.
|-
| Maximum MP Nonmultiplied
| Bonus to MP from Slimy Synapses since it is not affected by MP multipliers.
|-
| Spell Critical Percent
| Increased absolute spell critical rate.
|-
| Muscle Experience
| +X Mus substats/fight
|-
| Mysticality Experience
| +X Mys substats/fight
|-
| Moxie Experience
| +X Mox substats/fight
|-
| Effect Duration
| For use with the two-parameter form, using item as the other parameter. Returns duration of effect for potions.
|-
| Candy Drop
| Exclusive bonus to candy drops (e.g. peanut brittle shield).
|-
| DB Combat Damage
| Bonus damage from using DB combat skills (e.g. Chester's moustache)
|-
| Sombrero Bonus
| Provides X pounds of Sombrero (e.g. tiny sombrero)
|-
| Familiar Experience
| Bonus experience for familiars (e.g. Brother Corsican's Blessing)
|-
| Sporadic Meat Drop
| Bonus to Meat Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
|-
| Sporadic Item Drop
| Bonus to Item Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
|-
| Meat Bonus
| Absolute bonus to Meat Drop (e.g. ant sickle)
|-
| Pickpocket Chance
| Bonus to pickpocket chance (e.g. Elvish Sunglasses)
|}

==Derived Modifiers==
These are modifiers that are calculated based on other modifier values, rather than being a property of individual items. They can be used just like the numeric modifier names above, but are fairly useless with the one-parameter form of the function since you can easily retrieve the actual values (which may differ slightly from these predicted values, due to different rounding behavior or other errors in KoLmafia's modifier calculations). The intended usage is in the form numeric_modifier("_spec", ''name''), to determine the results of a potential equipment or effect change that has been tested by the CLI '''whatif''' command.
{| class="wikitable" border="1"
|-
! Modifier Name
! Related ASH function / Notes
|-
| Buffed Muscle
| Predicted value of [[my_buffedstat|my_buffedstat($stat[muscle])]]
|-
| Buffed Mysticality
| Predicted value of [[my_buffedstat|my_buffedstat($stat[mysticality])]]
|-
| Buffed Moxie
| Predicted value of [[my_buffedstat|my_buffedstat($stat[moxie])]]
|-
| Buffed HP Maximum
| Predicted value of [[my_maxhp|my_maxhp()]]
|-
| Buffed MP Maximum
| Predicted value of [[my_maxmp|my_maxmp()]]
|}

==Bitmap Modifiers==
Note: This does not have a corresponding ASH function. Instead, these modifiers can all be called using the [[numeric_modifier|numeric_modifier()]] function.

When not logged in, these all return 0x0 (0).
{| class="wikitable" border="1"
|-
! Modifier Name
! Notes
|-
| Clownosity
| If this is >= 4, you can "Push the nose" in the Fun House.
|-
| Raveosity
| If this is >= 7, you can "Get into the club".
|-
| Brimstone
| These have many "bonuses" when you equip more of them at once.
|-
| Synergetic
| For items that have hidden bonuses when used together, such as the Secrets from the Future and the snake/wolf sword & shield.
|}

==Boolean Modifiers==
When not logged in, these all return false for the 1-parameter form of [[boolean_modifier|boolean_modifier()]].
{| class="wikitable" border="1"
|-
! Modifier Name
! Notes
|-
| Softcore Only
| For use with the parameter "item"; returns true if the item in question has the Softcore Only flag (e.g. Travoltan Trousers).
|-
| Single Equip
| For use with the parameter "item"; returns true if the item in question has the Single Equip flag (e.g. plexiglass pendant).
|-
| Never Fumble
| Returns true if the player has an effect that prevents fumbling.
|-
| Weakens Monster
| For use with the parameter "item"; returns true if the item in question delevels on hit (e.g. 7-foot dwarven mattock).
|-
| Free Pull
| For use with the parameter "item"; returns true if the item in question can be pulled from Hagnk's for free (e.g. roll of toilet paper).
|-
| Variable
| For use with the parameter "item"; returns true if the item in question has a variable effect (e.g. depleted grimacite grappling hook).
|-
| Nonstackable Watch
| For use with the parameter "item"; returns true if the item in question counts as one of the nonstackable watches (e.g. dead guy's watch).
|-
| Cold Immunity
| Returns true if Coldform is active.
|-
| Hot Immunity
| Returns true if Hotform is active.
|-
| Sleaze Immunity
| Returns true if Sleazeform is active.
|-
| Spooky Immunity
| Returns true if Spookyform is active.
|-
| Stench Immunity
| Returns true if Stenchform is active.
|-
| Cold Vulnerability
| Returns true if the player is vulnerable to Cold (e.g. from Sleazeform).
|-
| Hot Vulnerability
| Returns true if the player is vulnerable to Hot (e.g. from Spookyform).
|-
| Sleaze Vulnerability
| Returns true if the player is vulnerable to Sleaze (e.g. from Stenchform).
|-
| Spooky Vulnerability
| Returns true if the player is vulnerable to Spooky (e.g. from Coldform).
|-
| Stench Vulnerability
| Returns true if the player is vulnerable to Stench (e.g. from Hotform).
|-
| Moxie Controls MP
| Returns true if the player has a moxie magnet equipped.
|-
| Moxie May Control MP
| Returns true if the player has Travoltan Trousers equipped.
|-
| Four Songs
| Returns true if the player is able to "Keep 4 songs in [his] head instead of 3" (e.g. Brimstone Beret).
|-
| Additional Song
| Returns true if the player has the bonus from the El Hebilla del Cinturón de Lopez (Accordion Thief Epic Accessory).
|-
| Adventure Underwater
| Returns true if the player has some way to breathe underwater (e.g. makeshift SCUBA gear).
|-
| Underwater Familiar
| Returns true if the player's familiar has some way to breathe underwater (e.g. das boot).
|-
| Generic
| Returns true if the item in question can be equipped to all familiars.
|}

==String Modifiers==
Note: These use the two-parameter form, for the most part.
{| class="wikitable" border="1"
|-
! Modifier Name
! Notes
|-
| Class
| Returns the class you must be to benefit from any of the enchantments on this item.
|-
| Intrinsic Effect
| Returns the intrinsic effect granted by a piece of equipment (e.g. Chapped Legs from leather chaps).
|-
| Equalize
| Returns the base stat of an equalizer potion.
|-
| Wiki Name
| Returns an empty string unless it is different, in which case the special HTML entities have been replaced. (e.g. frigid hankyu)
|-
| Modifiers
| Returns the raw text of this item's modifier data, useful for a quick view of all its enchantments.
|-
| Outfit
| Returns the name of the outfit (non-custom, folks!) that this item is part of.
|-
| Stat Tuning
| For use with Crimbo '06 items, like tropical paperweight; returns the stat associated with the item.
|-
| Familiar Tuning
| For use with Bandersnatch fold-able equipment; returns the stat associated with the item.
|-
| Effect
| Returns the effect that KoL associates with a potion (which may not be the potion's only effect).
|-
| Equips On
| Holds a <nowiki>|</nowiki>-separated list of familiars that the item equips on. Not needed for the basic familiar-specific item listed in familiars.txt.
|}

[[Category:Scripting]]

Help:Frequently Asked Questions

2010-07-18T20:55:58Z

Icon315: /* Interface */ Visual is always good

{{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/.
;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" bug (reproducible, describable, and undesired), 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 re-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. You can change the stickers command to indicate whichever stickers you want to keep active.
:: '''Trigger On:''' Unconditional trigger
:: '''Check For:'''
:: '''Command:''' stickers unicorn, unicorn, unicorn
;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]]
;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==
;How do I run an ASH 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've names like /scripts and /data .
:This varies depending on your operating system. Look for your system at [[mafia directories]].
;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). So, if you want to make use of, say, the hermit() function in a way that won't abort if the function returns false, you could:
<div style="margin-bottom: 1em; padding: 1em; margin:0px 20px;">
{{CodeSample|
description=Save the result as a boolean variable.|
code=<syntaxhighlight>
boolean fakeBool = hermit(1, $item[Ten-leaf clover]);
</syntaxhighlight>}}
{{CodeSample|
description=Capture the result in an if() conditional.|
code=<syntaxhighlight>
if(!hermit(1, $item[Ten-leaf clover])) print("Hermit looting failed: continuing on.");
</syntaxhighlight>}}
{{CodeSample|
description=An if() conditional doesn't even have to do anything.|
code=<syntaxhighlight>
if(hermit(1, $item[Ten-leaf clover])) {}
</syntaxhighlight>}}
{{CodeSample|
description=The most minimalistic method is to capture it with a not operator and parenthesis.|
code=<syntaxhighlight>
(!hermit(1, $item[Ten-leaf clover]));
</syntaxhighlight>}}
</div>
;I downloaded a script, but when I try to run it, it tells me that a function is undefined.
:This almost always means that the script makes use of newer ASH functions that are not available in the version you're using. See the link for daily builds above, and grab a newer version.

[[Category:New User Help]]