Kolmafia - User contributions [en]

Talk:Main Page

2007-12-08T00:35:28Z

ZammyWarrior: /* Current wiki layout... */

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

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

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

Fullness limit

2007-12-06T04:33:03Z

ZammyWarrior:

Will return your maximum fullness level.

<pre>if(my_fulness() < fulness_limit())
if(fulness_limit()== 15)
eat(3, $item[hot hi mein]);
else if(fulness_limit() == 20)
eat(4, $item[hot hi mein]);</pre>

Fullness limit

2007-12-06T04:32:54Z

ZammyWarrior: New page: Will return your maximum fullness level. <pre>if(my_fulness() < fulness_limit()) if(fulness_limit()== 15) eat(3, $item[hot hi mein]); else if(fulness_limit() == 20) eat(4, $it...

Will return your maximum fullness level.

<pre>if(my_fulness() < fulness_limit())
if(fulness_limit()== 15)
eat(3, $item[hot hi mein]);
else if(fulness_limit() == 20)
eat(4, $item[hot hi mein]);

My fullness

2007-12-06T04:30:49Z

ZammyWarrior: New page: Will return and int value of your current fullness level. <pre>if(my_fullness() < fullness_limit()){ eat(1, $item[papaya]); }</pre>

Will return and int value of your current fullness level.

<pre>if(my_fullness() < fullness_limit()){
eat(1, $item[papaya]);
}</pre>

Stat bonus tomorrow

2007-11-17T00:03:14Z

ZammyWarrior:

'''stat stat_bonus_tomorrow()''' 
Returns the stat that is benefited by the moon phases today or tomorrow. If it is an “ordinary” day, the return value is $stat[none].
<pre>if(stat_bonus_tomorrow() == $stat[muscle] && my_adventures() <= 140){
abort("Stat day tomorrow!!");
}
</pre>
[[Category:Your Character | Stat bonus tomorrow()]]
[[Category:Ash Functions |Stat bonus tomorrow()]]

Stat bonus tomorrow

2007-11-17T00:02:53Z

ZammyWarrior:

'''stat stat_bonus_tomorrow()''' 
Returns the stat that is benefited by the moon phases today or tomorrow. If it is an “ordinary” day, the return value is $stat[none].
if(stat_bonus_tomorrow() == $stat[muscle] && my_adventures() <= 140){
abort("Stat day tomorrow!!");
}
</pre>
[[Category:Your Character | Stat bonus tomorrow()]]
[[Category:Ash Functions |Stat bonus tomorrow()]]

Stat bonus tomorrow

2007-11-17T00:02:48Z

ZammyWarrior:

'''stat stat_bonus_tomorrow()''' 
Returns the stat that is benefited by the moon phases today or tomorrow. If it is an “ordinary” day, the return value is $stat[none].
if(stat_bonus_tomorrow() == $stat[muscle] && my_adventures() <= 140){
abort("Stat day tomorrow!!");
}
<pre>
[[Category:Your Character | Stat bonus tomorrow()]]
[[Category:Ash Functions |Stat bonus tomorrow()]]

Stat bonus tomorrow

2007-11-17T00:02:37Z

ZammyWarrior:

'''stat stat_bonus_tomorrow()''' 
Returns the stat that is benefited by the moon phases today or tomorrow. If it is an “ordinary” day, the return value is $stat[none].
if(stat_bonus_tomorrow() == $stat[muscle] && my_adventures() <= 140){
abort("Stat day tomorrow!!");
}
[[Category:Your Character | Stat bonus tomorrow()]]
[[Category:Ash Functions |Stat bonus tomorrow()]]

Stat bonus today

2007-11-17T00:01:07Z

ZammyWarrior:

'''stat stat_bonus_today()''' 
Returns the stat that is benefitted by the moon phases today. If it is an “ordinary” day, the return value is $stat[none].
<pre>if(stat_bonus_today() == $stat[moxie]){
eat(3, $item[rat appendix chow mein]);
}</pre>
[[Category:Your Character | Stat bonus today()]]
[[Category:Ash Functions |Stat bonus today()]]

Stat bonus today

2007-11-17T00:00:55Z

ZammyWarrior:

'''stat stat_bonus_today()''' 
Returns the stat that is benefitted by the moon phases today. If it is an “ordinary” day, the return value is $stat[none].
<pre>if(stat_bonus_today() == $stat[moxie]){
eat(3, $item[rat appendix chow mein]);
}
[[Category:Your Character | Stat bonus today()]]
[[Category:Ash Functions |Stat bonus today()]]

My familiar

2007-11-16T23:59:51Z

ZammyWarrior:

'''familiar my_familiar()''' 
Returns your current familiar.

[[Category:Your Character | My familiar()]]
[[Category:Ash Functions |My familiar()]]
<pre>#Script check if your current familiar is leprechaun. If true it will retrieve 1 meat detector
if(my_familiar() == $familiar[leprechaun]){
retrieve_item(1, $item[meat detector]);
}
</pre>

My name

2007-11-16T23:59:23Z

ZammyWarrior:

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

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

[[Category:Your Character | My name()]]
[[Category:Ash Functions |My name()]]
<pre>#Script checks players name. If your name returns ZammyWarrior it will import Zammy Morning.ash script.
#If name returns Hippymon it will import Hippymon Morning.ash script.
#Great script for one with multiple accounts as a "breakfast script".
if(my_name() == "ZammyWarrior"){
import <Zammy Morning.ash>;
}
else if(my_name() == "Hippymon"){
import <Hippy Morning.ash>;
}
</pre>

My primestat

2007-11-16T23:59:19Z

ZammyWarrior:

'''stat my_primestat()''' 
Returns the stat associated with your class.
[[Category:Your Character | My primestat()]]
[[Category:Ash Functions |My primestat()]]
<pre>#If primestat returns mysticality, script will retrieve X amount of delectable catalyst
#(X = amount of scrumptious reagents in inventory). Then it will use all of the delectable catalyst in your inventory.
#Designed to create scrumpdiddlyumptious solutions equal to the amount of scrumptious reagents in your inventory.

if(my_primestat() == $stat[mysticality]){
retrieve_item(item_amount($item[scrumptious reagent]), $item[delectable catalyst]);
use(item_amount($item[delectable catalyst]), $item[delectable catalyst]);
}
</pre>

My mp

2007-11-16T23:59:11Z

ZammyWarrior:

'''int my_mp()''' 
Returns your current and highest available HP and MP levels
[[Category:Your Character | My mp()]]
[[Category:Ash Functions |My mp()]]
<pre>if(my_mp() == 0){
restore_mp(mymax_mp());
} </pre>

My maxmp

2007-11-16T23:59:08Z

ZammyWarrior:

'''int my_maxmp()''' 
Returns your highest possible MP level
[[Category:Your Character | My maxmp()]]
[[Category:Ash Functions |My maxmp()]]
<pre>if(my_mp() == 0){
restore_mp(mymax_mp());
} </pre>

My maxhp

2007-11-16T23:59:02Z

ZammyWarrior:

'''int my_maxhp()''' 
Returns your highest available HP level
[[Category:Your Character | My maxhp()]]
[[Category:Ash Functions |My maxhp()]]
<pre>if(my_hp() == 0){
restore_hp(mymax_hp());
} </pre>

My hp

2007-11-16T23:58:58Z

ZammyWarrior:

'''int my_hp()''' 
Returns your current HP level
[[Category:Your Character | My hp()]]
[[Category:Ash Functions |My hp()]]

<pre>if(my_hp() == 0){
restore_hp(mymax_hp());
} </pre>

In mysticality sign

2007-11-16T23:58:53Z

ZammyWarrior:

'''boolean in_mysticality_sign()''' 
Returns true if your ascension sign is a mysticality sign otherwise false.
[[Category:Your Character | In mysticality sign()]]
[[Category:Ash Functions |In mysticality sign()]]
<pre>#Script checks to see if your in mysticality sign. If true, it 'farms' the logging camp.

if(in_mysticality_sign() && my_adventures() > 0){
adventure(my_adventure(), $location[logging camp]);
}</pre>

In muscle sign

2007-11-16T23:58:49Z

ZammyWarrior:

'''boolean in_muscle_sign()''' 
Returns true if your ascension sign is a muscle sign otherwise false.
[[Category:Your Character | In muscle sign()]]
[[Category:Ash Functions |In muscle sign()]]

<pre>#script checks to see if you are in a muscle sign. If true, it will import a script designed to plant mushrooms.
#If false, it does nothing.

if(in_muscle_sign()){
import <Mushroom Script.ash>;
}</pre>

In moxie sign

2007-11-16T23:58:20Z

ZammyWarrior:

'''boolean in_moxie_sign()''' 

Returns true if your ascension sign is a moxie sign otherwise false.

<pre>#If in moxie sign script will 'farm' the thugnerdome.

if(in_moxie_sign() && my_adventures > 0){
adventure(my_adventures(), $location[thugnerdome]);
}</pre>

[[Category:Your Character | In moxie sign()]]
[[Category:Ash Functions |In moxie sign()]]

Current mcd

2007-11-16T23:57:57Z

ZammyWarrior:

'''int current_mind_control_level()''' 
Returns the level of the Super-Secret Canadian Mind-Control Device

<pre>#This script simply checks to see if the Super-Secret Canadian Mind-Control Device
#is set at level 5 if it is then it will adventure once to attempt to kill the bonerdrag.

boolean Bonerdrag(){

if(in_mysticality_sign() && current_mind_control_level() == 5){

adventure(1, $location[Haert of the Cyrpt])
}
}

</pre>

[[Category:Your Character | Current mind control level()]]
[[Category:Ash Functions |Current mind control level()]]

Miscellaneous Functions

2007-09-09T20:49:26Z

ZammyWarrior:

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

In-combat Consulting

2007-09-09T20:48:11Z

ZammyWarrior:

== Part 6 - In-combat functions for consulting scripting ==
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.

string attack() 
string runaway() 
string use_skill( skill touse ) 
string throw_item( item tothrow ) 
string throw_items( item tothrow1, item tothrow2 ) 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

boolean use_skill( int count, skill touse ) 
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle. 
See [[Skills and Effects]] 

element monster_attack_element() 
element monster_defense_element() 
returns the element that the monster attacks with, or defends against accordingly.

int monster_attack() 
int monster_defense() 
int monster_hp() 
returns the (current?) attack, defense, and hp of the monster.

boolean will_usually_miss() 
boolean will_usually_dodge() 
returns if you will normally miss, or will usually be missed in battle.

In-combat Consulting

2007-09-09T20:47:49Z

ZammyWarrior:

== Part 6 - In-combat functions for consulting scripting ==
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.

string attack() 
string runaway() 
string use_skill( skill touse ) 
string throw_item( item tothrow ) 
string throw_items( item tothrow1, item tothrow2 ) 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

boolean use_skill( int count, skill touse ) 
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle. 
See [[Skills and Effects]]

element monster_attack_element() 
element monster_defense_element() 
returns the element that the monster attacks with, or defends against accordingly.

int monster_attack() 
int monster_defense() 
int monster_hp() 
returns the (current?) attack, defense, and hp of the monster.

boolean will_usually_miss() 
boolean will_usually_dodge() 
returns if you will normally miss, or will usually be missed in battle.

In-combat Consulting

2007-09-09T20:47:11Z

ZammyWarrior:

== Part 6 - In-combat functions for consulting scripting ==
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.

string attack() 
string runaway() 
string use_skill( skill touse ) 
string throw_item( item tothrow ) 
string throw_items( item tothrow1, item tothrow2 ) 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

boolean use_skill( int count, skill touse ) 
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle. 
See [[Skills and Effects]]

element monster_attack_element() 
element monster_defense_element() 
returns the element that the monster attacks with, or defends against accordingly.

int monster_attack() 
int monster_defense() 
int monster_hp() 
returns the (current?) attack, defense, and hp of the monster.

boolean will_usually_miss() 
boolean will_usually_dodge() 
returns if you will normally miss, or will usually be missed in battle.

Miscellaneous Functions

2007-09-09T20:45:57Z

ZammyWarrior:

== Part 6 - In-combat functions for consulting scripting ==
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.

string attack() 
string runaway() 
string use_skill( skill touse ) 
string throw_item( item tothrow ) 
string throw_items( item tothrow1, item tothrow2 ) 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

boolean use_skill( int count, skill touse ) 
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle. 
See [[Skills and Effects]] 

element monster_attack_element() 
element monster_defense_element() 
Returns the element that the monster attacks with, or defends against accordingly.

int monster_attack() 
int monster_defense() 
int monster_hp() 
returns the (current?) attack, defense, and hp of the monster.

boolean will_usually_miss() 
boolean will_usually_dodge() 
Returns if you will normally miss, or will usually be missed in battle.

In-combat Consulting

2007-09-09T20:42:35Z

ZammyWarrior:

== Part 6 - In-combat functions for consulting scripting ==
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.

<code>'''string attack()'''</code> 
<code>'''string runaway()'''</code> 
<code>'''string use_skill( skill touse )'''</code> 
<code>'''string throw_item( item tothrow )'''</code> 
<code>'''string throw_items( item tothrow1, item tothrow2 )'''</code> 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

<code>'''boolean use_skill( int count, skill touse )'''</code> 
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle. 
See [[Skills and Effects]]

<code>'''element monster_attack_element()'''</code> 
<code>'''element monster_defense_element()'''</code> 
returns the element that the monster attacks with, or defends against accordingly.

<code>'''int monster_attack()'''</code> 
<code>'''int monster_defense()'''</code> 
<code>'''int monster_hp()'''</code> 
returns the (current?) attack, defense, and hp of the monster

<code>'''boolean will_usually_miss()'''</code> 
<code>'''boolean will_usually_dodge()'''</code> 
returns if you will normally miss, or will usually be missed in battle.

KoLmafia Properties

2007-09-09T20:40:44Z

ZammyWarrior:

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

KoLmafia Properties

2007-09-09T20:40:19Z

ZammyWarrior:

== Part 11 - KoLmafia Properties ==
<div class="entrytext">
Well, whadda ya know?

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

Datatype Conversions

2007-09-09T20:39:15Z

ZammyWarrior:

== 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 
may accept: 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

String Handling Routines

2007-09-09T20:38:01Z

ZammyWarrior:

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

In-combat Consulting

2007-09-09T20:37:22Z

ZammyWarrior:

== Part 6 - In-combat functions for consultiung scripting ==
These functions are for use when handling a battle in a script using your custom combat settings. There is very little documentation of how to do this, and for most people these functions are useless.

<code>'''string attack()'''</code> 
<code>'''string runaway()'''</code> 
<code>'''string use_skill( skill touse )'''</code> 
<code>'''string throw_item( item tothrow )'''</code> 
<code>'''string throw_items( item tothrow1, item tothrow2 )'''</code> 
Returns a string containing the html response from sending the appropriate url request for the associated action while in battle.

<code>'''boolean use_skill( int count, skill touse )'''</code> 
Will loop the specified number of times using the specified skill, never reconsulting the script until the loop is complete. This function is handled differently when not in battle. 
See [[Skills and Effects]]

<code>'''element monster_attack_element()'''</code> 
<code>'''element monster_defense_element()'''</code> 
returns the element that the monster attacks with, or defends against accordingly.

<code>'''int monster_attack()'''</code> 
<code>'''int monster_defense()'''</code> 
<code>'''int monster_hp()'''</code> 
returns the (current?) attack, defense, and hp of the monster

<code>'''boolean will_usually_miss()'''</code> 
<code>'''boolean will_usually_dodge()'''</code> 
returns if you will normally miss, or will usually be missed in battle.

Miscellaneous Functions

2007-09-09T20:26:27Z

ZammyWarrior:

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

My primestat

2007-08-31T03:44:44Z

ZammyWarrior:

'''stat my_primestat()''' 
Returns the stat associated with your class.
[[Category:Your Character | My primestat()]]
[[Category:Ash Functions |My primestat()]]
[[Category:Needs Code Samples | My primestat()]]
<pre>#If primestat returns mysticality, script will retrieve X amount of delectable catalyst
#(X = amount of scrumptious reagents in inventory). Then it will use all of the delectable catalyst in your inventory.
#Designed to create scrumpdiddlyumptious solutions equal to the amount of scrumptious reagents in your inventory.

if(my_primestat() == $stat[mysticality]){
retrieve_item(item_amount($item[scrumptious reagent]), $item[delectable catalyst]);
use(item_amount($item[delectable catalyst]), $item[delectable catalyst]);
}
</pre>

My primestat

2007-08-31T03:44:27Z

ZammyWarrior:

'''stat my_primestat()''' 
Returns the stat associated with your class.
[[Category:Your Character | My primestat()]]
[[Category:Ash Functions |My primestat()]]
[[Category:Needs Code Samples | My primestat()]]
<pre>#If primestat returns mysticality, script will retrieve X amount of delectable catalyst
#(X = amount of scrumptious reagents in inventory). Then it will use all of the delectable catalyst in your inventory.
#Designed to create scrumpdiosldajksd solutions equal to the amount of scrumptious reagents in your inventory.
if(my_primestat() == $stat[mysticality]){
retrieve_item(item_amount($item[scrumptious reagent]), $item[delectable catalyst]);
use(item_amount($item[delectable catalyst]), $item[delectable catalyst]);
}
</pre>

My name

2007-08-31T03:39:07Z

ZammyWarrior:

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

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

[[Category:Your Character | My name()]]
[[Category:Ash Functions |My name()]]
[[Category:Needs Code Samples | My name()]]
<pre>#Script checks players name. If your name returns ZammyWarrior it will import Zammy Morning.ash script.
#If name returns Hippymon it will import Hippymon Morning.ash script.
#Great script for one with multiple accounts as a "breakfast script".
if(my_name() == "ZammyWarrior"){
import <Zammy Morning.ash>;
}
else if(my_name() == "Hippymon"){
import <Hippy Morning.ash>;
}
</pre>

My familiar

2007-08-31T03:34:45Z

ZammyWarrior:

'''familiar my_familiar()''' 
Returns your current familiar.

[[Category:Your Character | My familiar()]]
[[Category:Ash Functions |My familiar()]]
[[Category:Needs Code Samples | My familiar()]]
<pre>#Script check if your current familiar is leprechaun. If true it will retrieve 1 meat detector
if(my_familiar() == $familiar[leprechaun]){
retrieve_item(1, $item[meat detector]);
}
</pre>

In moxie sign

2007-08-31T03:32:29Z

ZammyWarrior:

'''boolean in_moxie_sign()''' 

Returns true if your ascension sign is a moxie sign otherwise false.

[[Category:Your Character | In moxie sign()]]
[[Category:Ash Functions |In moxie sign()]]
[[Category:Needs Code Samples | In moxie sign()]]
<pre>#If in moxie sign script will 'farm' the thugnerdome.

if(in_moxie_sign() && my_adventures > 0){
adventure(my_adventures(), $location[thugnerdome]);
}</pre>

In mysticality sign

2007-08-31T03:30:52Z

ZammyWarrior:

'''boolean in_mysticality_sign()''' 
Returns true if your ascension sign is a mysticality sign otherwise false.
[[Category:Your Character | In mysticality sign()]]
[[Category:Ash Functions |In mysticality sign()]]
[[Category:Needs Code Samples | In mysticality sign()]]
<pre>#Script checks to see if your in mysticality sign. If true, it 'farms' the logging camp.

if(in_mysticality_sign() && my_adventures() > 0){
adventure(my_adventure(), $location[logging camp]);
}</pre>

In muscle sign

2007-08-31T03:28:49Z

ZammyWarrior:

'''boolean in_muscle_sign()''' 
Returns true if your ascension sign is a muscle sign otherwise false.
[[Category:Your Character | In muscle sign()]]
[[Category:Ash Functions |In muscle sign()]]
[[Category:Needs Code Samples | In muscle sign()]]

<pre>#script checks to see if you are in a muscle sign. If true, it will import a script designed to plant mushrooms.
#If false, it does nothing.

if(in_muscle_sign()){
import <Mushroom Script.ash>;
}</pre>

In muscle sign

2007-08-31T03:28:41Z

ZammyWarrior:

'''boolean in_muscle_sign()''' 
Returns true if your ascension sign is a muscle sign otherwise false.
[[Category:Your Character | In muscle sign()]]
[[Category:Ash Functions |In muscle sign()]]
[[Category:Needs Code Samples | In muscle sign()]]

<pre>#script checks to see if you are in a muscle sign. If true, it will import a script designed to plant mushrooms.
#If false, it does nothing.
if(in_muscle_sign()){
import <Mushroom Script.ash>;
}</pre>

My maxhp

2007-08-31T03:25:59Z

ZammyWarrior:

'''int my_maxhp()''' 
Returns your highest available HP level
[[Category:Your Character | My maxhp()]]
[[Category:Ash Functions |My maxhp()]]
[[Category:Needs Code Samples | My maxhp()]]
<pre>if(my_hp() == 0){
restore_hp(mymax_hp());
} </pre>

My hp

2007-08-31T03:25:51Z

ZammyWarrior:

'''int my_hp()''' 
Returns your current HP level
[[Category:Your Character | My hp()]]
[[Category:Ash Functions |My hp()]]
[[Category:Needs Code Samples | My hp()]]

<pre>if(my_hp() == 0){
restore_hp(mymax_hp());
} </pre>

My mp

2007-08-31T03:25:35Z

ZammyWarrior:

'''int my_mp()''' 
Returns your current and highest available HP and MP levels
[[Category:Your Character | My mp()]]
[[Category:Ash Functions |My mp()]]
[[Category:Needs Code Samples | My mp()]]
<pre>if(my_mp() == 0){
restore_mp(mymax_mp());
} </pre>

My maxmp

2007-08-31T03:25:29Z

ZammyWarrior:

'''int my_maxmp()''' 
Returns your highest possible MP level
[[Category:Your Character | My maxmp()]]
[[Category:Ash Functions |My maxmp()]]
[[Category:Needs Code Samples | My maxmp()]]
<pre>if(my_mp() == 0){
restore_mp(mymax_mp());
} </pre>

My maxhp

2007-08-31T03:25:06Z

ZammyWarrior:

My hp

2007-08-31T03:24:52Z

ZammyWarrior:

Current mcd

2007-08-04T23:40:51Z

ZammyWarrior: