Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Function pauseGame

    • A hook event that fires when the game is paused or un-paused.

      Parameters

      • paused: boolean

        Is the game now paused (true) or un-paused (false)

      • options: { broadcast?: boolean; userId?: string }

        Options which modified the pause game request

        • Optionalbroadcast?: boolean

          Was the pause request broadcast to other clients?

        • OptionaluserId?: string

          The ID of the User who initiated the pause request

      Returns void