Class ActionUse

constructor

• new ActionUse(shared: Partial<SharedActionData>): ActionUse

  Parameters

  • shared: Partial<SharedActionData>

    The shared context for this action use

  Returns ActionUse

action

actor

item

shared

token

StaticTEMPLATES

rollData

• get rollData(): object

  Roll Data

  Returns object

_addDeprecations

• _addDeprecations(): void
  Internal

  Returns void

_filterTargets

• _filterTargets(targets: Set<TokenPF>): Set<TokenPF>

  Filter targets based on its combatant state and on the action targets properties. Used by getTargets.

  Parameters

  • targets: Set<TokenPF>

    List of targets to filter.

  Returns Set<TokenPF>

  Filtered targets.

_getConditionalParts

• _getConditionalParts(atk: AttackInstance, index?: number): ConditionalParts

  Determines conditional parts used in a specific attack.

  Parameters

  • atk: AttackInstance

    The attack used.

  • Optionalindex: number

    The index of the attack, in order of enabled attacks.

  Returns ConditionalParts

  The conditional parts used.

addAttacks

• addAttacks(): Promise<void>

  Adds ChatAttack entries to an attack's shared context.

  Returns Promise<void>

addCombatPropertyLabels

• addCombatPropertyLabels(): string[]

  Adds combat property labels to an attack's chat card.

  Returns string[]

  The resulting property labels.

  Todo

  Object format

addDamage

• addDamage(): Promise<void>

  Adds a ChatAttack entry for damage to an attack's shared context.

  Returns Promise<void>

addEffectNotes

• addEffectNotes(): Promise<void>

  Add effect notes for each individual attack.

  Returns Promise<void>

addEmptyAttack

• addEmptyAttack(): Promise<void>

  Returns Promise<void>

addFootnotes

• addFootnotes(): Promise<void>

  Returns Promise<void>

addGenericPropertyLabels

• addGenericPropertyLabels(): string[]

  Adds generic property labels to an attack's chat card.

  Returns string[]

  The resulting property labels.

  Todo

  Object format

applyConfig

• applyConfig(): void

  Apply configuration from form data

  Returns void

autoSelectAmmo

• autoSelectAmmo(): Promise<void>

  Returns Promise<void>

checkAttackRequirements

• checkAttackRequirements(): number | Promise<number>

  Checks all requirements to make the attack. This is after the attack dialog's data has been parsed.

  Returns number | Promise<number>

  0 if successful, otherwise one of the pf1.const.ACTION_ERRORS constants.

checkRequirements

• checkRequirements(): Promise<number>

  Returns Promise<number>

  • 0 when successful, otherwise one of the pf1.const.ACTION_ERRORS constants.

enrichEffectNotes

• enrichEffectNotes(): Promise<void>

  Enrich effect notes.

  Returns Promise<void>

enrichNotes

• enrichNotes(notes: string[], title: string, css: string): Promise<string>

  Enrich notes

  Parameters

  • notes: string[]

    Notes

  • title: string

    Notes section title

  • css: string

    CSS selectors

  Returns Promise<string>

  • Enriched HTML as text

executeScriptCalls

• executeScriptCalls(category?: "use" | "postUse"): Promise<void>

  Executes the item's script calls.

  Parameters

  • Optionalcategory: "use" | "postUse" = "use"

    Script call category

  Returns Promise<void>

generateAttacks

• generateAttacks(forceFullAttack?: boolean): components.AttackData[]

  Generates attacks for an item's action.

  Parameters

  • OptionalforceFullAttack: boolean = false

    Generate full attack data, e.g. as base data for an ActionDialog

  Returns components.AttackData[]

  The generated default attacks.

generateChatAttacks

• generateChatAttacks(): Promise<void>

  Generates ChatAttack entries based off the attack type.

  Returns Promise<void>

generateChatMetadata

• generateChatMetadata(): object

  Generates metadata for this attack for the chat card to store.

  Returns object

  The resulting metadata object.

getAmmo

• getAmmo(): AttackAmmo[]

  Fetch valid ammo items from actor.

  Returns AttackAmmo[]

  • Available ammo options

getDefenseDC

• getDefenseDC(attack: D20RollPF): RollPF

  Armor as DR defense DC determination.

  Parameters

  • attack: D20RollPF

    Attack roll

  Returns RollPF

  • Defense DC

  Remarks

  • Does not account for critical feats.
  • Does not account for size difference between target and attacker.

getMessageData

• getMessageData(): Promise<void>

  Adds an attack's chat card data to the shared object.

  Returns Promise<void>

getRollData

• getRollData(): Promise<object>

  Returns Promise<object>

  The roll data object for this attack.

getTargets

• getTargets(): Promise<void>

  Collect valid targets.

  Returns Promise<void>

handleConditionals

• handleConditionals(): Promise<void>

  Returns Promise<void>

handleDiceSoNice

• handleDiceSoNice(): Promise<void>

  Handles Dice So Nice integration.

  Returns Promise<void>

postMessage

• postMessage(): Promise<any>

  Posts the attack's chat card.

  Returns Promise<any>

prepareChargeCost

• prepareChargeCost(): Promise<void>

  Returns Promise<void>

process

• process(
      options?: { skipDialog?: boolean },
  ): Promise<void | ActionUse | SharedActionData>

  Process everything

  Parameters

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

    Additional options

    • OptionalskipDialog?: boolean

      Skip dialog

  Returns Promise<void | ActionUse | SharedActionData>

promptMeasureTemplate

• promptMeasureTemplate(): Promise<false | MeasureTemplateResult | null>

  Prompts the user for an area, based on the attack's measure template.

  Returns Promise<false | MeasureTemplateResult | null>

  Whether an area was selected, false if template placement is skipped, null if cancelled.

promptMeasureTemplates

• promptMeasureTemplates(): Promise<boolean>

  Prompts the user for areas, based on the attack's measure templates.

  Returns Promise<boolean>

  True if the placement process was skipped or successful, false if cancelled.

promptUse

• promptUse(): Promise<ActionFormData | null>

  Creates and renders an attack roll dialog, and returns a result.

  Returns Promise<ActionFormData | null>

  • Attack dialog result or null if cancelled.

subtractAmmo

• subtractAmmo(value?: number): Promise<any>

  Subtracts ammo for this attack, updating relevant items with new quantities.

  Parameters

  • Optionalvalue: number = 1

    How much ammo to subtract.

  Returns Promise<any>

  • Promise that resolves once ammo update is complete.

updateAmmoUsage

• updateAmmoUsage(): void

  Update remaining ammo in ChatAttacks

  Returns void