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

    Function createTokenMesh

    • A hook event that fires when the PrimarySpriteMesh for a Token is created. Listeners may choose the mesh class, its shader class, or both. A custom shader is used only when the Token does not utilize a dynamic Token ring. Return false from this hook to prevent other listeners from also claiming the Token. To cooperate with other listeners, assign a subclass of the current class instead.

      Parameters

      Returns boolean | void

      Return false to claim the mesh and prevent further listeners