Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class PhysicalItemModel

    Abstract model for physical items.

    Hierarchy (View Summary)

    Index

    General

    actions armorProf? artifact aura broken carried changeFlags? changes? cl classSkills contextNotes? creation cursed description equipped flags hardness hp identified languages? links nonhumanoid notes price? quantity resizing scriptCalls showInCombat? showInQuickbar? size sources subType? tag? tags technology timeworn unidentified weaponProf? weight activeState addonMaterial attackNotes auraStrength autoDeductCharges baseMaterial canEquip canUse capabilities charges defaultSchool effectiveCL effectNotes hasFiniteCharges isActive isBroken isCharged isDestroyed isPhysical isProficient isSingleUse maxCharges normalMaterial showIdentified system isPhysical _activeStateChange _chargePreUpdate _finalizeData _finalizeWeight _getArmorCostMultiplier _getArmorWeightMultiplier _getDescriptionData _prepareDependentData _prepareTraits _prepareWeight _rechargeActions _rechargeUses _resetChargesOnQuantityUpdate _sizeAdjustedHealth _updateChargeLinking _updateInheritedCharges adjustContained getChatData getConditionalTargets getCostMultiplier getDefaultChargeCost getDefaultChargeFormula getDescription getLabels getName getProficiency getRollData getValue getWeightMultiplier prepareBaseData prepareDerivedData prepareDurability recharge setActive _adjustNewItem migrateParentData pruneData

    Document

    metadata

    General

    actions: Record<string, pf1.components.Action>
    armorProf?: Trait<"med" | "lgt" | "hvy" | "shl" | "twr", string>
    artifact: boolean

    false

    aura: { custom: boolean; school?: string }
    broken: boolean
    carried: boolean | undefined

    true

    changeFlags?: Set<
        | "lowLightVision"
        | "seeInDarkness"
        | "seeInvisibility"
        | "immuneToMorale"
        | "loseDexToAC"
        | "noMediumEncumbrance"
        | "noHeavyEncumbrance"
        | "mediumArmorFullSpeed"
        | "heavyArmorFullSpeed"
        | "noAblScore.str"
        | "noAblScore.dex"
        | "noAblScore.con"
        | "noAblScore.int"
        | "noAblScore.wis"
        | "noAblScore.cha"
        | "powerAttack"
        | "piranhaStrike"
        | "deadlyAim"
        | "haste"
        | "pointBlankShot"
        | "rapidShot"
        | "manyshot"
        | "doubleSlice"
        | "weaponFinesse",
    >
    changes?: Record<string, Change>
    cl: number | null

    Caster Level

    null

    classSkills: Set<
        | "int"
        | "crf"
        | "acr"
        | "swm"
        | "clm"
        | "fly"
        | "lor"
        | "art"
        | "apr"
        | "blf"
        | "dip"
        | "dev"
        | "dis"
        | "esc"
        | "han"
        | "hea"
        | "kar"
        | "kdu"
        | "ken"
        | "kge"
        | "khi"
        | "klo"
        | "kna"
        | "kno"
        | "kpl"
        | "kre"
        | "lin"
        | "per"
        | "prf"
        | "pro"
        | "rid"
        | "sen"
        | "slt"
        | "spl"
        | "ste"
        | "sur"
        | "umd",
    >
    contextNotes?: Record<string, ContextNote>
    creation: {
        cost: { unit?: "gp" | "cp" | "pp" | "sp"; value?: number };
        dc?: number;
        description?: HTML;
    }
    cursed: boolean

    false

    description: any
    equipped: boolean | undefined

    true

    flags: { boolean: Set<Slug>; dictionary: Record<Slug, FreeText | number> }
    hardness: { base: any; total: any } | undefined
    hp: { base: number; max: number; offset: number; value: number }
    identified: boolean

    true

    languages?: Set<
        | "aboleth"
        | "abyssal"
        | "aklo"
        | "ancientosiriani"
        | "androffan"
        | "aquan"
        | "auran"
        | "azlanti"
        | "boggard"
        | "brethedan"
        | "canto"
        | "catfolk"
        | "celestial"
        | "common"
        | "cyclops"
        | "dark"
        | "draconic"
        | "drowsign"
        | "druidic"
        | "dtang"
        | "dwarven"
        | "dziriak"
        | "ekekeh"
        | "elderthing"
        | "elven"
        | "erutaki"
        | "firstspeech"
        | "gholgan"
        | "giant"
        | "gnoll"
        | "gnome"
        | "goblin"
        | "grippli"
        | "grioth"
        | "gug"
        | "halfling"
        | "hallit"
        | "honla"
        | "hwan"
        | "ib"
        | "ignan"
        | "infernal"
        | "iobaran"
        | "jandelayan"
        | "jistka"
        | "kasatha"
        | "kelish"
        | "kuru"
        | "lashunta"
        | "migo"
        | "minatan"
        | "minkaian"
        | "munavri"
        | "nagaji"
        | "necril"
        | "orc"
        | "orvian"
        | "osiriani"
        | "polyglot"
        | "protean"
        | "reptoid"
        | "rougarou"
        | "sakvroth"
        | "samsaran"
        | "sasquatch"
        | "senzar"
        | "shadowtongue"
        | "shae"
        | "shoanti"
        | "shobhad"
        | "skald"
        | "sphinx"
        | "strix"
        | "sylvan"
        | "syrinx"
        | "taldane"
        | "tekritanin"
        | "tengu"
        | "terran"
        | "thassilonian"
        | "tien"
        | "treant"
        | "triaxian"
        | "undercommon"
        | "urdefhan"
        | "vanaran"
        | "varisian"
        | "varki"
        | "vegepygmy"
        | "vishkanya"
        | "vudrani"
        | "wayang"
        | "yaddithian"
        | "yithian",
    >
    links: { children: LinkModel[]; supplements: LinkModel[] }
    nonhumanoid: boolean
    notes: Record<string, NoteEntry>
    price?: number
    quantity: number
    resizing: boolean
    scriptCalls: Record<string, ScriptCall>
    showInCombat?: boolean

    Show item in combat tab.

    showInQuickbar?: boolean

    Display item and its actions in quick actions and token HUD.

    size: "med" | "fine" | "dim" | "tiny" | "sm" | "lg" | "huge" | "grg" | "col"
    sources: SourceModel[]
    subType?: string
    tag?: Slug
    tags: Set<FreeText>
    technology: boolean

    false

    timeworn: boolean

    false

    unidentified: { name?: string; price: number }
    weaponProf?: Trait<"simple" | "siege" | "martial" | "firearm" | "heavy", string>
    weight: {
        contents?: number;
        converted: { one: number; total: number; value: number };
        currency?: number;
        total: number;
        value: number;
    }

    Type Declaration

    • Optionalcontents?: number

      Weight of contained items and currency, in lbs

    • converted: { one: number; total: number; value: number }

      Weight of this item, converted to the current unit system

    • Optionalcurrency?: number

      Effective weight of contained currency for containers, in lbs

    • total: number

      The effective total weight of the item (including quantity and contents), in lbs

    • value: number

      The weight of a single item instance, in lbs

    • get activeState(): boolean | undefined

      Active state as per what setActive would correspond with.

      Returns boolean | undefined

    • get addonMaterial(): Set<string>

      The item's material addons.

      Returns Set<string>

    • get attackNotes(): HTML[]

      Returns HTML[]

    • get auraStrength(): number

      Aura strength as number from 0 to 4.

      Returns number

      pf1.config.auraStrengths

    • get autoDeductCharges(): boolean

      Consumes are adds charges by default.

      Returns boolean

    • get baseMaterial(): string | null

      Base material

      Returns string | null

    • get canEquip(): boolean

      Can equip currently?

      Returns boolean

    • get canUse(): boolean | undefined

      Is this item usable at base level, disregarding per-action details.

      Returns boolean | undefined

    • get capabilities(): {}
      Experimental

      Returns {}

    • get charges(): number

      Remaining charges

      Returns number

    • get defaultSchool(): string | null

      The default spell school of this items aura, if any

      Returns string | null

    • get effectiveCL(): number

      Effective caster level of this item.

      Returns number

    • get effectNotes(): HTML[]

      Returns HTML[]

    • get hasFiniteCharges(): boolean

      Finite charges

      Returns boolean

    • get isActive(): boolean

      Is Active

      This returns composite result of if the item is equipped, has quantity, is not disabled, is not out of charges, etc. and is not representative if the item can be set active or not via setActive.

      Returns boolean

      activeState

    • get isBroken(): boolean

      Broken state

      Tests both explicit broken override and current health.

      Returns boolean

    • get isCharged(): boolean

      Returns boolean

    • get isDestroyed(): boolean

      Is the item destroyed?

      Returns boolean

    • get isPhysical(): boolean

      Is this a physical item?

      Returns boolean

    • get isProficient(): boolean

      Is the owning actor proficiency at using this as weapon.

      Returns boolean

      PF1 v10

    • get isSingleUse(): boolean

      Returns boolean

    • get maxCharges(): number

      Maximum possible charges this item can have.

      Returns number

      • Can return zero. Usually signifying something has reduced the potential uses below usability.
      • Can return infinity, signifying lack of limits.
    • get normalMaterial(): string | null

      The item's actual material.

      Returns string | null

    • get showIdentified(): boolean

      Should current user see identified info

      Returns boolean

    • get system(): this

      Returns this

      REMOVE BEFORE RELEASE

    • get isPhysical(): boolean

      Is this a physical item?

      Returns boolean

    _activeStateChange

    • _activeStateChange(changed: any): any
      Internal Experimental

      Return active state change from data if present

      This is a hack to allow item-type agnostic active state change detection.

      Parameters

      • changed: any

      Returns any

    _chargePreUpdate

    • _chargePreUpdate(changed: object, context: object): Promise<void>
      Internal

      Handle charge update sanity checking, constraining them to reasonable values, and propagating to parent items if charges are shared.

      Parameters

      • changed: object

        Changed data

      • context: object

        Context

      Returns Promise<void>

    _finalizeData

    • _finalizeData(): void
      Internal

      Finalize data after actor and other items are ready.

      Called at end of Item#prepareDerivedData() which is after TypeDataModel#prepareDerivedData()

      Returns void

    Protected_finalizeWeight

    • _finalizeWeight(): void
      Protected

      Finalize weight calculation effects

      Returns void

    _getArmorCostMultiplier

    • _getArmorCostMultiplier(): 0.5 | 1 | 2 | 4 | 8 | 16 | 32

      Returns 0.5 | 1 | 2 | 4 | 8 | 16 | 32

    _getArmorWeightMultiplier

    • _getArmorWeightMultiplier(): number
      Internal

      Weight scaling

      For use with () across item types

      Returns number

      • Weight multiplier

    Protected_getDescriptionData

    • _getDescriptionData(
          options?: { actionId?: string; isolated?: boolean; rollData?: object },
      ): Promise<object>
      Protected

      Description Data

      Required to be async due to spell associated class map building.

      Parameters

      • options: { actionId?: string; isolated?: boolean; rollData?: object } = {}

        Additional options

        • OptionalactionId?: string

          ID of an action. Default action is used if undefined.

        • Optionalisolated?: boolean

          Include extra data to reflect it not being so easily available in context.

        • OptionalrollData?: object

          Roll data instance

      Returns Promise<object>

      • Description context data

    _prepareDependentData

    • _prepareDependentData(): void

      Prepare data dependent on other items

      Called in actor.prepareDerivedData() when all items are guaranteed to be prepared.

      Returns void

    _prepareTraits

    • _prepareTraits(): void
      Internal

      Returns void

    Protected_prepareWeight

    • _prepareWeight(): void
      Protected

      Prepare this item's WeightData

      Returns void

    Protected_rechargeActions

    • _rechargeActions(
          options?: { exact: boolean; period?: string; rollData?: object },
      ): object | undefined
      Protected

      Update action limited uses

      {@inheritDoc ItemPF.recharge}

      TODO: Move this to the action itself.

      Parameters

      • options: { exact: boolean; period?: string; rollData?: object } = {}

        Options

        • exact: boolean

          Exact time period only

        • Optionalperiod?: string

          Recharge only if matching this time period

        • OptionalrollData?: object

          Roll data

      Returns object | undefined

      • Update data or undefined if no update is needed.

    Protected_rechargeUses

    • _rechargeUses(
          options?: {
              exact?: boolean;
              maximize?: boolean;
              period?: string;
              rollData?: object;
              value?: number;
          },
      ): Promise<object | undefined>
      Protected

      Recharges item's uses, if any.

      Parameters

      • options: {
            exact?: boolean;
            maximize?: boolean;
            period?: string;
            rollData?: object;
            value?: number;
        } = {}

        Options

        • Optionalexact?: boolean

          Match only exact time period

        • Optionalmaximize?: boolean

          Maximize instead of using recharge formula

        • Optionalperiod?: string

          Recharge only if it matches this time period

        • OptionalrollData?: object

          Roll data instance

        • Optionalvalue?: number

          Set charges to specific value

      Returns Promise<object | undefined>

      • Promise for the update, update data object, or undefined (no update needed).

    _resetChargesOnQuantityUpdate

    • _resetChargesOnQuantityUpdate(changed: object): Promise<void>

      Reset charges when quantity is changed to simulate a stack.

      • If charges are 0
      • ... and quantity is reduced, reset to max

      Parameters

      • changed: object

        Changed data

      Returns Promise<void>

    _sizeAdjustedHealth

    • _sizeAdjustedHealth(): number
      Internal

      Adjust HP value by item size.

      In reference to rules established at Table 7-12 of CRB p. 175

      Returns number

      • Size adjusted health

      https://aonprd.com/Rules.aspx?ID=126

    _updateChargeLinking

    • _updateChargeLinking(): void
      Internal

      Update Charge Linking

      Returns void

    _updateInheritedCharges

    • _updateInheritedCharges(source: any): void
      Internal

      Update this item's charges based on provided item.

      Parameters

      • source: any

        Charge source

      Returns void

    • Returns void

    • Protected

      Generates ChatData for this item, either in a default configuration or for a specific action.

      Parameters

      • Optionaloptions: {
            actionId?: string;
            body?: boolean;
            chatcard?: boolean;
            extended?: boolean;
            footer?: boolean;
            header?: boolean;
            interactive?: boolean;
            rollData?: object;
        } = {}

        Options affecting how descriptions are enriched.

        • OptionalactionId?: string

          The ID of an action on this item to generate chat data for, defaults to ItemPF.defaultAction

        • Optionalbody?: boolean

          Include main description

        • Optionalchatcard?: boolean

          Is this actually for chat card.

        • Optionalextended?: boolean

          Include extended information that may not be useful in all circumstances.

        • Optionalfooter?: boolean

          Include footer if it exists

        • Optionalheader?: boolean

          Include header if it exists

        • Optionalinteractive?: boolean

          Was this from user interaction (allowing farther interactions)

        • OptionalrollData?: object

          Defaults to Action#getRollData/ItemPF#getRollData.

      Returns Promise<ChatData>

      The chat data for this item (+action)

    • Item model specific conditional targets.

      Parameters

      • results: Record<string, object>

        Key to target mapping.

      Returns void

    • Return cost multiplier affecting this item.

      Such as item size dictating how costly an armor is.

      Returns number

      • Multiplier, 1 for most items regardless of size.

    • Get default charge cost for all actions.

      Parameters

      • Optionaloptions: { rollData?: object } = {}

        Additional options

        • OptionalrollData?: object

          Roll data instance

      Returns number

      Number for default cost.

    • Default charge formula.

      Returns string

      • Charge formula

    • Get full description.

      Parameters

      • __namedParameters: { body?: boolean; identified?: boolean } = {}

        Item type dependant options for rendering the description.

      Returns Promise<string>

      • Full description.

    • Called by ()

      Parameters

      • labels: any
      • options: any

      Returns void

    • Visible item name

      Parameters

      • asPlayer: boolean = false

        If true, return value players see.

      Returns string

      • Item name

    • Parameters

      • Optional_weapon: boolean = true

        Get proficiency as a weapon. Armor otherwise.

      Returns boolean

      • Whether or not the owner of the item is proficient.
      • If item type does not support proficiency.

      PF1 v10

    • DataModel specific roll data

      Parameters

      • result: any

        Roll data

      Returns void

    • Returns the displayed value of an item according to multiple options

      Parameters

      • Optionaloptions: {
            base?: boolean;
            forceUnidentified?: boolean;
            identical?: boolean;
            inLowestDenomination?: boolean;
            maximized?: boolean;
            recursive?: boolean;
            sell?: boolean;
            single?: boolean;
            type?: "resale" | null;
        } = {}

        Various optional parameters affecting value calculations

        • Optionalbase?: boolean

          Return only base value. This forces single & maximized to true.

        • OptionalforceUnidentified?: boolean

          Override whether the value should use the unidentified price

        • Optionalidentical?: boolean

          Treat all items in stack as identical (same number of charges).

        • OptionalinLowestDenomination?: boolean

          Whether the value should be returned in the lowest denomination. Standard denomination otherwise.

        • Optionalmaximized?: boolean

          Pretend as if the items were fresh (full charges)

        • Optionalrecursive?: boolean

          Whether the value of contained items should be included

        • Optionalsell?: boolean

          Return estimated sell value instead of actual value.

        • Optionalsingle?: boolean

          Return value of singular item instead of the actual stack. Disables recursive option.

        • Optionaltype?: "resale" | null

          Type of value to return. Default is full value if not specified.

      Returns number

      The item's value

      • On invalid type.

    • Return weight multiplier affecting this item.

      Such as item size dictating how heavy an armor is.

      Returns number

      • Multiplier, 1 for most items regardless of size.

    • Returns void

    • Internal

      Prepare hardness and hit points

      Returns void

    • Recharges item's uses, if any.

      Parameters

      • options: {
            commit?: boolean;
            context?: object;
            exact?: boolean;
            maximize?: boolean;
            period?: "round" | "minute" | "hour" | "day" | "week" | "any";
            rollData?: object;
            value?: number;
        } = {}

        Options

        • Optionalcommit?: boolean

          Commit update directly. If false, returns the update data instead.

        • Optionalcontext?: object

          Update context

        • Optionalexact?: boolean

          Use exact time period. Otherwise "week" for example will also recharge items with "day" period.

        • Optionalmaximize?: boolean

          Recharge to full regardless of recharge formula.

        • Optionalperiod?: "round" | "minute" | "hour" | "day" | "week" | "any"

          Recharge period. Use "any" to ignore item's configuration.

        • OptionalrollData?: object

          Roll data instance to use for formulas.

        • Optionalvalue?: number

          Recharge to specific value, respecting maximum and minimum bounds.

      Returns Promise<object | PhysicalItemModel | undefined>

      • Promise for the update, update data object, or undefined (no update needed).

    • Set item's active state.

      Parameters

      • active: any

        Active state

      • context: any

        Optional update context

      Returns Promise<any>

      • Update promise if item type supports the operation.
      • If item does not support the operation.

    Protected Static Abstract_adjustNewItem

    • _adjustNewItem(
          item?: ItemPF<BaseItemModel>,
          data?: object,
          override?: boolean,
      ): void
      Protected

      Adjust temporary item before creation

      Parameters

      • Optionalitem: ItemPF<BaseItemModel>

        Temporary document

      • Optionaldata: object

        Creation data

      • Optionaloverride: boolean = false

        Override values even if defined

      Returns void

    • Parent datamodel (item document) migration

      AVOID USING THIS

      Parameters

      • _source: object

        Document source data

      Returns void

    • Parameters

      • source: any

      Returns void

    Document

    metadata: Readonly<
        {
            activeState: "equipped";
            classAssociation: false;
            isPhysical: true;
            label: null;
            supplementLevel: false;
            type: null;
        },
    > = ...

    Settings

    Member Visibility

    On This Page

    General
    actionsarmorProfartifactaurabrokencarriedchangeFlagschangesclclassSkillscontextNotescreationcurseddescriptionequippedflagshardnesshpidentifiedlanguageslinksnonhumanoidnotespricequantityresizingscriptCallsshowInCombatshowInQuickbarsizesourcessubTypetagtagstechnologytimewornunidentifiedweaponProfweightactiveStateaddonMaterialattackNotesauraStrengthautoDeductChargesbaseMaterialcanEquipcanUsecapabilitieschargesdefaultSchooleffectiveCLeffectNoteshasFiniteChargesisActiveisBrokenisChargedisDestroyedisPhysicalisProficientisSingleUsemaxChargesnormalMaterialshowIdentifiedsystemisPhysical_activeStateChange_chargePreUpdate_finalizeData_finalizeWeight_getArmorCostMultiplier_getArmorWeightMultiplier_getDescriptionData_prepareDependentData_prepareTraits_prepareWeight_rechargeActions_rechargeUses_resetChargesOnQuantityUpdate_sizeAdjustedHealth_updateChargeLinking_updateInheritedChargesadjustContainedgetChatDatagetConditionalTargetsgetCostMultipliergetDefaultChargeCostgetDefaultChargeFormulagetDescriptiongetLabelsgetNamegetProficiencygetRollDatagetValuegetWeightMultiplierprepareBaseDataprepareDerivedDataprepareDurabilityrechargesetActive_adjustNewItemmigrateParentDatapruneData
    Document