Kolmafia - User contributions [en]

Create matcher

2010-09-13T19:57:48Z

Matt.chugg:

{{
#vardefine:name|create_matcher}}{{
#vardefine:return_type|matcher}}{{

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|regex}}|
p1desc={{pspan|regex}} is the regular expression to use|
parameter2={{Param|string|input}}|
p2desc={{pspan|input}} is the string to search with a regular expression|
}}|

function_description=Creates a matcher from a pattern and input string.|

needscode=yes|

code1={{CodeSample|
title=Code Sample|
description=The following code will check if you are entitled to any new trophies and if so will attempt to buy them.|
code=<syntaxhighlight>
string trophypage = visit_url("trophy.php");
matcher trophymatcher = create_matcher("name\=whichtrophy.*?value\=(.*?)\>",trophypage);
while (find(trophymatcher)){
if (my_meat() >= 10000) {
string buytrophy=visit_url("trophy.php?action=buytrophy&whichtrophy="+group(trophymatcher,1),true);
} else {
print("Not enough meat","red");
}
}
</syntaxhighlight>}}|

}}

[[Category:String Handling Routines]]

Create matcher

2010-09-13T19:56:55Z

Matt.chugg: adding code sample, properly this time!

{{
#vardefine:name|create_matcher}}{{
#vardefine:return_type|matcher}}{{

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|regex}}|
p1desc={{pspan|regex}} is the regular expression to use|
parameter2={{Param|string|input}}|
p2desc={{pspan|input}} is the string to search with a regular expression|
}}|

function_description=Creates a matcher from a pattern and input string.|

needscode=yes|

code1={{CodeSample|
title=Code Sample|
description=The following code will check if you are entitled to any new trophies and if so will attempt to buy them.
code=<syntaxhighlight>
string trophypage = visit_url("trophy.php");
matcher trophymatcher = create_matcher("name\=whichtrophy.*?value\=(.*?)\>",trophypage);
while (find(trophymatcher)){
if (my_meat() >= 10000) {
string buytrophy=visit_url("trophy.php?action=buytrophy&whichtrophy="+group(trophymatcher,1),true);
} else {
print("Not enough meat","red");
}
}
</syntaxhighlight>}}|

}}

[[Category:String Handling Routines]]

User talk:Matt.chugg

2010-09-13T19:53:58Z

Matt.chugg: I hate wiki markup!

I hate wiki markup.

Create matcher

2010-09-13T19:53:28Z

Matt.chugg:

Create matcher

2010-09-13T19:52:58Z

Matt.chugg: fix messed up code sample

{{
#vardefine:name|create_matcher}}{{
#vardefine:return_type|matcher}}{{

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|regex}}|
p1desc={{pspan|regex}} is the regular expression to use|
parameter2={{Param|string|input}}|
p2desc={{pspan|input}} is the string to search with a regular expression|
}}|

function_description=Creates a matcher from a pattern and input string.|

needscode=yes|

code1={{CodeSample|
title=Code Sample|
description=The following code will check if you are entitled to any new trophies and if so will attempt to buy them.
code=<syntaxhighlight>
string trophypage = visit_url("trophy.php");
matcher trophymatcher = create_matcher("name\=whichtrophy.*?value\=(.*?)\>",trophypage);
while (find(trophymatcher)){
if (my_meat() >= 10000) {
string buytrophy=visit_url("trophy.php?action=buytrophy&whichtrophy="+group(trophymatcher,1),true);
} else {
print("Not enough meat","red");
}
}
</syntaxhighlight>

}}

[[Category:String Handling Routines]]

Create matcher

2010-09-13T19:52:15Z

Matt.chugg: add code sample

{{
#vardefine:name|create_matcher}}{{
#vardefine:return_type|matcher}}{{

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|regex}}|
p1desc={{pspan|regex}} is the regular expression to use|
parameter2={{Param|string|input}}|
p2desc={{pspan|input}} is the string to search with a regular expression|
}}|

function_description=Creates a matcher from a pattern and input string.|

needscode=yes|

}}

code1={{CodeSample|
title=Code Sample|
description=The following code will check if you are entitled to any new trophies and if so will attempt to buy them.
code=<syntaxhighlight>
string trophypage = visit_url("trophy.php");
matcher trophymatcher = create_matcher("name\=whichtrophy.*?value\=(.*?)\>",trophypage);
while (find(trophymatcher)){
if (my_meat() >= 10000) {
string buytrophy=visit_url("trophy.php?action=buytrophy&whichtrophy="+group(trophymatcher,1),true);
} else {
print("Not enough meat","red");
}
}
</syntaxhighlight>

[[Category:String Handling Routines]]

Miscellaneous Functions

2009-08-31T08:03:23Z

Matt.chugg: /* 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

'''void [[batch_open()]]'''

'''boolean [[batch_close()]]'''

'''void [[abort()]]''' 
'''void [[abort()|abort( string message )]]''' 
Aborts the current script with an optional message.

Miscellaneous Functions

2009-08-31T08:01:06Z

Matt.chugg: /* 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

'''void [[batch_open()]]'''

'''boolean [[batch_close()]]'''

'''void [[abort()]]''' Aborts the current script with an optional message.

Miscellaneous Functions

2009-08-31T08:00:02Z

Matt.chugg: /* Part 7 - Miscellaneous */ added abort() (to existing page)

Miscellaneous Functions

2009-08-31T07:54:35Z

Matt.chugg: /* Part 7 - Miscellaneous */ added batch_open(), batch_close()

Helpful Links

2009-08-30T08:51:36Z

Matt.chugg:

KoLMafia:

[http://kolmafia.sourceforge.net Download KoLMafia]

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

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

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

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

[http://kolmafia.us The KoLMafia Script Repository]

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

[http://builds.kolmafia.us/ Daily builds of KoLMafia]

KoL:

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

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

Helpful Links

2009-08-30T08:51:24Z

Matt.chugg: Added link to daily builds

KoLMafia:

[http://kolmafia.sourceforge.net Download KoLMafia]

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

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

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

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

[http://kolmafia.us The KoLMafia Script Repository]

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

[http://builds.kolmafia.us/ Daily builds of KoLMafia

KoL:

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

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

Compiling from Source

2009-08-30T08:46:26Z

Matt.chugg: Fixed typo

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

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

==Linux==

==Mac==