Skip to content

SaveManager_ClassAPI

Jump to bottom
CG-Tespy edited this page Apr 26, 2020 · 2 revisions

The class that mainly handles saving, loading, and erasing save data.

Inherits from: MonoBehaviour
Namespace: CGTUnity.Fungus.SaveSystem

Table of Contents

Inspector Fields

protected SaveWriter saveWriter

  • Reference to the SaveWriter ScriptableObject the manager uses to write save data.
protected SaveReader saveReader
  • Reference to the SaveWriter ScriptableObject the manager uses to read save data from disk as GameSaveData objects.
protected GameLoader gameLoader
  • The GameLoader in the scene.
protected GameSaver gameSaver
  • The GameSaver in the scene.
protected bool warnOnUnallowedSave
  • Whether or not this should display warnings when asked to add saves when it isn't allowed to.
bool savingEnabled
  • Whether or not this SaveManager is allowed to write or register new save data.
protected float awakeSaveDelay
  • SaveManagers on Awake disallow themselves from doing any save-writing/registration. This decides how long they do so, before reallowing themselves (assuming savingEnabled was equal to true at the time).

Public Properties

virtual bool SavingEnabled { get; set; }

virtual float AwakeSaveDelay { get; set; }

virtual SaveReader SaveReader { get; }

virtual string SaveDirectory { get; }

  • Where on disk the save data gets written to.

Public Methods

Save-Writing

virtual bool AddSave(SaveSlot slot, bool writeToDisk = true)

  • Creates and registers new save data with the passed slot's number, then writing it to disk if set to do so. Save replacement may happen depending on the aforementioned number.
virtual bool AddSave(int slotNumber, bool writeToDisk = true)
  • Creates and registers new save data with the passed slot number, then writing it to disk if set to do so. Save replacement may happen depending on the aforementioned number.
virtual bool AddSave(GameSaveData newSave, bool writeToDisk = true)
  • Adds a save to this manager. If the passed save shares a number with one it's already keeping track of, the old one is replaced with the new one. In which case, the new one will be written to disk regardless of the second argument.

Save-Loading

virtual bool LoadSave(int slotNumber)

  • Loads a save with the passed slot number. Returns true if successful, false otherwise.
virtual bool LoadSave(SaveSlot slot)
  • Loads the save data assigned to the passed slot. Returns true if successful, false otherwise.
virtual bool LoadSave(GameSaveData saveData)
  • Loads the passed GameSaveData, regardless of whether this manager is keeping track of it or not.

Save-Retrieval

virtual GameSaveData GetSave(int slotNumber)

  • Returns the save that has the passed slot number, if it exists. Returns null if it doesn't.

Notes

  • If you want a slotless save system in your game, you can just have an instance of this in each of your scenes without any accompanying SaveSlot or SaveSlotManager objects. You can use Invoke Event and Invoke Method commands to access the public parts of the API outlined above.
    • The system still treats everything as slot-based under the hood, since you'd have to provide slot numbers for the save-writing-and-loading functions. That's just a small detail, however; your system will still look to the player like it's slotless.

Clone this wiki locally