Difference between revisions of "Your Character"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>StDoodle
m
Line 1: Line 1:
=='''The Basics'''==
+
==The Basics==
 
<p>''We'll start with a long look in the mirror.  Here's how to tell about you.''</p>
 
<p>''We'll start with a long look in the mirror.  Here's how to tell about you.''</p>
 
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
 
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
Line 18: Line 18:
 
{{flink|boolean|can_interact|desc=Reports on whether your character can access the mall, gift packages, etc.}}
 
{{flink|boolean|can_interact|desc=Reports on whether your character can access the mall, gift packages, etc.}}
 
{{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]])}}
 
{{flink|stat|my_primestat|desc=Returns the main stat of your current class. (''Sample'': [[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]])}}
 
{{flink|boolean|in_moxie_sign}}
 
{{flink|boolean|in_moxie_sign}}
Line 34: Line 34:
 
{{flink|stat|stat_bonus_today}}
 
{{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.}}
 
{{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.}}
=='''More Advanced Stats'''==
+
==More Advanced Stats==
'''stat [[current_hit_stat|current_hit_stat()]]''' - returns the stat that is currently used to calculate hit percentages.<br />
+
{{flink|stat|current_hit_stat|desc=Returns the stat currently used to calculate to-hit percentage.}}
'''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>.
+
{{flink|int|buffed_hit_stat|desc=Returns the buffed value of your currently used to-hit stat.}}
 
+
{{flink|int|raw_damage_absorption|desc=Returns your current DA total.}}
'''int [[raw_damage_absorption|raw_damage_absorption()]]''' - returns the total DA of all your gear and effects.<br />
+
{{flink|float|damage_absorption_percent|desc=Returns the percentage of damage mitigated by your DA.}}
'''float [[damage_absorption_percent|damage_absorption_percent()]]''' - returns the percentage of damage that is blocked by all your gear and effects.<br />
+
{{flink|float|elemental_resistance|element|desc=Returns the percentage of damage reduction to the given element based on your current resistance to that element.}}
'''int [[damage_reduction|damage_reduction()]]''' - returns the amount of damage deducted from successful attacks due to the DR of your gear and effects.
+
{{flink|float|combat_rate_modifier|desc=Returns the percentage adjustment to your combat rate.}}
 
+
{{flink|float|initiative_modifier|desc=Returns the percentage adjustment to your chance of gaining initiative.}}
'''float [[elemental_resistance|elemental_resistance( element elem )]]''' - returns the percentage of damage reduction from the indicated elemental damage.
+
{{flink|float|experience_bonus|desc=Returns the amount of bonus experience your receive after combat.}}
 
+
{{flink|float|meat_drop_modifier|desc=Returns the percentage adjustment to meat drops after combat.}}
'''float [[combat_rate_modifier|combat_rate_modifier()]]''' - returns the adjustment to your percentage of combat adventures.<br>
+
{{flink|float|item_drop_modifier|desc=Returns the percentage adjustment to item drops after combat.}}
'''float [[initiative_modifier|initiative_modifier()]]''' - returns the adjustment to your chance of winning initiative in battle.<br />
+
{{flink|int|monster_level_adjustment|desc=Returns the total +ML you have active, including your sign-specific device.}}
'''float [[experience_bonus|experience_bonus()]]''' - returns the amount of bonus experience you receive.<br />
 
'''float [[meat_drop_modifier|meat_drop_modifier()]]''' - returns the adjustment to your amount of meat dropped.<br />
 
'''float [[item_drop_modifier|item_drop_modifier()]]''' - returns the adjustment to your percentage of item drops.
 
 
 
'''int [[monster_level_adjustment|monster_level_adjustment()]]''' - returns your total +ML (including the MCD).
 

Revision as of 18:44, 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 currently used to calculate to-hit percentage.

int buffed_hit_stat()

Returns the buffed value of your currently used to-hit stat.

int raw_damage_absorption()

Returns your current DA total.

float damage_absorption_percent()

Returns the percentage of damage mitigated by your DA.

float elemental_resistance( element )

Returns the percentage of damage reduction to the given element based on your current resistance to that element.

float combat_rate_modifier()

Returns the percentage adjustment to your combat rate.

float initiative_modifier()

Returns the percentage adjustment to your chance of gaining initiative.

float experience_bonus()

Returns the amount of bonus experience your receive after combat.

float meat_drop_modifier()

Returns the percentage adjustment to meat drops after combat.

float item_drop_modifier()

Returns the percentage adjustment to item drops after combat.

int monster_level_adjustment()

Returns the total +ML you have active, including your sign-specific device.