Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class CombatPF

    Combat manager extension

    Hierarchy

    • Combat
      • CombatPF
    Index

    Constructors

    constructor

    Accessors

    initiative

    Methods

    _detectSkippedTurns _handleSkippedTurns _isForwardTime _onDelete _onEnter _onExit _onUpdate _preUpdate _processEndTurn _processInitiative _processTurnStart rollInitiative showInitiativeDialog

    Constructors

    • Parameters

      • Optionaldata: CreateData

        Initial data from which to construct the Combat

      • Optionalcontext: ConstructionContext

        Construction context options

      Returns CombatPF

    Accessors

    • get initiative(): undefined | number

      Get current initiative.

      Returns undefined | number

    Methods

    _detectSkippedTurns

    • _detectSkippedTurns(
          from?: { round: number; turn: number },
          context: object,
      ): Set<Combatant<"base" | ModuleSubType>>
      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<"base" | ModuleSubType>>

      • Set of combatant IDs whose turn was skipped

    _handleSkippedTurns

    • _handleSkippedTurns(
          skipped: Set<Combatant<"base" | ModuleSubType>>,
          context: object,
      ): 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 void

    _isForwardTime

    • _isForwardTime(changed: any, context: any): boolean

      Parameters

      • changed: any
      • context: any

      Returns boolean

    _onDelete

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

      Parameters

      • options: any
      • userId: any

      Returns void

    _onEnter

    • _onEnter(combatant: any): Promise<void>

      Parameters

      • combatant: any

      Returns Promise<void>

    _onExit

    • _onExit(combatant: any): Promise<void>

      Parameters

      • combatant: any

      Returns Promise<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>

    • 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>

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods