Class ItemSpellPF

Spell item

Hierarchy (View Summary)

Constructors

constructor

Properties

_memoryVariables actions changes links scriptCalls system

Accessors

actionTypes activeState addonMaterial alignments allDamageSources attackSources auraStrength autoDeductCharges baseMaterial canUse casterLevel charges defaultAction defaultAmmo effect firstAction fullDescription hasAction hasActions hasAttack hasChanges hasDamage hasFiniteCharges inContainer isActive isCharged isDomain isPhysical isProficient isSingleUse maxCharges memoryVariables normalMaterial rootItem showUnidentifiedData slotCost spellbook spellLevel subType uuid hasActions hasChanges isPhysical

Methods

_activeStateChange _addTypeRollData _canCreateItemLink _configure _generateLinkData _onCreate _onDelete _onMemorizedUpdate _onUpdate _preCreate _prepareActions _prepareChanges _prepareDependentData _prepareIdentifier _prepareScriptCalls _prepareTraits _preUpdate _preUpdateNumericValueGuard _rechargeActions _rechargeUses _transformContainerUpdateData _updateInheritedCharges _updateMaxUses addCharges addItemBooleanFlag adjustContained createItemLink displayCard executeScriptCalls getAllDamageSources getAllLinkedItems getAttackSources getChangeTargets getChatData getConcentrationDC getConditionalSubTargets getConditionalTargets getContextChanges getDefaultChargeCost getDefaultChargeFormula getDescription getDescriptionData getEmbeddedDocument getFlag getItemBooleanFlags getItemDictionaryFlag getItemDictionaryFlags getLabels getLinkedItems getLinkedItemsSync getName getProficiency getRawEffectData getRollData getScriptCalls getSpellComponents getSpellUses getTypeChatData hasItemBooleanFlag memorizeVariables prepareBaseData prepareDerivedData prepareLinks recharge removeItemBooleanFlag removeItemDictionaryFlag removeItemLink setActive setItemDictionaryFlag update use useSpellPoints _adjustNewItem _createSupplements _hasSizeUpdate _hasVisionUpdate _onCreateOperation _onDeleteOperation _onUpdateOperation _replaceConsumableConversionString createDialog defaultName getDefaultArtwork getMinimumCasterLevelBySpellData toConsumable toConsumablePrompt

Constructors

constructor

  • new ItemSpellPF(
        ...args: [data?: ItemDataConstructorData, context?: Context<ActorPF>],
    ): ItemSpellPF

  • Parameters

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

    Returns ItemSpellPF

Properties

_memoryVariables

_memoryVariables: undefined | null | {}

actions

actions: undefined | Collection<ItemAction>

A Collection of ItemActions.

changes

changes: undefined | Collection<any>

links

links: undefined | Record<string, ItemPF>

An object containing links to other items.

scriptCalls

scriptCalls: any

Static Internalsystem

system: Readonly<
    {
        hasActions: true;
        hasChanges: false;
        hasIdentifier: false;
        isPhysical: boolean;
        subtypeName: false;
    },
> = ...

A static object holding system-specific metadata applicable to all instances of this Document class.

Accessors

actionTypes

AbstractactiveState

addonMaterial

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

autoDeductCharges

baseMaterial

canUse

casterLevel

  • get casterLevel(): null | number

  • Effective caster level

    Returns null | number

    Remarks

    • Accounts for offset
    • Returns null if not linked to a valid spellbook.

charges

defaultAction

defaultAmmo

Abstracteffect

  • get effect(): null | ActiveEffect

  • An active effect associated with this item.

    Returns null | ActiveEffect

    Remarks

    • Most item types don't have associated effect.

firstAction

fullDescription

hasAction

hasActions

hasAttack

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

hasFiniteCharges

inContainer

AbstractisActive

  • 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

isCharged

isDomain

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

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

rootItem

showUnidentifiedData

slotCost

  • get slotCost(): number

  • Number of slots the spell takes to prepare.

    Quick access to .system.slotCost with additional considerations such as at-will toggle.

    Defaults to 1 if the data is not present, 0 if the spell is at-will.

    Returns number

spellbook

spellLevel

subType

uuid

StatichasActions

StatichasChanges

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

Methods

_activeStateChange

_addTypeRollData

_canCreateItemLink

  • _canCreateItemLink(type: string, item: Item): boolean
  • Internal

    Test if specified link can be created.

    Parameters

    • type: string

      The type of link.

    • item: Item

      The target item to link to.

    Returns boolean

    Whether a link to the item is possible here.

_configure

_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

_onMemorizedUpdate

_onUpdate

_preCreate

_prepareActions

_prepareChanges

_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

_prepareScriptCalls

_prepareTraits

_preUpdate

Abstract_preUpdateNumericValueGuard

_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" } } } }

_updateInheritedCharges

_updateMaxUses

addCharges

  • addCharges(value: number, data?: object): Promise<void | ItemSpellPF>

  • Add charges to the spell or its relevant resource pool (spell points or spontaneous spells).

    Parameters

    • value: number

      Number of charges to add

    • Optionaldata: object = null

      Additional data to pass to the update

    Returns Promise<void | ItemSpellPF>

    Updated document or undefined if no update is possible or required.

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

createItemLink

  • createItemLink(
        type: "children" | "charges" | "classAssociations" | "supplement",
        item: Item,
        extraData?: object,
    ): boolean

  • Creates a link to another item.

    Parameters

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

      The type of link.

    • item: Item

      The target item to link into this.

    • OptionalextraData: object

      Additional data to store int he link

    Returns boolean

    • Whether a link was created.

displayCard

  • displayCard(
        altChatData?: object,
        options?: { token?: TokenDocument },
    ): Promise<void | ChatMessage>

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

    Parameters

    • OptionalaltChatData: object = {}

      Optional data that will be merged into the chat data object.

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

      Additional options.

      • Optionaltoken?: TokenDocument

        Relevant token if any.

    Returns Promise<void | ChatMessage>

    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

getAllLinkedItems

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;
            chatcard?: boolean;
            extended?: boolean;
            interactive?: boolean;
            rollData?: object;
        },
    ): ChatData

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

    Parameters

    • Optionaloptions: {
          actionId?: string;
          chatcard?: boolean;
          extended?: 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

      • Optionalchatcard?: boolean

        Is this actually for chat card.

      • Optionalextended?: boolean

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

      • Optionalinteractive?: boolean
      • OptionalrollData?: object

        Defaults to ItemAction#getRollData/ItemPF#getRollData.

    Returns ChatData

    The chat data for this item (+action)

getConcentrationDC

  • getConcentrationDC(type?: string, options?: object): number

  • Concentration DC

    Parameters

    • type: string = "defensive"

      Type of concentration check

    • Optionaloptions: object = {}

      Additional options

    Returns number

    • DC

    Throws

    • If type is invalid

AbstractgetConditionalSubTargets

getConditionalTargets

getContextChanges

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

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

    Parameters

    • context:
          | "mattack"
          | "nattack"
          | "rattack"
          | "tattack"
          | "wdamage"
          | "mwdamage"
          | "rwdamage"
          | "twdamage"
          | "rdamage"
          | "mdamage"
          | "ndamage"
          | "sdamage"
          | "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 spell actions.

    Parameters

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

      Additional options

      • OptionalrollData?: object

        Roll data instance

    Returns number

    • Default cost.

getDefaultChargeFormula

getDescription

  • getDescription(
        __namedParameters?: {
            body?: boolean;
            chatcard?: boolean;
            data?: {};
            header?: boolean;
            isolated?: boolean;
        },
    ): Promise<string>

  • Get full description.

    Parameters

    • __namedParameters: {
          body?: boolean;
          chatcard?: boolean;
          data?: {};
          header?: boolean;
          isolated?: boolean;
      } = {}

      Item type dependant options for rendering the description.

    Returns Promise<string>

    • Full description.

getDescriptionData

getEmbeddedDocument

getFlag

getItemBooleanFlags

getItemDictionaryFlag

getItemDictionaryFlags

getLabels

getLinkedItems

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

  • 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 object[] | Item[]

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

getLinkedItemsSync

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

  • 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[]

    Linked items or their compendium index data

    Example

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

getName

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 }): object

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

    Parameters

    • options: { rollData: object } = {}

      Additional options

      • rollData: object

        Roll data

    Returns object

    • Active Effect creation data

getRollData

getScriptCalls

getSpellComponents

  • getSpellComponents(options?: { compact?: boolean }): string[]

  • Spell components

    Parameters

    • options: { compact?: boolean } = {}

      Additional options

      • Optionalcompact?: boolean

        Remove redundant components (e.g. M/DF becomes DF for divine caster)

    Returns string[]

    • Component keys

    Example

    Example with Discern Lies on Cleric

    spell.getSpellComponents(); // => ["V", "S", "M/DF"]

    Same with compacted components

    spell.getSpellComponents({compact:true}); // => ["V","S", "DF"]

getSpellUses

getTypeChatData

  • getTypeChatData(data: any, labels: any, props: any, rollData: any): void

  • Per item type chat data.

    Parameters

    • data: any

      A partial of a chat data object that can be modified to add per item type data.

    • labels: any

      The labels for this item.

    • props: any

      Additional property strings

    • rollData: any

      A rollData object to be used for checks

    Returns void

hasItemBooleanFlag

memorizeVariables

prepareBaseData

prepareDerivedData

prepareLinks

recharge

  • recharge(
        __namedParameters?: {
            commit?: boolean;
            exact?: boolean;
            maximize?: boolean;
            period?: string;
        },
    ): Promise<undefined | Item | { system: { preparation: { value: any } } }>

  • Recharges item's uses, if any.

    Parameters

    • __namedParameters: { commit?: boolean; exact?: boolean; maximize?: boolean; period?: string } = {}

      Options

    Returns Promise<undefined | Item | { system: { preparation: { value: any } } }>

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

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

    • Updated document, update data, or undefined

AbstractsetActive

  • setActive(active: boolean, context?: object): Promise<ItemSpellPF>

  • Set item's active state.

    Parameters

    • active: boolean

      Active state

    • Optionalcontext: object

      Optional update context

    Returns Promise<ItemSpellPF>

    • Update promise if item type supports the operation.

    Throws

    • If item does not support the operation.

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

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.

useSpellPoints

Static_adjustNewItem

  • _adjustNewItem(item: any, data: any, override?: boolean): void

  • Adjust temporary item before creation

    Parameters

    • item: any

      Temporary document

    • data: any

      Creation data

    • override: boolean = false

      Override values even if defined

    Returns void

Static_createSupplements

Static_hasSizeUpdate

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

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>

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>

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>

Static_replaceConsumableConversionString

  • _replaceConsumableConversionString(string: string, rollData: object): string
  • Internal

    Used in consumable creation

    Parameters

    • string: string

      String to convert

    • rollData: object

      Roll data instance

    Returns string

    • Converted string

StaticcreateDialog

  • 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

StaticdefaultName

  • 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

StaticgetDefaultArtwork

StaticgetMinimumCasterLevelBySpellData

  • getMinimumCasterLevelBySpellData(itemData: object): [number, number]

  • Parameters

    • itemData: object

      A spell item's data.

    Returns [number, number]

    • A tuple containing the spell level and caster level in order.

StatictoConsumable

  • toConsumable(
        origData: object,
        type: "wand" | "scroll" | "potion",
        options?: { spellType?: string },
    ): null | object

  • Convert spell into a consumable item.

    Parameters

    • origData: object

      Spell item data

    • type: "wand" | "scroll" | "potion"

      Consumable type

    • Optionaloptions: { spellType?: string } = {}

      Additional options

      • OptionalspellType?: string

        Spell type

    Returns null | object

    • Item data for appropriate consumable, or null if dialog option was used and it was cancelled.

StatictoConsumablePrompt

  • toConsumablePrompt(
        itemData: object,
        options?: { actor?: object; allowSpell?: boolean; spellType?: string },
    ): Promise<null | false | object>

  • Open Consumable conversion dialog.

    Automatically calls this.toConsumable as appropriate.

    Parameters

    • itemData: object

      Spell item data

    • Optionaloptions: { actor?: object; allowSpell?: boolean; spellType?: string } = {}

      Additional options

      • Optionalactor?: object

        The actor the consumable is being created on.

      • OptionalallowSpell?: boolean

        Allow spell creation

      • OptionalspellType?: string

        Spell type

    Returns Promise<null | false | object>

    • Returns null if cancelled, false if no conversion is to take place, or converted data.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_activeStateChange_addTypeRollData_canCreateItemLink_configure_generateLinkData_onCreate_onDelete_onMemorizedUpdate_onUpdate_preCreate_prepareActions_prepareChanges_prepareDependentData_prepareIdentifier_prepareScriptCalls_prepareTraits_preUpdate_preUpdateNumericValueGuard_rechargeActions_rechargeUses_transformContainerUpdateData_updateInheritedCharges_updateMaxUsesaddChargesaddItemBooleanFlagadjustContainedcreateItemLinkdisplayCardexecuteScriptCallsgetAllDamageSourcesgetAllLinkedItemsgetAttackSourcesgetChangeTargetsgetChatDatagetConcentrationDCgetConditionalSubTargetsgetConditionalTargetsgetContextChangesgetDefaultChargeCostgetDefaultChargeFormulagetDescriptiongetDescriptionDatagetEmbeddedDocumentgetFlaggetItemBooleanFlagsgetItemDictionaryFlaggetItemDictionaryFlagsgetLabelsgetLinkedItemsgetLinkedItemsSyncgetNamegetProficiencygetRawEffectDatagetRollDatagetScriptCallsgetSpellComponentsgetSpellUsesgetTypeChatDatahasItemBooleanFlagmemorizeVariablesprepareBaseDataprepareDerivedDataprepareLinksrechargeremoveItemBooleanFlagremoveItemDictionaryFlagremoveItemLinksetActivesetItemDictionaryFlagupdateuseuseSpellPoints_adjustNewItem_createSupplements_hasSizeUpdate_hasVisionUpdate_onCreateOperation_onDeleteOperation_onUpdateOperation_replaceConsumableConversionStringcreateDialogdefaultNamegetDefaultArtworkgetMinimumCasterLevelBySpellDatatoConsumabletoConsumablePrompt