Class ItemPF

_memoryVariables

actions

changes

links

scriptCalls

Static Internalsystem

actionTypes

• get actionTypes(): string[]

  An array containing all action types from this item's actions.

  Returns string[]

  See

  config.itemActionTypes

addonMaterial

• get addonMaterial(): string[]

  The item's material addons.

  Returns string[]

alignments

• get alignments(): null | string

  The item's alignment attributes, or null if the item has no alignment attributes

  Returns null | string

allDamageSources

• get allDamageSources(): undefined | ItemChange[]

  Generic damage source retrieval for default action, includes default conditionals and other item specific modifiers.

  Returns undefined | ItemChange[]

  All relevant changes, or undefined if action was not found.

attackSources

• get attackSources(): undefined | object[]

  Return attack sources for default action.

  Returns undefined | object[]

  Array of value and label pairs for attack bonus sources on the main attack.

auraStrength

• get auraStrength(): number

  Aura strength as number from 0 to 4.

  Returns number

  See

  pf1.config.auraStrengths

autoDeductCharges

• get autoDeductCharges(): boolean

  Consumes are adds charges by default.

  Returns boolean

baseMaterial

• get baseMaterial(): null | string

  Base material

  Returns null | string

charges

• get charges(): number

  Remaining charges

  Returns number

defaultAction

• get defaultAction(): undefined | ItemAction

  Returns undefined | ItemAction

defaultAmmo

• get defaultAmmo(): undefined | Item<"base" | ModuleSubType>

  Linked ammunition item if any.

  Returns undefined | Item<"base" | ModuleSubType>

Abstracteffect

• get effect(): null | ActiveEffect<"base" | ModuleSubType>

  An active effect associated with this item.

  Returns null | ActiveEffect<"base" | ModuleSubType>

  Remarks

  • Most item types don't have associated effect.

effectiveCl

• get effectiveCl(): number

  Effective caster level of this item.

  Returns number

fullDescription

• get fullDescription(): any

  Returns any

hasAction

• get hasAction(): boolean

  Returns boolean

hasActions

• get hasActions(): any

  {@inheritDoc ItemPF.hasActions:getter}

  Returns any

hasAttack

• get hasAttack(): boolean

  Returns true if any of this item's actions have an attack, see ItemAction#hasAttack.

  Returns boolean

hasChanges

• get hasChanges(): any

  Whether the item is tangible physical object in reality.

  Returns any

  Remarks

  • You can utilize this with raw data via CONFIG.Item.documentClasses[type]?.isPhysical

hasDamage

• get hasDamage(): boolean

  Returns true if any of this item's actions have a damage roll, see ItemAction#hasDamage.

  Returns boolean

hasFiniteCharges

• get hasFiniteCharges(): boolean

  Finite charges

  Returns boolean

inContainer

• get inContainer(): boolean

  Is this item inside a container?

  Returns boolean

isCharged

• get isCharged(): boolean

  Returns boolean

isPhysical

• get isPhysical(): any

  Whether the item is tangible physical object in reality.

  Returns any

  Remarks

  • You can utilize this with raw data via CONFIG.Item.documentClasses[type]?.isPhysical

AbstractisProficient

• get isProficient(): boolean

  Is the owning actor proficiency at using this as weapon.

  Returns boolean

  Since

  PF1 v10

isSingleUse

• get isSingleUse(): boolean

  Returns boolean

maxCharges

• get maxCharges(): number

  Maximum possible charges this item can have.

  Returns number

  Remarks

  • Can return zero. Usually signifying something has reduced the potential uses below usability.
  • Can return infinity, signifying lack of limits.

memoryVariables

• get memoryVariables(): string[]

  Returns string[]

  The keys of data variables to memorize between updates, for e.g. determining the difference in update.

normalMaterial

• get normalMaterial(): null | string

  The item's actual material.

  Returns null | string

rootItem

• get rootItem(): Item<"base" | ModuleSubType>
  Internal

  Root item.

  Specifically the item at bottom of the container tree.

  Returns Item<"base" | ModuleSubType>

showUnidentifiedData

• get showUnidentifiedData(): boolean

  Should the item show unidentified data

  Returns boolean

subType

• get subType(): null | string

  The item's subtype, or null if the item has no subtype

  Returns null | string

uuid

• get uuid(): string

  A Universally Unique Identifier (uuid) for this Document instance.

  Returns string

StatichasActions

• get hasActions(): true

  Returns true

StatichasChanges

• get hasChanges(): boolean

  Returns boolean

StaticisPhysical

• get isPhysical(): boolean

  Whether the item is tangible physical object in reality.

  Returns boolean

  Remarks

  • You can utilize this with raw data via CONFIG.Item.documentClasses[type]?.isPhysical

_activeStateChange

• _activeStateChange(changed: object): any
  Internal Experimental

  Return active state change from data if present

  This is a hack to allow item-type agnostic active state change detection.

  Parameters

  • changed: object

  Returns any

Abstract_addTypeRollData

• _addTypeRollData(result: object): void
  Internal

  Add item type specific roll data.

  Parameters

  • result: object

    Roll data

  Returns void

_buildEmbedHTML

• _buildEmbedHTML(
      config: any,
      options?: {},
  ): Promise<HTMLElement | HTMLCollection | DocumentFragment>

  Parameters

  • config: any
  • options: {} = {}

  Returns Promise<HTMLElement | HTMLCollection | DocumentFragment>

  Inherit Doc

_canCreateItemLink

• _canCreateItemLink(
      type: string,
      item: Item<"base" | ModuleSubType>,
      options?: object,
  ): Promise<boolean>
  Internal

  Test if specified link can be created.

  Parameters

  • type: string

    The type of link.

  • item: Item<"base" | ModuleSubType>

    The target item to link to.

  • Optionaloptions: object = {}

    Additional options

  Returns Promise<boolean>

  Whether a link to the item is possible here.

_configure

• _configure(options?: object): void

  Configure item before data preparation.

  Parameters

  • options: object = {}

    Data model options

  Returns void

_createInlineEmbed

• _createInlineEmbed(
      content: any,
      config: any,
      options: any,
  ): Promise<null | HTMLElement>

  Parameters

  • content: any
  • config: any
  • options: any

  Returns Promise<null | HTMLElement>

  Inherit Doc

_embedDescription

• _embedDescription(config: any, options?: {}): Promise<DocumentFragment>

  Copy from foundry.documents.JournalEntryPage#_embedTextPage

  Parameters

  • config: any
  • options: {} = {}

  Returns Promise<DocumentFragment>

  See

  foundry.documents.JournalEntryPage#_embedTextPage

_generateLinkData

• _generateLinkData(type: string, item: object, uuid: string): any[]
  Internal

  Parameters

  • type: string

    The type of link.

  • item: object

    The target item to link to.

  • uuid: string

    The link identifier for the item.

  Returns any[]

  An array to insert into this item's link data.

_onCreate

• _onCreate(data: object, context: object, userId: string): void

  Parameters

  • data: object

    Creation data

  • context: object

    Creation context options

  • userId: string

    Triggering user ID

  Returns void

_onDelete

• _onDelete(context: object, userId: string): void

  Parameters

  • context: object

    Delete context options

  • userId: string

    Triggering user

  Returns void

_onMemorizedUpdate

• _onMemorizedUpdate(changed: any, context: any): void

  Parameters

  • changed: any
  • context: any

  Returns void

_onUpdate

• _onUpdate(changed: object, context: object, userId: string): void

  Parameters

  • changed: object

    Changed data

  • context: object

    Context

  • userId: string

    Triggering user ID

  Returns void

_preCreate

• _preCreate(data: any, context: any, user: any): Promise<void>

  Parameters

  • data: any
  • context: any
  • user: any

  Returns Promise<void>

  Inherit Doc

_prepareActions

• _prepareActions(): void
  Internal

  Prepare actions

  Returns void

_prepareChanges

• _prepareChanges(): void
  Internal

  Prepare and update Changes collection.

  Returns void

_prepareDependentData

• _prepareDependentData(final?: boolean): void

  Prepare data potentially dependent on other items.

  This should be run at in Item.prepareDerivedData() if no actor is present, or in actor's prepareDerivedData after document preparation is done.

  Parameters

  • final: boolean = false

    Is this final call to this?

  Returns void

_prepareIdentifier

• _prepareIdentifier(): void
  Internal

  Initialize identifier

  Returns void

_prepareScriptCalls

• _prepareScriptCalls(): void
  Internal

  Prepare ItemPF.scriptCalls collection.

  Returns void

_prepareTraits

• _prepareTraits(): void
  Internal

  Returns void

_preUpdate

• _preUpdate(changed: object, context: object, user: User): Promise<void>
  Internal

  Parameters

  • changed: object

    Changed data

  • context: object

    Context

  • user: User

    Triggering user

  Returns Promise<void>

Abstract_preUpdateNumericValueGuard

• _preUpdateNumericValueGuard(system: object): void
  Internal

  Fake DataModel-like behaviour

  Ensure numeric bits remain numbers

  Parameters

  • system: object

    System data

  Returns void

_rechargeActions

• _rechargeActions(
      options?: { exact: boolean; period?: string; rollData?: object },
  ): undefined | object
  Internal

  Recharges item's uses, if any.

  Parameters

  • options: { exact: boolean; period?: string; rollData?: object } = {}

    Options

    • exact: boolean

      Exact time period only

    • Optionalperiod?: string

      Recharge only if matching this time period

    • OptionalrollData?: object

      Roll data

  Returns undefined | object

  • Update data or undefined if no update is needed.

_rechargeUses

• _rechargeUses(
      options?: {
          exact?: boolean;
          maximize?: boolean;
          period?: string;
          rollData?: object;
          value?: number;
      },
  ): Promise<undefined | object>
  Internal

  Recharges item's uses, if any.

  Parameters

  • options: {
        exact?: boolean;
        maximize?: boolean;
        period?: string;
        rollData?: object;
        value?: number;
    } = {}

    Options

    • Optionalexact?: boolean

      Match only exact time period

    • Optionalmaximize?: boolean

      Maximize instead of using recharge formula

    • Optionalperiod?: string

      Recharge only if it matches this time period

    • OptionalrollData?: object

      Roll data instance

    • Optionalvalue?: number

      Set charges to specific value

  Returns Promise<undefined | object>

  • Update data or undefined if no update is necessary.

_transformContainerUpdateData

• _transformContainerUpdateData(
      data: object,
      options?: { recursive?: boolean },
  ): object
  Internal

  Transform given data so it becomes valid update data within parent item.

  This can, for example, be used to generate batched update to the real item.

  Parameters

  • data: object

    Update data

  • Optionaloptions: { recursive?: boolean } = {}

    Additional options

    • Optionalrecursive?: boolean

      Create data recursively, meant for the real item document.

  Returns object

  • Transformed update data

  Example

  _transformContainerUpdateData({ name: "new name" })
  // => { system: { items: { [itemID]: { name: "new name" } } } }
  Copy

_updateInheritedCharges

• _updateInheritedCharges(source: Item<"base" | ModuleSubType>): void
  Internal

  Update this item's charges based on provided item.

  Parameters

  • source: Item<"base" | ModuleSubType>

    Charge source

  Returns void

_updateMaxUses

• _updateMaxUses(): void
  Internal

  Update max uses

  Returns void

addCharges

• addCharges(value: number): Promise<void | ItemPF>

  Generic charge addition (or subtraction) function that either adds charges or quantity, based on item data.

  Parameters

  • value: number

    The amount of charges to add.

  Returns Promise<void | ItemPF>

  Updated document or undefined if no update is possible.

addItemBooleanFlag

• addItemBooleanFlag(flagName: string, context?: object): Promise<boolean>

  Sets a boolean flag on this item.

  Parameters

  • flagName: string

    The name/key of the flag to set.

  • context: object = {}

    Update context

  Returns Promise<boolean>

  Whether something was changed.

AbstractadjustContained

• adjustContained(): void

  Adjust data if the item is in container.

  Returns void

createItemLink

• createItemLink(
      type: "charges" | "children" | "supplement" | "classAssociations",
      item: Item<"base" | ModuleSubType>,
      extraData?: object,
      options?: object,
  ): Promise<boolean>

  Creates a link to another item.

  Parameters

  • type: "charges" | "children" | "supplement" | "classAssociations"

    The type of link.

  • item: Item<"base" | ModuleSubType>

    The target item to link into this.

  • OptionalextraData: object

    Additional data to store int he link

  • Optionaloptions: object = {}

    Additional options

  Returns Promise<boolean>

  • Whether a link was created.

displayCard

• displayCard(
      messageData?: object,
      options?: { token?: TokenDocument },
  ): Promise<void | ChatMessage<"base" | ModuleSubType>>

  Display the chat card for an Item as a message in chat

  Parameters

  • OptionalmessageData: object = {}

    Optional data that will be merged into the message data.

  • Optionaloptions: { token?: TokenDocument } = {}

    Additional options.

    • Optionaltoken?: TokenDocument

      Relevant token if any.

  Returns Promise<void | ChatMessage<"base" | ModuleSubType>>

  Chat message instance if one was created.

executeScriptCalls

• executeScriptCalls(
      category: string,
      extraParams?: Record<string, any>,
      shared?: object,
  ): Promise<object>

  Executes all script calls on this item of a specified category.

  Parameters

  • category: string

    The category of script calls to call.

  • OptionalextraParams: Record<string, any> = {}

    A dictionary of extra parameters to pass as variables for use in the script.

  • Optionalshared: object = {}

    Shared data object

  Returns Promise<object>

  The shared object between calls which may have been given data.

getAllDamageSources

• getAllDamageSources(actionId: any): undefined | ItemChange[]

  Parameters

  • actionId: any

  Returns undefined | ItemChange[]

getAllLinkedItems

• getAllLinkedItems(): Promise<Item<"base" | ModuleSubType>[]>

  Get all items linked by any means.

  Returns Promise<Item<"base" | ModuleSubType>[]>

  • Linked items

getAttackSources

• getAttackSources(
      actionId: string,
      options?: { rollData?: object },
  ): undefined | object[]

  Attack sources for a specific action.

  Parameters

  • actionId: string

    Action ID

  • Optionaloptions: { rollData?: object } = {}

    Additional options

    • OptionalrollData?: object

      Roll data instance

  Returns undefined | object[]

  Array of value and label pairs for attack bonus sources on the main attack, or undefined if the action is missing.

getChangeTargets

• getChangeTargets(target: string): Record<string, string>

  Generates lists of change targets this item can have.

  Parameters

  • target: string

    The target key, as defined in PF1.buffTargets.

  Returns Record<string, string>

  A list of changes

getChatData

• getChatData(
      options?: {
          actionId?: string;
          body?: boolean;
          chatcard?: boolean;
          extended?: boolean;
          footer?: boolean;
          header?: boolean;
          interactive?: boolean;
          rollData?: object;
      },
  ): Promise<ChatData>

  Generates ChatData for this item, either in a default configuration or for a specific action.

  Parameters

  • Optionaloptions: {
        actionId?: string;
        body?: boolean;
        chatcard?: boolean;
        extended?: boolean;
        footer?: boolean;
        header?: boolean;
        interactive?: boolean;
        rollData?: object;
    } = {}

    Options affecting how descriptions are enriched. rollData

    • OptionalactionId?: string

      The ID of an action on this item to generate chat data for, defaults to ItemPF.defaultAction

    • Optionalbody?: boolean

      Include main description

    • Optionalchatcard?: boolean

      Is this actually for chat card.

    • Optionalextended?: boolean

      Include extended information that may not be useful in all circumstances.

    • Optionalfooter?: boolean

      Include footer if it exists

    • Optionalheader?: boolean

      Include header if it exists

    • Optionalinteractive?: boolean

      Was this from user interaction (allowing farther interactions)

    • OptionalrollData?: object

      Defaults to ItemAction#getRollData/ItemPF#getRollData.

  Returns Promise<ChatData>

  The chat data for this item (+action)

AbstractgetConditionalSubTargets

• getConditionalSubTargets(result: object): void

  Item specific conditional sub targets.

  Parameters

  • result: object

    Result key to label mapping.

  Returns void

AbstractgetConditionalTargets

• getConditionalTargets(results: Record<string, object>): void

  Item specific conditional targets.

  Parameters

  • results: Record<string, object>

    Key to target mapping.

  Returns void

getContextChanges

• getContextChanges(
      context?:
          | "mwdamage"
          | "twdamage"
          | "rwdamage"
          | "sdamage"
          | "mattack"
          | "wdamage"
          | "nattack"
          | "rattack"
          | "tattack"
          | "rdamage"
          | "mdamage"
          | "ndamage"
          | "tdamage",
  ): ItemChange[]

  Finds, filters and alters changes relevant to a context, and returns the result (as an array)

  Parameters

  • context:
        | "mwdamage"
        | "twdamage"
        | "rwdamage"
        | "sdamage"
        | "mattack"
        | "wdamage"
        | "nattack"
        | "rattack"
        | "tattack"
        | "rdamage"
        | "mdamage"
        | "ndamage"
        | "tdamage" = ...

    The given context.

  Returns ItemChange[]

  • The matching changes.

  Remarks

  • Always returns empty array if no actor is present.

getDefaultChargeCost

• getDefaultChargeCost(options?: { rollData?: object }): number

  Get default charge cost for all actions.

  Parameters

  • Optionaloptions: { rollData?: object } = {}

    Additional options

    • OptionalrollData?: object

      Roll data instance

  Returns number

  Number for default cost.

getDefaultChargeFormula

• getDefaultChargeFormula(): string

  Default charge formula.

  Returns string

  Charge formula

AbstractgetDescription

• getDescription(
      options?: {
          actionId: any;
          body?: boolean;
          chatcard?: boolean;
          data?: object;
          header?: boolean;
          identified?: boolean;
          isolated?: boolean;
          rollData?: object;
      },
  ): Promise<string>

  Get full description.

  Parameters

  • options: {
        actionId: any;
        body?: boolean;
        chatcard?: boolean;
        data?: object;
        header?: boolean;
        identified?: boolean;
        isolated?: boolean;
        rollData?: object;
    } = {}

    Item type dependant options for rendering the description.

    • actionId: any

    • Optionalbody?: boolean

      Include main description body if such exists.

    • Optionalchatcard?: boolean

      Instruct template to render chat card in mind.

    • Optionaldata?: object

      Template data for rendering

    • Optionalheader?: boolean

      Include header if such exists.

    • Optionalidentified?: boolean

      Enforce identified description retrieval

    • Optionalisolated?: boolean

      Passed to getDescriptionData

    • OptionalrollData?: object

      Roll data for transforming description

  Returns Promise<string>

  • Full description.

getDescriptionData

• getDescriptionData(
      options?: { actionId?: string; isolated?: boolean; rollData?: object },
  ): Promise<object>

  Description Data

  Required to be async due to spell associated class map building.

  Parameters

  • options: { actionId?: string; isolated?: boolean; rollData?: object } = {}

    Additional options

    • OptionalactionId?: string

      ID of an action. Default action is used if undefined.

    • Optionalisolated?: boolean

      Include extra data to reflect it not being so easily available in context.

    • OptionalrollData?: object

      Roll data instance

  Returns Promise<object>

  • Description context data

getItemBooleanFlags

• getItemBooleanFlags(): string[]

  Get all item boolean flags as array.

  Returns string[]

  • Flag keys

getItemDictionaryFlag

• getItemDictionaryFlag(flagName: string): undefined | string | number

  Parameters

  • flagName: string

    The name/key of the flag to get.

  Returns undefined | string | number

  The value stored in the flag.

getItemDictionaryFlags

• getItemDictionaryFlags(): Record<string, any>

  Get all item dictionary flags as array of objects.

  Returns Record<string, any>

  • All dictionary flags

getLabels

• getLabels(
      options?: { actionId?: string; isolated?: boolean; rollData?: object },
  ): Record<string, string>

  Returns labels for this item

  Parameters

  • Optionaloptions: { actionId?: string; isolated?: boolean; rollData?: object } = {}

    Additional options

    • OptionalactionId?: string

      ID of one of this item's actions to get labels for; defaults to first action

    • Optionalisolated?: boolean

      Is this isolated use? If true, more data is included.

    • OptionalrollData?: object

      Roll data to use.

  Returns Record<string, string>

  This item's labels

getLinkedItems

• getLinkedItems(
      type: string,
      includeLinkData?: boolean,
      options?: { _results?: Set<any>; recursive?: boolean },
  ): Promise<object[] | Item<"base" | ModuleSubType>[]>

  Get item links of type

  Parameters

  • type: string

    Link type

  • includeLinkData: boolean = false

    Include link data, return value changes from item array to object array

  • Optionaloptions: { _results?: Set<any>; recursive?: boolean } = {}

    Additional options

    • Optional_results?: Set<any>

      Internal use only.

    • Optionalrecursive?: boolean

      Retrieved linked items recursively.

  Returns Promise<object[] | Item<"base" | ModuleSubType>[]>

  • Linked items, or objects with linked items and additional data

getLinkedItemsSync

• getLinkedItemsSync(
      type: string,
      options?: { _results?: Set<string>; recursive?: boolean },
  ): object[] | Item<"base" | ModuleSubType>[]

  Retrieve list of linked items for a type, synchronously. Intended mainly for fetching child or charge links quickly.

  Parameters

  • type: string

    Link type, e.g. "children", "charges", or "classAssociations"

  • Optionaloptions: { _results?: Set<string>; recursive?: boolean } = {}

    Additional options

    • Optional_results?: Set<string>

      Internal use only

    • Optionalrecursive?: boolean

      Retrieve links recursively.

  Returns object[] | Item<"base" | ModuleSubType>[]

  Linked items or their compendium index data

  Example

  const childItems = item.getLinkedItemsSync("children");
  Copy

AbstractgetProficiency

• getProficiency(weapon?: boolean): boolean

  Parameters

  • Optionalweapon: boolean = true

    Get proficiency as a weapon. Armor otherwise.

  Returns boolean

  • Whether or not the owner of the item is proficient.

  Throws

  • If item type does not support proficiency.

  Since

  PF1 v10

getRawEffectData

• getRawEffectData(options?: { rollData: object }): Promise<object>

  Determines the starting data for an ActiveEffect based off this item.

  Parameters

  • options: { rollData: object } = {}

    Additional options

    • rollData: object

      Roll data

  Returns Promise<object>

  • Active Effect creation data

getRollData

• getRollData(options?: object): object

  Parameters

  • Optionaloptions: object

    Additional options

  Returns object

  An object with data to be used in rolls in relation to this item.

getScriptCalls

• getScriptCalls(category: string): ItemScriptCall[]
  Internal

  Fetches all this item's script calls of a specified category

  Parameters

  • category: string

    Category

  Returns ItemScriptCall[]

  • Script calls within the category.

hasItemBooleanFlag

• hasItemBooleanFlag(flagName: string): boolean

  Parameters

  • flagName: string

    The name/key of the flag on this item.

  Returns boolean

  Whether the flag was found on this item.

memorizeVariables

• memorizeVariables(): void
  Internal

  Memorize quantity and level for later diffing.

  Returns void

prepareBaseData

• prepareBaseData(): void

  Returns void

prepareDerivedData

• prepareDerivedData(): void

  Returns void

prepareResources

• prepareResources(): void
  Internal

  Prepare item resources.

  Returns void

recharge

• recharge(
      options?: {
          commit?: boolean;
          context?: object;
          exact?: boolean;
          maximize?: boolean;
          period?: "round" | "minute" | "hour" | "day" | "week" | "any";
          rollData?: object;
          value?: number;
      },
  ): Promise<undefined | object | ItemPF>

  Recharges item's uses, if any.

  Parameters

  • options: {
        commit?: boolean;
        context?: object;
        exact?: boolean;
        maximize?: boolean;
        period?: "round" | "minute" | "hour" | "day" | "week" | "any";
        rollData?: object;
        value?: number;
    } = {}

    Options

    • Optionalcommit?: boolean

      Commit update directly. If false, returns the update data instead.

    • Optionalcontext?: object

      Update context

    • Optionalexact?: boolean

      Use exact time period. Otherwise "week" for example will also recharge items with "day" period.

    • Optionalmaximize?: boolean

      Recharge to full regardless of recharge formula.

    • Optionalperiod?: "round" | "minute" | "hour" | "day" | "week" | "any"

      Recharge period. Use "any" to ignore item's configuration.

    • OptionalrollData?: object

      Roll data instance to use for formulas.

    • Optionalvalue?: number

      Recharge to specific value, respecting maximum and minimum bounds.

  Returns Promise<undefined | object | ItemPF>

  • Promise for the update, update data object, or undefined (no update needed).

removeItemBooleanFlag

• removeItemBooleanFlag(flagName: string, context?: object): Promise<boolean>

  Removes a boolean flag from this item.

  Parameters

  • flagName: string

    The name/key of the flag to remove.

  • context: object = {}

    Update context

  Returns Promise<boolean>

  Whether something was changed.

removeItemDictionaryFlag

• removeItemDictionaryFlag(flagName: string, context?: object): Promise<boolean>

  Removes a dictionary flag from this item.

  Parameters

  • flagName: string

    The name/key of the flag to remove.

  • context: object = {}

    Update context

  Returns Promise<boolean>

  Whether something was changed.

removeItemLink

• removeItemLink(
      uuid: string,
      options?: { commit?: boolean },
  ): Promise<undefined | object | Item<"base" | ModuleSubType>>

  Removes all link references to an item.

  Parameters

  • uuid: string

    The UUID of the item to remove links to.

  • Optionaloptions: { commit?: boolean } = {}

    Additional options

    • Optionalcommit?: boolean

      Commit changes to database. If false, resulting update data is returned instead.

  Returns Promise<undefined | object | Item<"base" | ModuleSubType>>

  • Updated document, update data, or undefined

render

• render(force: any, context: any): void

  Parameters

  • force: any
  • context: any

  Returns void

setItemDictionaryFlag

• setItemDictionaryFlag(
      flagName: string,
      value: string | number,
      context?: object,
  ): Promise<boolean>

  Sets a dictionary flag value on this item.

  Parameters

  • flagName: string

    The name/key of the flag to set.

  • value: string | number

    The flag's new value.

  • context: object = {}

    Update context

  Returns Promise<boolean>

  Whether something was changed.

update

• update(data: object, context?: object): Promise<Item<"base" | ModuleSubType>>

  Parameters

  • data: object

    Update data

  • context: object = {}

    Context

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

  • Updated item

use

• use(
      options?: {
          actionId?: string;
          chatMessage?: boolean;
          cost?: number;
          dice?: string;
          ev?: null | Event;
          options?: UseOptions;
          rollMode?: string;
          skipDialog?: boolean;
          token?: TokenDocument;
      },
  ): Promise<void | ActionUse | SharedActionData>

  Use an attack, using SharedActionData

  Parameters

  • options: {
        actionId?: string;
        chatMessage?: boolean;
        cost?: number;
        dice?: string;
        ev?: null | Event;
        options?: UseOptions;
        rollMode?: string;
        skipDialog?: boolean;
        token?: TokenDocument;
    } = {}

    Options

    • OptionalactionId?: string

      The ID of the action to use, defaults to the first action

    • OptionalchatMessage?: boolean

      Whether to send a chat message for this action

    • Optionalcost?: number

      Cost override. Replaces charge cost or slot cost as appropriate.

    • Optionaldice?: string

      The base dice to roll for this action

    • Optionalev?: null | Event

      The event that triggered the use, if any

    • Optionaloptions?: UseOptions

      Additional use options.

    • OptionalrollMode?: string

      The roll mode to use for the chat message

    • OptionalskipDialog?: boolean

      Whether to skip the dialog for this action

    • Optionaltoken?: TokenDocument

      Token this action is for, if any.

  Returns Promise<void | ActionUse | SharedActionData>

  • Action use, shared data, or nothing.

  See

  SharedActionData

  Throws

  • On some invalid inputs.

Static_hasSizeUpdate

• _hasSizeUpdate(data: object): boolean
  Internal

  Determine whether a given change set affects size

  Parameters

  • data: object

    Item data

  Returns boolean

  • Contains size targeting change

Static_hasVisionUpdate

• _hasVisionUpdate(changes: object): boolean
  Internal

  Determine whether a given change set affect senses

  Parameters

  • changes: object

    An object containing changeFlags and changes to be inspected.

  Returns boolean

  • Vision alteration detected