Class ItemBasePF

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

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

isActive

get isActive(): boolean
Is the item functional.

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

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

prepareData

prepareData(): void
Returns void
Overrides Item.prepareData
- Defined in module/documents/item/item-base.mjs:22

`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:15

Class ItemBasePF

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

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

Returns ItemBasePF

Accessors

canUse

Returns boolean

Abstract

isActive

Returns boolean

Abstract

Methods

getName

Parameters

`Optional` forcePlayerPerspective: boolean = false

Returns string

prepareData

Returns void

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

Settings

Member Visibility

Theme

On This Page

Class ItemBasePF

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

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

Returns ItemBasePF

Accessors

canUse

Returns boolean

Abstract

isActive

Returns boolean

Abstract

Methods

getName

Parameters

Optional forcePlayerPerspective: boolean = false

Returns string

prepareData

Returns void

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>

Settings

Member Visibility

Theme

On This Page

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

`Optional` forcePlayerPerspective: boolean = false

`Static` createDialog

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