Runtime Studio API

Save API

Create, load, and restore Runtime Studio saves from game code.

Save API

Game code can create and load saves with RuntimeStudioSaveApi:

csharp
using Fullscreen.RuntimeStudio.Runtime;

var path = RuntimeStudioSaveApi.Save("checkpoint");
var loaded = RuntimeStudioSaveApi.Load(path);
var latestLoaded = RuntimeStudioSaveApi.LoadLatest();

RuntimeStudioSaveApi.Save returns the saved file path. Load and LoadLatest return true when the save was found and restored. For large saves, use LoadRoutine as a coroutine so the restore work can be spread across frames:

csharp
StartCoroutine(RuntimeStudioSaveApi.LoadRoutine(
    path,
    completed: success => Debug.Log($"Save loaded: {success}")
));