Kolmafia - User contributions [en]

Now to string

2014-01-23T13:29:30Z

Alhifar: Updated SimpleDateFormat link

{{
#vardefine:name|now_to_string}}{{
#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|string|format}}|
p1desc={{pspan|format}} is how the return value should be formatted.|
}}|

function_description=Returns the current time (based on your local computer's system settings) in SimpleDateFormat format. Full information on [http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html SimpleDateFormat] here.|

code1={{CodeSample|
title=Code Sample|
description=Examples of using now_to_string().|
code=
<syntaxhighlight>
print("Example 1: "+ now_to_string("yyyy.MM.dd G 'at' HH:mm:ss z"));
print("Example 2: "+ now_to_string("EEE, MMM d, ''yy"));
print("Example 3: "+ now_to_string("h:mm a"));
print("Example 4: "+ now_to_string("hh 'o''clock' a, zzzz"));
print("Example 5: "+ now_to_string("K:mm a, z"));
print("Example 6: "+ now_to_string("yyyyy.MMMMM.dd GGG hh:mm aaa"));
print("Example 7: "+ now_to_string("EEE, d MMM yyyy HH:mm:ss Z"));
print("Example 8: "+ now_to_string("yyMMddHHmmssZ"));
</syntaxhighlight>|
moreinfo=
This is the output:
<pre>
Example 1: 2011.01.25 AD at 21:14:56 CST
Example 2: Tue, Jan 25, '11
Example 3: 9:15 PM
Example 4: 09 o'clock PM, Central Standard Time
Example 5: 9:15 PM, CST
Example 6: 02011.January.25 AD 09:16 PM
Example 7: Tue, 25 Jan 2011 21:16:16 -0600
Example 8: 110125211624-0600
</pre>
}}|
}}
{{SeeAlso|gameday_to_string|gameday_to_int|today_to_string|time_to_string}}

[[Category:Miscellaneous Functions]]

Equipment

2010-03-02T00:24:26Z

Alhifar: /* Part 3 - Equipment */

== Part 3 - Equipment ==
Time to get dressed!

'''boolean [[equip|equip( item it )]]''' - equips the specified [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] in the “natural” slot. Only equips accessories in empty slots.

'''boolean [[equip|equip( slot sl, item it )]]''' - equips the specified [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] in the specified [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot]].

'''item [[equipped_item|equipped_item( slot sl )]]''' - returns the item currently equipped in the given slot. (Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])

'''boolean [[have_equipped|have_equipped( item it )]]''' - tells you if the specified item is currently equipped (as it would not otherwise show up in [[item_amount]]).

'''boolean [[can_equip|can_equip( item it )]]''' - tells you if you meet the requirements to equip the given item (regardless of whether you own it).

'''string [[item_type|item_type( item it )]]''' - returns a string indicating the type of weapon which was passed as a parameter.

'''int [[weapon_hands|weapon_hands( item it )]]''' - tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. (Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])

'''stat [[weapon_type|weapon_type( item it )]]''' - tells you what stat your weapon bases its hit chance on.

'''boolean [[have_familiar|have_familiar( familiar pet )]]''' - tells you if you have placed the specified [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar]] in your Terrarium (or have it equipped now).

'''boolean [[use_familiar|use_familiar( familiar pet )]]''' - equips the specified [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar]]. Use [[equip]] to change your familiar’s gear.

'''item [[familiar_equipment|familiar_equipment( familiar pet )]]''' - returns the most common piece of equipment that is specially designed for the familiar’s type.

'''item [[familiar_equipped_equipment|familiar_equipped_equipment( familiar pet )]]''' - returns the current item equipped on a [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar]], as opposed to familiar_equipment( familiar ) which returns the special item only the familiar can use.

'''boolean [[have_outfit|have_outfit( string outfit_name )]]''' - returns ''true'' if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. (Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]])

'''boolean [[outfit|outfit( string outfit_name )]]''' - wears the specified outfit. (Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])

Pulls remaining

2010-03-01T18:22:48Z

Alhifar:

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

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

function_description=Returns the number of pulls remaining for the day for characters in-Ronin, or 0 otherwise.|

code1={{CodeSample|
title=Code Sample|
description=The following checks to see if you've forgotten to use up your daily pulls.|
code=
<syntaxhighlight>
if (pulls_remaining() > 0) {
print("You still have " + pulls_remaining() + " pulls you can make today.");
} else {
print("You're all set on daily pulls.");
}
</syntaxhighlight>}}|
special=Returns 0 when not logged in.
}}

Initiative modifier

2010-03-01T18:19:12Z

Alhifar:

{{#vardefine:name|initiative_modifier}}
{{#vardefine:return_type|float}}
{{FunctionPage|
name={{#var:name}}|
function_category=Your Character|
function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|
function_description=Returns your current percentage initiative modifier in the form of a float.|
code1={{CodeSample|
title=Code Samples|
description=Checks to see whether your initiative modifier is positive.|
code=
<syntaxhighlight>
boolean positive_initiative() {
if(initiative_modifier() < 0){
return false;
}
return true;
}
</syntaxhighlight>
}}|
code2={{CodeSample|
description=Uses your initiative result to determine whether it will adventure in the sewers (where a +60% initiative guarantees getting the jump). There is also a check for my_familiar().|
code=
<syntaxhighlight>
boolean first_yellow_ray() {
if(initiative_modifier() >= 60) {
if(my_familiar() == $familiar[he-boulder]) {
adventure(1 , $location[A Maze of Sewer Tunnels]);
return true;
}
else {
print("You should use the He-Boulder for this");
}
}
else {
print("Your initiative is too low");
}
return false;
}
</syntaxhighlight>
}}|
see_also={{SeeAlso|my_familiar}}|
special=When not logged in the function returns 0.0
}}

Elemental resistance

2010-03-01T18:18:03Z

Alhifar:

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

{{FunctionPage|
name={{#var:name}}|
function_category=Your Character|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|element|}}|
p1desc=The parameter of element is invoked using $element. Valid elements are hot ($element[hot]), cold, stench, spooky, sleaze.
}}|

function_description=Returns your current resistance for a specified element in the form of a floating point integer.|

code1={{CodeSample|
title=Code Samples|
description=Checks that you have a resistance greater than 20 for the element "hot".|
code=
<syntaxhighlight>
boolean hot_check() {
if(elemental_resistance($element[hot]) > 20) {
return true;
}
return false;
}
</syntaxhighlight>
}}|

special=When not logged in the function returns 0.0
}}

Current hit stat

2010-03-01T18:15:30Z

Alhifar:

{{#vardefine:name|current_hit_stat}}
{{#vardefine:return_type|stat}}

{{FunctionPage|
name={{#var:name}}|
function_category=Your Character|

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

function_description=Returns the stat (muscle, mysticality or moxie) that is currently being used to calculate hit percentages. This is most likely to be useful in consult ccs scripts, or scripts designed to optimise equipment usage.|

code1={{CodeSample|
title=Code Samples|
description=Checks to ensure your mainstat and hit stat are the same - to make sure you have the right type of weapon equipped. This only applies to muscle and moxie classes, so it checks to make sure you are not a mysticality class first.|
code=
<syntaxhighlight>
if(my_primestat() != $stat[mysticality]) {
if(current_hit_stat() != my_primestat()) {
print("You could probably select a more effective weapon!");
}
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|my_primestat}}|
special=When not logged in, this function returns $stat[muscle].
}}

Buffed hit stat

2010-03-01T18:12:43Z

Alhifar:

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

{{FunctionPage|
name={{#var:name}}|
function_category=Your Character|

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

function_description=Returns the buffed value of the stat that is currently used to calculate hit percentages. Note, ranged weapons use moxie to calculate hit percentage, melee weapons use muscle.|

code1={{CodeSample|
title=Code Samples|
description=This code will check your hit percentage against every monster in a specified location to make sure it is 50% or over for every monster.|
code=
<syntaxhighlight>
boolean safe_to_attack() {
int x = buffed_hit_stat();
monster [int] monster_list = get_monsters($location[Fantasy Airship]);
foreach int in monster_list {
float fumble = 1/22;
float hit_percentage = (((6 + (x - monster_defense(monster_list[int]))) / 10.5) * (100 - fumble));
if(hit_percentage < 50) {
return false;
}
}
return true;
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|get_monsters|monster_defense}}|
more_info=http://kol.coldfront.net/thekolwiki/index.php/Hit_Chance|
special=This function returns 0 when not logged in.
}}

My id

2010-03-01T18:10:48Z

Alhifar:

{{#vardefine:name|my_id}}
{{#vardefine:return_type|string}}
{{FunctionPage|
name={{#var:name}}|
function_category=Your Character|
function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|
function_description=Returns the Character ID of the logged-in character.|
code1={{CodeSample|
title=Code Sample|
description=This example allows you to visit your own charsheet.|
code=
<syntaxhighlight>
visit_url("showplayer.php?who=" + my_id());
</syntaxhighlight>
}}|
see_also={{SeeAlso|my_name}}|
special=When no character is logged in, this function returns the Character ID of the last logged-in character or 0 if no character has logged in yet.
}}

Closet amount

2010-03-01T18:08:23Z

Alhifar:

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

{{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}}|
parameter1={{Param|item|it}}|
p1desc={{Pspan|it}} is the item that will be checked for in the closet.|
}}|

function_description=Returns the amount of a given item that is contained in your closet.|

code1={{CodeSample|
title=Sample Code|
description=Checks if you have enough filthy lucre for Olfaction|
code=
<syntaxhighlight>
void main(){
if( item_amount($item[filthy lucre]) + display_amount($item[filthy lucre]) + closet_amount($item[filthy lucre]) > 200 ){ print( "Go get olfaction!" ) }
else print( "Keep going, you need more lucre!" );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|item_amount|display_amount}}|
special=Not logged in value: 0
}}

Closet amount

2010-03-01T18:07:23Z

Alhifar: Created page with '{{#vardefine:name|closet_amount}} {{#vardefine:return_type|int}} {{FunctionPage| name={{#var:name}}| function_category=Item Management| function1={{Function| name={{#var:name}}…'

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

{{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}}|
parameter1={{Param|item|checked}}|
p1desc=This is the item that will be checked for in the closet.|
}}|

function_description=Returns the amount of a given item that is contained in your closet.|

code1={{CodeSample|
title=Sample Code|
description=Checks if you have enough filthy lucre for Olfaction|
code=
<syntaxhighlight>
void main(){
if( item_amount($item[filthy lucre]) + display_amount($item[filthy lucre]) + closet_amount($item[filthy lucre]) > 200 ){ print( "Go get olfaction!" ) }
else print( "Keep going, you need more lucre!" );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|item_amount|display_amount}}|
special=Not logged in value: 0
}}

Talk:Main Page

2009-04-15T04:45:18Z

Alhifar: Undo revision 4772 by 212.116.219.52 (Talk) -- Spam?

Save these links for now:

ELg27M df1zv853gvrvb7gv94gmlas

WaBgN9 dfv078fnw8f934ndvkg2l

== Updating? ==
Let's get started, guys. Soon enough, I'll have a list of all the functions, which I think should go in a wiki page to (as someone above said) search and link. Also, is there a way to do monospacing with code? --[[User:MagiNinjA|MagiNinjA]] 00:35, 29 March 2007 (CDT)
:You can get mono-spaced text by using <code> tags. For example, using <pre><code>EXAMPLE TEXT</code></pre> produces this as a result. <code>EXAMPLE TEXT</code>
:If you need anymore help, just drop me a line on my [[User_talk:Ksumoe|talk page]]. [[User:Ksumoe|ksumoe]] ([[User_talk:Ksumoe|talk]] [[Special:Contributions/Ksumoe|contrib]]) 18:35, 10 April 2007 (CDT)

== Ideas... ==

These are my ideas that I have floating around in my head:
# A template to put all the relevant information about a function into a table (with proper colored backgrounds and such)
## I can do this; I just need to know what information is 'relevant'.
# Move this type of discussion to the Community Portal. Right now the CP is just a bunch of links (we can make a 'links' page and add it to the sidebar if needed).
# An overhaul of the main page. Someone said that they don't like the 'portal' type of look, but that kind of look has become the ''de facto'' standard for wikis, as it is the most popular. I'll pound out a rough draft on a subpage of my user space.
# Creation of a template structure. Templates for requesting deletion, protection, etc. That way non-sysop flagged users can 'tag' pages [[Talk:Bad title|such as this]] for deletion.
# Logo! 'Cause we need to be cool like that.
# Define a category structure. Do it now before too many pages get created.

Like I said... I'm here to help. [[User_talk:Ksumoe|Comments]]  plox. [[User:Ksumoe|ksumoe]] ([[User_talk:Ksumoe|talk]] [[Special:Contributions/Ksumoe|contrib]]) 21:17, 13 April 2007 (CDT)

I added some links on the home page -- hope that helps users find more documentation... :) -Daychilde

I corrected the Script Repository link to http://www.kolmafia.us from http://www.kolmafia.ua. ;) -Regnar

== Links to Redirects? ==

While I understand the need for redirect, why are we linking to redirect pages? Why not use <nowiki>[[Page Title|Displayed Text]]</nowiki> links instead?

== Protection ==
Seriously, protect the front page. This is getting completely destroyed by spam [[User:80.189.248.109|80.189.248.109]] 12:05, 27 August 2007 (CDT)

Is $wgSpamRegex set? If not it should be. If it is, it needs updating. Spam storming in like the flood! -divinewind420

Articles on the subject
http://nothing.tmtm.com/archives/2571
http://wiki.evernex.com/index.php?title=Blocking_Spam_in_Mediawiki
-divinewind420

== Current wiki layout ==
I was just curious if we could get the current wiki main page layout centered? As in simply putting <pre> <center> </center> </pre> around the main text.
--[[User:ZammyWarrior|ZammyWarrior]] 16:35, 7 December 2007 (PST)

What do you mean? And please sign your comments --[[User:Fewyn|Fewyn]] 10:59, 6 December 2007 (PST)

String Handling Routines

2008-08-18T05:28:25Z

Alhifar: Seriously, do these bots have something against dealing with strings?

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string [[visit_url alpha|visit_url( string url )]] 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

buffer append( buffer source, string text ) 
Returns the source buffer with the string added on at the end. 
buffer append_tail( matcher regex, buffer source ) 
This function appends the text returned by a matcher to the end of the buffer text.

String Handling Routines

2008-08-03T08:15:45Z

Alhifar: Die.

String Handling Routines

2008-07-30T20:24:53Z

Alhifar: Damned spammers.

String Handling Routines

2008-07-24T01:13:23Z

Alhifar: /* Part 8 - String Handling Routines */

KoLmafia Properties

2008-07-21T07:39:15Z

Alhifar:

== Part 11 - KoLmafia Properties ==

In addition to affecting gameplay directly through ASH functions and CLI commands, scripters also have the ability to control certain core behaviors of KoLmafia through direct modification of the preferences file. In addition, scripters can also create variables that will survive across sessions. 
To see all of the pre-defined variables that exist, look in the “settings” subfolder wherever you keep the KoLmafia executable and open up any of the prefs_<character name>.txt and GLOBAL_prefs.txt files named for your characters. This guide will not attempt to describe all of the variables that are there: many are uninteresting from the player’s point of view and others are too unwieldy to be properly set at the moment. Of those that are interesting and accessable, the functionality can be divided into three main sections:

<h3>Choice Adventures</h3>
These settings control all of the non-combat adventures that give you a choice of outcomes. In the GUI, you can view and set these options in the Choices tab of the Preferences window, but you can also more-or-less directly access the values from ASH. This is slightly unorthodox behavior, given that the GUI doesn’t get notified that the true value has been updated and so your Choices page could be out of synch, but needs must when the Devil drives, eh?
As I said before, setting these values may be more-or-less direct, which turns out to be true in a literal sense. Of the two sections on the Choices tab, the lower set is “more” direct. These line up as follows:

<TABLE BORDER=1 CELLPADDING=4><TR><TH>Property Name</TH><TH>Preferences Tab Name</TH><TH>KoL Adventure Name 
</TH></TR><TR><TD>choiceAdventure2</TD><TD>Palindome</TD><TD ALIGN=LEFT>Denim Axes Examined 
</TD></TR><TR><TD>choiceAdventure3</TD><TD>Teleportitis</TD><TD ALIGN=LEFT>The Oracle Will See You Now 
</TD></TR><TR><TD>choiceAdventure4</TD><TD>South of the Border</TD><TD ALIGN=LEFT>Finger-Lickin’ … Death 

</TD></TR><TR><TD>choiceAdventure5</TD><TD>Gravy Barrow 1</TD><TD ALIGN=LEFT>Heart of Very, Very Dark Darkness 
</TD></TR><TR><TD>choiceAdventure7</TD><TD>Gravy Barrow 2</TD><TD ALIGN=LEFT>How Depressing 
</TD></TR><TR><TD>choiceAdventure8</TD><TD>Gravy Barrow 3</TD><TD ALIGN=LEFT>On the Verge of a Dirge 
</TD></TR><TR><TD>choiceAdventure15</TD><TD>eXtreme Slope 1</TD><TD ALIGN=LEFT>Yeti Nother Hippy 

</TD></TR><TR><TD>choiceAdventure16</TD><TD>eXtreme Slope 2</TD><TD ALIGN=LEFT>Saint Beernard 
</TD></TR><TR><TD>choiceAdventure17</TD><TD>eXtreme Slope 3</TD><TD ALIGN=LEFT>Generic Teen Comedy 
</TD></TR><TR><TD>choiceAdventure18</TD><TD>Itznotyerzitz Mine 1</TD><TD ALIGN=LEFT>A Flat Miner 
</TD></TR><TR><TD>choiceAdventure19</TD><TD>Itznotyerzitz Mine 2</TD><TD ALIGN=LEFT>100% Legal 

</TD></TR><TR><TD>choiceAdventure20</TD><TD>Itznotyerzitz Mine 3</TD><TD ALIGN=LEFT>See You Next Fall 
</TD></TR><TR><TD>choiceAdventure21</TD><TD>Sleazy Back Alley</TD><TD ALIGN=LEFT>Under the Knife 
</TD></TR><TR><TD>choiceAdventure22</TD><TD>Pirate’s Cove 1</TD><TD ALIGN=LEFT>The Arrrbitrator 
</TD></TR><TR><TD>choiceAdventure23</TD><TD>Pirate’s Cove 2</TD><TD ALIGN=LEFT>Barrie Me at Sea 

</TD></TR><TR><TD>choiceAdventure24</TD><TD>Pirate’s Cove 3</TD><TD ALIGN=LEFT>Amatearrr Night 
</TD></TR><TR><TD>choiceAdventure25</TD><TD>Dungeon of Doom</TD><TD ALIGN=LEFT>Ouch! You bump into a door! 
</TD></TR><TR><TD>choiceAdventure40</TD><TD>Cola Wars 1</TD><TD ALIGN=LEFT>The Effervescent Fray 
</TD></TR><TR><TD>choiceAdventure41</TD><TD>Cola Wars 2</TD><TD ALIGN=LEFT>Smells Like Team Spirit 

</TD></TR><TR><TD>choiceAdventure42</TD><TD>Cola Wars 3</TD><TD ALIGN=LEFT>What is it Good For? 
</TD></TR><TR><TD>choiceAdventure45</TD><TD>Spooky Forest 1</TD><TD ALIGN=LEFT>Maps and Legends 
</TD></TR><TR><TD>choiceAdventure46</TD><TD>Spooky Forest 2</TD><TD ALIGN=LEFT>An Interesting Choice 
</TD></TR><TR><TD>choiceAdventure47</TD><TD>Spooky Forest 3</TD><TD ALIGN=LEFT>Have a Heart 

</TD></TR><TR><TD>choiceAdventure73</TD><TD>Whitey’s Grove 1</TD><TD ALIGN=LEFT>Don’t Fence Me In 
</TD></TR><TR><TD>choiceAdventure74</TD><TD>Whitey’s Grove 2</TD><TD ALIGN=LEFT>The Only Thing About Him… 
</TD></TR><TR><TD>choiceAdventure75</TD><TD>Whitey’s Grove 3</TD><TD ALIGN=LEFT>Rapido! 

</TD></TR></TABLE>
Changing the settings for these adventures is as easy as an ASH function like set_property(”choiceAdventure40″, “2″) or the CLI command “set choiceAdventure46=3″. To be candid, I can never figure out the correct numeric value by any amount of cleverness, so what I do is to log in to KoLmafia, use the Preferences Window to set the value to what I want, quit KoLmafia, and then check my character’s .txt file to see the value that was set for the appropriate key.
By contrast, there is limited support for setting the adventures in the upper set, as these are compound settings. The two that are most affected are Castle Wheel, which controls all of choiceAdventure9 through choiceAdventure12, and which corpse you want to loot in the Spooky Forest, which covers choiceAdventure26 through choiceAdventure29. Again, your best bet is to set these two adventures to the choice you want and then check your data file to see which specific settings correspond to the high-level decision. So far as I know, there is no way to use scripts to specify your choices for the Astral Trip.
A full list of the choice adventure numbers can be found on the KoL Wiki here: [http://kol.coldfront.net/thekolwiki/index.php/Choice_adventures_by_number]
However, 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).

<h3>Other KoLmafia-based preferences</h3>
This is going to be a limited survey of the more interesting of the settings that you can control.
battleAction - This specifies the strategy that you will use in battle. The sorts of values that you might select here are “attack” for normal attacking, “custom” to use the Custom Combat Scripts, “item dictionary” when you’re adventuring in the Valley beyond Orc Chasm, or “skill thrust smack” to use TS during the entire battle.

hpAutoRecovery - This is a float value that specifies the percentage of your HP at which the autohealer kicks in. I haven’t tried it, but I think you’d be generally unhappy if you set it to something other than a multiple of 0.1.
hpAutoRecoveryTarget - A companion to the above, this is the target that the autohealer will aspire to achieve.
As before, feel free to peruse the .kcs file to see all of the values. The names aren’t very subtle, so you should be able to guess what they’re all for.
<h3>User-defined variables</h3>
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).

Datatype Conversions

2008-07-21T07:32:54Z

Alhifar: /* Part 10 - Datatype Conversions */

== Part 10 - Datatype Conversions ==

These functions will convert 1 type of data to another.

string to_string( variable ) 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties. 
accepts: boolean, int, float, item, zodiac, location, familiar, class, stat, skill, effect, slot, element, monster

int to_int( variable ) 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you’re building raw URLs from time to time. 
accepts: String, float, item, zodiac, location, familiar, skill, effect, slot, element, monster, boolean, class, stat

boolean to_boolean( variable ) 
Converts the ASH-based object into boolean. 
Accepts: String, int

float to_float( variable ) 
Converts the ASH-based object into a float. 
Accepts: String, int

item to_item( variable ) 
Converts the ASH-based object into an item. 
Accepts: string, int


location to_location( variable ) 
Converts the ASH-based object into a location. 
Accepts: string


familiar to_familiar( variable ) 
Converts the ASH-based object into a familiar. 
Accepts: string, int


skill to_skill( variable ) 
Converts the ASH-based object into a skill. 
Accepts: string, int, effect


effect to_effect( variable ) 
Converts the ASH-based object into an effect. 
Accepts: string, int, skill


slot to_slot( variable ) 
Converts the ASH-based object into a slot. 
Accepts: item


monster to_monster( variable ) 
Converts the ASH-based object into a monster. 
Accepts: string

Datatype Conversions

2008-07-21T07:28:42Z

Alhifar: /* Part 10 - Datatype Conversions */

== Part 10 - Datatype Conversions ==

These functions will convert 1 type of data to another.

string to_string( variable ) 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties. 
accepts: boolean, int, float, item, zodiac, location, familiar, class, stat, skill, effect, slot, element, monster

int to_int( variable ) 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you’re building raw URLs from time to time. 
accepts: String, float, item, zodiac, location, familiar, skill, effect, slot, element, monster 
may accept: boolean, class, stat

boolean to_boolean( variable ) 
Converts the ASH-based object into boolean. 
Accepts: String 
may accept: Int

float to_float( variable ) 
Converts the ASH-based object into a float. 
Accepts: String, int

item to_item( variable ) 
Converts the ASH-based object into an item. 
Accepts: string, int


location to_location( variable ) 
Converts the ASH-based object into a location. 
Accepts: string


familiar to_familiar( variable ) 
Converts the ASH-based object into a familiar. 
Accepts: string, int


skill to_skill( variable ) 
Converts the ASH-based object into a skill. 
Accepts: string, int, effect


effect to_effect( variable ) 
Converts the ASH-based object into an effect. 
Accepts: string, int, skill


slot to_slot( variable ) 
Converts the ASH-based object into a slot. 
Accepts: item


monster to_monster( variable ) 
Converts the ASH-based object into a monster. 
Accepts: string

Miscellaneous Functions

2008-07-21T07:19:53Z

Alhifar: /* Part 7 - Miscellaneous */

== Part 7 - Miscellaneous ==
Mostly internal stuff. Some good for everyone, some only for ASH wizards.

void print( string output ) 
void print( string output, string color ) 
Prints output to the CLI buffer and displays it in the status line of the main Adventuring window. If color is specified any HTML in output is escaped and the string is wrapped in a font tag before being printed.

void logprint( string output ) 
Prints the output to the session log.

void print_html( string output ) 
Prints output to the CLI buffer, and parses any html.

boolean cli_execute( string command ) 
Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you’re careful and not an asshat, for raw URLs. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

void wait( int delay ) 
Sleeps for delay seconds.

string get_property( string key ) 
boolean set_property( string key, string value ) 
Gets or sets a stored property from your character’s .kcs file. 
The KoLmafia [[%28ASHRM%29_KoLMafia_Properties|properties]] page contains details on many of the keys that are available for access. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean file_to_map( string file_to_load, map map_to_fill ) 
boolean map_to_file( map map_to_save, string file_to_write ) 
Loads and saves maps as tab-delimited text files.

int random( int range ) 
Generates a random integer between 0 and (range-1) inclusive.

int round( float ratio ) 
int floor( float ratio ) 
int ceil( float ratio ) 
int truncate( float ratio ) 
Returns an integer near the given real number. Respectively, it returns the nearest, next lowest, next highest, and decimal-stripped integer.

int count( map ) 
Returns the number of defined keys for the aggregate.

void clear( map ) 
Remove all keys from a map. 

void disable( string function_name ) 
void enable( string function_name ) 
For debugging purposes disables or enables the indicated function

float square_root( float value ) 
returns the square root of the passed value

string today_to_string() 
Returns today’s (real-world) date in the form yyyymmdd. It is based on your computer’s system date

Adventuring

2008-07-21T07:15:11Z

Alhifar: /* Part 5 - Adventuring */

== Part 5 - Adventuring ==
Go get ‘em, tiger!

boolean adventure( int visits, [[%28ASHRM%29_Datatype_Constants#.24location.5Bconstant.5D|location place]] ) 
Visits the desired place the number of times that you wish. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

void add_item_condition( int quantity, [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Specifies adventuring conditions. With conditions in place, adventure(…) will successfully complete before using all the specified adventures if the conditions are all met. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for additional condition programming.

void council() 
Visits the Council of Loathing.

item guardians() 
Climbs the Naughty Sorceress’ Tower and passes the challenges that it can. If it completes the challenge, it returns $item[none]. Otherwise, it returns the item that is needed to pass the next stage.

boolean guild() 
boolean gourd() 
int tavern() 
boolean nemesis() 
boolean entryway() 
boolean hedgemaze() 
boolean chamber() 
Attempts to perform the associated tasks. The return value indicates the success. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

boolean train_familiar( int nGoal, string sGoal ) 
Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target weight or desired number of battles.

location my_location() 
Returns the location where you last adventured. 

void refresh_status() 
Grabs a fresh copy of your sidebar, so that information on your health, effects, and such will be guaranteed accurate. In theory, this is not necessary unless you are attempting to script your own custom combat function.

monster [int] get_monsters( [[%28ASHRM%29_Datatype_Constants#.24location.5Bconstant.5D|location place]] ) 
returns an integer indexed map of potential monsters in the given location.

int monster_base_attack( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
int monster_base_defense( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
int monster_base_hp( [[%28ASHRM%29_Datatype_Constants#.24monster.5Bconstant.5D|monster eek]] ) 
Returns the stats for the given monster. 

spiceloop is a verified kolmafia ash function however the parameters and return type are speculation. This needs verified. 
void spiceloop( int count ) 
Executes kolmafia’s internal spiceloop for the specified number of adventures.

element monster_attack_element( monster ) 
element monster_defense_element( monster ) 
Returns the given monsters attack element and element which it can defend against.

buffer run_combat() 
Uses the built in mafia combat to run a combat. For use with visit_url.

Equipment

2008-07-21T07:07:34Z

Alhifar: /* Part 3 - Equipment */

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]], [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the specified spot.

item equipped_item( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Returns the item currently equipped in the given slot. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean have_equipped( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

stat weapon_type( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you what stat your weapon bases its hit chance on.

boolean have_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean use_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check equipped_item( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

Equipment

2008-07-21T07:05:51Z

Alhifar: /* Part 3 - Equipment */

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]], [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the specified spot.

item equipped_item( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Returns the item currently equipped in the given slot. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean have_equipped( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean ranged_weapon( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) Function no longer available. Someone who knows better, please show a workaround here.
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean use_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check equipped_item( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

Equipment

2008-07-21T07:02:24Z

Alhifar: /* Part 3 - Equipment */ removed unequip commands and equip_slot, they no longer exist

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]], [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 

item equipped_item( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Returns the item currently equipped in the given slot. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean have_equipped( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean ranged_weapon( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) Function no longer available. Someone who knows better, please show a workaround here.
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean use_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check equipped_item( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

String Handling Routines

2008-07-21T04:32:44Z

Alhifar: Damn it, it's hard enough to keep this updated without it getting screwed with!

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string [[visit_url alpha|visit_url( string url )]] 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

buffer append( buffer source, string text ) 
Returns the source buffer with the string added on at the end. 
buffer append_tail( matcher regex, buffer source ) 
This function appends the text returned by a matcher to the end of the buffer text.

Ashref

2008-07-13T02:30:19Z

Alhifar: Fixed copy-paste error

Ashref

2008-07-13T02:27:13Z

Alhifar: /* Example */ updated to 6192

[[ashref]]

AshRef is not an actual ash function, it is a cli function.

Enter "ashref" into the Graphical cli with no parameters will display a list of all available ASH scripting functions.

Entering "ashref " and a partial command name will display all commands matching the partial command name entered.

==Example==
Entering "ashref string" into the GCLI in subversion 6192 yields: 

<TABLE CELLPADDING=1 cellspacing=3 BORDER=1px>
<tr><td>
void enable( string ) 
void disable( string ) 
boolean user_confirm( string ) 
void logprint( string ) 
void print( string ) 
void print( string, string ) 
void print_html( string ) 
void abort( string ) 
void abort( ) 
boolean cli_execute( string ) 
buffer load_html( string ) 
void write( string ) 
void writeln( string ) 
string form_field( string ) 
buffer visit_url( ) 
buffer visit_url( string ) 
void wait( int ) 
string to_string( any ) 
boolean to_boolean( any ) 
int to_int( any ) 
float to_float( any ) 
item to_item( string ) 
item to_item( int ) 
class to_class( string ) 
stat to_stat( string ) 
skill to_skill( int ) 
skill to_skill( string ) 
skill to_skill( effect ) 
effect to_effect( int ) 
effect to_effect( string ) 
effect to_effect( skill ) 
location to_location( string ) 
familiar to_familiar( int ) 
familiar to_familiar( string ) 
monster to_monster( string ) 
slot to_slot( item ) 
string to_url( location ) 
string today_to_string( ) 
int moon_phase( ) 
int moon_light( ) 
stat stat_bonus_today( ) 
stat stat_bonus_tomorrow( ) 
string [int] session_logs( int ) 
string [int] session_logs( string, int ) 
boolean adventure( int, location ) 
void add_item_condition( int, item ) 
boolean buy( int, item ) 
boolean create( int, item ) 
boolean use( int, item ) 
boolean eat( int, item ) 
boolean drink( int, item ) 
boolean put_closet( int, item ) 
boolean put_shop( int, int, item ) 
boolean put_stash( int, item ) 
boolean put_display( int, item ) 
boolean take_closet( int, item ) 
boolean take_storage( int, item ) 
boolean take_display( int, item ) 
boolean take_stash( int, item ) 
boolean autosell( int, item ) 
boolean hermit( int, item ) 
boolean retrieve_item( int, item ) 
int [item] get_inventory( ) 
boolean is_npc_item( item ) 
boolean is_tradeable( item ) 
item daily_special( ) 
boolean refresh_stash( ) 
int available_amount( item ) 
int item_amount( item ) 
int closet_amount( item ) 
int creatable_amount( item ) 
int [item] get_ingredients( item ) 
int storage_amount( item ) 
int display_amount( item ) 
int shop_amount( item ) 
int stash_amount( item ) 
int pulls_remaining( ) 
int stills_available( ) 
boolean have_mushroom_plot( ) 
boolean refresh_status( ) 
boolean restore_hp( int ) 
boolean restore_mp( int ) 
string my_name( ) 
string my_id( ) 
string my_hash( ) 
boolean in_muscle_sign( ) 
boolean in_mysticality_sign( ) 
boolean in_moxie_sign( ) 
boolean in_bad_moon( ) 
class my_class( ) 
int my_level( ) 
int my_hp( ) 
int my_maxhp( ) 
int my_mp( ) 
int my_maxmp( ) 
stat my_primestat( ) 
int my_basestat( stat ) 
int my_buffedstat( stat ) 
int my_meat( ) 
int my_adventures( ) 
int my_turncount( ) 
int my_fullness( ) 
int fullness_limit( ) 
int my_inebriety( ) 
int inebriety_limit( ) 
int my_spleen_use( ) 
int spleen_limit( ) 
boolean can_eat( ) 
boolean can_drink( ) 
int turns_played( ) 
boolean can_interact( ) 
boolean in_hardcore( ) 
boolean have_skill( skill ) 
int mp_cost( skill ) 
int turns_per_cast( skill ) 
int have_effect( effect ) 
boolean use_skill( int, skill ) 
boolean use_skill( int, skill, string ) 
buffer attack( ) 
buffer steal( ) 
buffer runaway( ) 
buffer use_skill( skill ) 
buffer throw_item( item ) 
buffer throw_items( item, item ) 
buffer run_combat( ) 
boolean can_equip( item ) 
boolean equip( item ) 
boolean equip( slot, item ) 
item equipped_item( slot ) 
boolean have_equipped( item ) 
boolean outfit( string ) 
boolean have_outfit( string ) 
familiar my_familiar( ) 
boolean have_familiar( familiar ) 
boolean use_familiar( familiar ) 
item familiar_equipment( familiar ) 
int familiar_weight( familiar ) 
int weapon_hands( item ) 
string item_type( item ) 
stat weapon_type( item ) 
int get_power( item ) 
void council( ) 
int current_mcd( ) 
boolean change_mcd( int ) 
boolean have_chef( ) 
boolean have_bartender( ) 
boolean contains_text( string, string ) 
int extract_meat( string ) 
int [item] extract_items( string ) 
int length( string ) 
int index_of( string, string ) 
int index_of( string, string, int ) 
int last_index_of( string, string ) 
int last_index_of( string, string, int ) 
string substring( string, int ) 
string substring( string, int, int ) 
string to_lower_case( string ) 
string to_upper_case( string ) 
buffer append( buffer, string ) 
buffer insert( buffer, int, string ) 
boolean replace( buffer, int, int, string ) 
buffer delete( buffer, int, int ) 
buffer append_tail( matcher, buffer ) 
buffer append_replacement( matcher, buffer, string ) 
matcher create_matcher( string, string ) 
boolean find( matcher ) 
boolean start( matcher ) 
boolean end( matcher ) 
boolean group( matcher ) 
boolean group( matcher, int ) 
boolean group_count( matcher ) 
string replace_first( matcher, string ) 
string replace_all( matcher, string ) 
matcher reset( matcher ) 
matcher reset( matcher, string ) 
buffer replace_string( buffer, string, string ) 
buffer replace_string( string, string, string ) 
string [int] split_string( string ) 
string [int] split_string( string, string ) 
string [int, int] group_string( string, string ) 
void chat_reply( string ) 
boolean entryway( ) 
boolean hedgemaze( ) 
item guardians( ) 
boolean chamber( ) 
int tavern( ) 
int random( int ) 
int round( float ) 
int truncate( float ) 
int floor( float ) 
int ceil( float ) 
float square_root( float ) 
string url_encode( string ) 
string url_decode( string ) 
string get_property( string ) 
void set_property( string, string ) 
int count( aggregate ) 
void clear( aggregate ) 
boolean file_to_map( string, aggregate ) 
boolean file_to_map( string, aggregate, boolean ) 
boolean map_to_file( aggregate, string ) 
boolean map_to_file( aggregate, string, boolean ) 
location my_location( ) 
monster [int] get_monsters( location ) 
int expected_damage( ) 
int expected_damage( monster ) 
int monster_level_adjustment( ) 
int weight_adjustment( ) 
int mana_cost_modifier( ) 
int raw_damage_absorption( ) 
float damage_absorption_percent( ) 
int damage_reduction( ) 
float elemental_resistance( element ) 
float elemental_resistance( ) 
float elemental_resistance( monster ) 
float combat_rate_modifier( ) 
float initiative_modifier( ) 
float experience_bonus( ) 
float meat_drop_modifier( ) 
float item_drop_modifier( ) 
int buffed_hit_stat( ) 
stat current_hit_stat( ) 
element monster_element( ) 
element monster_element( monster ) 
int monster_attack( ) 
int monster_attack( monster ) 
int monster_defense( ) 
int monster_defense( monster ) 
int monster_hp( ) 
int monster_hp( monster ) 
int item_drops( ) 
int item_drops( monster ) 
boolean will_usually_miss( ) 
boolean will_usually_dodge( ) 
float numeric_modifier( string ) 
float numeric_modifier( item, string ) 
float numeric_modifier( effect, string ) 
float numeric_modifier( skill, string ) 
boolean boolean_modifier( string ) 
boolean boolean_modifier( item, string ) 
effect effect_modifier( item, string ) 
class class_modifier( item, string ) 
stat stat_modifier( effect, string ) 
</td></tr>
</table>

String Handling Routines

2008-07-13T01:33:48Z

Alhifar: Added append_tail and append

String Handling Routines

2008-07-12T07:42:35Z

Alhifar: /* Part 8 - String Handling Routines */

String Handling Routines

2008-07-09T18:41:22Z

Alhifar:

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string visit_url( string url ) 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

String Handling Routines

2008-07-08T05:10:03Z

Alhifar:

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string visit_url( string url ) 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

String Handling Routines

2008-07-07T06:09:44Z

Alhifar: Spammers need to die.

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string visit_url( string url ) 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

String Handling Routines

2008-07-07T05:32:52Z

Alhifar: Hopefully latest real version.

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string visit_url( string url ) 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879