Difference between revisions of "String Handling Routines"

From Kolmafia
Jump to navigation Jump to search
(given that "progress level" goes to 99 when this page is destroyed, I wonder if there's a way to script this reversion)
(hDghqMve)
Line 1: Line 1:
== Part  8 - String Handling Routines ==
+
270_96.txt;8;12
<p><em>Under Construction</em></p>
 
<p><strong>void print( string helloworld )</strong><br>
 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.</p>
 
<p><strong>string [[visit_url alpha|visit_url( string url )]]</strong><br>
 
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.</p>
 
<p><strong>string location_to_url( location place )</strong><br>
 
 
 
Returns the URL that would need to be accessed to visit the specified location.</p>
 
<p><strong>boolean contains_text( string source, string query )</strong><br>
 
Reveals if the query string is a substring of the source string.</p>
 
<p><strong>int extract_meat( string text )</strong><br>
 
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.*</p>
 
<p><strong>int [item] extract_items( string text )</strong><br>
 
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.*</p>
 
<p><strong>int length( string text )</strong><br>
 
Returns the length of the given string.</p>
 
 
 
<p><strong>int index_of( string source, string search )</strong><br>
 
Returns the first index of a given substring in a string.<br>
 
<strong>int index_of( string source, string search, int start )</strong><br>
 
Returns the next index of a given substring in a string starting from the given position.<br>
 
<strong>int last_index_of( string source, string search )</strong><br>
 
Returns the last index of a given substring in a string.</p>
 
<p><strong>string substring( string source, int startfrom )</strong><br>
 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character.<br>
 
<strong>string substring( string source, int start, int end )</strong><br>
 
 
 
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.</p>
 
<p><strong>string replace_string( string source, string search, string replace )</strong><br>
 
searches the source string for the search string and replaces all instances with the replace string</p>
 
<p><strong>string url_encode( string text )</strong><br>
 
<strong>string url_decode( string text )</strong><br>
 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.</p>
 
 
 
<p><strong>string [int] split_string( string source )</strong><br>
 
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/showthread.php?t=573 <br>
 
<strong>string [int] split_string( string source, string regex )</strong><br>
 
<strong>string [int,int] group_string( string source, string regex )</strong><br>
 
see this post located on the script repository for more information:  http://kolmafia.us/showthread.php?t=318 </p>
 
 
 
<strong>string [int] session_logs( string player, int day_count )</strong>
 
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/showthread.php?t=573
 
 
 
<p><strong>buffer append( buffer source, string text )</strong><br>
 
Returns the source buffer with the string added on at the end.<br>
 
<strong>buffer append_tail( matcher regex, buffer source )</strong><br>
 
This function appends the text returned by a matcher to the end of the buffer text.
 

Revision as of 02:51, 18 November 2009

270_96.txt;8;12