logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityGameSaveSettings

    ScriptableObject configuration for the Unity GameSave service: how many slots it exposes, which backend it persists through, and which table/collection it uses.

    Inheritance
    object
    UnityGameSaveSettings
    Implements
    IGameSaveSettings
    IFoundationSettings
    Namespace: Serenity.GameSave.Infrastructure.Settings
    Assembly: Serenity.UnityGameSave.Infrastructure.dll
    Syntax
    public class UnityGameSaveSettings : ScriptableObject, IGameSaveSettings, IFoundationSettings

    Constructors

    UnityGameSaveSettings()

    Declaration
    public UnityGameSaveSettings()

    Fields

    Backend

    Declaration
    public UnityStructuredBackendDefinition Backend
    Field Value
    Type Description
    UnityStructuredBackendDefinition

    Backend selection: a shared, consumer-agnostic UnityStructuredBackendDefinition asset whose concrete type picks the store (create one under Assets ▸ Create ▸ Serenity ▸ Persistence ▸ Backends). Left unassigned, saves persist through the device's PlayerPrefs key-value store.

    Guid

    Declaration
    public string Guid
    Field Value
    Type Description
    string

    GUID for this settings asset.

    Id

    Declaration
    public string Id
    Field Value
    Type Description
    string

    Unique identifier for this settings asset.

    RouteCheckpointsIntoActiveSlot

    Declaration
    public bool RouteCheckpointsIntoActiveSlot
    Field Value
    Type Description
    bool

    When true (the default), UnityGameSaveInstaller registers a CheckpointsSection with the installed game-save service and exposes a ready-to-use ActiveSlotKeyValueStore via UnityGameSaveInstaller.GetCheckpointStore, so a project can route its Checkpoint aggregate's snapshots into the active save slot by handing that store to its own UnityCheckpointInstaller. Has zero effect on a project that never reads UnityGameSaveInstaller.GetCheckpointStore.

    SlotCount

    Declaration
    public int SlotCount
    Field Value
    Type Description
    int

    The fixed number of save slots the game exposes.

    TableOrCollectionName

    Declaration
    public string TableOrCollectionName
    Field Value
    Type Description
    string

    Table or collection name storing every save-slot row. Blank falls back to DefaultTableName.

    Implements

    IGameSaveSettings
    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved