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

    Class ItemBasePF

    Base item

    From which all other item documents inherit from.

    Hierarchy (View Summary)

    Index

    Accessors

    activeState canUse isActive

    Methods

    _prepareDependentData getName setActive _createSupplements

    Accessors

    • get activeState(): boolean

      If the item can be activated via setActive.

      isActive can return variable state independent of the toggle that setActive controls, this returns .

      Returns boolean

      pf1.models.item.BaseItemModel.activeState

      • This queries this.system.activeState for the actual state.
    • get canUse(): boolean

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

      Returns boolean

    • get isActive(): boolean

      Is the item is fully functional.

      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

      • This queries this.system.isActive for the actual state.

    Methods

    _prepareDependentData

    • _prepareDependentData(final?: boolean): void
      Internal

      Prepare data dependent on other items

      Parameters

      • final: boolean = false

      Returns void

    • Item name

      Parameters

      • OptionalasPlayer: boolean = false

        If true, return value players see.

      Returns string

      • Item name

    • Set item's active state.

      Parameters

      • active: boolean

        Active state

      • Optionalcontext: object

        Optional update context

      Returns Promise<ItemBasePF>

      • Update promise if item type supports the operation.

      ()

      • If item does not support the operation.

    Static_createSupplements

    • _createSupplements(items: ItemPF[], actor: ActorPF): Promise<void>
      Internal

      Collect information on supplemental items and create them

      Parameters

      • items: ItemPF[]

        Array of items to draw supplemental data from

      • actor: ActorPF

        Owner

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods