Kolmafia - User contributions [en]

Proxy Records

2022-06-09T06:10:51Z

Beldur: adding a few proxy fields to location

Proxy records are special records associated with the special [[Data Types|data types]] available to scripters. These records are always available for the special datatypes. The fields in a proxy record are referenced in the same manner as a [[Data_Structures#Records|record]].

==Special Datatypes==

===bounty===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| plural
| string
| ""
|
|-
| type
| string
| ""
|
|-
| kol_internal_type
| string
| ""
|
|-
| number
| int
| 0
|
|-
| image
| string
| ""
|
|-
| monster
| monster
| none
|
|-
| location
| location
| none
|
|}

===class===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| primestat
| stat
| Muscle
|
|}

===coinmaster===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| token
| string
| ""
|
|-
| item
| item
| none
|
|-
| property
| string
| ""
|
|-
| available_tokens
| int
| 0
|
|-
| buys
| boolean
| false
|
|-
| sells
| boolean
| false
|
|}

===effect===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| default
| string
| ""
|
|-
| note
| string
| ""
|
|-
| all
| aggregate
boolean [string] =>
|
|-
| image
| string
| "/images/debug.gif"
|
|-
| descid
| string
| ""
|
|}

===element===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| image
| string
| "circle.gif"
|
|}

===familiar===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| hatchling
| item
| none
|
|-
| image
| string
| "debug.gif"
|
|-
| name
| string
| ""
|
|-
| experience
| int
| 0
|
|-
| charges
| int
| 0
|
|-
| drop_name
| string
| ""
|
|-
| drop_item
| item
| none
|
|-
| drops_today
| int
| 0
|
|-
| drops_limit
| int
| 0
|
|-
| combat
| boolean
| false
|
|-
| physical_damage
| boolean
| false
|
|-
| elemental_damage
| boolean
| false
|
|-
| block
| boolean
| false
|
|-
| delevel
| boolean
| false
|
|-
| hp_during_combat
| boolean
| false
|
|-
| mp_during_combat
| boolean
| false
|
|-
| other_action_during_combat
| boolean
| false
|
|-
| hp_after_combat
| boolean
| false
|
|-
| mp_after_combat
| boolean
| false
|
|-
| other_action_after_combat
| boolean
| false
|
|-
| passive
| boolean
| false
|
|-
| variable
| boolean
| false
|
|}

===item===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| plural
| string
| ""
|
|-
| descid
| string
| ""
|
|-
| image
| string
| ""
|
|-
| smallimage
| string
| ""
|
|-
| levelreq
| int
| 0
|
|-
| quality
| string
| ""
|
|-
| adventures
| string
| ""
|
|-
| muscle
| string
| ""
|
|-
| mysticality
| string
| ""
|
|-
| moxie
| string
| ""
|
|-
| fullness
| int
| 0
|
|-
| inebriety
| int
| 0
|
|-
| spleen
| int
| 0
|
|-
| minhp
| int
| 0
|
|-
| maxhp
| int
| 0
|
|-
| minmp
| int
| 0
|
|-
| maxmp
| int
| 0
|
|-
| dailyusesleft
| int
| 0
|
|-
| notes
| string
| ""
|
|-
| quest
| boolean
| false
|
|-
| gift
| boolean
| false
|
|-
| tradeable
| boolean
| false
|
|-
| discardable
| boolean
| false
|
|-
| combat
| boolean
| false
|
|-
| combat_reusable
| boolean
| false
|
|-
| usable
| boolean
| false
|
|-
| reusable
| boolean
| false
|
|-
| multi
| boolean
| false
|
|-
| fancy
| boolean
| false
|
|-
| candy
| boolean
| false
|
|-
| seller
| coinmaster
| none
|
|-
| buyer
| coinmaster
| none
|
|-
| name_length
| int
| 0
|
|}

===location===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| nocombats
| boolean
| false
|
|-
| combat_percent
| float
| 0.0
|
|-
| zone
| string
| ""
|
|-
| parent
| string
| ""
|
|-
| parentdesc
| string
| ""
|
|-
| environment
| string
| ""
|
|-
| fire_level
| int
| 0
|
|-
| bounty
| bounty
| none
|
|-
| combat_queue
| string
| ""
|
|-
| noncombat_queue
| string
| ""
|
|-
| turns_spent
| int
| 0
|
|-
| kisses
| int
| 0
|
|-
| recommended_stat
| int
| 0
|
|-
| water_level
| int
| 0
|
|-
| wanderers
| boolean
| false
|
|}

===monster===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| base_hp
| int
| 0
| {{f|monster_hp}} (includes modifiers)
|-
| base_attack
| int
| 0
| {{f|monster_attack}} (includes modifiers)
|-
| base_defense
| int
| 0
| {{f|monster_defense}} (includes modifiers)
|-
| raw_hp
| int
| 0
| (excludes modifiers)
|-
| raw_attack
| int
| 0
| (excludes modifiers)
|-
| raw_defense
| int
| 0
| (excludes modifiers)
|-
| base_initiative
| int
| 0
| {{f|monster_initiative}} (includes modifiers)
|-
| raw_initiative
| int
| 0
| (excludes modifiers)
|-
| element attack_element
| element
| none
|
|-
| element defense_element
| element
| none
| {{f|monster_element}}
|-
| physical_resistance
| int
| 0
|
|-
| min_meat
| int
| 0
| (excludes modifiers)
|-
| max_meat
| int
| 0
| (excludes modifiers)
|-
| base_mainstat_exp
| float
| 0.0
| (includes bonus stats from +ML, but not from +stat effects)
|-
| phylum
| phylum
| none
| {{f|monster_phylum}}
|-
| poison
| effect
| none
|
|-
| boss
| boolean
| false
|
|-
| dummy
| boolean
| false
|
|-
| image
| string
| ""
|
|-
| images
| aggregate boolean [string]
|
|
|-
| attributes
| string
| ""
| A compilation of attack, defense, initiative, element, meat drop, and phylum
|-
| random_modifiers
| aggregate boolean [string]
|
| The monster's random modifiers - like those generated in the One Crazy Random Summer path
|-
| manuel_name
| string
| ""
|
|}

===phylum===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| image
| string
| none
|
|}

===servant===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| name
| string
| ""
|
|-
| level
| int
| 0
|
|-
| experience
| int
| 0
|
|-
| image
| string
| ""
|
|-
| level1_ability
| string
| ""
|
|-
| level7_ability
| string
| ""
|
|-
| level14_ability
| string
| ""
|
|-
| level21_ability
| string
| ""
|
|}

===skill===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| level
| int
| -1
|
|-
| image
| string
| none
|
|-
| traincost
| int
| 0
|
|-
| class
| class
| none
|
|-
| libram
| boolean
| false
|
|-
| passive
| boolean
| false
|
|-
| buff
| boolean
| false
|
|-
| combat
| boolean
| false
|
|-
| song
| boolean
| false
| Avatar of Boris song
|-
| expression
| boolean
| false
|
|-
| summon
| boolean
| false
|
|-
| permable
| boolean
| true
|
|-
| dailylimit
| int
| -1
|
|-
| timescast
| int
| 0
|
|}

=== slot ===
Slot does not have any fields.

===stat===
Stat does not have any fields.

===thrall===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| name
| string
| ""
|
|-
| level
| int
| 0
|
|-
| image
| string
| ""
|
|-
| tinyimage
| string
| ""
|
|-
| skill
| skill
| none
|
|-
| current_modifiers
| string
| ""
|
|}

User:Beldur

2021-06-05T04:40:46Z

Beldur: Filled out my user page a little bit.

Hi, if you need to reach me, I can be found on the ASS Discord @Beldur#2906 or in-game @Beldur (#1046951). I'm not involved in mafia development at all, merely interested in this wiki from the scripting side of things.

Modifiers

2021-06-05T04:29:50Z

Beldur: /* Numeric Modifiers */ Just adding % stat gain modifiers

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

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 {{f|numeric_modifier}}.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Related ASH function / Notes
|-
| Familiar Weight
| {{f|weight_adjustment}}
|-
| Monster Level
| {{f|monster_level_adjustment}}
|-
| Combat Rate
| {{f|combat_rate_modifier}}
|-
| Initiative
| {{f|initiative_modifier}}
|-
| Experience
| {{f|experience_bonus}}
|-
| Item Drop
| {{f|item_drop_modifier}}
|-
| Meat Drop
| {{f|meat_drop_modifier}}
|-
| Damage Absorption
| {{f|raw_damage_absorption}}
|-
| Damage Reduction
| {{f|damage_reduction}}
|-
| Cold Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[cold] )]], but returns the level of resistance.
|-
| Hot Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[hot] )]], but returns the level of resistance.
|-
| Sleaze Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[sleaze] )]], but returns the level of resistance.
|-
| Spooky Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[spooky] )]], but returns the level of resistance.
|-
| Stench Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[stench] )]], but returns the level of resistance.
|-
| Mana Cost
| Similar to {{f|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.
|-
| Critical
| Critical multiplier.
|-
| 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 {{f|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|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.
|-
| Maximum HP Nonmultiplied
| Bonus to HP from Slimy Sinews since it is not affected by HP multipliers.
|-
| Maximum MP Nonmultiplied
| Bonus to MP from Slimy Synapses since it is not affected by MP multipliers.
|-
| 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
|-
|Muscle Experience Percent
| +X% to all Muscle Gains
|-
|Mysticality Experience Percent
| +X% to all Mysticality Gains
|-
|Moxie Experience Percent
| +X% to all Moxie Gains
|-
| 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)
|}

==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==
Note: This does not have a corresponding ASH function. Instead, these modifiers can all be called using the {{f|numeric_modifier}} function.

When not logged in, these all return 0x0 (0).
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Notes
|-
| Clownosity
| 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
| 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 {{f|boolean_modifier}}.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! 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.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! 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 <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.
|-
| 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. {{Pspan|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)
|}

[[Category:Scripting]]