Class ItemAction

constructor

• new ItemAction(data: object, options: any): ItemAction

• Parameters

  • data: object

    Action data
  • options: any

    Data model options

  Returns ItemAction

Internal_id

ability

actionType

activation

alignments

ammo

area

attackBonus

attackName

bab

conditionals

damage

description

duration

effect

enh

extraAttacks

held

Optionalimg

material

measureTemplate

naturalAttack

nonlethal

notes

Optionalparent

powerAttack

range

save

soundEffect

splash

Optionaltag

target

touch

uses

Static ReadonlyFALLBACK_IMAGE

Static Readonly Internalmetadata

actor

• get actor(): undefined | ActorPF

• Parent actor of the parent item

  Returns undefined | ActorPF

addonMaterial

• get addonMaterial(): string[]

• Addon materials

  Returns string[]

allDamageSources

• get allDamageSources(): ItemChange[]

• All relevant Changes the action's damage.

  Returns ItemChange[]

ammoCost

• get ammoCost(): number

• Effective per-attack ammo cost.

  Returns number

  Deprecated

  • Use action.ammo.cost instead.

ammoType

• get ammoType(): null | string

• Effective ammo type.

  Returns null | string

  Deprecated

  • Use action.ammo.type instead.

attackNotes

• get attackNotes(): string[]

• Returns string[]

  Deprecated

  • Use action.notes.footer instead

attackSources

• get attackSources(): ItemChange[]

• Get all appropriate context changes for attack rolls.

  Returns ItemChange[]

  See

  ItemPF.getContextChanges

autoDeductCharges

• get autoDeductCharges(): boolean

• Consumes charges on use?

  Returns boolean

canUse

• get canUse(): boolean

• Can this action be used?

  Returns false if any known criteria for use limitation fails. Calls owning item's canUse functionality also.

  Returns boolean

  See

  pf1.documents.item.ItemBasePF.canUse

critRange

• get critRange(): number

• Effective critical range when accounting for broken status and action type.

  Returns number

damageSources

• get damageSources(): ItemChange[]

• An array of changes affecting this action's damage

  Returns ItemChange[]

data

• get data(): this

• Returns this

  Deprecated

  • Use the action directly instead

effectNotes

• get effectNotes(): string[]

• Returns string[]

  Deprecated

  • Use action.notes.effect instead

enhancementBonus

• get enhancementBonus(): null | number

• Effective enhancement bonus

  Action's enhancement override or what is inherited from item.

  Returns null | number

  Remarks

  • Null if not enhanced.

hasAttack

• get hasAttack(): boolean

• Includes attack roll?

  Returns boolean

hasDamage

• get hasDamage(): boolean

• Does the action implement a damage roll as part of its usage

  Returns boolean

hasEffect

• get hasEffect(): boolean

• Returns boolean

hasMultiAttack

• get hasMultiAttack(): boolean

• Has potentially multiple attacks

  Returns boolean

hasRange

• get hasRange(): boolean

• Does the item have range defined.

  Returns boolean

hasSave

• get hasSave(): boolean

• Does the Item implement a saving throw as part of its usage

  Returns boolean

hasSound

• get hasSound(): boolean

• Has sound effect?

  Returns boolean

  Deprecated

  • Test !!action.soundEffect instead.

hasTemplate

• get hasTemplate(): boolean

• Has measured template?

  Returns boolean

id

• get id(): string

• Action ID

  Returns string

isCharged

• get isCharged(): boolean

• Does parent item have charges?

  Returns boolean

isCombatManeuver

• get isCombatManeuver(): boolean

• Returns whether this action is a combat maneuver

  Returns boolean

isHealing

• get isHealing(): boolean

• Does the item provide an amount of healing instead of conventional damage?

  Returns boolean

isRanged

• get isRanged(): boolean

• Is ranged rather than melee.

  Returns boolean

isSelfCharged

• get isSelfCharged(): boolean

• Action has charges of its own?

  Returns boolean

isSpell

• get isSpell(): boolean

• Is spell-like action

  Returns boolean

  Remarks

  • Action type is set to melee/ranged spell attack or spell save.

item

• get item(): undefined | ItemPF

• Parent item

  Returns undefined | ItemPF

maxRange

• get maxRange(): number

• The action's maximum range (range multiplied by maximum range increments).

  Returns number

minRange

• get minRange(): number

• The action's exclusive minimum range.

  Returns number

misfire

• get misfire(): number

• Misfire threshold

  Returns number

  Remarks

  • Zero if action does not misfire.

normalMaterial

• get normalMaterial(): null | string

• Normal material

  Returns null | string

  Remarks

  • Null if no material is configured in action or item.

rangeIncrement

• get rangeIncrement(): number

• The action's first increment range (in system configured units)

  Returns number

sheet

• get sheet(): ItemActionSheet

• Current sheet.

  Returns ItemActionSheet

  Remarks

  • Initializes a new sheet if one doesn't exist yet.

spellEffect

• get spellEffect(): string

• Returns string

  Deprecated

  • Use action.effect instead

uuid

• get uuid(): string

• Retrieve UUID

  Relies on Item#getEmbeddedDocument() override to function with fromUuid() and similar functions.

  Returns string

StaticdefaultDamageType

• get defaultDamageType(): { custom: string; values: never[] }

• Returns { custom: string; values: never[] }

  Deprecated

  • No replacement

StaticdefaultData

• get defaultData(): any

• Returns any

  Deprecated

  • No replacement

_configure

• _configure(options: any): void

• Parameters

  • options: any

  Returns void

_prepareConditionals

• _prepareConditionals(): void
• Internal

  Replace conditionals array with collection

  Returns void

delete

• delete(): Item

• Delete this action

  Returns Item

  • Updated parent item document.

getAttacks

• getAttacks(
      options?: {
          bonuses?: boolean;
          conditionals?: boolean;
          full?: boolean;
          resolve?: boolean;
          rollData?: object;
      },
  ): object[]

• Generate attacks.

  Parameters

  • Optionaloptions: {
        bonuses?: boolean;
        conditionals?: boolean;
        full?: boolean;
        resolve?: boolean;
        rollData?: object;
    } = {}

    Options

    • Optionalbonuses?: boolean

      Include other bonuses. Requires resolve to be enabled.

    • Optionalconditionals?: boolean

      Include conditional modifications. Requires resolve to be enabled.

    • Optionalfull?: boolean

      Full attack

    • Optionalresolve?: boolean

      If the bonuses are to be resolved directly.

    • OptionalrollData?: object

      Roll data

  Returns object[]

  • Array of attack data

getChargeCost

• getChargeCost(
      options?: {
          interactive?: boolean;
          maximize?: boolean;
          minimize?: boolean;
          rollData?: object;
      },
  ): null
  | Roll<any>

• Parameters

  • Optionaloptions: {
        interactive?: boolean;
        maximize?: boolean;
        minimize?: boolean;
        rollData?: object;
    } = {}

    Additional options to configure behavior.

    • Optionalinteractive?: boolean

    • Optionalmaximize?: boolean

    • Optionalminimize?: boolean

    • OptionalrollData?: object

      Pre-determined roll data to pass for determining the charge cost.

  Returns null | Roll<any>

  • Cost in charges for this action. Null if not charged.

getChargeCostSync

• getChargeCostSync(
      options?: { maximize?: boolean; minimize?: boolean; rollData?: object },
  ): null | Roll<any>

• Parameters

  • Optionaloptions: { maximize?: boolean; minimize?: boolean; rollData?: object } = {}

    Additional options to configure behavior.

    • Optionalmaximize?: boolean

    • Optionalminimize?: boolean

    • OptionalrollData?: object

      Pre-determined roll data to pass for determining the charge cost.

  Returns null | Roll<any>

  • Cost in charges for this action. Null if not charged.

getChatData

• getChatData(chatDataOptions?: object): Promise<ChatData>

• Generates ChatData for this action's parent item, but with this action's data, regardless of whether it is the first action or not.

  Parameters

  • OptionalchatDataOptions: object = {}

    Options passed to ItemPF#getChatData affecting the chat data

  Returns Promise<ChatData>

  Chat data for this action's parent and this action

  See

  ItemPF#getChatData

getConditionalCritical

• getConditionalCritical(target: any): {}

• Parameters

  • target: any

  Returns {}

getConditionalModifierTypes

• getConditionalModifierTypes(target: any): {}

• Parameters

  • target: any

  Returns {}

getConditionalSubTargets

• getConditionalSubTargets(entry: object, _results: any): object

• Generates lists of conditional sub-targets this action can have.

  Parameters

  • entry: object

    The target entry
  • _results: any

    Unused. Deprecated option

  Returns object

  • Same as the target entry parameter with added info.

getConditionalTargets

• getConditionalTargets(): Record<string, string>

• Generates a list of targets this modifier can have.

  Returns Record<string, string>

  Target ID to label mapping.

getDC

• getDC(rollData?: object): number

• Parameters

  • OptionalrollData: object = null

    Data to pass to the roll. If none is given, get new roll data.

  Returns number

  The Difficulty Class for this action.

getLabels

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

• Returns labels related to this particular action

  Parameters

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

    • Optionalisolated?: boolean

      Are these labels generated for isolated information (that is, need more details)

    • OptionalrollData?: object

      Pre-determined roll data. If not provided, finds the action's own roll data.

  Returns Record<string, string>

  This action's labels

getPowerAttackMult

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

• Get power attack, deadly aim or piranha strike multiplier.

  Parameters

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

    Additional options

    • OptionalrollData?: object

      Roll data instance

  Returns number

  • Effective multiplier

getRange

• getRange(
      options?: { rollData?: object; type?: "min" | "max" | "single" },
  ): null | number

• Parameters

  • Optionaloptions: { rollData?: object; type?: "min" | "max" | "single" } = {}

    Additional options to configure behavior.

    • OptionalrollData?: object

      Specific roll data to pass.

    • Optionaltype?: "min" | "max" | "single"

      What type of range to query. Either "single" (for a single range increment), "max" or "min".

  Returns null | number

  The given range, in system configured units, or null if no range is applicable.

getRollData

• getRollData(options?: object): object
• Internal

  Parameters

  • Optionaloptions: object

  Returns object

prepareData

• prepareData(): void
• Internal

  Data preparation

  Returns void

render

• render(force?: boolean, context?: object): void

• Render all connected application instances.

  Parameters

  • Optionalforce: boolean = false

    Force rendering
  • Optionalcontext: object = {}

    Optional context

  Returns void

rollAttack

• rollAttack(
      options?: {
          bonus?: string;
          data?: object;
          extraChanges?: ItemChange[];
          extraParts?: string[];
          primary?: boolean;
      },
  ): D20RollPF

• Place an attack roll using an item (weapon, feat, spell, or equipment)

  Parameters

  • Optionaloptions: {
        bonus?: string;
        data?: object;
        extraChanges?: ItemChange[];
        extraParts?: string[];
        primary?: boolean;
    } = {}

    Options

    • Optionalbonus?: string

      Additional attack bonus

    • Optionaldata?: object

      Roll data

    • OptionalextraChanges?: ItemChange[]

      Additional changes

    • OptionalextraParts?: string[]

      Additional attack parts

    • Optionalprimary?: boolean

      Treat as primary natural attack

  Returns D20RollPF

rollDamage

• rollDamage(
      options?: {
          conditionalParts?: object;
          critical?: boolean;
          data?: null | object;
          extraParts?: string[];
          primaryAttack?: boolean;
      },
  ): Promise<DamageRoll[]>

• Roll damage for an action.

  Parameters

  • Optionaloptions: {
        conditionalParts?: object;
        critical?: boolean;
        data?: null | object;
        extraParts?: string[];
        primaryAttack?: boolean;
    } = {}

    Options configuring the damage roll

    • OptionalconditionalParts?: object

      Conditional data sets

    • Optionalcritical?: boolean

      Whether to roll critical damage

    • Optionaldata?: null | object

      rollData to be used

    • OptionalextraParts?: string[]

      Additional strings added to the roll formula

    • OptionalprimaryAttack?: boolean

      Whether this is the primary attack

  Returns Promise<DamageRoll[]>

  Created damage rolls, one roll per damage part

update

• update(updateData: object, context?: object): Promise<void>

• Update the action

  TODO: BROKEN

  Parameters

  • updateData: object

    Update data
  • context: object = {}

    Update context

  Returns Promise<void>

use

• use(options?: object): Promise<void>

• Use action.

  Wrapper for () ItemPF.use()

  Parameters

  • options: object = {}

    Options passed to ItemPF.use().

  Returns Promise<void>

  • Returns what ItemPF.use() returns.

Staticcreate

• create(data: object[], context?: { parent?: ItemPF }): ItemAction[]

• Creates an action.

  Parameters

  • data: object[]

    Data to initialize the action(s) with.
  • context: { parent?: ItemPF } = {}

    An object containing update context information.

    • Optionalparent?: ItemPF

      The parent entity to create the action within.

  Returns ItemAction[]

  • The resulting actions

  Throws

  • If the action has no parent

StaticdefineSchema

• defineSchema(): any

• Returns any

StaticmigrateData

• migrateData(source: any): any

• Parameters

  • source: any

  Returns any

StaticpruneData

• pruneData(data: object): void
• Internal

  Prune data

  Parameters

  • data: object

    Raw data (e.g. product of toObject())

  Returns void