• Preparing search index...
  • The search index is not available
Foundry Virtual Tabletop - API Documentation - Version 13
  • Foundry Virtual Tabletop - API Documentation - Version 13
  • foundry
  • utils
  • fromUuid

Function fromUuid

  • fromUuid(
        uuid: string,
        options?: {
            invalid?: boolean;
            relative?: Document<object, DocumentConstructionContext>;
        },
    ): Promise<null | Document<object, DocumentConstructionContext>>

    Retrieve a Document by its Universally Unique Identifier (uuid).

    Parameters

    • uuid: string

      The uuid of the Document to retrieve.

    • Optionaloptions: { invalid?: boolean; relative?: Document<object, DocumentConstructionContext> } = {}

      Options to configure how a UUID is resolved.

      • Optionalinvalid?: boolean

        Allow retrieving an invalid Document.

      • Optionalrelative?: Document<object, DocumentConstructionContext>

        A Document to resolve relative UUIDs against.

    Returns Promise<null | Document<object, DocumentConstructionContext>>

    Returns the Document if it could be found, otherwise null.

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.