cz.xprees.variables 1.0.13 → 1.0.15

package/Runtime/Base/VariableBaseSO.cs

@@ -9,10 +9,13 @@ namespace Xprees.Variables.Base
         private void OnEnable()
         {
             hideFlags = HideFlags.DontUnloadUnusedAsset;
-            ResetState();
+            ForceResetState();
         }
 
-        public override abstract void ResetState();
+        /// Force reset state regardless of any protection settings.
+        public abstract void ForceResetState();
+
+        public override void ResetState() => ForceResetState();
     }
 
     /// <summary>
@@ -22,9 +25,18 @@ namespace Xprees.Variables.Base
     /// <typeparam name="T">Unity Serializable</typeparam>
     public class VariableBaseSO<T> : VariableBaseSO
     {
+        [Tooltip("Value to which the variable will be reset on OnEnable or ResetState call.")]
         [SerializeField] protected T defaultValue;
+
+        [Tooltip("Current value of variable - Runtime only value.")]
         [SerializeField] private T currentValue;
 
+        [Header("Settings")]
+        [Tooltip("If true, the variable will not be reset when calling ResetState()."
+                 + " However, it will still be reset on OnEnable and when ForceResetState() is called. "
+                 + "Useful for game-system variables where runtime value should persist unless explicitly reset.")]
+        [SerializeField] protected bool protectedDontReset = false;
+
         public virtual T CurrentValue
         {
             get => currentValue;
@@ -35,6 +47,7 @@ namespace Xprees.Variables.Base
             }
         }
 
+        /// Event invoked when CurrentValue changes.
         public UnityAction<T> onValueChanged;
 
         public void SetValue(T value) => CurrentValue = value;
@@ -44,6 +57,14 @@ namespace Xprees.Variables.Base
         public static implicit operator T(VariableBaseSO<T> variable) =>
             variable != null ? variable.CurrentValue : default;
 
-        public override void ResetState() => CurrentValue = defaultValue;
+        public override void ResetState()
+        {
+            if (protectedDontReset) return; // skip reset if protected
+
+            ForceResetState();
+        }
+
+        public override void ForceResetState() => CurrentValue = defaultValue;
+
     }
 }

package/Runtime/Base/VariableModifierBaseSO.cs

@@ -24,7 +24,12 @@ namespace Xprees.Variables.Base
             get => ModifyValue(variable.CurrentValue);
             set
             {
-                if (disableWrite.Value) return;
+                if (disableWrite.Value)
+                {
+                    Debug.LogWarning($"Trying to set value of {name} but writing is disabled.", this);
+                    return;
+                }
+
                 variable.CurrentValue = ModifyValue(value);
             }
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cz.xprees.variables",
   "displayName": "Variables",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "unity": "2021.3",
   "description": "This package contains a system for creating variables based on ScriptableObjects in Editor.",
   "license": "Apache-2.0",