Class ActionUse

constructor

• new ActionUse(shared?): ActionUse

• Parameters

  • Optionalshared: Partial<SharedActionData> = {}

    The shared context for this action use

  Returns ActionUse

action

actor

formData

item

shared

token

_filterAmmo

• _filterAmmo(item, ammoCost?): boolean
• Internal

  Determine if item is valid for use as ammo.

  Parameters

  • item: Item

    Item to filter
  • ammoCost: number = 1

    Ammo usage per attack

  Returns boolean

_getConditionalParts

• _getConditionalParts(atk, index?): object

• Determines conditional parts used in a specific attack.

  Parameters

  • atk: object

    The attack used.
  • Optionalindex: number

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

  Returns object

  The conditional parts used.

_getDefenseDCParts

• _getDefenseDCParts(attack): string[]

• Parameters

  • attack: any

  Returns string[]

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.

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.

alterRollData

• alterRollData(formData?): Promise<any>

• Alters roll (and shared) data based on user input during the attack's dialog.

  Parameters

  • formData: object = {}

    The attack dialog's form data

  Returns Promise<any>

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 ERR_REQUIREMENT constants.

checkRequirements

• checkRequirements(): Promise<number>

• Returns Promise<number>

  • 0 when successful, otherwise one of the ERR_REQUIREMENT constants.

createAttackDialog

• createAttackDialog(): Promise<null | ItemAttack_Dialog_Result>

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

  Returns Promise<null | ItemAttack_Dialog_Result>

enrichNotes

• enrichNotes(notes, title, css): string

• Enrich notes

  Parameters

  • notes: string[]

    Notes
  • title: string

    Notes section title
  • css: string

    CSS selectors

  Returns string

  • Enriched HTML as text

executeScriptCalls

• executeScriptCalls(category?): Promise<void>

• Executes the item's script calls.

  Parameters

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

    Script call category

  Returns Promise<void>

generateAttacks

• generateAttacks(forceFullAttack?): ItemAttack_AttackData[] | Promise<ItemAttack_AttackData[]>

• Generates attacks for an item's action.

  Parameters

  • OptionalforceFullAttack: boolean = false

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

  Returns ItemAttack_AttackData[] | Promise<ItemAttack_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

getDefenseDC

• getDefenseDC(attack): RollPF

• Armor as DR defense DC determination.

  Parameters

  • attack: any

  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<ChatMessage | SharedActionData | {
      descriptionOnly: boolean;
  }>

• Posts the attack's chat card.

  Returns Promise<ChatMessage | SharedActionData | {
      descriptionOnly: boolean;
  }>

prepareChargeCost

• prepareChargeCost(): Promise<void>

• Returns Promise<void>

process

• process(options?): Promise<void | ActionUse | SharedActionData>

• Process everything

  Parameters

  • Optionaloptions: {
        skipDialog: undefined | boolean;
    } = {}

    Additional options

    • skipDialog: undefined | boolean

      Skip dialog

  Returns Promise<void | ActionUse | SharedActionData>

promptMeasureTemplate

• promptMeasureTemplate(): Promise<Attack_MeasureTemplateResult>

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

  Returns Promise<Attack_MeasureTemplateResult>

  Whether an area was selected.

subtractAmmo

• subtractAmmo(value?): 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>

updateAmmoUsage

• updateAmmoUsage(): void

• Update remaining ammo in ChatAttacks

  Returns void