cz.xprees.variables 1.0.3

package/.github/workflows/deploy.yml

@@ -0,0 +1,30 @@
+name: Publish to NPM registry
+
+on:
+  push:
+    branches:
+      - master
+      - release/*
+
+jobs:
+  publish-gpr:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    environment: Production
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Version Patcher
+        uses: justalemon/VersionPatcher@v0.8
+        with:
+          version: 1.0.${{ github.run_number }}
+          npm-files: 'package.json'
+      - run: npm i
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_AUTH_TOKEN }}
+          access: public

package/Editor/ReferenceDrawerBase.cs

@@ -0,0 +1,58 @@
+// ------------------------------------------------------------------------------------------------------
+// Heavily inspired by Ryan Hipple, 10/04/17 from Unite 2017 - Game Architecture with Scriptable Objects
+// ------------------------------------------------------------------------------------------------------
+
+using UnityEditor;
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Editor.Editor
+{
+    [CustomPropertyDrawer(typeof(ReferenceBase<>), true)]
+    public class ReferenceDrawerBase : PropertyDrawer
+    {
+        /// Options to display in the popup to select constant or variable.
+        private readonly string[] _popupOptions = { "Inlined Value", "Variable" };
+
+        private GUIStyle _popupStyle;
+
+        public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+        {
+            _popupStyle ??= new GUIStyle(GUI.skin.GetStyle("PaneOptions"))
+            {
+                imagePosition = ImagePosition.ImageOnly,
+            };
+
+            label = EditorGUI.BeginProperty(position, label, property);
+            position = EditorGUI.PrefixLabel(position, label);
+
+            EditorGUI.BeginChangeCheck();
+            // Get properties
+            var useConstant = property.FindPropertyRelative("useInlined");
+            var constantValue = property.FindPropertyRelative("inlinedValue");
+            var variable = property.FindPropertyRelative("variable");
+
+            // Calculate rect for configuration button
+            var buttonRect = new Rect(position);
+            buttonRect.yMin += _popupStyle.margin.top;
+            buttonRect.width = _popupStyle.fixedWidth + _popupStyle.margin.right;
+            position.xMin = buttonRect.xMax;
+
+            // Store old indent level and set it to 0, the PrefixLabel takes care of it
+            var indent = EditorGUI.indentLevel;
+            EditorGUI.indentLevel = 0;
+
+            var result = EditorGUI.Popup(buttonRect, useConstant.boolValue ? 0 : 1, _popupOptions, _popupStyle);
+
+            useConstant.boolValue = result == 0;
+
+            EditorGUI.PropertyField(position, useConstant.boolValue ? constantValue : variable, GUIContent.none);
+
+
+            if (EditorGUI.EndChangeCheck()) property.serializedObject.ApplyModifiedProperties();
+
+            EditorGUI.indentLevel = indent;
+            EditorGUI.EndProperty();
+        }
+    }
+}

package/Editor/ReferenceDrawerBase.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 5f5f191ae80b43a0bf7ddbcec136c74e
+timeCreated: 1678464383

package/Editor/cz.xprees.variables.editor.asmdef

@@ -0,0 +1,18 @@
+{
+  "name": "cz.xprees.variables.editor",
+  "rootNamespace": "Xprees.Variables.Editor",
+  "references": [
+    "cz.xprees.variables"
+  ],
+  "includePlatforms": [
+    "Editor"
+  ],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": [],
+  "versionDefines": [],
+  "noEngineReferences": false
+}

package/Editor/cz.xprees.variables.editor.asmdef.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c2bb97124a5a46f0bdc4118e26f9bbb0
+timeCreated: 1684876046

package/Editor.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 72e9b289611248989bd98ad00a76842e
+timeCreated: 1684875963

package/Runtime/Aggregations/BoolAggregation.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Linq;
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Aggregations
+{
+    [CreateAssetMenu(menuName = "Variables/Aggregations/Bool", fileName = "BoolVarAgg")]
+    public class BoolAggregation : VariableAggregationBaseSO<bool>
+    {
+        [SerializeField] protected BoolAggregator aggregator = BoolAggregator.And;
+
+        protected override bool AggregateValue(VariableBaseSO<bool>[] variableBases) => aggregator switch
+        {
+            BoolAggregator.And => variables.All(v => v.CurrentValue),
+            BoolAggregator.Or => variables.Any(v => v.CurrentValue),
+            BoolAggregator.Xor => variables.Aggregate(false, (current, v) => current ^ v.CurrentValue),
+            _ => throw new ArgumentOutOfRangeException()
+        };
+    }
+
+    public enum BoolAggregator
+    {
+        And,
+        Or,
+        Xor,
+    }
+}

package/Runtime/Aggregations/BoolAggregation.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: efcb87ed64af492f9ff36f17c2ef5fa4
+timeCreated: 1701876801

package/Runtime/Aggregations.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 4d9d6551f361439ab4eefcd2d61924ef
+timeCreated: 1701876613

package/Runtime/Base/ReferenceBase.cs

@@ -0,0 +1,63 @@
+// ------------------------------------------------------------------------------------------------------
+// Heavily inspired by Ryan Hipple, 10/04/17 from Unite 2017 - Game Architecture with Scriptable Objects
+// ------------------------------------------------------------------------------------------------------
+
+using System;
+using UnityEngine.Events;
+using Xprees.Core;
+
+namespace Xprees.Variables.Base
+{
+    [Serializable]
+    public class ReferenceBase<T> : IResettable
+    {
+        private T _defaultInlinedValue; // Used to reset state of inlined value
+
+        public bool useInlined = true;
+        public T inlinedValue;
+        public VariableBaseSO<T> variable;
+
+        public UnityAction<T> onValueChanged = delegate { };
+
+        public ReferenceBase()
+        {
+        }
+
+        public ReferenceBase(T value)
+        {
+            useInlined = true;
+            inlinedValue = value;
+            _defaultInlinedValue = value;
+        }
+
+        public T Value
+        {
+            get => useInlined ? inlinedValue : variable.CurrentValue;
+            set
+            {
+                if (useInlined)
+                {
+                    inlinedValue = value;
+                    onValueChanged?.Invoke(value);
+                    return;
+                }
+
+                variable.SetValue(value);
+                onValueChanged?.Invoke(value); // ignores that variable has its own onValueChanged
+            }
+        }
+
+        public static implicit operator T(ReferenceBase<T> reference) => reference != null ? reference.Value : default;
+
+        public virtual void ResetState()
+        {
+            if (useInlined)
+            {
+                inlinedValue = _defaultInlinedValue;
+                return;
+            }
+
+            variable.ResetState();
+        }
+    }
+}

package/Runtime/Base/ReferenceBase.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 242310719bb543a5bf8919de3031b634
+timeCreated: 1678464183

package/Runtime/Base/VariableAgregationBaseSO.cs

@@ -0,0 +1,25 @@
+using UnityEngine;
+
+namespace Xprees.Variables.Base
+{
+    public abstract class VariableAggregationBaseSO<T> : VariableBaseSO<T>
+    {
+        [Header("Aggregation")]
+        [Tooltip("Aggregated variables.")]
+        [SerializeField] protected VariableBaseSO<T>[] variables;
+
+        private void OnEnable()
+        {
+            hideFlags = HideFlags.DontUnloadUnusedAsset;
+            ResetState();
+        }
+
+        public override T CurrentValue
+        {
+            get => AggregateValue(variables);
+            set => Debug.LogWarning($"{GetType().Name} on {name} - cannot set value for aggregation!"); // cannot set value of aggregation
+        }
+
+        protected abstract T AggregateValue(VariableBaseSO<T>[] variableBases);
+    }
+}

package/Runtime/Base/VariableAgregationBaseSO.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 9b9b7bc755564e709fd59eed38fdf857
+timeCreated: 1701876529

package/Runtime/Base/VariableBaseSO.cs

@@ -0,0 +1,49 @@
+using UnityEngine;
+using UnityEngine.Events;
+using Xprees.Core;
+
+namespace Xprees.Variables.Base
+{
+    public abstract class VariableBaseSO : DescriptionBaseSO
+    {
+        private void OnEnable()
+        {
+            hideFlags = HideFlags.DontUnloadUnusedAsset;
+            ResetState();
+        }
+
+        public override abstract void ResetState();
+    }
+
+    /// <summary>
+    /// Base class for all variables ScriptableObjects.
+    /// Object holds the state on runtime, but reset every time OnEnable to defaultValue.
+    /// </summary>
+    /// <typeparam name="T">Unity Serializable</typeparam>
+    public class VariableBaseSO<T> : VariableBaseSO
+    {
+        [SerializeField] protected T defaultValue;
+        [SerializeField] private T currentValue;
+
+        public virtual T CurrentValue
+        {
+            get => currentValue;
+            set
+            {
+                currentValue = value;
+                onValueChanged?.Invoke(value);
+            }
+        }
+
+        public UnityAction<T> onValueChanged;
+
+        public void SetValue(T value) => CurrentValue = value;
+
+        public void SetValue(VariableBaseSO<T> variable) => CurrentValue = variable.CurrentValue;
+
+        public static implicit operator T(VariableBaseSO<T> variable) =>
+            variable != null ? variable.CurrentValue : default;
+
+        public override void ResetState() => CurrentValue = defaultValue;
+    }
+}

package/Runtime/Base/VariableBaseSO.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 386a8646e45c08f41a3e2a14d074875f
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Base/VariableModifierBaseSO.cs

@@ -0,0 +1,33 @@
+using UnityEngine;
+using Xprees.Variables.Reference.Primitive;
+
+namespace Xprees.Variables.Base
+{
+    public abstract class VariableModifierBaseSO<T> : VariableBaseSO<T>
+    {
+        [Header("Modifier")]
+        [Tooltip("Variable to modify.")]
+        [SerializeField] protected VariableBaseSO<T> variable;
+
+        [Space]
+        [SerializeField] private BoolReference disableWrite = new(true);
+
+        private void OnEnable()
+        {
+            hideFlags = HideFlags.DontUnloadUnusedAsset;
+            ResetState();
+        }
+
+        public override T CurrentValue
+        {
+            get => ModifyValue(variable.CurrentValue);
+            set
+            {
+                if (disableWrite.Value) return;
+                variable.CurrentValue = ModifyValue(value);
+            }
+        }
+
+        protected abstract T ModifyValue(T value);
+    }
+}

package/Runtime/Base/VariableModifierBaseSO.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 116e107ff7b6ce74fbfa5fb7083d7872
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Base.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c97f543b968a48f98dc28a0605c1ea52
+timeCreated: 1679506207

package/Runtime/Modifiers/BoolModifier.cs

@@ -0,0 +1,24 @@
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Modifiers
+{
+    [CreateAssetMenu(menuName = "Variables/Modifiers/Bool modifier", fileName = "BoolVarMod")]
+    public class BoolModifier : VariableModifierBaseSO<bool>
+    {
+        [SerializeField] protected BoolModifiers variableModifier = BoolModifiers.Identity;
+
+        protected override bool ModifyValue(bool value) => variableModifier switch
+        {
+            BoolModifiers.Identity => value,
+            BoolModifiers.Not => !value,
+            _ => value,
+        };
+    }
+
+    public enum BoolModifiers
+    {
+        Identity,
+        Not,
+    }
+}

package/Runtime/Modifiers/BoolModifier.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 850e43d4476f4dbd9a5e86cbe64b038a
+timeCreated: 1701869703

package/Runtime/Modifiers.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 7a83842809334d17b0d714f9463556eb
+timeCreated: 1701869687

package/Runtime/Primitive/BoolVariable.cs

@@ -0,0 +1,10 @@
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Primitive
+{
+    [CreateAssetMenu(menuName = "Variables/Bool", fileName = "BoolVar")]
+    public class BoolVariable : VariableBaseSO<bool>
+    {
+    }
+}

package/Runtime/Primitive/BoolVariable.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 01435584ac4c4cd9a431d3e0a91a1138
+timeCreated: 1669145376

package/Runtime/Primitive/FloatVariable.cs

@@ -0,0 +1,10 @@
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Primitive
+{
+    [CreateAssetMenu(menuName = "Variables/Float", fileName = "FloatVar")]
+    public class FloatVariable : VariableBaseSO<float>
+    {
+    }
+}

package/Runtime/Primitive/FloatVariable.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 3b7922099009494d83dc519ce54dbadd
+timeCreated: 1669143145

package/Runtime/Primitive/IntVariable.cs

@@ -0,0 +1,10 @@
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Primitive
+{
+    [CreateAssetMenu(menuName = "Variables/Int", fileName = "IntVar")]
+    public class IntVariable : VariableBaseSO<int>
+    {
+    }
+}

package/Runtime/Primitive/IntVariable.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 8788ae78ca0d4deaa86ab809de41cb5d
+timeCreated: 1669143293

package/Runtime/Primitive/StringVariable.cs

@@ -0,0 +1,10 @@
+using UnityEngine;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Primitive
+{
+    [CreateAssetMenu(menuName = "Variables/String", fileName = "StringVar")]
+    public class StringVariable : VariableBaseSO<string>
+    {
+    }
+}

package/Runtime/Primitive/StringVariable.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c54e66a8977e4ae2be7d188c04d2dc69
+timeCreated: 1679324257

package/Runtime/Primitive.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 70ea20c566744e7282ff1ba83bbff4f8
+timeCreated: 1679506174

package/Runtime/Reference/Primitive/BoolReference.cs

@@ -0,0 +1,13 @@
+using System;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Reference.Primitive
+{
+    [Serializable]
+    public class BoolReference : ReferenceBase<bool>
+    {
+        public BoolReference(bool value = false) : base(value)
+        {
+        }
+    }
+}

package/Runtime/Reference/Primitive/BoolReference.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 76e869a023144278847da541575de062
+timeCreated: 1678464320

package/Runtime/Reference/Primitive/FloatReference.cs

@@ -0,0 +1,13 @@
+using System;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Reference.Primitive
+{
+    [Serializable]
+    public class FloatReference : ReferenceBase<float>
+    {
+        public FloatReference(float value) : base(value)
+        {
+        }
+    }
+}

package/Runtime/Reference/Primitive/FloatReference.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 787cb41d56a14227929e708309e1c311
+timeCreated: 1678465414

package/Runtime/Reference/Primitive/IntReference.cs

@@ -0,0 +1,17 @@
+using System;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Reference.Primitive
+{
+    [Serializable]
+    public class IntReference : ReferenceBase<int>
+    {
+        public IntReference()
+        {
+        }
+
+        public IntReference(int value) : base(value)
+        {
+        }
+    }
+}

package/Runtime/Reference/Primitive/IntReference.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 19513ed19e6f469aa63d053ab3a1462b
+timeCreated: 1678537296

package/Runtime/Reference/Primitive/StringReference.cs

@@ -0,0 +1,17 @@
+using System;
+using Xprees.Variables.Base;
+
+namespace Xprees.Variables.Reference.Primitive
+{
+    [Serializable]
+    public class StringReference : ReferenceBase<string>
+    {
+        public StringReference()
+        {
+        }
+
+        public StringReference(string value = null) : base(value)
+        {
+        }
+    }
+}

package/Runtime/Reference/Primitive/StringReference.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: f90c9c0370ea4faba29fcd2b17ae1f3d
+timeCreated: 1679321743

package/Runtime/Reference/Primitive.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: e4596e541b13468993ea1c49b6393c38
+timeCreated: 1679506266

package/Runtime/Reference.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c920a8c83bac4c0dab7de12ddc393d2e
+timeCreated: 1678464076

package/Runtime/cz.xprees.variables.asmdef

@@ -0,0 +1,16 @@
+{
+  "name": "cz.xprees.variables",
+  "rootNamespace": "Xprees.Variables",
+  "references": [
+    "cz.xprees.core"
+  ],
+  "includePlatforms": [],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": [],
+  "versionDefines": [],
+  "noEngineReferences": false
+}

package/Runtime/cz.xprees.variables.asmdef.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 758763dcb3bb46caad0f8486302cbadf
+timeCreated: 1679504891

package/Runtime.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 0e4410be438b4df193d3b0a5cf84ddf0
+timeCreated: 1678537109

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "cz.xprees.variables",
+  "displayName": "Variables",
+  "version": "1.0.3",
+  "unity": "2021.3",
+  "description": "This package contains a system for creating variables based on ScriptableObjects in Editor.",
+  "license": "MIT",
+  "category": "Core",
+  "dependencies": {
+    "cz.xprees.core": "1.0.0"
+  },
+  "keywords": [
+    "Unity",
+    "Variables",
+    "ScriptableObjects"
+  ],
+  "author": {
+    "name": "xprees",
+    "email": "xprees.developer@gmail.com",
+    "url": "https://xprees.com"
+  },
+  "bugs": {
+    "url": "https://github.com/xprees/unity-variables/issues"
+  },
+  "repository": {
+    "url": "https://github.com/xprees/unity-variables"
+  }
+}

package/package.json.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 8f2b88fba3f34793b36e240bd8b06435
+timeCreated: 1684876255