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

Function moveToken

  • moveToken(
        document: TokenDocument,
        movement: DeepReadonly<TokenMovementOperation>,
        operation: Partial<DatabaseUpdateOperation>,
        user: documents.User,
    ): void

    A hook event that fires for every Token document that was moved after conclusion of an update workflow. This hook fires for all connected clients after the update has been processed.

    Parameters

    • document: TokenDocument

      The existing TokenDocument which was updated

    • movement: DeepReadonly<TokenMovementOperation>

      The movement of the Token

    • operation: Partial<DatabaseUpdateOperation>

      The update operation that contains the movement

    • user: documents.User

      The User that requested the update operation

    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.