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

    Interface DataModelUpdateOptions

    interface DataModelUpdateOptions {
        clean?: boolean | Omit<DataModelCleaningOptions, "partial">;
        dryRun?: boolean;
        fallback?: boolean;
        recursive?: boolean;
        restoreDelta?: boolean;
        user?: any;
    }
    Index

    Properties

    clean?: boolean | Omit<DataModelCleaningOptions, "partial">

    Configuration of data cleaning steps applied to user input data. This can be explicitly passed as false to skip preprocessing when using data that is known to already be fully cleaned.

    dryRun?: boolean

    Do not finally apply the change, but instead simulate the update workflow

    fallback?: boolean

    Allow automatic fallback to a valid initial value if the value provided for a field in the model is invalid.

    recursive?: boolean

    Apply changes to inner objects recursively rather than replacing the top-level object. This is automatically re-interpreted as every key of the update being defined as a ForcedReplacement operator.

    restoreDelta?: boolean

    An advanced option used specifically and internally by the ActorDelta model

    user?: any

    Used only by the server to understand update context