Documentation
    Preparing search index...

    Interface MigrateSceneDocumentOptions

    Options for runSceneMigrations and migrateSceneDocument.

    interface MigrateSceneDocumentOptions {
        onWarning?: (warning: SceneMigrationWarning) => void;
        targetVersion?: number;
    }
    Index
    onWarning? targetVersion?
    onWarning?: (warning: SceneMigrationWarning) => void

    Called for each lossy-change report a step raises (§80).

    targetVersion?: number

    The version to upgrade to; SCENE_FORMAT_VERSION by default. A document already at that version is returned unchanged (validated, in migrateSceneDocument's case), and a newer one is refused — this build cannot know what a later format means, and §80 defines upgrades only.

    Settings
    Member Visibility

    On This Page
    Properties