Kolmafia - User contributions [en]

User:Metraxis

2009-08-30T16:10:42Z

Metraxis: Added the Linux install page

[[User:Metraxis|Metraxis]]:

A KoL player of old but not ancient vintage (after Black Sunday, but before Ascension), and a somwhat prolific scripter.

Currently working on: Adding and segmenting basic ASH information. Only a few edits have been done so far, as 'proof of concept', in order to draw comment before expanding to larger chunks of the wiki.

----

Pages Authored by Metraxis:

[[User:Metraxis]]

[[my_name()]]

[[Template:Primitive]]

[[string]]

[[my_class()]]

[[Template:Enumerated]]

[[class]]

[[int]]

[[my_level()]]

[[location]]

[[item]]

[[my_adventures()]]

[[my_turncount()]]

[[can_interact()]]

[[boolean]]

[[my_inebriety()]]

[[inebriety_limit()]]

[[void]]

[[Linux]]

Mall price

2009-08-04T15:22:55Z

Metraxis: Correction to offline return value

[[int]] '''mall_price( item it )'''

Returns the current mall price of the given item. Specifically it returns the price of the 5th item that would be purchased. Hopefully this will skip over some limited items and give you useful data. If items are purchased mall_price is automatically increased to the price of the new 5th item.

For example, if there are 7 Stench Wads priced at 385 meat and 700 priced at 390, the following code:

<code>
print("stench wad price: "+ mall_price($item[stench wad]));
buy(5, $item[stench wad]);
print("stench wad price: "+ mall_price($item[stench wad]));
buy(5, $item[stench wad]);
print("stench wad price: "+ mall_price($item[stench wad]));
</code>

Will yield this output:

<code>
Searching for "stench wad"...
stench wad price: 385
Searching for "stench wad"...
Purchasing stench wad (5 @ 385)...
You acquire stench wad (5)
Purchases complete.
stench wad price: 390
Using cached search results for stench wad...
Purchasing stench wad (2 @ 385)...
You acquire stench wad (2)
Purchasing stench wad (3 @ 390)...
You acquire stench wad (3)
Purchases complete.
stench wad price: 390
</code>

Notice how mall_price went to 390 before any stench wads were purchased at that price. Magic!
[[Category:Your Character | My meat()]]
[[Category:Ash Functions | My meat()]]

When not logged in, this function returns -1.

<center><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;">
'''See Also:''' [[my_closetmeat()]] || [[item_amount()]]</td>
</tr></table></center>

Main Page

2007-09-16T15:20:06Z

Metraxis: Revert

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

Miscellaneous Functions

2007-09-15T17:03:21Z

Metraxis: Revert. Again.

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

void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window

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 ) 
Does nothing for the desired number of 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

Talk:String Handling Routines

2007-09-15T17:02:27Z

Metraxis: Revert. Again.

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-09-15T16:51:16Z

Metraxis: Revert. Again.

Can interact

2007-02-18T17:36:00Z

Metraxis: Spelling Error

[[boolean]] [[can_interact()]]

This function returns true if the logged-in character is subject to neither the Hardcore or Ronin restrictions on inter-player interactions. If the character has not spent the requisite turns and/or has not freed the King (for Hardcore characters), the function returns false.

An example:

<code>
if([[can_interact()]]) {
buy(3,$[[item]][hot hi mein]);
} else {
adventure(10,$[[location]][Knob Goblin Kitchens]);
}
</code>

Can interact

2007-02-18T17:35:22Z

Metraxis: Spelling Error

[[boolean]] [[can_interact()]]

This function returns true if the logged-in character is subject to neither the Hardcore or Ronin restrictions on inter-player interactions. If the chracter has not spent the requisite turns and/or has not freed the King (for Hardcore characters), the function returns false.

An example:

<code>
if([[can_interact()]]) {
buy(3,$[[item]][hot hi mein]);
} else {
adventure(10,$[[location]][Knob Goblin Kitchens]);
}
</code>

Talk:Main Page

2007-02-18T17:27:50Z

Metraxis:

Save these links for now:

== Getting started ==

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

== Wiki layout... ==

We really should consider exactly how to lay out the wiki... We should probably see how others (especially the KoL wiki) do it and take inspiration... :)

Also, I'm thinking we should eventually have a page for each function, to make searching the wiki more valuable... :)

--[[User:Daychilde|Daychilde]] 23:00, 8 January 2007 (CST)

I agree with your idea about one-page-per-function.

Also I think every* function's documentation should show a real-world example of use. The links to example scripts are a good start in this direction, but some code to read right on the function page would be nice. (*Yes, even the "you are not cool enough to use this" undocumented stuff.)

A master ASH function list page would be helpful. When trying to Find a keyword in browser to see if KM implements a given functionality, it's a minor PITA to have to click into each categorized page and search them all individually.

Also welcome would be some kind of icon, color, or other indicator for newly-added functions. Master list sorted/sortable by implementation version/date if possible.

Also, on the subject of general layout/UI improvements (since you asked): for the main page, I prefer a high-level bulleted-listy index/ToC, kinda like the ToCs on the current sourceforge manual pages. Personally, I find this more useful than the increasingly popular "widgety-portaly-stocks-news-and-weather" look.

Redundancy should be removed wherever possible -- e.g. (ASHRM) in front of every link. I understand if prefixes of that sort are there to assist in organizing the underlying database, but if not, I think they are totally unnecessary and a distraction -- that is, provided the containing page is appropriately identified with a nice big "ASH Reference Manual" heading at the top, breadcrumbs, etc.

I'll quit before I arrive at a frenzy of usability fanaticism the likes of which would make J. Nielsen repent like a dirty sinner. (Got work to do, actually. Now maybe if there was a "job opportunities" section.......)

--[[User:somebody who sincerely appreciates not having to register/login and probably wouldn't participate elsewise]] 12:35, 30 January 2007 (EST)

On the other hand, speed-bumping idiot apammers may be worth it. I could go on for ages about how offensive I find that kind of griefing (If you think life isn't a game, you're doing it wrong)--[[User:Metraxis|Metraxis]] 11:27, 18 February 2007 (CST)

User:Metraxis

2007-01-23T07:36:42Z

Metraxis:

My inebriety

2007-01-23T07:36:26Z

Metraxis: New Page

[[int]] [[my_inebriety()]]

This function returns the logged-in character's current level of drunkenness as an [[int]]. This information, combined with the character's [[inebriety_limit()]], is vital for any script which intends to drink for the character, but without overdrinking.

An example:
<code>
if([[inebriety_limit()]] - [[my_inebriety()]] < 5) {
[[int]] advisable = [[inebriety_limit()]] - [[my_inebriety()]] - 1;
[[drink]](advisable,$[[item]][Ram's Face Lager]);
}
</code>

Inebriety limit

2007-01-23T07:35:47Z

Metraxis: Spelling

[[int]] [[inebriety_limit()]]

This function returns the minimum drunkenness at which the logged-in character will become falling-down drink as an [[int]]. For characters without a Liver of Steel, this value will be 15. For those characters with a Liver of Steel, this value is 20.

An example:

<code>
[[void]] get_sneaky() {
[[item]] FavoredDrink = $[[item]][grogtini];
while([[my_inebriety()]] < [[inebriety_limit()]]) {
[[drink]](1,FavoredDrink);
}
int cirrosis = [[inebriety_limit()]] + 10 - [[my_inebriety()]];
[[drink]](cirrosis,$item[green beer]);
if([[inebriety_limit()]] < 16) {
print("Not ... drunk ... enough. Need ... ! ... potion");
}
}
</code>

Inebriety limit

2007-01-23T07:35:19Z

Metraxis: New Page

[[int]] [[inebriety_limit()]]

This function returns the minimum drunkenness at which the logged-in character's will become falling-down drink as an [[int]]. For characters without a Liver of Steel, this value will be 15. For those characters with a Liver of Steel, this value is 20.

An example:

<code>
[[void]] get_sneaky() {
[[item]] FavoredDrink = $[[item]][grogtini];
while([[my_inebriety()]] < [[inebriety_limit()]]) {
[[drink]](1,FavoredDrink);
}
int cirrosis = [[inebriety_limit()]] + 10 - [[my_inebriety()]];
[[drink]](cirrosis,$item[green beer]);
if([[inebriety_limit()]] < 16) {
print("Not ... drunk ... enough. Need ... ! ... potion");
}
}
</code>

Void

2007-01-23T07:35:01Z

Metraxis: New Page

User:Metraxis

2007-01-20T08:23:16Z

Metraxis:

My turncount

2007-01-20T08:22:59Z

Metraxis: New Page

[[int]] [[my_turncount()]]

This function returns the total number of adventures used thus far by the logged-in character during the current ascension as an [[int]]. With the introduction of [[can_interact()]], the use of this function to determine whether a softcore character is still in Ronin is no longer required, but it can still be used for logging.

An example:

<code>
[[int]] [ [[string]] ] Accomplishments;

if(adventure(1,$[[location]][The Boss Bat's Lair]) {
Accomplishments["Defeated Boss Bat"] = [[my_turncount()]];
}
</code>

Can interact

2007-01-20T08:21:59Z

Metraxis: New Page

[[boolean]] [[can_interact()]]

This function returns true if the logged-in character is subject to neither the Hardcore or Ronin restrictions on inter-player interactions. If the chracter has not spent the requisite turns and/or has not freed the King (for Hardcore characters), the function returns false.

An example:

<code>
if([[can_interact()]]) {
buy(3,$[[item]][hot hi hein]);
} else {
adventure(10,$[[location]][Knob Goblin Kitchens]);
}
</code>

Boolean

2007-01-20T08:19:47Z

Metraxis: New Page

My adventures

2007-01-19T07:48:53Z

Metraxis: typo

[[int]] [[my_adventures()]]

This function returns the logged-in character's current number of remaining adventures as an [[int]]. Use of this function is essential in any kind of goal-seeking loop, lest it run on forever trying to adventure with no way to do so.

An example:
<code>
while([[my_adventures()]] >= 4) {
if(use(1,$[[item]][dance card])) {
adventure(3,$[[location]][Haunted Gallery]);
adventure(1,$[[location]][Haunted Ballroom]);
}
}</code>

My adventures

2007-01-19T07:48:26Z

Metraxis: Grammar

User:Metraxis

2007-01-19T07:47:40Z

Metraxis:

My adventures

2007-01-19T07:45:42Z

Metraxis: New Page

[[int]] [[my_adventures()]]

This function returns the logged-in character's current number of remaining adventures as an [[int]]. Use of this function is essential in any kind of goal-seeking loop, lest they run on forever trying to adventure with no way to do so.

An example:
<code>
while([[my_adventures()]] >= 4) {
if(use(1,$[[item]][dance card])) {
adventure(3,$[[location]][Haunted Gallery]);
adventure(3,$[[location]][Haunted Ballroom]);
}
}</code>

User:Metraxis

2007-01-18T06:50:00Z

Metraxis:

Item

2007-01-18T06:47:41Z

Metraxis:

My level

2007-01-18T06:47:10Z

Metraxis: More type links

[[int]] [[my_level()]]

This function returns the logged-in character's current level as an [[int]], and is easily used as an initial test to avoid aborts and loops in scripts which attempt to burn adventures in specific areas due to the targetted area being unavailable. An example:

<code>
[[location]] select_farming_area() {
if([[my_level()]] >= 10) {
if(item_amount($[[item]][S.O.C.K.]) + ...
item_amount($[[item]][intragalactic rowboat]) > 0) {
return $[[location]][Castle in the Clouds in the Sky];
} else {
return $[[location]][Penultimate Fantasy Airship];
}
} else if([[my_level()]] >= 8) {
...etc...
</code>

Location

2007-01-18T06:46:18Z

Metraxis:

My level

2007-01-18T06:45:03Z

Metraxis:

[[int]] [[my_level()]]

This function returns the logged-in character's current level as an [[int]], and is easily used as an initial test to avoid aborts and loops in scripts which attempt to burn adventures in specific areas due to the targetted area being unavailable. An example:

<code>
[[location]] select_farming_area() {
if([[my_level()]] >= 10) {
if(item_amount($item[S.O.C.K.]) + ...
item_amount($item[intragalactic rowboat]) > 0) {
return $[[location]][Castle in the Clouds in the Sky];
} else {
return $[[location]][Penultimate Fantasy Airship];
}
} else if([[my_level()]] >= 8) {
...etc...
</code>

My name

2007-01-18T06:34:31Z

Metraxis: Wiki-style formatting

[[string]] [[my_name()]]

This function returns the logged-in character's name as a [[string]].

My meat

2007-01-17T07:34:41Z

Metraxis: My meat moved to My meat(): Spelling correction

int my_meat() 
Returns the amount of meat you currently have in your inventory. This does not include meat you have in Your Colossal Closet or Hagnk's storage.
 
 
 
The following sample checks to see if you have enough meat to buy a hermit Permit and if you do, it will buy one.
<code>
int a = my_meat();
if(a <= 100)
{
buy(1, $item[hermit permit]);
}
</code>

The following code does the same, but places my_meat in the if statement rather than storing it in a variable first.
<code>
if(my_meat() <= 100)
{
buy(1, $item[hermit permit]);
}
</code>

<Center>
<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;">
'''See Also:''' [[my_closetmeat]] || [[item_amount]]</td>
</tr>
</table>
</Center>

My class

2007-01-17T07:33:17Z

Metraxis:

[[class]] my_class()

This function returns the logged-in character's current class as a [[class]].

As an example, the following code snippet decides how many big rocks to acquire based on the character's class:

<code>
[[int]] rocks;

if([[my_class()]] == $[[class]][Seal Clubber] ||
[[my_class()]] == $[[class]][Turtle Tamer] ||
[[my_class()]] == $[[class]][Disco Bandit]) {
rocks = 2;
} else {
rocks = 1;
}
</code>

User:Metraxis

2007-01-17T07:19:58Z

Metraxis:

Int

2007-01-17T07:19:31Z

Metraxis:

User:Metraxis

2007-01-17T07:17:58Z

Metraxis:

User:Metraxis

2007-01-17T07:13:36Z

Metraxis:

User:Metraxis

2007-01-17T07:11:15Z

Metraxis:

My class

2007-01-17T07:10:09Z

Metraxis:

[[class]] my_class()

This function returns the logged-in character's current class as a [[class]].

User:Metraxis

2007-01-17T07:08:06Z

Metraxis:

User:Metraxis

2007-01-15T17:38:02Z

Metraxis:

String

2007-01-15T17:33:45Z

Metraxis:

User:Metraxis

2007-01-15T17:32:39Z

Metraxis:

[[User:Metraxis|Metraxis]]:

A KoL player of old but not ancient vintage (after Black Sunday, but before Ascension), and a somwhat prolific scripter

----

Pages Authored by Metraxis:

[[User:Metraxis]]

[[my_name()]]

[[Template:Primitive]]

User:Metraxis

2007-01-15T17:31:56Z

Metraxis:

User:Metraxis

2007-01-15T17:28:26Z

Metraxis:

My name

2007-01-15T17:27:45Z

Metraxis:

[[string]] my_name()

This function returns the logged-in character's name as a [[string]].

User:Metraxis

2007-01-15T17:21:58Z

Metraxis:

User:Metraxis

2007-01-09T08:21:39Z

Metraxis:

User:Metraxis

2007-01-09T08:18:10Z

Metraxis:

User:Metraxis

2007-01-09T08:16:26Z

Metraxis:

[[Metraxis]]:

A KoL player of old but not ancient vintage (after Black Sunday, but before Ascension), and a somwhat prolific scripter

----

Pages Authored by Metraxis:

[[Metraxis]]

{{ASH function}}