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

    Function preDeleteDocument

    • A hook event that fires for every Document type before execution of a deletion workflow. Substitute the Document name in the hook event to target a specific Document type, for example "preDeleteActor". This hook only fires for the client who is initiating the update request.

      The hook provides the Document instance which is requested for deletion. Hooked functions may prevent the workflow entirely by explicitly returning false.

      Parameters

      Returns boolean | void

      Explicitly return false to prevent deletion of this Document