ProjectDDD/Assets/Plugins/Pixel Crushers/Common/Scripts/Save System/Savers/Saver.cs

// Copyright (c) Pixel Crushers. All rights reserved.

using UnityEngine;

namespace PixelCrushers
{

    /// <summary>
    /// Abstract base class for a "saver", which is a component that contributes
    /// to saved game data.
    /// </summary>
    public abstract class Saver : MonoBehaviour
    {

        [Tooltip("Save data under this key. If blank, use GameObject name.")]
        [SerializeField]
        private string m_key;

        [Tooltip("Append the name of this saver type to the key.")]
        [SerializeField]
        private bool m_appendSaverTypeToKey;

        [Tooltip("Save when changing scenes to be able to restore saved state when returning to scene.")]
        [SerializeField]
        private bool m_saveAcrossSceneChanges = true;

        [Tooltip("When starting, restore this saver's state from current saved game data. Normally the save system restores state when loading games or changing scenes without this checkbox.")]
        [SerializeField]
        private bool m_restoreStateOnStart = false;

        protected string m_runtimeKey = null;

        /// <summary>
        /// Append the name of this saver type to the key.
        /// </summary>
        public bool appendSaverTypeToKey
        {
            get { return m_appendSaverTypeToKey; }
            set { m_appendSaverTypeToKey = value; }
        }

        /// <summary>
        /// Save data under this key. If blank, use GameObject name.
        /// </summary>
        public virtual string key
        {
            get
            {
                if (string.IsNullOrEmpty(m_runtimeKey))
                {
                    m_runtimeKey = !string.IsNullOrEmpty(m_key) ? m_key : name;
                    if (appendSaverTypeToKey)
                    {
                        var typeName = GetType().Name;
                        if (typeName.EndsWith("Saver")) typeName.Remove(typeName.Length - "Saver".Length);
                        m_runtimeKey += typeName;
                    }
                }
                return m_runtimeKey;
            }
            set
            {
                m_key = value;
                m_runtimeKey = value;
            }
        }

        /// <summary>
        /// Accesses the internal key value. Normally leave this untouched and 
        /// access the key property instead.
        /// </summary>
        public string _internalKeyValue
        {
            get { return m_key; }
            set { m_key = value; }
        }

        /// <summary>
        /// Save when changing scenes to be able to restore saved state when returning to scene.
        /// </summary>
        public virtual bool saveAcrossSceneChanges
        {
            get { return m_saveAcrossSceneChanges; }
            set { m_saveAcrossSceneChanges = value; }
        }

        public virtual bool restoreStateOnStart
        {
            get { return m_restoreStateOnStart; }
            set { m_restoreStateOnStart = value; }
        }

        public virtual void Awake() { }

        public virtual void Start()
        {
            if (restoreStateOnStart)
            {
                ApplyData(SaveSystem.currentSavedGameData.GetData(key));
            }
        }

        public virtual void Reset() { }

        public virtual void OnEnable()
        {
            SaveSystem.RegisterSaver(this);
        }

        public virtual void OnDisable()
        {
            SaveSystem.UnregisterSaver(this);
        }

        public virtual void OnDestroy() { }

        /// <summary>
        /// This method should return a string that represents the data you want to save.
        /// You can use SaveSystem.Serialize() to serialize a serializable object to a 
        /// string. This will use the serializer component on the Save System GameObject,
        /// which defaults to JSON serialization.
        /// </summary>
        public abstract string RecordData();

        /// <summary>
        /// This method should process the string representation of saved data and apply
        /// it to the current state of the game. You can use SaveSystem.Deserialize()
        /// to deserialize the string to an object that specifies the state to apply to
        /// the game.
        /// </summary>
        public abstract void ApplyData(string s);

        /// <summary>
        /// If the Saver needs to pull data from the Save System immediately after loading a
        /// scene, instead of waiting for ApplyData to be called at it its normal time, it 
        /// can implement this method. For efficiency, the Save System will not look up the 
        /// Saver's data; your method must look it up manually by calling 
        /// SaveSystem.savedGameData.GetData(key).
        /// </summary>
        public virtual void ApplyDataImmediate() { }

        /// <summary>
        /// The Save System will call this method before scene changes. If your saver listens for 
        /// OnDisable or OnDestroy messages (see DestructibleSaver for example), it can use this 
        /// method to ignore the next OnDisable or OnDestroy message since they will be called
        /// because the entire scene is being unloaded.
        /// </summary>
        public virtual void OnBeforeSceneChange() { }

        /// <summary>
        /// The Save System will call this method when restarting the game. Your saver can
        /// reset data to a fresh state if necessary.
        /// </summary>
        public virtual void OnRestartGame() { }
    }

}