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

    Interface DocumentCloneOptions

    interface DocumentCloneOptions {
        addSource?: boolean;
        discardInvalidEmbedded?: boolean;
        keepId?: boolean;
        save?: boolean;
    }
    Index

    Properties

    addSource? discardInvalidEmbedded? keepId? save?

    Properties

    addSource?: boolean

    Track the clone source. Default: false.

    discardInvalidEmbedded?: boolean

    Discard invalid embedded documents from the source. Not to be confused with dropInvalidEmbedded, which does not discard the invalid embedded documents but just prevents the document from being considered invalid and drops invalid embedded documents during preparation. Default: false.

    keepId?: boolean

    Keep the same ID of the original document. Default: false.

    save?: boolean

    Save the clone to the World database? Default: false.

    Settings

    Member Visibility

    On This Page

    Properties