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

    Class ActionItemModel

    Basic Item model with actions and related data

    Hierarchy (View Summary)

    Index

    General

    actions armorProf? changeFlags? changes? classSkills contextNotes? description flags languages? links notes scriptCalls showInCombat? showInQuickbar? sources subType? tag? tags weaponProf? activeState addonMaterial attackNotes auraStrength autoDeductCharges baseMaterial canUse capabilities charges effectNotes hasFiniteCharges isActive isCharged isPhysical isProficient isSingleUse maxCharges normalMaterial system isPhysical _activeStateChange _chargePreUpdate _finalizeData _getDescriptionData _prepareDependentData _prepareTraits _rechargeActions _rechargeUses _updateChargeLinking _updateInheritedCharges getChatData getConditionalTargets getDefaultChargeCost getDefaultChargeFormula getDescription getLabels getName getProficiency getRollData prepareBaseData recharge setActive _adjustNewItem migrateParentData pruneData

    Document

    metadata

    General

    actions: Record<string, pf1.components.Action>
    armorProf?: Trait<"med" | "lgt" | "hvy" | "shl" | "twr", string>
    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>
    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>
    description: { instructions: HTML; summary: FreeText; value: HTML }
    flags: { boolean: Set<Slug>; dictionary: Record<Slug, FreeText | number> }
    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[] }
    notes: Record<string, NoteEntry>
    scriptCalls: Record<string, ScriptCall>
    showInCombat?: boolean

    Show item in combat tab.

    showInQuickbar?: boolean

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

    sources: SourceModel[]
    subType?: string
    tag?: Slug
    tags: Set<FreeText>
    weaponProf?: Trait<"simple" | "siege" | "martial" | "firearm" | "heavy", string>
    • get activeState(): boolean

      Active state as per what setActive would correspond with.

      Returns boolean

    • 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 canUse(): boolean

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

      Returns boolean

    • get capabilities(): {}
      Experimental

      Returns {}

    • get charges(): number

      Remaining charges

      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 isCharged(): boolean

      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 system(): this

      Returns this

      REMOVE BEFORE RELEASE

    • get isPhysical(): boolean

      Is this a physical item?

      Returns boolean

    Abstract_activeStateChange

    • _activeStateChange(changed: object): boolean
      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: object

      Returns boolean

    _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>

    Abstract_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_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

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

    _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

    • 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

    • 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

      • options: {
            actionId?: string;
            body?: boolean;
            chatcard?: boolean;
            data?: object;
            header?: boolean;
            identified?: boolean;
            isolated?: boolean;
            rollData?: object;
        } = {}

        Item type dependant options for rendering the description.

        • OptionalactionId?: string

          Action ID

        • Optionalbody?: boolean

          Include main description body if such exists.

        • Optionalchatcard?: boolean

          Instruct template to render chat card in mind.

        • Optionaldata?: object

          Template data for rendering

        • Optionalheader?: boolean

          Include header if such exists.

        • Optionalidentified?: boolean

          Enforce identified description retrieval

        • Optionalisolated?: boolean

          Passed to _getDescriptionData

        • OptionalrollData?: object

          Roll data for transforming description

      Returns Promise<string>

      • Full description.
    • Protected

      Called by ()

      Parameters

      • labels: object
      • Optionaloptions: { isolated?: boolean; rollData?: object } = {}

      Returns void

    • Visible item name

      Parameters

      • OptionalasPlayer: 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: object

        Roll data

      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 | ActionItemModel | undefined>

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

    • Set item's active state.

      Parameters

      • active: boolean

        Active state

      • Optionalcontext: object

        Optional update context

      Returns Promise<ActionItemModel>

      • 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<
        {
            classAssociation: false;
            isPhysical: false;
            label: null;
            supplementLevel: false;
            type: null;
        },
    > = ...

    Settings

    Member Visibility

    On This Page

    General
    Document