• Preparing search index...
  • The search index is not available
Foundry Virtual Tabletop - API Documentation - Version 13
  • Foundry Virtual Tabletop - API Documentation - Version 13
  • hookEvents
  • combatTurnChange

Function combatTurnChange

  • combatTurnChange(
        combat: documents.Combat,
        prior: CombatHistoryData,
        current: CombatHistoryData,
    ): void

    A hook event which fires when the turn order of a Combat encounter is progressed. This event fires on all clients after the database update has occurred for the Combat.

    Parameters

    • combat: documents.Combat

      The Combat encounter for which the turn order has changed

    • prior: CombatHistoryData

      The prior turn state

    • current: CombatHistoryData

      The new turn state

    Returns void

Settings

Member Visibility
Foundry Virtual Tabletop - API Documentation - Version 13
  • Loading...

Public API documentation for Foundry Virtual Tabletop version 13.346 Stable. © 2025 Foundry Gaming LLC. All Rights Reserved.