Types

Summary: Browse the Save System types covered by this reference.

Browse the Save System types covered by this reference.

Options

TypeDescription
SaveOptionsSelect a slot for a save or load, or override protection and compression when saving.

Results and events

TypeDescription
SaveResultInspect the outcome of a save, delete, or other operation that returns a result.
LoadResult<T>Inspect loaded data, errors and backup recovery information.
SaveStatusIdentify the outcome of a save or load operation.
SlotInfoRead the save names and metadata reported for a slot.
SaveEventInfoIdentify the save and slot associated with a SaveService event.

Storage and recovery

TypeDescription
SaveServiceThe object behind API.Default. Subscribe to its events to react to saves and loads.
ISaveStorageImplement your own storage backend, for example to save to the cloud.
IBackupStorageAdd temporary and backup copies to a custom storage so loads can recover.
MemoryStorageKeep saves in memory for tests and temporary sessions.
StorageCandidateDescribe a stored copy or a read failure during backup recovery.
CandidateKindIdentify a stored copy used during recovery.

Versioning

TypeDescription
SaveVersionAttributeMark the data version of a serializable class or struct.
ISaveUpgradableUpdate loaded data in code after an older version is read.
ISaveUpgradeStepTransform the saved data of one version before it is read into the current type.
JsonUpgradeStep<T>Transform older saved JSON before reading it into the current data type.
On This Page