Pulse Save
Pulse Save is a runtime Unreal Engine plugin that saves and loads objects through save models (UPulseSaveModel) and a save manager (UPulseSaveManager). A game saves and loads through one API, the save game (UPulseSaveGameSubsystem): its functions in C++ and its async nodes in Blueprint. With PulseGameplay the frontend menus call it through PulseGameplaySaveBridge.
The core idea is MVVM-inspired: instead of serializing your live gameplay objects directly, you save a small, explicit model that represents exactly the data you want persisted. See Core concepts for why this matters.
Documentation map
- Getting started
- Core concepts
- Storage: where the slots are kept (files on this machine by default, a cloud or a storage of your game), byte layers (compression, check sum, encryption) and the mirror that keeps a cloud in step with this machine
- Save manager workflow
- Implementing saveable objects
- Customize: what a game can swap or extend, with its default and where to set it
- Models and collectors
- Model factories and settings
- Save migration
- Reports
- Save and load menus: slot list with preview pictures, saving, loading, overwriting, a handler for your game
- Console
- Blueprint and C++ API reference
At a glance
| Step | In this plugin |
|---|---|
| Set Up | 0 required, 4 optional |
| Create | Save Model, Save Model Migration, Save Collector, Save UI Handler; starter content |
| Test | Example map LV_PulseSave_Example |
| Check | Pulse window, Check All, -run=PulseCheck |
In more detail:
- Implement
UPulseSaveInterfaceon every object you want to save (only override the events you need), orIPulseByteSaveableof Pulse Foundation for an object that saves itself as bytes. - Save and load with the save game: Save Game (Async), Load Game (Async) and Delete Slot (Async) in Blueprint,
SaveGame,LoadGameandDeleteSlotin C++. It needs no setup: its manager and collectors come from Project Settings > Pulse > Save > Game, and its slots are files on this machine (see Storage). - A call that reads or writes a storage or waits for objects answers once with an
FPulseResult, never inside the call. A call that only changes memory answers at once. - One object on its own (an actor spawned while the game runs): Save Object (Async) and Load Object (Async).
- To change what is saved, where and how, see Customize. Every part works with its default.
Modules
| Module | Type | Contents |
|---|---|---|
PulseSave | Runtime | Save manager, models, collectors, storages, the save game, session and profiles |
PulseSaveMVVM | Runtime | View models of the slot list and its slots |
PulseSaveUI | Runtime | Save and load menus (CommonUI) |
PulseSaveDebugger | Developer tool | The Save page of the Pulse Debugger |
PulseSaveEditor | Editor | The Pulse workflow and the migration menu |