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

    Interface DatabaseCreateOperation

    interface DatabaseCreateOperation {
        _createData?: Record<string, object>;
        _result?: (string | object)[];
        action: "create";
        broadcast: boolean;
        controlObject?: boolean;
        data: object[];
        documentName: string;
        dryRun?: boolean;
        extractedImages?: Record<string, string>;
        keepEmbeddedIds?: boolean;
        keepId?: boolean;
        modifiedTime?: number;
        noHook?: boolean;
        pack: string | null;
        parent?: Document<object, DocumentConstructionContext> | null;
        parentUuid?: string | null;
        render?: boolean;
        renderSheet?: boolean;
    }
    Index

    Properties

    _createData? _result? action broadcast controlObject? data documentName dryRun? extractedImages? keepEmbeddedIds? keepId? modifiedTime? noHook? pack parent? parentUuid? render? renderSheet?

    Properties

    Optional_createData

    _createData?: Record<string, object>

    Used internally by server-side backend

    Optional_result

    _result?: (string | object)[]

    Used internally by the server-side backend

    action: "create"

    The action of this database operation

    broadcast: boolean

    Whether the database operation is broadcast to other connected clients

    controlObject?: boolean

    Control the object of any created Documents

    data: object[]

    An array of data objects from which to create Documents

    documentName: string

    The Document name

    dryRun?: boolean

    Is the operation a dry run? If so, an empty result array is returned before the Documents are created.

    extractedImages?: Record<string, string>

    Base64 images extracted during server-side processing

    keepEmbeddedIds?: boolean

    Retain the _id values of embedded document data instead of generating new ids for each embedded document

    keepId?: boolean

    Retain the _id values of provided data instead of generating new ids

    modifiedTime?: number

    The timestamp when the operation was performed

    noHook?: boolean

    Block the dispatch of hooks related to this operation

    pack: string | null

    A compendium collection ID which contains the Documents

    parent?: Document<object, DocumentConstructionContext> | null

    A parent Document within which Documents are embedded

    parentUuid?: string | null

    A parent Document UUID provided when the parent instance is unavailable

    render?: boolean

    Re-render Applications whose display depends on the created Documents

    renderSheet?: boolean

    Render the sheet Application for any created Documents

    Settings

    Member Visibility

    On This Page

    Properties