Class CombatPF

Hierarchy

  • Combat
    • CombatPF

Constructors

constructor

Methods

_expireEffectsOnUpdate _onUpdate rollInitiative showInitiativeDialog

Constructors

constructor

  • Parameters

    • Optional data: any

      Initial data provided to construct the Combat document

    • Optional context: any

    Returns CombatPF

Methods

_expireEffectsOnUpdate

  • _expireEffectsOnUpdate(data, options, userId): Promise<void>

  • Expire active effects & buffs.

    Parameters

    • data: object

      Update data

    • options: any

      Context options

    • userId: string

      Triggering user ID

    Returns Promise<void>

_onUpdate

  • _onUpdate(data, options, userId): void

  • Parameters

    • data: object

      Update data

    • options: any

      Context options

    • userId: string

      Triggering user ID

    Returns void

rollInitiative

  • Parameters

    • ids: string[]

      Combatant IDs to roll initiative for.

    • Optional options: {
          bonus: undefined | string;
          rollMode: undefined | string;
          skipDialog: undefined | boolean;
      } = {}

      Additional options

      • bonus: undefined | string

        Formula for bonus to initiative

      • rollMode: undefined | string

        Roll mode override

      • skipDialog: undefined | boolean

        Skip roll dialog

    Returns Promise<CombatPF | {
        combat: CombatPF;
        messages: any;
    }>

Static showInitiativeDialog

  • Parameters

    • options: {
          bonus: string;
          formula: string;
          name: string;
      } = {}
      • bonus: string

        Bonus formula override

      • formula: string

        Formula override

      • name: string

        Name of the roller

    Returns object

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc