logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityCheckpointStore

    Unity implementation of ICheckpointStore backed by an IKeyValueStore.

    Inheritance
    object
    UnityCheckpointStore
    Implements
    ICheckpointStore
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.Checkpoint.Infrastructure.Stores
    Assembly: Serenity.UnityCheckpoint.Infrastructure.dll
    Syntax
    public class UnityCheckpointStore : ICheckpointStore
    Remarks

    Serializes checkpoint data as JSON (via UnityEngine.JsonUtility) and stores the resulting UTF-8 bytes through the injected IKeyValueStore. Suitable for lightweight local checkpoint storage.

    Constructors

    UnityCheckpointStore(IKeyValueStore)

    Initializes a new instance of the UnityCheckpointStore class.

    Declaration
    public UnityCheckpointStore(IKeyValueStore store)
    Parameters
    Type Name Description
    IKeyValueStore store

    The key-value store used for persistence.

    Exceptions
    Type Condition
    ArgumentNullException

    Thrown when store is null.

    Methods

    Delete(CheckpointSlot)

    Declaration
    public void Delete(CheckpointSlot slot)
    Parameters
    Type Name Description
    CheckpointSlot slot

    Exists(CheckpointSlot)

    Declaration
    public bool Exists(CheckpointSlot slot)
    Parameters
    Type Name Description
    CheckpointSlot slot
    Returns
    Type Description
    bool

    QueryAll()

    Declaration
    public CheckpointMetadata[] QueryAll()
    Returns
    Type Description
    CheckpointMetadata[]

    Save(CheckpointSlot, CheckpointSnapshot)

    Declaration
    public void Save(CheckpointSlot slot, CheckpointSnapshot snapshot)
    Parameters
    Type Name Description
    CheckpointSlot slot
    CheckpointSnapshot snapshot

    TryLoad(CheckpointSlot, out CheckpointSnapshot)

    Declaration
    public bool TryLoad(CheckpointSlot slot, out CheckpointSnapshot snapshot)
    Parameters
    Type Name Description
    CheckpointSlot slot
    CheckpointSnapshot snapshot
    Returns
    Type Description
    bool

    Implements

    ICheckpointStore
    In this article
    © 2026 Serenity. All Rights Reserved