Class CombatPF

Combat manager extension

Hierarchy

Combat
- CombatPF

Index

Methods

_detectSkippedTurns _handleSkippedTurns _isForwardTime _onNewTurn _processEndTurn _processInitiative _processTurnStart showInitiativeDialog

Methods

_detectSkippedTurns

_detectSkippedTurns(
from?: { round: number; turn: number },
context: object,
): Set<Combatant<"base" | ModuleSubType>>
Internal
Determine skipped turns

Specifically combatants whose end of turn event may have not fired, which includes combatant the skip started from.
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<"base" | ModuleSubType>>
- Set of combatant IDs whose turn was skipped
- Defined in module/documents/combat.mjs:328

_handleSkippedTurns

_handleSkippedTurns(
skipped: Set<Combatant<"base" | ModuleSubType>>,
context: object,
): Promise<void>
Internal
Handle effects of skipped turns.
Parameters
- skipped: Set<Combatant<"base" | ModuleSubType>>
  Combatant IDs of those whose turn was skipped.
- context: object
  Combat update context
Returns Promise<void>
- Defined in module/documents/combat.mjs:359

_isForwardTime

_isForwardTime(changed: object, context: object): boolean
Internal
Is turn cycling forward?
Parameters
- changed: object
  Combat update data
- context: object
  Combat update context
Returns boolean
- Defined in module/documents/combat.mjs:297

_onNewTurn

_onNewTurn(changed: object, context: object, userId: string): Promise<void>
Internal
New turn handling.
Parameters
- changed: object
  Changed data
- context: object
  Context
- userId: string
  Triggering user ID
Returns Promise<void>
- Defined in module/documents/combat.mjs:273

_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>
- Defined in module/documents/combat.mjs:396

_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
- Defined in module/documents/combat.mjs:462

_processTurnStart

_processTurnStart(changed: object, context: options): Promise<void>
Internal
Process current combatant: expire active effects & buffs.
Parameters
- changed: object
  Update data
- context: options
  Context options
Returns Promise<void>
- Defined in module/documents/combat.mjs:425

`Static`showInitiativeDialog

showInitiativeDialog(
    options?: {
        bonus?: string;
        check?: boolean;
        d20?: string;
        name: string;
    },
): Promise<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 Promise<object>
- Result
- Defined in module/documents/combat.mjs:196