Skip to main content

View as Markdown · AI documentation index

Interface: SaveSchema

Defined in: types.ts:47

A comparable description of one version's save shape.

Properties​

capturedFrom​

capturedFrom: CaptureSource

Defined in: types.ts:53

See CaptureSource.


entities​

entities: string[]

Defined in: types.ts:55

Sorted ids of every game entity, excluding engine-owned system state.


gameVersion​

gameVersion: string

Defined in: types.ts:51

Game version this shape belongs to.


passages​

passages: string[] | null

Defined in: types.ts:64

Sorted ids of every registered passage, or null when the capture source could not know them.

Remarks​

Only a code capture knows the passage registry. Saves and dumps record just the one id the player was on, so passage checks are skipped for them.


paths​

paths: Record<string, SchemaKind>

Defined in: types.ts:66

Dotted path to kind, for every node in the state tree, sorted by path.


schemaVersion​

schemaVersion: number

Defined in: types.ts:49

See SCHEMA_VERSION.