Class ItemBasePF

Base item

From which all other item documents inherit from.

Hierarchy (View Summary)

Item
- ItemBasePF
  - ItemPF

Index

Constructors

constructor

new ItemBasePF(
...args: [data?: ItemDataConstructorData, context?: Context<ActorPF>],
): ItemBasePF
Parameters
- ...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

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

`Abstract`canUse

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

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

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

Methods

getEmbeddedDocument

getEmbeddedDocument(embeddedName: any, id: any, options: any): any
For supporting actions and changes in fromUuid()

Synced with Foundry v12.331
Parameters
- embeddedName: any
- id: any
- options: any
Returns any
Overrides Item.getEmbeddedDocument
- Defined in module/documents/item/item-base.mjs:477

getName

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

`Abstract`setActive

setActive(active: boolean, context?: object): Promise<ItemBasePF>
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.
Throws
- If item does not support the operation.
- Defined in module/documents/item/item-base.mjs:456

`Static`_createSupplements

_createSupplements(items: Item[], actor: Actor): Promise<void>
Internal
Collect Data on supplements
Parameters
- items: Item[]
  Array of items to draw supplemental data from
- actor: Actor
  Owner
Returns Promise<void>
- Defined in module/documents/item/item-base.mjs:298

`Static`_onCreateOperation

_onCreateOperation(
    documents: Document[],
    operation: any,
    user: User,
): Promise<void>
On-Create Operation

Post-create processing so awaiting the original operation has all secondary updates completed when it returns.
Parameters
- documents: Document[]
  Documents
- operation: any
  Operations and context data
- user: User
  Triggering user
Returns Promise<void>
- Defined in module/documents/item/item-base.mjs:92

`Static`_onDeleteOperation

_onDeleteOperation(
    documents: Document[],
    operation: any,
    user: User,
): Promise<void>
On-Delete Operation

Post-delete processing so awaiting the original operation has all secondary updates completed when it returns.
Parameters
- documents: Document[]
  Documents
- operation: any
  Operations and context data
- user: User
  Triggering user
Returns Promise<void>
- Defined in module/documents/item/item-base.mjs:230

`Static`_onUpdateOperation

_onUpdateOperation(
    documents: Document[],
    operation: any,
    user: User,
): Promise<void>
On-Update Operation

Post-update processing so awaiting the original operation has all secondary updates completed when it returns.
Parameters
- documents: Document[]
  Documents
- operation: any
  Operations and context data
- user: User
  Triggering user
Returns Promise<void>
- Defined in module/documents/item/item-base.mjs:174

`Static`createDialog

createDialog(
    data?: object,
    context?: {
        options?: object;
        pack?: null | string;
        parent?: null | Actor;
        types?: string[];
    },
): Promise<null | Item>
Item create dialog.
Parameters
- data: object = {}
  Initial form data
- Optionalcontext: {
      options?: object;
      pack?: null | string;
      parent?: null | Actor;
      types?: string[];
  } = {}
  Additional options.
  - Optionaloptions?: object
    Dialog context options.
  - Optionalpack?: null | string
    Pack ID parameter passed to Item.create() options
  - Optionalparent?: null | Actor
    Parent parameter passed to Item.create() options
  - Optionaltypes?: string[]
    Item types to limit creation choices to.
Returns Promise<null | Item>
Synchronized with Foundry VTT v12.331
Overrides Item.createDialog
- Defined in module/documents/item/item-base.mjs:38

`Static`defaultName

defaultName(
    context?: {
        pack?: null | string;
        parent?: null | Document;
        subType?: string;
        type?: string;
    },
): string
Override to provide naming by subType potential.
Parameters
- context: {
      pack?: null | string;
      parent?: null | Document;
      subType?: string;
      type?: string;
  } = {}
  Context where the name would be used
  - Optionalpack?: null | string
    Pack this would be within
  - Optionalparent?: null | Document
    Parent document
  - OptionalsubType?: string
    Document subtype. Nonstandard option.
  - Optionaltype?: string
    Type
Returns string
Synced with Foundry v12.331
- Defined in module/documents/item/item-base.mjs:57

`Static`getDefaultArtwork

getDefaultArtwork(itemData?: object): { img: string }
Internal
Add default artwork.
Parameters
- OptionalitemData: object
  Item data
Returns { img: string }
- Default image
See
pf1.config.defaultIcons.items
- Defined in module/documents/item/item-base.mjs:17

Class ItemBasePF

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemBasePF

Accessors

AbstractactiveState

Returns boolean

AbstractcanUse

Returns boolean

AbstractisActive

Returns boolean

See

Methods

getEmbeddedDocument

Parameters

Returns any

getName

Parameters

Returns string

AbstractsetActive

Parameters

Returns Promise<ItemBasePF>

Throws

Static_createSupplements

Parameters

Returns Promise<void>

Static_onCreateOperation

Parameters

Returns Promise<void>

Static_onDeleteOperation

Parameters

Returns Promise<void>

Static_onUpdateOperation

Parameters

Returns Promise<void>

StaticcreateDialog

Parameters

Optionaloptions?: object

Optionalpack?: null | string

Optionalparent?: null | Actor

Optionaltypes?: string[]

Returns Promise<null | Item>

StaticdefaultName

Parameters

Optionalpack?: null | string

Optionalparent?: null | Document

OptionalsubType?: string

Optionaltype?: string

Returns string

StaticgetDefaultArtwork

Parameters

Returns { img: string }

See

Settings

On This Page

`Abstract`activeState

`Abstract`canUse

`Abstract`isActive

`Abstract`setActive

`Static`_createSupplements

`Static`_onCreateOperation

`Static`_onDeleteOperation

`Static`_onUpdateOperation

`Static`createDialog

`Optional`options?: object

`Optional`pack?: null | string

`Optional`parent?: null | Actor

`Optional`types?: string[]

`Static`defaultName

`Optional`pack?: null | string

`Optional`parent?: null | Document

`Optional`subType?: string

`Optional`type?: string

`Static`getDefaultArtwork