Class CombatPF

Combat manager extension

Hierarchy

  • Combat
    • CombatPF

Constructors

constructor

Accessors

initiative

Methods

_detectSkippedTurns _handleSkippedTurns _isForwardTime _onDelete _onUpdate _preUpdate _processEndTurn _processInitiative _processTurnStart rollInitiative showInitiativeDialog

Constructors

constructor

  • new CombatPF(data?: any, context?: any): CombatPF

  • Parameters

    • Optionaldata: any

      Initial data provided to construct the Combat document

    • Optionalcontext: any

    Returns CombatPF

Accessors

initiative

Methods

_detectSkippedTurns

  • _detectSkippedTurns(
        from?: { round: number; turn: number },
        context: object,
    ): Set<Combatant>
  • Internal

    Determine skipped turns

    Parameters

    • from: { round: number; turn: number } = {}

      Origin combat time frame

      • round: number

        From round

      • turn: number

        From turn

    • context: object

      Update context

    Returns Set<Combatant>

    • Set of combatant IDs whose turn was skipped

_handleSkippedTurns

  • _handleSkippedTurns(skipped: Set<Combatant>, context: object): void
  • Internal

    Handle effects of skipped turns.

    Parameters

    • skipped: Set<Combatant>

      Combatant IDs of those whose turn was skipped.

    • context: object

      Combat update context

    Returns void

_isForwardTime

_onDelete

  • _onDelete(options: any, userId: any): void

  • Parameters

    • options: any
    • userId: any

    Returns void

_onUpdate

  • _onUpdate(changed: object, context: options, userId: string): void

  • Parameters

    • changed: object

      Update data

    • context: options

      Context options

    • userId: string

      Triggering user ID

    Returns void

_preUpdate

  • _preUpdate(changed: object, context: object, user: User): Promise<void>
  • Internal

    Parameters

    • changed: object

      Changed data

    • context: object

      Context

    • user: User

      Triggering user

    Returns Promise<void>

_processEndTurn

  • _processEndTurn(
        originTime?: { round: number; turn: number },
        context?: object,
    ): Promise<void>
  • Internal

    Handle end of turn

    Parameters

    • originTime: { round: number; turn: number } = {}

      Origin time frame

      • round: number

        Round on which the turn ended

      • turn: number

        Turn that ended

    • context: object = {}

      Context

    Returns Promise<void>

_processInitiative

  • _processInitiative(context?: object): void
  • Internal

    Process end of durations based on initiative.

    Only active GM processes these to avoid conflicts and logic bloat.

    Parameters

    • Optionalcontext: object = {}

      Update context

    Returns void

_processTurnStart

  • _processTurnStart(changed: object, context: options): Promise<void>

  • Process current combatant: expire active effects & buffs.

    Parameters

    • changed: object

      Update data

    • context: options

      Context options

    Returns Promise<void>

rollInitiative

  • rollInitiative(
        ids: string[],
        options?: {
            bonus?: string;
            d20?: string;
            formula?: string;
            messageOptions?: object;
            rollMode?: string;
            skipDialog?: boolean;
            updateTurn?: boolean;
        },
    ): Promise<CombatPF>

  • Parameters

    • ids: string[]

      Combatant IDs to roll initiative for.

    • Optionaloptions: {
          bonus?: string;
          d20?: string;
          formula?: string;
          messageOptions?: object;
          rollMode?: string;
          skipDialog?: boolean;
          updateTurn?: boolean;
      } = {}

      Additional options

      • Optionalbonus?: string

        Formula for bonus to initiative

      • Optionald20?: string

        d20 override. Passed to Combatant.getInitiativeRoll

      • Optionalformula?: string

        Formula override. Passed to Combatant.getInitiativeRoll

      • OptionalmessageOptions?: object

        Additional data for created chat message

      • OptionalrollMode?: string

        Roll mode override.

      • OptionalskipDialog?: boolean

        Skip roll dialog Synced with Foundry v12.331

      • OptionalupdateTurn?: boolean

        Adjust current turn if the new init would shift it

    Returns Promise<CombatPF>

StaticshowInitiativeDialog

  • showInitiativeDialog(
        options?: {
            bonus?: string;
            check?: boolean;
            d20?: string;
            name: string;
        },
    ): object

  • Parameters

    • Optionaloptions: { bonus?: string; check?: boolean; d20?: string; name: string } = {}

      Additional options

      • Optionalbonus?: string

        Bonus formula override

      • Optionalcheck?: boolean

        If false, no base d20 check is provided

      • Optionald20?: string

        Formula override

      • name: string

        Name of the roller

    Returns object

    • Result

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods