Skip to content

Save — Sample Scenes

The Save Scenes folder contains runnable scenes that demonstrate the save coordinator using real participants and real payloads.

These scenes are designed to:

  • Teach the IRevSaveParticipant contract
  • Show the actual payload the coordinator produces
  • Demonstrate how failures and unknown data are reported

They are not production systems and can be safely removed from builds.

Folder Layout

Samples/
  Systems/
    Save/
      Scenes/
        00_Save_Quickstart/     // The coordinator contract, no system dependencies

Scene Samples

Scene Demonstrates Notes
00_Save_Quickstart Capture, restore, failure isolation, carry-over No system dependencies — participants are defined in the panel itself

Usage

Open the scene from:

Assets/RevFramework/Samples/Systems/Save/Scenes/

The scene is:

  • Self-contained — a camera, a light, and the teaching panel
  • Focused on the contract, not on any one system's save format
  • Designed to be run in Play Mode

Teachable Panels

Teachable panels are provided as debug and learning tools.

  • They are safe to run at runtime — no UnityEditor dependencies
  • They interact only through the public API
  • They can be dropped into your own scenes for debugging and inspection

However:

  • They are not designed for shipping builds
  • They are not optimised UI
  • They are not a supported gameplay layer

The Save panel gates on REV_TEACHABLES, so it compiles out when Teaching/ is removed before a player build. If you remove Teaching/ while this scene is open, the panel becomes a missing script — that is expected, not a fault.

What These Samples Show

  • How the coordinator composes participants into one versioned payload
  • That the coordinator never parses what a participant writes — it labels a string and hands it back later
  • How a participant that throws is isolated and reported, while the others still complete
  • How a section no participant claims is preserved rather than discarded
  • Why your own game state is not second-class: the demo participants are ordinary implementations written in the panel's own file

Important Notes

  • These scenes use real runtime behaviour, not simplified demos
  • UI is for demonstration only and is not part of the runtime system
  • Nothing here writes a file — the coordinator does no file I/O by design
  • Per-system participants live in Integrations/Save/ and work exactly the same way
  • Save — Guarantees Matrix
  • Save — Public API
  • Core — IRevSaveParticipant
  • Teachable Panels — guided diagnostics and learning scenes

These samples are runnable references of actual behaviour.

Use them to learn the contract — then write participants for your own state.