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

    Function chatInput

    • A hook event that fires during handling of user chat input.

      Parameters

      • event: KeyboardEvent

        The triggering event.

      • options: { recordPending: boolean }

        Additional options to configure handling of chat input if default behavior is suppressed.

        • recordPending: boolean

          Record the user's keystroke as pending. If the hook returns false and otherwise prevents the keystroke appearing in the chat input, this option should also be set to false in order to prevent chat history from becoming out-of-sync.

      Returns boolean | void

      Returning false will prevent default chat input behavior.