Class CombatPF

Hierarchy

  • Combat
    • CombatPF

Constructors

constructor

Accessors

initiative

Methods

_detectSkippedTurns _handleSkippedTurns _isForwardTime _onDelete _onNewTurn _onUpdate _preUpdate _processEndTurn _processInitiative _processTurnStart rollInitiative showInitiativeDialog

Constructors

constructor

  • Parameters

    • Optional data: any

      Initial data provided to construct the Combat document

    • Optional context: any

    Returns CombatPF

Accessors

initiative

Methods

_detectSkippedTurns

  • _detectSkippedTurns(from?, context): Set<Combatant>
  • Internal

    Determine skipped turns

    Parameters

    • from: {
          round: number;
          turn: number;
      } = {}
      • 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, context): 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

Private _onNewTurn

  • _onNewTurn(changed, context, userId): Promise<void>
  • Private

    New turn handling.

    Parameters

    • changed: any
    • context: any
    • userId: any

    Returns Promise<void>

_onUpdate

  • _onUpdate(changed, context, userId): void

  • Parameters

    • changed: any
    • context: any
    • userId: string

      Triggering user ID

    Returns void

_preUpdate

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

    Parameters

    • changed: object
    • context: object
    • user: User

    Returns Promise<void>

_processEndTurn

  • _processEndTurn(originTime?, context?): Promise<void>
  • Internal

    Handle end of turn

    Parameters

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

        Round on which the turn ended

      • turn: number

        Turn that ended

    • context: object = {}

    Returns Promise<void>

_processInitiative

  • _processInitiative(context?): void
  • Internal

    Process end of durations based on initiative.

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

    Parameters

    • Optional context: object = {}

      Update context

    Returns void

_processTurnStart

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

  • Process current combatant: expire active effects & buffs.

    Parameters

    • changed: object

      Update data

    • context: options

      Context options

    • userId: string

      Triggering user ID

    Returns Promise<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;
          d20: string;
          name: string;
      } = {}
      • bonus: string

        Bonus formula override

      • d20: string

        Formula override

      • name: string

        Name of the roller

    Returns object

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc