Difference between revisions of "Your Character"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>StDoodle
m
Line 19: Line 19:
 
{{flink|boolean|in_hardcore|desc=Reports on whether your character is under Hardcore restrictions.}}
 
{{flink|boolean|in_hardcore|desc=Reports on whether your character is under Hardcore restrictions.}}
 
=='''Basic Stats'''==
 
=='''Basic Stats'''==
 
+
{{flink|stat|my_primestat|desc=Returns the main stat of your current class. (''Sample'': [[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]])}}
'''stat [[my_primestat|my_primestat()]]''' - returns the stat associated with your class. (''Sample'': [[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]])
+
{{flink|boolean|in_moxie_sign}}
 
+
{{flink|boolean|in_muscle_sign}}
'''boolean [[in_moxie_sign|in_moxie_sign()]]'''<br />
+
{{flink|boolean|in_mysticality_sign}}
'''boolean [[in_muscle_sign|in_muscle_sign()]]'''<br />
+
{{flink|boolean|in_bad_moon|desc=These four functions report on whether your character is ascended under the appropriate sign.}}
'''boolean [[in_mysticality_sign|in_mysticality_sign()]]'''<br />
+
{{flink|int|my_hp|desc=Returns your current HP.}}
Returns whether your ascension sign is associated with a specific stat zone.
+
{{flink|int|my_mp|desc=Returns your current MP.}}
 
+
{{flink|int|my_maxhp|desc=Returns your current maximum HP.}}
'''int [[my_hp|my_hp()]]''' - returns your current HP.<br />
+
{{flink|int|my_maxmp|desc=Returns your current maximum MP.}}
'''int [[my_mp|my_mp()]]''' - returns your current MP.<br />
+
{{flink|int|my_basestat|desc=Returns your base value in the given stat (or substat).}}
'''int [[my_maxhp|my_maxhp()]]''' - returns your current maximum HP.<br />
+
{{flink|int|my_buffedstat|desc=Returns your buffed value in the given stat (or substat).}}
'''int [[my_maxmp|my_maxmp()]]''' - returns your current maximum MP.<br />
+
{{flink|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
'''int [[my_basestat|my_basestat( stat st )]]''' - returns your current base value in the given [[%28ASHRM%29_Datatype_Constants#.24stat.5Bconstant.5D|stat]].  Passing $stat[SubMuscle], $stat[SubMysticality], or $stat[SubMoxie] to this function will return total substat points.<br />
+
{{flink|boolean|change_mcd|int|desc=Tries to set your +ML device to a specified setting and reports on success.}}
'''int [[my_buffedstat|my_buffedstat( stat st )]]''' - returns your current buffed value in the given [[%28ASHRM%29_Datatype_Constants#.24stat.5Bconstant.5D|stat]].
+
{{flink|stat|stat_bonus_today}}
 
+
{{flink|stat|stat_bonus_tomorrow|desc=These two functions report on what stat has a stat-day bonus or $stat[none] if it isn't a stat day.}}
'''int [[current_mcd|current_mcd()]]''' - returns the current level of your mind-control device.<br />
+
=='''More Advanced Stats'''==
'''boolean [[change_mcd|change_mcd( int level )]]''' - sets your mind-control device to the specified level.
 
 
 
'''stat [[stat_bonus_today|stat_bonus_today()]]'''<br />
 
'''stat [[stat_bonus_tomorrow|stat_bonus_tomorrow()]]'''<br />
 
Returns the stat that is benefitted by the moon phases today or tomorrow.  If it is an &#8220;ordinary&#8221; day, the return value is $stat[none].
 
 
 
=== '''More Advanced Stats''' ===
 
<hr>
 
 
 
 
'''stat [[current_hit_stat|current_hit_stat()]]''' - returns the stat that is currently used to calculate hit percentages.<br />
 
'''stat [[current_hit_stat|current_hit_stat()]]''' - returns the stat that is currently used to calculate hit percentages.<br />
 
'''int [[buffed_hit_stat|buffed_hit_stat()]]''' - returns the current buffed value of your hit stat.  Identical to <tt>my_buffedstat(current_hit_stat())</tt>.
 
'''int [[buffed_hit_stat|buffed_hit_stat()]]''' - returns the current buffed value of your hit stat.  Identical to <tt>my_buffedstat(current_hit_stat())</tt>.

Revision as of 18:35, 1 March 2010

The Basics

We'll start with a long look in the mirror. Here's how to tell about you.

string my_name()

Returns your character's name in lowercase.

string my_id()

Returns your character ID.

class my_class()

Returns your class. (Sample: Seltzer)

int my_level()

Returns your level. (Sample: Battlefield_gather)

int my_adventures()

Returns the number of adventures you have remaining. (Sample: Hedging)

int my_turncount()

Returns the number of adventures used this ascension.

int my_inebriety()

Returns your current drunkenness.

int inebriety_limit()

Returns your maximum safe drunk (before overdrinking).

int my_spleen_use()

Returns your current spleen use.

int spleen_limit()

Returns your spleen limit.

int my_fullness()

Returns how full you are.

int fullness_limit()

Returns your maximum fullness.

boolean can_eat()

Reports on whether your characters path allows food consumption.

boolean can_drink()

Reports on whether your characters path allows booze consumption

boolean can_interact()

Reports on whether your character can access the mall, gift packages, etc.

boolean in_hardcore()

Reports on whether your character is under Hardcore restrictions.

Basic Stats

stat my_primestat()

Returns the main stat of your current class. (Sample: Seltzer)

boolean in_moxie_sign()

boolean in_muscle_sign()

boolean in_mysticality_sign()

boolean in_bad_moon()

These four functions report on whether your character is ascended under the appropriate sign.

int my_hp()

Returns your current HP.

int my_mp()

Returns your current MP.

int my_maxhp()

Returns your current maximum HP.

int my_maxmp()

Returns your current maximum MP.

int my_basestat()

Returns your base value in the given stat (or substat).

int my_buffedstat()

Returns your buffed value in the given stat (or substat).

int current_mcd()

Returns the current setting of your sign-specific +ML device.

boolean change_mcd( int )

Tries to set your +ML device to a specified setting and reports on success.

stat stat_bonus_today()

stat stat_bonus_tomorrow()

These two functions report on what stat has a stat-day bonus or $stat[none] if it isn't a stat day.

More Advanced Stats

stat current_hit_stat() - returns the stat that is currently used to calculate hit percentages.
int buffed_hit_stat() - returns the current buffed value of your hit stat. Identical to my_buffedstat(current_hit_stat()).

int raw_damage_absorption() - returns the total DA of all your gear and effects.
float damage_absorption_percent() - returns the percentage of damage that is blocked by all your gear and effects.
int damage_reduction() - returns the amount of damage deducted from successful attacks due to the DR of your gear and effects.

float elemental_resistance( element elem ) - returns the percentage of damage reduction from the indicated elemental damage.

float combat_rate_modifier() - returns the adjustment to your percentage of combat adventures.
float initiative_modifier() - returns the adjustment to your chance of winning initiative in battle.
float experience_bonus() - returns the amount of bonus experience you receive.
float meat_drop_modifier() - returns the adjustment to your amount of meat dropped.
float item_drop_modifier() - returns the adjustment to your percentage of item drops.

int monster_level_adjustment() - returns your total +ML (including the MCD).