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

    Interface DocumentClassMetadata

    interface DocumentClassMetadata {
        baseTypeAllowed?: boolean;
        collection: string;
        compendiumIndexFields: string[];
        coreTypes: string[];
        embedded: Record<string, string>;
        hasTypeData: boolean;
        indexed: boolean;
        label: string;
        name: string;
        permissions: Record<
            "view"
            | "create"
            | "update"
            | "delete",

                | "INHERIT"
                | "NONE"
                | "LIMITED"
                | "OBSERVER"
                | "OWNER"
                | "PLAYER"
                | "TRUSTED"
                | "ASSISTANT"
                | "GAMEMASTER"
                | DocumentPermissionTest,
        >;
        preserveOnImport: string[];
        schemaVersion?: string;
    }
    Index

    Properties

    baseTypeAllowed?: boolean

    If the Document class has type data, can users normally create instances of the "base" type?

    collection: string
    compendiumIndexFields: string[]
    coreTypes: string[]
    embedded: Record<string, string>
    hasTypeData: boolean
    indexed: boolean
    label: string
    name: string
    permissions: Record<
        "view"
        | "create"
        | "update"
        | "delete",

            | "INHERIT"
            | "NONE"
            | "LIMITED"
            | "OBSERVER"
            | "OWNER"
            | "PLAYER"
            | "TRUSTED"
            | "ASSISTANT"
            | "GAMEMASTER"
            | DocumentPermissionTest,
    >
    preserveOnImport: string[]
    schemaVersion?: string