Difference between revisions of "Modifiers"

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
(Filled in more; need help with some stuff that I either haven't tried or can't test.)
(add more modifiers, but we're missing a load)
 
(41 intermediate revisions by 9 users not shown)
Line 1: Line 1:
Here is a comprehensive list of modifiers calculated by KoLMafia. Note that these are also available as ASH functions -- the first form, which takes one parameter, information about your character's current state; the second form, which takes two parameters, information about the [string|item|effect|skill|familiar] in question.
+
{{TOCright}}
 +
Here is a comprehensive list of modifiers calculated by KoLmafia. Note that these are also available as ASH functions -- the first form, which takes one parameter, provides information about your character's current state; the second form, which takes two parameters, information about the object in question.
  
==[[Numeric modifier| Numeric Modifiers]]==
+
To view this list of modifiers as it pertains to your character [and a specified ''object''], use the CLI command "modref [''object'']". To see what affects a certain modifier (or modifiers), use "modtrace ''filter''". For a list of all items that modify ''modifier'', use "modifies ''modifier''".
Note that although some of these functions have an ASH derivative that may be easier to use, the two-parameter form is still relevant and rather useful when obtaining information about a particular [string|item|effect|skill|familiar], rather than your current state.
+
 
{| class="wikitable" border="1"
+
More specific information regarding these modifiers is available in modifiers.txt, one of KoLmafia's internally-stored datafiles.
 +
 
 +
A list of the functions used to access these modifiers can be found at [[Modifier Functions]].
 +
 
 +
==Numeric Modifiers==
 +
Note that although some of these functions have an ASH derivative that may be easier to use, the two-parameter form is still relevant and rather useful when obtaining information about a particular object, rather than your current state.
 +
 
 +
When not logged in, these all return 0 for the 1-parameter form of {{f|numeric_modifier}}.
 +
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
 +
|- | style="background-color: #F2F2F2"
 
|-
 
|-
 
!  Modifier Name
 
!  Modifier Name
!  Not-logged-in Value
 
 
!  Related ASH function / Notes
 
!  Related ASH function / Notes
 
|-
 
|-
 
| Familiar Weight
 
| Familiar Weight
| 0.0
+
| {{f|weight_adjustment}}
| [[weight_adjustment| weight_adjustment()]]
 
 
|-
 
|-
 
| Monster Level
 
| Monster Level
| 0.0
+
| {{f|monster_level_adjustment}}
| [[monster_level_adjustment| monster_level_adjustment()]]
 
 
|-
 
|-
 
| Combat Rate
 
| Combat Rate
| 0.0
+
| {{f|combat_rate_modifier}}
| [[combat_rate_modifier| combat_rate_modifier()]]
 
 
|-
 
|-
 
| Initiative
 
| Initiative
| 0.0
+
| {{f|initiative_modifier}}
| [[initiative_modifier| initiative_modifier()]]
 
 
|-
 
|-
 
| Experience
 
| Experience
| 0.0
+
| {{f|experience_bonus}}
| [[experience_bonus| experience_bonus()]]
 
 
|-
 
|-
 
| Item Drop
 
| Item Drop
| 0.0
+
| {{f|item_drop_modifier}}
| [[item_drop_modifier| item_drop_modifier()]]
 
 
|-
 
|-
 
| Meat Drop
 
| Meat Drop
| 0.0
+
| {{f|meat_drop_modifier}}
| [[meat_drop_modifier| meat_drop_modifier()]]
 
 
|-
 
|-
 
| Damage Absorption
 
| Damage Absorption
| 0.0
+
| {{f|raw_damage_absorption}}
| [[raw_damage_absorption| raw_damage_absorption()]]
 
 
|-
 
|-
 
| Damage Reduction
 
| Damage Reduction
| 0.0
+
| {{f|damage_reduction}}
| [[damage_reduction|damage_reduction()]]
 
 
|-
 
|-
 
| Cold Resistance
 
| Cold Resistance
| 0.0
+
| Similar to [[elemental_resistance|elemental_resistance( $element[cold] )]], but returns the level of resistance.
| [[elemental_resistance|elemental_resistance( $element[cold] )]]
 
 
|-
 
|-
 
| Hot Resistance
 
| Hot Resistance
| 0.0
+
| Similar to [[elemental_resistance|elemental_resistance( $element[hot] )]], but returns the level of resistance.
| [[elemental_resistance|elemental_resistance( $element[hot] )]]
 
 
|-
 
|-
 
| Sleaze Resistance
 
| Sleaze Resistance
| 0.0
+
| Similar to [[elemental_resistance|elemental_resistance( $element[sleaze] )]], but returns the level of resistance.
| [[elemental_resistance|elemental_resistance( $element[sleaze] )]]
 
 
|-
 
|-
 
| Spooky Resistance
 
| Spooky Resistance
| 0.0
+
| Similar to [[elemental_resistance|elemental_resistance( $element[spooky] )]], but returns the level of resistance.
| [[elemental_resistance|elemental_resistance( $element[spooky] )]]
 
 
|-
 
|-
 
| Stench Resistance
 
| Stench Resistance
| 0.0
+
| Similar to [[elemental_resistance|elemental_resistance( $element[stench] )]], but returns the level of resistance.
| [[elemental_resistance|elemental_resistance( $element[stench] )]]
 
 
|-
 
|-
 
| Mana Cost
 
| Mana Cost
| 0.0
+
| Similar to {{f|mana_cost_modifier}} -- only counts up to the -3 cap.
| Similar to [[mana_cost_modifier|mana_cost_modifier()]] -- only counts up to the -3 cap.
 
 
|-
 
|-
 
| Moxie
 
| Moxie
| 0.0
 
 
| Sum of all absolute moxie modifiers.
 
| Sum of all absolute moxie modifiers.
 
|-
 
|-
 
| Moxie Percent
 
| Moxie Percent
| 0.0
 
 
| Sum of all percentage-based moxie modifiers.
 
| Sum of all percentage-based moxie modifiers.
 
|-
 
|-
 
| Muscle
 
| Muscle
| 0.0
 
 
| Sum of all absolute muscle modifiers.
 
| Sum of all absolute muscle modifiers.
 
|-
 
|-
 
| Muscle Percent
 
| Muscle Percent
| 0.0
 
 
| Sum of all percentage-based muscle modifiers.
 
| Sum of all percentage-based muscle modifiers.
 
|-
 
|-
 
| Mysticality
 
| Mysticality
| 0.0
 
 
| Sum of all absolute mysticality modifiers.
 
| Sum of all absolute mysticality modifiers.
 
|-
 
|-
 
| Mysticality Percent
 
| Mysticality Percent
| 0.0
 
 
| Sum of all percentage-based mysticality modifiers.
 
| Sum of all percentage-based mysticality modifiers.
 
|-
 
|-
 
| Maximum HP
 
| Maximum HP
| 0.0
 
 
| Sum of all absolute HP modifiers.
 
| Sum of all absolute HP modifiers.
 
|-
 
|-
 
| Maximum HP Percent
 
| Maximum HP Percent
| 0.0
 
 
| Sum of all percentage-based HP modifiers.
 
| Sum of all percentage-based HP modifiers.
 
|-
 
|-
 
| Maximum MP
 
| Maximum MP
| 0.0
 
 
| Sum of all absolute MP modifiers.
 
| Sum of all absolute MP modifiers.
 
|-
 
|-
 
| Maximum MP Percent
 
| Maximum MP Percent
| 0.0
 
 
| Sum of all percentage-based MP modifiers.
 
| Sum of all percentage-based MP modifiers.
 
|-
 
|-
 
| Weapon Damage
 
| Weapon Damage
| 0.0
 
 
| Sum of all absolute weapon damage modifiers.
 
| Sum of all absolute weapon damage modifiers.
 
|-
 
|-
 
| Ranged Damage
 
| Ranged Damage
| 0.0
 
 
| Sum of all absolute ranged damage modifiers.
 
| Sum of all absolute ranged damage modifiers.
 
|-
 
|-
 
| Spell Damage
 
| Spell Damage
| 0.0
 
 
| Sum of all absolute spell damage modifiers.
 
| Sum of all absolute spell damage modifiers.
 
|-
 
|-
 
| Spell Damage Percent
 
| Spell Damage Percent
| 0.0
 
 
| Sum of all percentage-based spell damage modifiers.
 
| Sum of all percentage-based spell damage modifiers.
 
|-
 
|-
 
| Cold Damage
 
| Cold Damage
| 0.0
 
 
| Total cold damage.
 
| Total cold damage.
 
|-
 
|-
 
| Hot Damage
 
| Hot Damage
| 0.0
 
 
| Total hot damage.
 
| Total hot damage.
 
|-
 
|-
 
| Sleaze Damage
 
| Sleaze Damage
| 0.0
 
 
| Total sleaze damage.
 
| Total sleaze damage.
 
|-
 
|-
 
| Spooky Damage
 
| Spooky Damage
| 0.0
 
 
| Total spooky damage.
 
| Total spooky damage.
 
|-
 
|-
 
| Stench Damage
 
| Stench Damage
| 0.0
 
 
| Total stench damage.
 
| Total stench damage.
 
|-
 
|-
 
| Cold Spell Damage
 
| Cold Spell Damage
| 0.0
 
 
| Total cold spell damage.
 
| Total cold spell damage.
 
|-
 
|-
 
| Hot Spell Damage
 
| Hot Spell Damage
| 0.0
 
 
| Total hot spell damage.
 
| Total hot spell damage.
 
|-
 
|-
 
| Sleaze Spell Damage
 
| Sleaze Spell Damage
| 0.0
 
 
| Total sleaze spell damage.
 
| Total sleaze spell damage.
 
|-
 
|-
 
| Spooky Spell Damage
 
| Spooky Spell Damage
| 0.0
 
 
| Total spooky spell damage.
 
| Total spooky spell damage.
 
|-
 
|-
 
| Stench Spell Damage
 
| Stench Spell Damage
| 0.0
 
 
| Total stench spell damage.
 
| Total stench spell damage.
 
|-
 
|-
| Critical
+
| Underwater Combat Rate
| 0.0
+
| Combat rate modifier, but underwater only.
| Critical multiplier.
 
 
|-
 
|-
 
| Fumble
 
| Fumble
| 0.0
 
 
| Fumble multiplier.
 
| Fumble multiplier.
 
|-
 
|-
 
| HP Regen Min
 
| HP Regen Min
| 0.0
 
 
| Lower bound of all HP-regenerating effects/equipment.
 
| Lower bound of all HP-regenerating effects/equipment.
 
|-
 
|-
 
| HP Regen Max
 
| HP Regen Max
| 0.0
 
 
| Upper bound of all HP-regenerating effects/equipment.
 
| Upper bound of all HP-regenerating effects/equipment.
 
|-
 
|-
 
| MP Regen Min
 
| MP Regen Min
| 0.0
 
 
| Lower bound of all MP-regenerating effects/equipment.
 
| Lower bound of all MP-regenerating effects/equipment.
 
|-
 
|-
 
| MP Regen Max
 
| MP Regen Max
| 0.0
 
 
| Upper bound of all MP-regenerating effects/equipment.
 
| Upper bound of all MP-regenerating effects/equipment.
 
|-
 
|-
 
| Adventures
 
| Adventures
| 0.0
+
| Bonus Rollover adventures
| Bonus Rollover Adventures
 
 
|-
 
|-
 
| Familiar Weight Percent
 
| Familiar Weight Percent
| 0.0
 
 
| Percentage modifier of Familiar Weight (from Bad Moon effects; always <= 0)
 
| Percentage modifier of Familiar Weight (from Bad Moon effects; always <= 0)
 
|-
 
|-
 
| Weapon Damage Percent
 
| Weapon Damage Percent
| 0.0
 
 
| Sum of all percentage-based weapon damage modifiers.
 
| Sum of all percentage-based weapon damage modifiers.
 
|-
 
|-
 
| Ranged Damage Percent
 
| Ranged Damage Percent
| 0.0
 
 
| Sum of all percentage-based ranged damage modifiers.
 
| Sum of all percentage-based ranged damage modifiers.
 
|-
 
|-
 
| Stackable Mana Cost
 
| Stackable Mana Cost
| 0.0
+
| Similar to {{f|mana_cost_modifier}} -- all other MP cost modifiers.
| Similar to [[mana_cost_modifier|mana_cost_modifier()]] -- all other MP cost modifiers.
 
 
|-
 
|-
 
| Hobo Power
 
| Hobo Power
| 0.0
+
| Hobo Power from equipment and effects (effect, technically).
| Hobo Power from equipment and effects (effect?).
 
 
|-
 
|-
 
| Base Resting HP
 
| Base Resting HP
| 0.0
 
 
| Average HP gained from resting.
 
| Average HP gained from resting.
 
|-
 
|-
 
| Resting HP Percent
 
| Resting HP Percent
| 0.0
 
 
| Percentage modifier to HP gained from resting (e.g. from Pagoda).
 
| Percentage modifier to HP gained from resting (e.g. from Pagoda).
 
|-
 
|-
 
| Bonus Resting HP
 
| Bonus Resting HP
| 0.0
 
 
| Absolute modifier to HP gained from resting (e.g. from Gauze hammock).
 
| Absolute modifier to HP gained from resting (e.g. from Gauze hammock).
 
|-
 
|-
 
| Base Resting MP
 
| Base Resting MP
| 0.0
 
 
| MP gained from resting.
 
| MP gained from resting.
 
|-
 
|-
 
| Resting MP Percent
 
| Resting MP Percent
| 0.0
 
 
| Percentage modifier to HP gained from resting (e.g. Pagoda).
 
| Percentage modifier to HP gained from resting (e.g. Pagoda).
 
|-
 
|-
 
| Bonus Resting MP
 
| Bonus Resting MP
| 0.0
 
 
| Absolute modifier to HP gained from resting (e.g. from Beanbag chair).
 
| Absolute modifier to HP gained from resting (e.g. from Beanbag chair).
 
|-
 
|-
 
| Critical Hit Percent
 
| Critical Hit Percent
| 0.0
 
 
| Percentage modifiers to critical hits (e.g. Depleted Grimacite Kneecapping stick).
 
| Percentage modifiers to critical hits (e.g. Depleted Grimacite Kneecapping stick).
 
|-
 
|-
 
| PvP Fights
 
| PvP Fights
| 0.0
 
 
| Bonus PvP fights upon Rollover.
 
| Bonus PvP fights upon Rollover.
 
|-
 
|-
 
| Volleyball
 
| Volleyball
| 0.0
+
| Only for use with multiple parameters (e.g. Llama returns .5, metallic foil radar dish returns -1).
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter.
 
 
|-
 
|-
 
| Sombrero
 
| Sombrero
| 0.0
+
| Only for use with multiple parameters (e.g. Baby Sandworm returns 1, metallic foil radar dish returns 1).
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter.
 
 
|-
 
|-
 
| Leprechaun
 
| Leprechaun
| 0.0
+
| Only for use with multiple parameters (e.g. Hobo monkey returns 1.25).
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter.
 
 
|-
 
|-
 
| Fairy
 
| Fairy
| 0.0
+
| Only for use with multiple parameters (e.g. Hound dog returns 1.25).
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter.
 
 
|-
 
|-
 
| Meat Drop Penalty
 
| Meat Drop Penalty
| 0.0
 
 
| Penalty to Meat Drops; result of having an Underwater location selected as your current location.
 
| Penalty to Meat Drops; result of having an Underwater location selected as your current location.
 
|-
 
|-
 
| Hidden Familiar Weight
 
| Hidden Familiar Weight
| 0.0
 
 
| Bonus familiar weight that does not show up on the character pane (e.g. from Temporary Teardrop Tattoo).
 
| Bonus familiar weight that does not show up on the character pane (e.g. from Temporary Teardrop Tattoo).
 
|-
 
|-
 
| Item Drop Penalty
 
| Item Drop Penalty
| 0.0
 
 
| Penalty to Item Drops; result of having an Underwater location selected as your current location.
 
| Penalty to Item Drops; result of having an Underwater location selected as your current location.
 
|-
 
|-
 
| Initiative Penalty
 
| Initiative Penalty
| 0.0
 
 
| Penalty to Initiative Drops; result of having an Underwater location selected as your current location.
 
| Penalty to Initiative Drops; result of having an Underwater location selected as your current location.
 
|-
 
|-
 
| Food Drop
 
| Food Drop
| 0.0
 
 
| Exclusive bonus to food drops (e.g. Brother Flying Burrito's Blessing).
 
| Exclusive bonus to food drops (e.g. Brother Flying Burrito's Blessing).
 
|-
 
|-
 
| Booze Drop
 
| Booze Drop
| 0.0
+
| Exclusive bonus to booze drops (e.g. Brother Smother's Blessing).
| Exclusive bonus to food drops (e.g. Brother Smother's Blessing).
 
 
|-
 
|-
 
| Hat Drop
 
| Hat Drop
| 0.0
 
 
| Exclusive bonus to hat drops (e.g. velcro broadsword).
 
| Exclusive bonus to hat drops (e.g. velcro broadsword).
 
|-
 
|-
 
| Weapon Drop
 
| Weapon Drop
| 0.0
+
| Exclusive bonus to weapon drops (e.g. pilgrim shield).
| Exclusive bonus to weapon drops (e.g. velcro broadsword).
 
 
|-
 
|-
 
| Offhand Drop
 
| Offhand Drop
| 0.0
+
| Exclusive bonus to offhand drops (None at the moment; placeholder).
| Exclusive bonus to offhand drops (e.g. velcro broadsword).
 
 
|-
 
|-
 
| Shirt Drop
 
| Shirt Drop
| 0.0
+
| Exclusive bonus to shirt drops (None at the moment; placeholder).
| Exclusive bonus to shirt drops (e.g. velcro broadsword).
 
 
|-
 
|-
 
| Pants Drop
 
| Pants Drop
| 0.0
+
| Exclusive bonus to pants drops (e.g. baneful bandolier).
| Exclusive bonus to weapon drops (e.g. Baneful Bandolier).
 
 
|-
 
|-
 
| Accessory Drop
 
| Accessory Drop
| 0.0
+
| Exclusive bonus to accessory drops (e.g. velcro paddle ball).
| Exclusive bonus to weapon drops (e.g. velcro paddle ball).
 
 
|-
 
|-
 
| Volleyball Effectiveness
 
| Volleyball Effectiveness
| 0.0
+
| Exclusive to the Baby Mutant Rattlesnake; evaluates an expression that factors in the current moon phase.
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter.
 
 
|-
 
|-
 
| Sombrero Effectiveness
 
| Sombrero Effectiveness
| 0.0
+
| Currently only returns 0; placeholder.
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter. (e.g. Llama returns .5?)
 
 
|-
 
|-
 
| Leprechaun Effectiveness
 
| Leprechaun Effectiveness
| 0.0
+
| Exclusive to the Mutant Cactus Bud; evaluates an expression that factors in the current moon phase.
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter. (e.g. Hobo monkey returns 1.25?)
 
 
|-
 
|-
 
| Fairy Effectiveness
 
| Fairy Effectiveness
| 0.0
+
| Exclusive to the Mutant Fire Ant; evaluates an expression that factors in the current moon phase.
| (?) Only for use with the two-parameter form, taking a familiar as the other parameter. (e.g. Hound dog returns 1.25?)
 
 
|-
 
|-
 
| Familiar Weight Cap
 
| Familiar Weight Cap
| 0.0
+
| Relevant only to the Mad Hatrack; returns maximum base weight based on equipment.
| (?) Maximum base weight for the current familiar.
 
 
|-
 
|-
 
| Slime Resistance
 
| Slime Resistance
| 0.0
+
| Similar to [[elemental_resistance|elemental_resistance( $element[slime] )]], but returns the level of resistance.
|
 
 
|-
 
|-
 
| Slime Hates It
 
| Slime Hates It
| 0.0
 
 
| Number of Slime Hates It active, as taken from equipment and effects.
 
| Number of Slime Hates It active, as taken from equipment and effects.
|-
 
| Maximum HP Nonmultiplied
 
| 0.0
 
| ?
 
|-
 
| Maximum MP Nonmultiplied
 
| 0.0
 
| ?
 
 
|-
 
|-
 
| Spell Critical Percent
 
| Spell Critical Percent
| 0.0
 
 
| Increased absolute spell critical rate.
 
| Increased absolute spell critical rate.
 
|-
 
|-
 
| Muscle Experience
 
| Muscle Experience
| 0.0
 
 
| +X Mus substats/fight
 
| +X Mus substats/fight
 
|-
 
|-
 
| Mysticality Experience
 
| Mysticality Experience
| 0.0
 
 
| +X Mys substats/fight
 
| +X Mys substats/fight
 
|-
 
|-
 
| Moxie Experience
 
| Moxie Experience
| 0.0
 
 
| +X Mox substats/fight
 
| +X Mox substats/fight
 
|-
 
|-
 
| Effect Duration
 
| Effect Duration
| 0.0
 
 
| For use with the two-parameter form, using item as the other parameter. Returns duration of effect for potions.
 
| For use with the two-parameter form, using item as the other parameter. Returns duration of effect for potions.
 +
|-
 +
| Candy Drop
 +
| Exclusive bonus to candy drops (e.g. peanut brittle shield).
 +
|-
 +
| DB Combat Damage
 +
| Bonus damage from using DB combat skills (e.g. Chester's moustache)
 +
|-
 +
| Sombrero Bonus
 +
| Provides X pounds of Sombrero (e.g. tiny sombrero)
 +
|-
 +
| Familiar Experience
 +
| Bonus experience for familiars (e.g. Brother Corsican's Blessing)
 +
|-
 +
| Sporadic Meat Drop
 +
| Bonus to Meat Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
 +
|-
 +
| Sporadic Item Drop
 +
| Bonus to Item Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
 +
|-
 +
| Meat Bonus
 +
| Absolute bonus to Meat Drop (e.g. ant sickle)
 +
|-
 +
| Pickpocket Chance
 +
| Bonus to pickpocket chance (e.g. Elvish Sunglasses)
 +
|-
 +
| Combat Mana Cost
 +
| Reduction to skill cost, in-combat only (e.g. camouflage T-shirt)
 +
|-
 +
|Muscle Experience Percent
 +
| +X% to all Muscle Gains
 +
|-
 +
|Mysticality Experience Percent
 +
| +X% to all Mysticality Gains
 +
|-
 +
|Moxie Experience Percent
 +
| +X% to all Moxie Gains
 +
|-
 +
| Minstrel Level
 +
| Level of Boris' Minstrel, Clancy
 +
|-
 +
| Muscle Limit
 +
| Limit to Base Muscle
 +
|-
 +
| Mysticality Limit
 +
| Limit to Base Mysticality
 +
|-
 +
| Moxie Limit
 +
| Limit to Base Moxie
 +
|-
 +
| Song Duration
 +
| Length of accordion song cast by accordion
 +
|-
 +
| Smithsness
 +
| Bonus to Smithsness (used by The Smith's equipment)
 +
|-
 +
| Supercold Resistance
 +
| Resistance to supercold damage (inflicted by warbears)
 +
|-
 +
| Reduce Enemy Defense
 +
| Reduce enemy defense stat by a given percentage
 +
|-
 +
| Pool Skill
 +
| How good you are at playing pool in The Haunted Billiards Room
 +
|-
 +
| Familiar Damage
 +
| How much damage your familiar deals (e.g. autumn leaf pendant)
 +
|-
 +
| Gear Drop
 +
| Exclusive bonus to gear drop (e.g. Combat Lover's Locket after reminiscing a Demon)
 +
|-
 +
| Damage Aura
 +
| Sources of damage each turn (e.g. smirking shrunken head)
 +
|-
 +
| Sporadic Damage Aura
 +
| Average sources of damage each turn, but not every turn (e.g. Biologically Shocked)
 +
|-
 +
| Thorns
 +
| Source of damage when the enemy hits you (e.g. Spiky Shell)
 +
|-
 +
| Sporadic Thorns
 +
| Average sources of damage when the enemy hits you, but not every turn (e.g. cannonball charrrm bracelet)
 +
|}
 +
 +
==Derived Modifiers==
 +
These are modifiers that are calculated based on other modifier values, rather than being a property of individual items.  They can be used just like the numeric modifier names above, but are fairly useless with the one-parameter form of the function since you can easily retrieve the actual values (which may differ slightly from these predicted values, due to different rounding behavior or other errors in KoLmafia's modifier calculations).  The intended usage is in the form numeric_modifier("_spec", ''name''), to determine the results of a potential equipment or effect change that has been tested by the CLI '''whatif''' command.
 +
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
 +
|- | style="background-color: #F2F2F2"
 +
|-
 +
!  Modifier Name
 +
!  Related ASH function / Notes
 +
|-
 +
| Buffed Muscle
 +
| Predicted value of [[my_buffedstat|my_buffedstat($stat[muscle])]]
 +
|-
 +
| Buffed Mysticality
 +
| Predicted value of [[my_buffedstat|my_buffedstat($stat[mysticality])]]
 +
|-
 +
| Buffed Moxie
 +
| Predicted value of [[my_buffedstat|my_buffedstat($stat[moxie])]]
 +
|-
 +
| Buffed HP Maximum
 +
| Predicted value of {{f|my_maxhp}}
 +
|-
 +
| Buffed MP Maximum
 +
| Predicted value of {{f|my_maxmp}}
 
|}
 
|}
  
 
==Bitmap Modifiers==
 
==Bitmap Modifiers==
Note: This does not have a corresponding ASH function.
+
Note: This does not have a corresponding ASH function. Instead, these modifiers can all be called using the {{f|numeric_modifier}} function.
{| class="wikitable" border="1"
+
 
 +
When not logged in, these all return 0x0 (0).
 +
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
 +
|- | style="background-color: #F2F2F2"
 
|-
 
|-
 
!  Modifier Name
 
!  Modifier Name
!  Default Value
 
 
!  Notes
 
!  Notes
 
|-
 
|-
 
| Clownosity
 
| Clownosity
| 0x0 (0)
+
| If this is >= 4, you can "Push the nose" in the Fun House. Might be "Clowniness" now.
| If this is > 4, you can "Push the nose" in the Fun House.
+
|-
 +
| Raveosity
 +
| If this is >= 7, you can "Get into the club".
 
|-
 
|-
 
| Brimstone
 
| Brimstone
| 0x0 (0)
 
 
| These have many "bonuses" when you equip more of them at once.
 
| These have many "bonuses" when you equip more of them at once.
 
|-
 
|-
 
| Synergetic
 
| Synergetic
| 0x0 (0)
+
| For items that have hidden bonuses when used together, such as the Secrets from the Future and the snake/wolf sword & shield.
| (?) Secrets from the future?
 
 
|}
 
|}
  
==[[Boolean modifier| Boolean Modifiers]]==
+
==Boolean Modifiers==
{| class="wikitable" border="1"
+
When not logged in, these all return false for the 1-parameter form of {{f|boolean_modifier}}.
 +
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
 +
|- | style="background-color: #F2F2F2"
 
|-
 
|-
 
!  Modifier Name
 
!  Modifier Name
!  Default Value
 
 
!  Notes
 
!  Notes
 
|-
 
|-
 
| Softcore Only
 
| Softcore Only
| false
 
 
| For use with the parameter "item"; returns true if the item in question has the Softcore Only flag (e.g. Travoltan Trousers).
 
| For use with the parameter "item"; returns true if the item in question has the Softcore Only flag (e.g. Travoltan Trousers).
 
|-
 
|-
 
| Single Equip
 
| Single Equip
| false
 
 
| For use with the parameter "item"; returns true if the item in question has the Single Equip flag (e.g. plexiglass pendant).
 
| For use with the parameter "item"; returns true if the item in question has the Single Equip flag (e.g. plexiglass pendant).
 
|-
 
|-
 
| Never Fumble
 
| Never Fumble
| false
 
 
| Returns true if the player has an effect that prevents fumbling.
 
| Returns true if the player has an effect that prevents fumbling.
 
|-
 
|-
 
| Weakens Monster
 
| Weakens Monster
| false
 
 
| For use with the parameter "item"; returns true if the item in question delevels on hit (e.g. 7-foot dwarven mattock).
 
| For use with the parameter "item"; returns true if the item in question delevels on hit (e.g. 7-foot dwarven mattock).
 
|-
 
|-
 
| Free Pull
 
| Free Pull
| false
 
 
| For use with the parameter "item"; returns true if the item in question can be pulled from Hagnk's for free (e.g. roll of toilet paper).
 
| For use with the parameter "item"; returns true if the item in question can be pulled from Hagnk's for free (e.g. roll of toilet paper).
 
|-
 
|-
 
| Variable
 
| Variable
| false
 
 
| For use with the parameter "item"; returns true if the item in question has a variable effect (e.g. depleted grimacite grappling hook).
 
| For use with the parameter "item"; returns true if the item in question has a variable effect (e.g. depleted grimacite grappling hook).
 
|-
 
|-
 
| Nonstackable Watch
 
| Nonstackable Watch
| false
 
 
| For use with the parameter "item"; returns true if the item in question counts as one of the nonstackable watches (e.g. dead guy's watch).
 
| For use with the parameter "item"; returns true if the item in question counts as one of the nonstackable watches (e.g. dead guy's watch).
 +
|-
 +
| Lasts Until Rollover
 +
| For use with the parameter "item"; returns true if the item in question disappears at rollover
 
|-
 
|-
 
| Cold Immunity
 
| Cold Immunity
| false
+
| Returns true if Coldform is active.
| Returns true if Cold Resistance > 0.
 
 
|-
 
|-
 
| Hot Immunity
 
| Hot Immunity
| false
+
| Returns true if Hotform is active.
| Returns true if Hot Resistance > 0.
 
 
|-
 
|-
 
| Sleaze Immunity
 
| Sleaze Immunity
| false
+
| Returns true if Sleazeform is active.
| Returns true if Sleaze Resistance > 0.
 
 
|-
 
|-
 
| Spooky Immunity
 
| Spooky Immunity
| false
+
| Returns true if Spookyform is active.
| Returns true if Spooky Resistance > 0.
 
 
|-
 
|-
 
| Stench Immunity
 
| Stench Immunity
| false
+
| Returns true if Stenchform is active.
| Returns true if Stench Resistance > 0.
 
 
|-
 
|-
 
| Cold Vulnerability
 
| Cold Vulnerability
| false
+
| Returns true if the player is vulnerable to Cold (e.g. from Sleazeform).
| Returns true if the player is vulnerable to Cold (e.g. from various BM-specific noncombats).
 
 
|-
 
|-
 
| Hot Vulnerability
 
| Hot Vulnerability
| false
+
| Returns true if the player is vulnerable to Hot (e.g. from Spookyform).
| Returns true if the player is vulnerable to Hot (e.g. from various BM-specific noncombats).
 
 
|-
 
|-
 
| Sleaze Vulnerability
 
| Sleaze Vulnerability
| false
+
| Returns true if the player is vulnerable to Sleaze (e.g. from Stenchform).
| Returns true if the player is vulnerable to Sleaze (e.g. from Easily Embarrassed).
 
 
|-
 
|-
 
| Spooky Vulnerability
 
| Spooky Vulnerability
| false
+
| Returns true if the player is vulnerable to Spooky (e.g. from Coldform).
| Returns true if the player is vulnerable to Spooky (e.g. from various BM-specific noncombats).
 
 
|-
 
|-
 
| Stench Vulnerability
 
| Stench Vulnerability
| false
+
| Returns true if the player is vulnerable to Stench (e.g. from Hotform).
| Returns true if the player is vulnerable to Stench (e.g. from Flared Nostrils).
 
 
|-
 
|-
 
| Moxie Controls MP
 
| Moxie Controls MP
| false
 
 
| Returns true if the player has a moxie magnet equipped.
 
| Returns true if the player has a moxie magnet equipped.
 
|-
 
|-
 
| Moxie May Control MP
 
| Moxie May Control MP
| false
+
| Returns true if the player has Travoltan Trousers equipped.
| Returns true if the player has Travoltan Trousers equipped (but not the moxie magnet?).
 
 
|-
 
|-
 
| Four Songs
 
| Four Songs
| false
 
 
| Returns true if the player is able to "Keep 4 songs in [his] head instead of 3" (e.g. Brimstone Beret).
 
| Returns true if the player is able to "Keep 4 songs in [his] head instead of 3" (e.g. Brimstone Beret).
 
|-
 
|-
 
| Additional Song
 
| Additional Song
| false
 
 
| Returns true if the player has the bonus from the El Hebilla del Cinturón de Lopez (Accordion Thief Epic Accessory).
 
| Returns true if the player has the bonus from the El Hebilla del Cinturón de Lopez (Accordion Thief Epic Accessory).
 
|-
 
|-
 
| Adventure Underwater
 
| Adventure Underwater
| false
 
 
| Returns true if the player has some way to breathe underwater (e.g. makeshift SCUBA gear).
 
| Returns true if the player has some way to breathe underwater (e.g. makeshift SCUBA gear).
 
|-
 
|-
 
| Underwater Familiar
 
| Underwater Familiar
| false
 
 
| Returns true if the player's familiar has some way to breathe underwater (e.g. das boot).
 
| Returns true if the player's familiar has some way to breathe underwater (e.g. das boot).
 +
|-
 +
| Generic
 +
| Returns true if the item in question can be equipped to all familiars.
 
|}
 
|}
  
==[[String Modifier| String Modifiers]]==
+
==String Modifiers==
Note: These all appear in the two-parameter form.
+
Note: These use the two-parameter form, for the most part.
{| class="wikitable" border="1"
+
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
 +
|- | style="background-color: #F2F2F2"
 
|-
 
|-
 
!  Modifier Name
 
!  Modifier Name
Line 495: Line 501:
 
|-
 
|-
 
| Class
 
| Class
| ?
+
| Returns the class you must be to benefit from any of the enchantments on this item.
 
|-
 
|-
| Intrinsic Effect
+
| Effect
| Returns the intrinsic effect granted by a piece of equipment (e.g. Chapped Legs from leather chaps).
+
| Returns the effect that KoL associates with a potion (which may not be the potion's only effect).
 
|-
 
|-
 
| Equalize
 
| Equalize
| (something with potion equalizers?)
+
| Returns the base stat of an equalizer potion.
 +
|-
 +
| Equips On
 +
| Holds a <nowiki>|</nowiki>-separated list of familiars that the item equips on. Not needed for the basic familiar-specific item listed in familiars.txt.
 +
|-
 +
| Familiar Tuning
 +
| For use with Bandersnatch fold-able equipment; returns the stat associated with the item.
 
|-
 
|-
| Wiki Name
+
| Intrinsic Effect
| Returns an empty string unless it is different, in which case the special HTML entities have been replaced. (e.g. frigid hankyu)
+
| Returns the intrinsic effect granted by a piece of equipment (e.g. Chapped Legs from leather chaps).
 
|-
 
|-
 
| Modifiers
 
| Modifiers
|  
+
| Returns the raw text of this item's modifier data, useful for a quick view of all its enchantments.
 
|-
 
|-
 
| Outfit
 
| Outfit
 
| Returns the name of the outfit (non-custom, folks!) that this item is part of.
 
| Returns the name of the outfit (non-custom, folks!) that this item is part of.
 +
|-
 +
| Sign:xxx
 +
| Returns sign specific modifiers. e.g. {{Pspan|string_modifier( "Sign:Vole", "Modifiers" )}} returns all modifiers related to being born under the Vole.
 
|-
 
|-
 
| Stat Tuning
 
| Stat Tuning
| (Crimbo '07 items, like tropical paperweight?)
+
| For use with Crimbo '06 items, like tropical paperweight; returns the stat associated with the item.
 
|-
 
|-
| Familiar Tuning
+
| Wiki Name
| (Bandersnatch equips?)
+
| Returns an empty string unless it is different, in which case the special HTML entities have been replaced. (e.g. frigid hankyu)
|-
 
| Effect
 
| Returns the effect associated with a potion.
 
 
|}
 
|}
{{RFI|Can someone check to make sure that I didn't screw up?|Also, fill in the missing data?}}
+
 
 +
[[Category:Scripting]]

Latest revision as of 18:34, 10 March 2023

Here is a comprehensive list of modifiers calculated by KoLmafia. Note that these are also available as ASH functions -- the first form, which takes one parameter, provides information about your character's current state; the second form, which takes two parameters, information about the object in question.

To view this list of modifiers as it pertains to your character [and a specified object], use the CLI command "modref [object]". To see what affects a certain modifier (or modifiers), use "modtrace filter". For a list of all items that modify modifier, use "modifies modifier".

More specific information regarding these modifiers is available in modifiers.txt, one of KoLmafia's internally-stored datafiles.

A list of the functions used to access these modifiers can be found at Modifier Functions.

Numeric Modifiers

Note that although some of these functions have an ASH derivative that may be easier to use, the two-parameter form is still relevant and rather useful when obtaining information about a particular object, rather than your current state.

When not logged in, these all return 0 for the 1-parameter form of numeric_modifier().

Modifier Name Related ASH function / Notes
Familiar Weight weight_adjustment()
Monster Level monster_level_adjustment()
Combat Rate combat_rate_modifier()
Initiative initiative_modifier()
Experience experience_bonus()
Item Drop item_drop_modifier()
Meat Drop meat_drop_modifier()
Damage Absorption raw_damage_absorption()
Damage Reduction damage_reduction()
Cold Resistance Similar to elemental_resistance( $element[cold] ), but returns the level of resistance.
Hot Resistance Similar to elemental_resistance( $element[hot] ), but returns the level of resistance.
Sleaze Resistance Similar to elemental_resistance( $element[sleaze] ), but returns the level of resistance.
Spooky Resistance Similar to elemental_resistance( $element[spooky] ), but returns the level of resistance.
Stench Resistance Similar to elemental_resistance( $element[stench] ), but returns the level of resistance.
Mana Cost Similar to mana_cost_modifier() -- only counts up to the -3 cap.
Moxie Sum of all absolute moxie modifiers.
Moxie Percent Sum of all percentage-based moxie modifiers.
Muscle Sum of all absolute muscle modifiers.
Muscle Percent Sum of all percentage-based muscle modifiers.
Mysticality Sum of all absolute mysticality modifiers.
Mysticality Percent Sum of all percentage-based mysticality modifiers.
Maximum HP Sum of all absolute HP modifiers.
Maximum HP Percent Sum of all percentage-based HP modifiers.
Maximum MP Sum of all absolute MP modifiers.
Maximum MP Percent Sum of all percentage-based MP modifiers.
Weapon Damage Sum of all absolute weapon damage modifiers.
Ranged Damage Sum of all absolute ranged damage modifiers.
Spell Damage Sum of all absolute spell damage modifiers.
Spell Damage Percent Sum of all percentage-based spell damage modifiers.
Cold Damage Total cold damage.
Hot Damage Total hot damage.
Sleaze Damage Total sleaze damage.
Spooky Damage Total spooky damage.
Stench Damage Total stench damage.
Cold Spell Damage Total cold spell damage.
Hot Spell Damage Total hot spell damage.
Sleaze Spell Damage Total sleaze spell damage.
Spooky Spell Damage Total spooky spell damage.
Stench Spell Damage Total stench spell damage.
Underwater Combat Rate Combat rate modifier, but underwater only.
Fumble Fumble multiplier.
HP Regen Min Lower bound of all HP-regenerating effects/equipment.
HP Regen Max Upper bound of all HP-regenerating effects/equipment.
MP Regen Min Lower bound of all MP-regenerating effects/equipment.
MP Regen Max Upper bound of all MP-regenerating effects/equipment.
Adventures Bonus Rollover adventures
Familiar Weight Percent Percentage modifier of Familiar Weight (from Bad Moon effects; always <= 0)
Weapon Damage Percent Sum of all percentage-based weapon damage modifiers.
Ranged Damage Percent Sum of all percentage-based ranged damage modifiers.
Stackable Mana Cost Similar to mana_cost_modifier() -- all other MP cost modifiers.
Hobo Power Hobo Power from equipment and effects (effect, technically).
Base Resting HP Average HP gained from resting.
Resting HP Percent Percentage modifier to HP gained from resting (e.g. from Pagoda).
Bonus Resting HP Absolute modifier to HP gained from resting (e.g. from Gauze hammock).
Base Resting MP MP gained from resting.
Resting MP Percent Percentage modifier to HP gained from resting (e.g. Pagoda).
Bonus Resting MP Absolute modifier to HP gained from resting (e.g. from Beanbag chair).
Critical Hit Percent Percentage modifiers to critical hits (e.g. Depleted Grimacite Kneecapping stick).
PvP Fights Bonus PvP fights upon Rollover.
Volleyball Only for use with multiple parameters (e.g. Llama returns .5, metallic foil radar dish returns -1).
Sombrero Only for use with multiple parameters (e.g. Baby Sandworm returns 1, metallic foil radar dish returns 1).
Leprechaun Only for use with multiple parameters (e.g. Hobo monkey returns 1.25).
Fairy Only for use with multiple parameters (e.g. Hound dog returns 1.25).
Meat Drop Penalty Penalty to Meat Drops; result of having an Underwater location selected as your current location.
Hidden Familiar Weight Bonus familiar weight that does not show up on the character pane (e.g. from Temporary Teardrop Tattoo).
Item Drop Penalty Penalty to Item Drops; result of having an Underwater location selected as your current location.
Initiative Penalty Penalty to Initiative Drops; result of having an Underwater location selected as your current location.
Food Drop Exclusive bonus to food drops (e.g. Brother Flying Burrito's Blessing).
Booze Drop Exclusive bonus to booze drops (e.g. Brother Smother's Blessing).
Hat Drop Exclusive bonus to hat drops (e.g. velcro broadsword).
Weapon Drop Exclusive bonus to weapon drops (e.g. pilgrim shield).
Offhand Drop Exclusive bonus to offhand drops (None at the moment; placeholder).
Shirt Drop Exclusive bonus to shirt drops (None at the moment; placeholder).
Pants Drop Exclusive bonus to pants drops (e.g. baneful bandolier).
Accessory Drop Exclusive bonus to accessory drops (e.g. velcro paddle ball).
Volleyball Effectiveness Exclusive to the Baby Mutant Rattlesnake; evaluates an expression that factors in the current moon phase.
Sombrero Effectiveness Currently only returns 0; placeholder.
Leprechaun Effectiveness Exclusive to the Mutant Cactus Bud; evaluates an expression that factors in the current moon phase.
Fairy Effectiveness Exclusive to the Mutant Fire Ant; evaluates an expression that factors in the current moon phase.
Familiar Weight Cap Relevant only to the Mad Hatrack; returns maximum base weight based on equipment.
Slime Resistance Similar to elemental_resistance( $element[slime] ), but returns the level of resistance.
Slime Hates It Number of Slime Hates It active, as taken from equipment and effects.
Spell Critical Percent Increased absolute spell critical rate.
Muscle Experience +X Mus substats/fight
Mysticality Experience +X Mys substats/fight
Moxie Experience +X Mox substats/fight
Effect Duration For use with the two-parameter form, using item as the other parameter. Returns duration of effect for potions.
Candy Drop Exclusive bonus to candy drops (e.g. peanut brittle shield).
DB Combat Damage Bonus damage from using DB combat skills (e.g. Chester's moustache)
Sombrero Bonus Provides X pounds of Sombrero (e.g. tiny sombrero)
Familiar Experience Bonus experience for familiars (e.g. Brother Corsican's Blessing)
Sporadic Meat Drop Bonus to Meat Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
Sporadic Item Drop Bonus to Item Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
Meat Bonus Absolute bonus to Meat Drop (e.g. ant sickle)
Pickpocket Chance Bonus to pickpocket chance (e.g. Elvish Sunglasses)
Combat Mana Cost Reduction to skill cost, in-combat only (e.g. camouflage T-shirt)
Muscle Experience Percent +X% to all Muscle Gains
Mysticality Experience Percent +X% to all Mysticality Gains
Moxie Experience Percent +X% to all Moxie Gains
Minstrel Level Level of Boris' Minstrel, Clancy
Muscle Limit Limit to Base Muscle
Mysticality Limit Limit to Base Mysticality
Moxie Limit Limit to Base Moxie
Song Duration Length of accordion song cast by accordion
Smithsness Bonus to Smithsness (used by The Smith's equipment)
Supercold Resistance Resistance to supercold damage (inflicted by warbears)
Reduce Enemy Defense Reduce enemy defense stat by a given percentage
Pool Skill How good you are at playing pool in The Haunted Billiards Room
Familiar Damage How much damage your familiar deals (e.g. autumn leaf pendant)
Gear Drop Exclusive bonus to gear drop (e.g. Combat Lover's Locket after reminiscing a Demon)
Damage Aura Sources of damage each turn (e.g. smirking shrunken head)
Sporadic Damage Aura Average sources of damage each turn, but not every turn (e.g. Biologically Shocked)
Thorns Source of damage when the enemy hits you (e.g. Spiky Shell)
Sporadic Thorns Average sources of damage when the enemy hits you, but not every turn (e.g. cannonball charrrm bracelet)

Derived Modifiers

These are modifiers that are calculated based on other modifier values, rather than being a property of individual items. They can be used just like the numeric modifier names above, but are fairly useless with the one-parameter form of the function since you can easily retrieve the actual values (which may differ slightly from these predicted values, due to different rounding behavior or other errors in KoLmafia's modifier calculations). The intended usage is in the form numeric_modifier("_spec", name), to determine the results of a potential equipment or effect change that has been tested by the CLI whatif command.

Modifier Name Related ASH function / Notes
Buffed Muscle Predicted value of my_buffedstat($stat[muscle])
Buffed Mysticality Predicted value of my_buffedstat($stat[mysticality])
Buffed Moxie Predicted value of my_buffedstat($stat[moxie])
Buffed HP Maximum Predicted value of my_maxhp()
Buffed MP Maximum Predicted value of my_maxmp()

Bitmap Modifiers

Note: This does not have a corresponding ASH function. Instead, these modifiers can all be called using the numeric_modifier() function.

When not logged in, these all return 0x0 (0).

Modifier Name Notes
Clownosity If this is >= 4, you can "Push the nose" in the Fun House. Might be "Clowniness" now.
Raveosity If this is >= 7, you can "Get into the club".
Brimstone These have many "bonuses" when you equip more of them at once.
Synergetic For items that have hidden bonuses when used together, such as the Secrets from the Future and the snake/wolf sword & shield.

Boolean Modifiers

When not logged in, these all return false for the 1-parameter form of boolean_modifier().

Modifier Name Notes
Softcore Only For use with the parameter "item"; returns true if the item in question has the Softcore Only flag (e.g. Travoltan Trousers).
Single Equip For use with the parameter "item"; returns true if the item in question has the Single Equip flag (e.g. plexiglass pendant).
Never Fumble Returns true if the player has an effect that prevents fumbling.
Weakens Monster For use with the parameter "item"; returns true if the item in question delevels on hit (e.g. 7-foot dwarven mattock).
Free Pull For use with the parameter "item"; returns true if the item in question can be pulled from Hagnk's for free (e.g. roll of toilet paper).
Variable For use with the parameter "item"; returns true if the item in question has a variable effect (e.g. depleted grimacite grappling hook).
Nonstackable Watch For use with the parameter "item"; returns true if the item in question counts as one of the nonstackable watches (e.g. dead guy's watch).
Lasts Until Rollover For use with the parameter "item"; returns true if the item in question disappears at rollover
Cold Immunity Returns true if Coldform is active.
Hot Immunity Returns true if Hotform is active.
Sleaze Immunity Returns true if Sleazeform is active.
Spooky Immunity Returns true if Spookyform is active.
Stench Immunity Returns true if Stenchform is active.
Cold Vulnerability Returns true if the player is vulnerable to Cold (e.g. from Sleazeform).
Hot Vulnerability Returns true if the player is vulnerable to Hot (e.g. from Spookyform).
Sleaze Vulnerability Returns true if the player is vulnerable to Sleaze (e.g. from Stenchform).
Spooky Vulnerability Returns true if the player is vulnerable to Spooky (e.g. from Coldform).
Stench Vulnerability Returns true if the player is vulnerable to Stench (e.g. from Hotform).
Moxie Controls MP Returns true if the player has a moxie magnet equipped.
Moxie May Control MP Returns true if the player has Travoltan Trousers equipped.
Four Songs Returns true if the player is able to "Keep 4 songs in [his] head instead of 3" (e.g. Brimstone Beret).
Additional Song Returns true if the player has the bonus from the El Hebilla del Cinturón de Lopez (Accordion Thief Epic Accessory).
Adventure Underwater Returns true if the player has some way to breathe underwater (e.g. makeshift SCUBA gear).
Underwater Familiar Returns true if the player's familiar has some way to breathe underwater (e.g. das boot).
Generic Returns true if the item in question can be equipped to all familiars.

String Modifiers

Note: These use the two-parameter form, for the most part.

Modifier Name Notes
Class Returns the class you must be to benefit from any of the enchantments on this item.
Effect Returns the effect that KoL associates with a potion (which may not be the potion's only effect).
Equalize Returns the base stat of an equalizer potion.
Equips On Holds a |-separated list of familiars that the item equips on. Not needed for the basic familiar-specific item listed in familiars.txt.
Familiar Tuning For use with Bandersnatch fold-able equipment; returns the stat associated with the item.
Intrinsic Effect Returns the intrinsic effect granted by a piece of equipment (e.g. Chapped Legs from leather chaps).
Modifiers Returns the raw text of this item's modifier data, useful for a quick view of all its enchantments.
Outfit Returns the name of the outfit (non-custom, folks!) that this item is part of.
Sign:xxx Returns sign specific modifiers. e.g. string_modifier( "Sign:Vole", "Modifiers" ) returns all modifiers related to being born under the Vole.
Stat Tuning For use with Crimbo '06 items, like tropical paperweight; returns the stat associated with the item.
Wiki Name Returns an empty string unless it is different, in which case the special HTML entities have been replaced. (e.g. frigid hankyu)