Interface SceneMigrationContext

What a migration step is told about the link it is performing (§80).

interface SceneMigrationContext {
    fromVersion: number;
    toVersion: number;
    warn(message: string): void;
}

Index

Properties

fromVersion toVersion

Methods

Properties

`Readonly`fromVersion

fromVersion: number

The version of the document handed to the step.

`Readonly`toVersion

toVersion: number

The version the step's result is stamped with — always fromVersion + 1.

Methods

warn

warn(message: string): void
Reports a lossy change (§80). Purely informational: the message reaches the caller through MigrateSceneDocumentOptions.onWarning and nothing in the engine reads it, so it should say what was dropped and what replaced it.
Parameters
- message: string
Returns void
- Defined in serialization/src/migration.ts:72