Your Character: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
mNo edit summary
imported>StDoodle
mNo edit summary
Line 1: Line 1:
==The Basics==
{{TOCright}}
<p>''We'll start with a long look in the mirror.  Here's how to tell about you.''</p>
==Viewable Info==
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
{{flink|string|my_id|desc=Returns  your character ID.}}
{{flink|string|my_id|desc=Returns  your character ID.}}
{{flink|class|my_class|desc=Returns your class. (''Sample'': [[Code_Samples#Sample_1:_Seltzer|Seltzer]])}}
{{flink|class|my_class|desc=Returns your class. (''Sample'': [[Code_Samples#Sample_1:_Seltzer|Seltzer]])}}
{{flink|int|my_level|desc=Returns your level. (''Sample'': [[Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])}}
{{flink|int|my_level|desc=Returns your level. (''Sample'': [[Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])}}
{{flink|int|my_adventures|desc=Returns the number of adventures you have remaining. (''Sample'': [[Code_Samples#Sample_4:_Hedging|Hedging]])
{{flink|int|my_adventures|desc=Returns the number of adventures you have remaining. (''Sample'': [[Code_Samples#Sample_4:_Hedging|Hedging]])}}
}}
{{flink|int|my_turncount|desc=Returns the number of adventures used this ascension.}}
{{flink|int|my_turncount|desc=Returns the number of adventures used this ascension.}}
{{flink|int|my_inebriety|desc=Returns your current drunkenness.}}
{{flink|int|inebriety_limit|desc=Returns your maximum safe drunk (before overdrinking).}}
{{flink|int|my_spleen_use|desc=Returns your current spleen use.}}
{{flink|int|spleen_limit|desc=Returns your spleen limit.}}
{{flink|int|my_fullness|desc=Returns how full you are.}}
{{flink|int|fullness_limit|desc=Returns your maximum fullness.}}
{{flink|boolean|can_eat|desc=Reports on whether your characters path allows food consumption.}}
{{flink|boolean|can_drink|desc=Reports on whether your characters path allows booze consumption}}
{{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.}}
==Basic Stats==
{{flink|stat|my_primestat|desc=Returns the main stat of your current class. (''Sample'': [[Code_Samples#Sample_1:_Seltzer|Seltzer]])}}
{{flink|stat|my_primestat|desc=Returns the main stat of your current class. (''Sample'': [[Code_Samples#Sample_1:_Seltzer|Seltzer]])}}
{{flink|boolean|in_moxie_sign}}
{{flink|boolean|in_muscle_sign}}
{{flink|boolean|in_mysticality_sign}}
{{flink|boolean|in_bad_moon|desc=These four functions report on whether your character is ascended under the appropriate sign.}}
{{flink|int|my_hp|desc=Returns your current HP.}}
{{flink|int|my_hp|desc=Returns your current HP.}}
{{flink|int|my_mp|desc=Returns your current MP.}}
{{flink|int|my_mp|desc=Returns your current MP.}}
Line 30: Line 14:
{{flink|int|my_basestat|stat|desc=Returns your base value in the given stat (or substat).}}
{{flink|int|my_basestat|stat|desc=Returns your base value in the given stat (or substat).}}
{{flink|int|my_buffedstat|stat|desc=Returns your buffed value in the given stat (or substat).}}
{{flink|int|my_buffedstat|stat|desc=Returns your buffed value in the given stat (or substat).}}
{{flink|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
==Hidden Info==
{{flink|boolean|change_mcd|int|desc=Tries to set your +ML device to a specified setting and reports on success.}}
{{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.}}
 
==More Advanced Stats==
{{flink|stat|current_hit_stat|desc=Returns the stat currently used to calculate to-hit percentage.}}
{{flink|stat|current_hit_stat|desc=Returns the stat currently used to calculate to-hit percentage.}}
{{flink|int|buffed_hit_stat|desc=Returns the buffed value of your currently used to-hit stat.}}
{{flink|int|buffed_hit_stat|desc=Returns the buffed value of your currently used to-hit stat.}}
Line 47: Line 26:
{{flink|float|item_drop_modifier|desc=Returns the percentage adjustment to item drops after combat.}}
{{flink|float|item_drop_modifier|desc=Returns the percentage adjustment to item drops after combat.}}
{{flink|int|monster_level_adjustment|desc=Returns the total +ML you have active, including your sign-specific device.}}
{{flink|int|monster_level_adjustment|desc=Returns the total +ML you have active, including your sign-specific device.}}
 
{{flink|stat|stat_bonus_today}}
==Location Availability==
{{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|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
==Sign & Path==
{{flink|boolean|can_eat|desc=Reports on whether your characters path allows food consumption.}}
{{flink|boolean|can_drink|desc=Reports on whether your characters path allows booze consumption}}
{{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_moxie_sign}}
{{flink|boolean|in_muscle_sign}}
{{flink|boolean|in_mysticality_sign}}
{{flink|boolean|in_bad_moon|desc=These four functions report on whether your character is ascended under the appropriate sign.}}
==Consumption==
{{flink|int|my_fullness|desc=Returns how full you are.}}
{{flink|int|fullness_limit|desc=Returns your maximum fullness.}}
{{flink|int|my_inebriety|desc=Returns your current drunkenness.}}
{{flink|int|inebriety_limit|desc=Returns your maximum safe drunk (before overdrinking).}}
{{flink|int|my_spleen_use|desc=Returns your current spleen use.}}
{{flink|int|spleen_limit|desc=Returns your spleen limit.}}
=Location Availability=
{{flink|boolean|black_market_available|desc=Returns the availability of the Black Market.}}
{{flink|boolean|black_market_available|desc=Returns the availability of the Black Market.}}
{{flink|boolean|guild_store_available|desc=Returns the availability of your guild store.}}
{{flink|boolean|guild_store_available|desc=Returns the availability of your guild store.}}
{{flink|boolean|hippy_store_available|desc=Returns the availability of the Hippy Store.}}
{{flink|boolean|hippy_store_available|desc=Returns the availability of the Hippy Store.}}
{{flink|boolean|white_citadel_available|desc=Returns the availability of White Citadel.}}
{{flink|boolean|white_citadel_available|desc=Returns the availability of White Citadel.}}

Revision as of 11:18, 6 March 2010

Viewable Info

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.

stat my_primestat()

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

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( stat )

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

int my_buffedstat( stat )

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

Hidden Info

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.

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.

int current_mcd()

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

Sign & Path

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.

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.

Consumption

int my_fullness()

Returns how full you are.

int fullness_limit()

Returns your maximum fullness.

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.

Location Availability

boolean black_market_available()

Returns the availability of the Black Market.

boolean guild_store_available()

Returns the availability of your guild store.

boolean hippy_store_available()

Returns the availability of the Hippy Store.

boolean white_citadel_available()

Returns the availability of White Citadel.