Class ItemBasePF

Base item

From which all other item documents inherit from.

Hierarchy (View Summary)

Item
- ItemBasePF
  - ItemPF

Index

Constructors

constructor

new ItemBasePF(data: CreateData, context?: ConstructionContext): ItemBasePF
Parameters
- data: CreateData
  Initial data from which to construct the Item
- Optionalcontext: ConstructionContext
  Construction context options
Returns ItemBasePF
Inherited from Item.constructor
- Defined in node_modules/fvtt-types/src/foundry/client/documents/item.d.mts:559

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
See
pf1.models.item.BaseItemModel.activeState
Remarks
- This queries this.system.activeState for the actual state.
- Defined in module/documents/item/item-base.mjs:521

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:560

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
- pf1.models.item.BaseItemModel.isActive
Remarks
- This queries this.system.isActive for the actual state.
- Defined in module/documents/item/item-base.mjs:506

Methods

_onUpdate

_onUpdate(changed: any, context: any, user: any): void
Parameters
- changed: any
- context: any
- user: any
Returns void
Overrides Item._onUpdate
- Defined in module/documents/item/item-base.mjs:218

_prepareDependentData

_prepareDependentData(final?: boolean): void
Internal
Prepare data dependent on other items
Parameters
- final: boolean = false
Returns void
- Defined in module/documents/item/item-base.mjs:547

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:571

getName

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

getRollData

getRollData(options: any): any
Prepare a data object which defines the data schema used by dice roll commands against this Item
Parameters
- options: any
Returns any
Remarks
defaults to this.system, but provided as object for flexible overrides
Overrides Item.getRollData
- Defined in module/documents/item/item-base.mjs:551

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.
See
()
Throws
- If item does not support the operation.
- Defined in module/documents/item/item-base.mjs:535

`Static`_createSupplements

_createSupplements(
items: Item<"base" | ModuleSubType>[],
actor: Actor<"base" | ModuleSubType>,
): Promise<void>
Internal
Collect information on supplemental items and create them
Parameters
- items: Item<"base" | ModuleSubType>[]
  Array of items to draw supplemental data from
- actor: Actor<"base" | ModuleSubType>
  Owner
Returns Promise<void>
- Defined in module/documents/item/item-base.mjs:357

`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>
Overrides Item._onCreateOperation
- Defined in module/documents/item/item-base.mjs:143

`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>
Overrides Item._onDeleteOperation
- Defined in module/documents/item/item-base.mjs:292

`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>
Overrides Item._onUpdateOperation
- Defined in module/documents/item/item-base.mjs:237

`Static`createDialog

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

`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 v13.351
Overrides Item.defaultName
- Defined in module/documents/item/item-base.mjs:101

`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
Overrides Item.getDefaultArtwork
- Defined in module/documents/item/item-base.mjs:17

`Static`migrateData

migrateData(source: any): AnyMutableObject
Parameters
- source: any
Returns AnyMutableObject
Overrides Item.migrateData
- Defined in module/documents/item/item-base.mjs:127

Class ItemBasePF

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemBasePF

Accessors

activeState

Returns boolean

See

Remarks

canUse

Returns boolean

isActive

Returns boolean

See

Remarks

Methods

_onUpdate

Parameters

Returns void

_prepareDependentData

Parameters

Returns void

getEmbeddedDocument

Parameters

Returns any

getName

Parameters

Returns string

getRollData

Parameters

Returns any

Remarks

setActive

Parameters

Returns Promise<ItemBasePF>

See

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<"base" | ModuleSubType>

Optionaltypes?: string[]

Returns Promise<null | Item<"base" | ModuleSubType>>

StaticdefaultName

Parameters

Optionalpack?: null | string

Optionalparent?: null | Document

OptionalsubType?: string

Optionaltype?: string

Returns string

StaticgetDefaultArtwork

Parameters

Returns { img: string }

See

StaticmigrateData

Parameters

Returns AnyMutableObject

Settings

On This Page

`Static`_createSupplements

`Static`_onCreateOperation

`Static`_onDeleteOperation

`Static`_onUpdateOperation

`Static`createDialog

`Optional`options?: object

`Optional`pack?: null | string

`Optional`parent?: null | Actor<"base" | ModuleSubType>

`Optional`types?: string[]

`Static`defaultName

`Optional`pack?: null | string

`Optional`parent?: null | Document

`Optional`subType?: string

`Optional`type?: string

`Static`getDefaultArtwork

`Static`migrateData