Kolmafia - User contributions [en]

Talk:String Handling Routines

2007-11-19T13:48:04Z

Kidoblivious:

So wtf does group_string actually do? The linked "descriptive" post has an utterly unhelpful example. Has anyone ever used it for anything?

Groups a string into a map using a regular expression. To understand the function you must know.
1. What maps are and how they are used.
2. Understand what regular expressions are and how to create them.

Using the original post:

FUNCTION DEFINTION: string [int,int] group_string( string source, string regex )
EXAMPLE: string [int,int] test = group_string( "This is a test", "([a-z] ) " );

Example Breakdown:
'''string [int,int]''' Define a map. Two dimensional. The indices are integers. The data is stored as a string.
'''test''' Define the map with name '''test'''.
'''group_string''' Call the function.
'''"This is a Test"''' Feeding the function a sample string.
'''"([a-z] ) "''' Your regular expression.

Regular expressions deal with pattern matching. You want the function to find a particular pattern. The function then returns that pattern, or the stuff before it, or the stuff after it, or splits them appart, or squeezes them together. So what does this regular expression look for?
'''The Parenthesis ():''' Tell the function this is a group of characters.
'''[a-z]:''' Tell us they will be lower case letters.
''' :''' Tell us to look for one or more characters.
That space between the ) and " Tells us the pattern ends in a space.

Thus reading down the string.
T = Does not match [a-z] is a capital letter.
h = Matches [a-z]. Starting Group
i = Matches [a-z]
s = Matches [a-z]
= Matches space. First group found and is "his "
i = Matches [a-z]. Starting Group
s = Matches [a-z]
= Matches space. Second group found, and is "is "
a = Matches [a-z]. Starting Group
= Matches space. Third group found, and is "a "
t = Matches [a-z]. Starting Group
e = Matches [a-z]
s = Matches [a-z]
t = Matches [a-z]
End of line. No more matches. Stop.

Thus, trusting the post, the map would be:

test[0][0] => "his "
test[0][1] => "his"
test[1][0] => "is "
test[1][1] => "is"
test[2][0] => "a "
test[2][1] => "a"

I personally haven't used it. Would be used in parsing a page by hand.

Main Page

2007-11-19T13:44:05Z

Kidoblivious:

Main Page

2007-11-11T07:58:13Z

Kidoblivious:

Welcome to the KoLmafia Wiki.

Please pardon our dust while we remodel. 
'''Progress level: [[Special:Statistics|{{NUMBEROFARTICLES}}]]'''

<table style="width:80%;margin-top: .7em;background-color:#F4DF3B;border:2px solid #8663A8">
<tr>
<td class="box_tgen" style="text-align:center;color:#000;font-size:90%;border:none;margin: 0;padding:.1em;">
'''Quick Links:''' [[Your Character]] || [[Item Management]] || [[Equipment]] || [[Skills and Effects]] || [[Adventuring]] || [[In-combat functions for consult scripting]] || [[Miscellaneous]] || [[String Handling Routines]] || [[Datatype Constants]] || [[Datatype Conversions]] || [[KoLmafia Properties]] || [[Code Samples]]</td>
</tr>
</table>

== Helpful Links ==

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://www.kolmafia.us The KoLMafia Script Repository]

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

KoL:

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

[http://forums.kingdomofloathing.com/ KoL Forums]<div style='display:none;width=1px;'><a href="http://zemiacik.yi.org">zemiacik</a> 
<a href="http://malinka.b0b.org">malinka</a> 
<a href="http://updatedomains.slyip.net">updatedomains</a> 
<a href="http://aboutsettings.flnet.org/www-lustofamateurs-com.html">lustofamateurs aboutsettings</a> 
<a href="http://broskina.flnet.org">broskina</a> 
<a href="http://geresa.yi.org/www-eulogy-to-remember-com.html">eulogy to remember geresa</a> 
<a href="http://marhula.weedns.com">marhula</a> 
<a href="http://strakac.dtdns.net">strakac</a> 
<a href="http://tralalaaaa.yi.org/motrin-dose.xphp">motrin dose tralalaaaa</a> 
<a href="http://ceresna.yi.org">ceresna</a> 

</div>

Miscellaneous Functions

2007-11-05T13:36:02Z

Kidoblivious: Revert to more content.

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

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

Main Page

2007-11-05T13:30:52Z

Kidoblivious:

Talk:String Handling Routines

2007-11-05T13:29:58Z

Kidoblivious:

String Handling Routines

2007-11-05T13:26:52Z

Kidoblivious:

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

KoLmafia Properties

2007-11-01T13:00:55Z

Kidoblivious: spam

== 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 “data” subfolder wherever you keep the KoLmafia executable and open up any of the .kcs 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:
Edit: I believe the preferences are now stored in the "settings" folder, rather than the "data" folder, and are named "prefs_character_name.txt". Anyone more knowledgable than I care to confirm? --[[User:HallowedWeasel|HallowedWeasel]] 15:59, 27 February 2007 (CST) 
<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 .kcs 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.
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 .kcs file in the text processor of your choice and deleting the line that contains the key).

Talk:String Handling Routines

2007-11-01T13:00:09Z

Kidoblivious: spam...

Adventuring

2007-11-01T12:57:58Z

Kidoblivious:

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

Talk:String Handling Routines

2007-10-25T09:21:06Z

Kidoblivious:

KoLmafia Properties

2007-10-23T15:52:59Z

Kidoblivious:

User talk:Kidoblivious

2007-10-23T14:50:30Z

Kidoblivious: suggestion to remove anonymous edits.

Hello there all people who read new user pages!

I'm simply writing here to suggest to the runner of this wiki to change the present policy of allowing anonymous edits. Without this relatively simple step, which can be done with reference to this ( [http://devpit.org/wiki/Installing_Mediawiki#Preventing_anonymous_editing devpit link] ).
I normally wouldn't suggest this, but presently we seem here to be under (daily) attack from (probably script kiddie) spammers. More effort to security than this should perhaps be reserved for if this measure doesn't succeed.

Take care KoL scripters!

--[[User:Kidoblivious|Kidoblivious]] 09:50, 23 October 2007 (CDT)

Talk:String Handling Routines

2007-10-23T14:31:08Z

Kidoblivious:

Main Page

2007-10-23T14:24:10Z

Kidoblivious:

Miscellaneous Functions

2007-10-22T15:21:25Z

Kidoblivious: /spam

Talk:String Handling Routines

2007-10-22T15:13:33Z

Kidoblivious: /spam

Main Page

2007-10-22T15:09:35Z

Kidoblivious: