Class ItemBasePF

Base item

From which all other item documents inherit from.

Hierarchy

Item
- ItemBasePF
  - ItemPF

Index

Constructors

constructor

new ItemBasePF(...args): ItemBasePF
Parameters
- Rest ...args: [data?: ItemDataConstructorData, context?: Context<ActorPF>]
Returns ItemBasePF
Inherited from Item.constructor
- Defined in node_modules/@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/data/abstract/client-document.d.ts:51

Accessors

activeState

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
Abstract
- Defined in module/documents/item/item-base.mjs:218

canUse

get canUse(): boolean
Is this item usable at base level, disregarding per-action details.

Returns boolean
Abstract
- Defined in module/documents/item/item-base.mjs:241

isActive

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
See
activeState

Abstract
- Defined in module/documents/item/item-base.mjs:206

Methods

getName

getName(forcePlayerPerspective?): string
Fetch item name
Parameters
- Optional forcePlayerPerspective: boolean = false
  If true, return value players see.
Returns string
- Defined in module/documents/item/item-base.mjs:191

setActive

setActive(active, context?): Promise<ItemBasePF>
Set item's active state.
Parameters
- active: boolean
  Active state
- Optional context: object
  Optional update context
Returns Promise<ItemBasePF>
- Update promise if item type supports the operation.
Abstract
Throws
- If item does not support the operation.
- Defined in module/documents/item/item-base.mjs:231

`Static` _addSupplementChildLinks

_addSupplementChildLinks(items, supplements, context): Promise<undefined | ItemPF[]>
Internal
Update item child links with supplements.
Parameters
- items: Item[]
- supplements: Map<string, object>
- context: any
Returns Promise<undefined | ItemPF[]>
- Defined in module/documents/item/item-base.mjs:157

`Static` _collectItemSupplements

_collectItemSupplements(items, context): Map<string, any>
Internal
Parameters
- items: object[]
  Array of item data
- context: object
Returns Map<string, any>
- Defined in module/documents/item/item-base.mjs:70

`Static` createDialog

createDialog(data?, context?): Promise<null | Item>
Item create dialog.
Parameters
- data: object = {}
  Initial form data
- Optional context: {
      options: undefined | object;
      pack: undefined | null | string;
      parent: undefined | null | Actor;
  } = {}
  Additional options.
  - options: undefined | object
    Dialog context options.
  - pack: undefined | null | string
    Pack ID parameter passed to Item.create() options
  - parent: undefined | null | Actor
    Parent parameter passed to Item.create() options
Returns Promise<null | Item>
Synchronized with Foundry VTT v11.315
Overrides Item.createDialog
- Defined in module/documents/item/item-base.mjs:37

`Static` createDocuments

createDocuments(data?, context?): Promise<StoredDocument<ItemPF>[]>
Parameters
- data: any[] = []
- context: {} = {}
Returns Promise<StoredDocument<ItemPF>[]>
Overrides Item.createDocuments
- Defined in module/documents/item/item-base.mjs:44

`Static` getDefaultArtwork

getDefaultArtwork(itemData?): object
Internal
Add default artwork.
Parameters
- Optional itemData: object
Returns object
See
pf1.config.defaultIcons.items
- Defined in module/documents/item/item-base.mjs:17

Class ItemBasePF

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: [data?: ItemDataConstructorData, context?: Context<ActorPF>]

Returns ItemBasePF

Accessors

activeState

Returns boolean

Abstract

canUse

Returns boolean

Abstract

isActive

Returns boolean

See

Abstract

Methods

getName

Parameters

Optional forcePlayerPerspective: boolean = false

Returns string

setActive

Parameters

active: boolean

Optional context: object

Returns Promise<ItemBasePF>

Abstract

Throws

Static _addSupplementChildLinks

Parameters

items: Item[]

supplements: Map<string, object>

context: any

Returns Promise<undefined | ItemPF[]>

Static _collectItemSupplements

Parameters

items: object[]

context: object

Returns Map<string, any>

Static createDialog

Parameters

data: object = {}

Optional context: { options: undefined | object; pack: undefined | null | string; parent: undefined | null | Actor; } = {}

options: undefined | object

pack: undefined | null | string

parent: undefined | null | Actor

Returns Promise<null | Item>

Static createDocuments

Parameters

data: any[] = []

context: {} = {}

Returns Promise<StoredDocument<ItemPF>[]>

Static getDefaultArtwork

Parameters

Optional itemData: object

Returns object

See

Settings

Member Visibility

Theme

On This Page

`Rest` ...args: [data?: ItemDataConstructorData, context?: Context<ActorPF>]

`Optional` forcePlayerPerspective: boolean = false

`Optional` context: object

`Static` _addSupplementChildLinks

`Static` _collectItemSupplements

`Static` createDialog

`Optional` context: {
options: undefined | object;
pack: undefined | null | string;
parent: undefined | null | Actor;
} = {}

`Static` createDocuments

`Static` getDefaultArtwork

`Optional` itemData: object