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

    Function preMoveToken

    • A hook event that fires for every Token document that is about to me moved before the conclusion of an update workflow. This hook only fires for the client who is initiating the update request. The waypoints of the movement are final and cannot be changed. The movement can only be rejected entirely by explicitly returning false. The ONLY writable properties of movement are autoRotate and showRuler.

      Parameters

      Returns boolean | void

      If false, the movement is prevented