Difference between revisions of "Your Character"

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
m (→‎Sign & Path: OCD alphabetizing (boredom))
imported>Heeheehee
m (Reverted edits by Heeheehee (Talk) to last revision by StDoodle)
Line 1: Line 1:
 
{{TOCright}}
 
{{TOCright}}
 
==Viewable Info==
 
==Viewable Info==
{{flink|int|familiar_weight|familiar|desc=Returns the base weight of the specified familiar.}}{{flink|int|my_adventures|desc=Returns the number of adventures you have remaining. (''Sample'': [[Code_Samples#Hedging|Hedging]])}}
+
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
 +
{{flink|string|my_id|desc=Returns your character ID.}}
 
{{Flink|int|my_ascensions|desc=Returns the number of times your character has ascended.}}
 
{{Flink|int|my_ascensions|desc=Returns the number of times your character has ascended.}}
{{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|class|my_class|desc=Returns your class. (''Sample'': [[Code_Samples#Seltzer|Seltzer]])}}
 
{{flink|class|my_class|desc=Returns your class. (''Sample'': [[Code_Samples#Seltzer|Seltzer]])}}
{{flink|familiar|my_familiar|desc=Returns your current familiar.}}
+
{{flink|int|my_level|desc=Returns your level. (''Sample'': [[Code_Samples#Battlefield Gather|Battlefield Gather]])}}
 +
{{flink|int|my_adventures|desc=Returns the number of adventures you have remaining. (''Sample'': [[Code_Samples#Hedging|Hedging]])}}
 +
{{flink|int|my_turncount|desc=Returns the number of adventures used this ascension.}}
 +
{{flink|stat|my_primestat|desc=Returns the main stat of your current class. (''Sample'': [[Code_Samples#Seltzer|Seltzer]])}}
 
{{flink|int|my_hp|desc=Returns your current HP.}}
 
{{flink|int|my_hp|desc=Returns your current HP.}}
{{flink|string|my_id|desc=Returns  your character ID.}}
+
{{flink|int|my_mp|desc=Returns your current MP.}}
{{flink|int|my_level|desc=Returns your level. (''Sample'': [[Code_Samples#Battlefield Gather|Battlefield Gather]])}}
 
 
{{flink|int|my_maxhp|desc=Returns your current maximum HP.}}
 
{{flink|int|my_maxhp|desc=Returns your current maximum HP.}}
 
{{flink|int|my_maxmp|desc=Returns your current maximum MP.}}
 
{{flink|int|my_maxmp|desc=Returns your current maximum MP.}}
{{flink|int|my_mp|desc=Returns your current MP.}}
+
{{flink|int|my_basestat|stat|desc=Returns your base value in the given stat (or substat).}}
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
+
{{flink|int|my_buffedstat|stat|desc=Returns your buffed value in the given stat (or substat).}}
{{flink|stat|my_primestat|desc=Returns the main stat of your current class. (''Sample'': [[Code_Samples#Seltzer|Seltzer]])}}
+
{{flink|familiar|my_familiar|desc=Returns your current familiar.}}
{{flink|int|my_turncount|desc=Returns the number of adventures used this ascension.}}
+
{{flink|int|familiar_weight|familiar|desc=Returns the base weight of the specified familiar.}}
  
 
==Hidden Info==
 
==Hidden Info==
 +
{{flink|string|my_hash|desc=Returns the password hash for your current session.}}
 +
{{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.}}
{{flink|float|combat_rate_modifier|desc=Returns the percentage adjustment to your combat rate.}}
+
{{flink|int|raw_damage_absorption|desc=Returns your current DA total.}}
{{flink|stat|current_hit_stat|desc=Returns the stat currently used to calculate to-hit percentage.}}
 
{{flink|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
 
 
{{flink|float|damage_absorption_percent|desc=Returns the percentage of damage mitigated by your DA.}}
 
{{flink|float|damage_absorption_percent|desc=Returns the percentage of damage mitigated by your DA.}}
 
{{flink|int|damage_reduction|desc=Returns the amount of damage reduction your character currently has.}}
 
{{flink|int|damage_reduction|desc=Returns the amount of damage reduction your character currently has.}}
 
{{flink|float|elemental_resistance|element|desc=Returns the percentage of damage reduction to the given element based on your current resistance to that element.}}
 
{{flink|float|elemental_resistance|element|desc=Returns the percentage of damage reduction to the given element based on your current resistance to that element.}}
 +
{{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.}}
 
{{flink|float|experience_bonus|desc=Returns the amount of bonus experience your receive after combat.}}
 
{{flink|float|experience_bonus|desc=Returns the amount of bonus experience your receive after combat.}}
{{flink|float|initiative_modifier|desc=Returns the percentage adjustment to your chance of gaining initiative.}}
+
{{flink|float|meat_drop_modifier|desc=Returns the percentage adjustment to meat drops after combat.}}
 
{{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|float|meat_drop_modifier|desc=Returns the percentage adjustment to meat 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|string|my_hash|desc=Returns the password hash for your current session.}}
 
{{flink|int|raw_damage_absorption|desc=Returns your current DA total.}}
 
 
{{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.}}
 +
{{flink|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
 
{{flink|int|weight_adjustment|desc=Returns the cumulative total of all familiar weight adjustments from all sources.}}
 
{{flink|int|weight_adjustment|desc=Returns the cumulative total of all familiar weight adjustments from all sources.}}
 
 
==Sign & Path==
 
==Sign & Path==
{{flink|boolean|in_bad_moon|desc=These four functions report on whether your character is ascended under the appropriate sign.}}
 
 
{{flink|boolean|can_eat|desc=Reports on whether your characters path allows food consumption.}}
 
{{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_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_hardcore|desc=Reports on whether your character is under Hardcore restrictions.}}
{{flink|boolean|can_interact|desc=Reports on whether your character can access the mall, gift packages, etc.}}
 
 
{{flink|boolean|in_moxie_sign}}
 
{{flink|boolean|in_moxie_sign}}
 
{{flink|boolean|in_muscle_sign}}
 
{{flink|boolean|in_muscle_sign}}
 
{{flink|boolean|in_mysticality_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==
 
==Consumption==
 
{{flink|int|my_fullness|desc=Returns how full you are.}}
 
{{flink|int|my_fullness|desc=Returns how full you are.}}

Revision as of 04:10, 22 March 2010

Viewable Info

string my_name()

Returns your character's name in lowercase.

string my_id()

Returns your character ID.

int my_ascensions()

Returns the number of times your character has ascended.

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

familiar my_familiar()

Returns your current familiar.

int familiar_weight( familiar )

Returns the base weight of the specified familiar.


Hidden Info

string my_hash()

Returns the password hash for your current session.

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.

int damage_reduction()

Returns the amount of damage reduction your character currently has.

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.

int weight_adjustment()

Returns the cumulative total of all familiar weight adjustments from all sources.

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.