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

    Interface FromCompendiumOptions

    interface FromCompendiumOptions {
        clearFolder?: boolean;
        clearOwnership?: boolean;
        clearSort?: boolean;
        clearState?: boolean;
        dialog?: boolean;
        keepId?: boolean;
    }
    Index

    Properties

    clearFolder? clearOwnership? clearSort? clearState? dialog? keepId?

    Properties

    clearFolder?: boolean

    Clear the currently assigned folder.

    clearOwnership?: boolean

    Clear Document ownership (recursive).

    clearSort?: boolean

    Clear the current sort order.

    clearState?: boolean

    Clear fields which store Document state.

    dialog?: boolean

    In cases where necessary, prompt the user with a confirmation dialog

    keepId?: boolean

    Retain the Document ID from the source Compendium.

    Settings

    Member Visibility

    On This Page

    Properties