Babushka/scripts/CSharp/Common/Savegame/ISaveable.cs

namespace Babushka.scripts.CSharp.Common.Savegame;

/// <summary>
/// Defines the behaviour of Nodes that have fields that should save / load to disk.
/// When implementing new Saveable objects, please beware: Please check if object instances need to be identified separately.
/// If so, make sure to give them a proper ID. You can use the <see cref="SaveIDProvider"/> tool for that.
/// </summary>
public interface ISaveable 
{
    /// <summary>
    /// Adds or updates the field data that shall be stored to disk.
    /// </summary>
    public void UpdateSaveData();
    
    /// <summary>
    /// Loads the field data from disk.
    /// </summary>
    public void LoadFromSaveData();
}