net.dreditor.uihandling 0.0.0-stage → 0.1.7

package/AnimatorBoolUIVisibility.cs

@@ -0,0 +1,129 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Services;
+using System.Collections;
+using UnityEngine;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(UIVisibilityComponent) +
+        "\n\n")]
+    public class AnimatorBoolUIVisibility : UIVisibilityComponent, IToTitleScreen
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool debugLogs = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Animator animator = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected string showBoolTriggerName = "HideBox"; // ShowDUI MoveDUI ConfirmSelect Appear On DisplayName
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected string hideBoolTriggerName = "HideBox"; // ShowDUI MoveDUI ConfirmSelect Appear On DisplayName
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool setBoolOnShow = true;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool setBoolOnHide = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected int animatorLayer = 0;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool rebindOnTitleScreen = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool hideOnTitleScreen = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool rebindOnHide = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool keepAnimatorStateOnDisable = false;
+
+
+        protected virtual void Awake()
+        {
+            if (animator != null)
+                animator.keepAnimatorStateOnDisable = keepAnimatorStateOnDisable;
+        }
+
+        /// <inheritdoc/>
+        protected override void ShowUI() => UpdateVisibility(showBoolTriggerName, setBoolOnShow);
+
+        /// <inheritdoc/>
+        protected override void HideUI()
+        {
+            UpdateVisibility(hideBoolTriggerName, setBoolOnHide);
+
+            if (rebindOnHide)
+                animator.Rebind();
+        }
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="trigger"></param>
+        /// <param name="triggerState"></param>
+        protected virtual void UpdateVisibility(string trigger, bool triggerState)
+        {
+            if (debugLogs)
+                UnityEngine.Debug.Log($"REPORT: {gameObject.name}: Is setting {trigger} to {triggerState}.");
+
+            animator.SetBool(trigger, triggerState);
+        }
+
+        /// <inheritdoc/>
+        protected override IEnumerator WaitForUIToComplete() => animator.WaitForStateToComplete(animatorLayer);
+
+
+        /// <inheritdoc/>
+        public virtual void ToTitleScreen()
+        {
+            if (hideOnTitleScreen)
+                Hide();
+
+            if (rebindOnTitleScreen)
+                animator.Rebind();
+        }
+    }
+}

package/AnimatorBoolUIVisibility.cs.meta

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

package/AnimatorUIVisibility.cs

@@ -0,0 +1,102 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Services;
+using System.Collections;
+using UnityEngine;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(UIVisibilityComponent) + ", " + nameof(IUIVisibility) + ", " + nameof(IToTitleScreen) +
+        "\n\n")]
+    public class AnimatorUIVisibility : UIVisibilityComponent, IToTitleScreen
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Animator animator = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected string showStateName = "ShowMainUI"; // ShowProtag ShowInstant
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected string hideStateName = "HideMainUI"; // HideProtag HideInstant
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected int animatorLayer = 0;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected bool rebindOnPlay = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool rebindOnTitleScreen = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool hideOnTitleScreen = true;
+
+
+        protected virtual void Start()
+        {
+            if (animator == null && !TryGetComponent(out animator))
+                UnityEngine.Debug.LogError("ALERT: An animator component must be referenced or on the gameobject of this component!");
+        }
+
+        /// <inheritdoc/>
+        protected override void ShowUI() => PlayAnimation(showStateName, animatorLayer);
+
+        /// <inheritdoc/>
+        protected override void HideUI() => PlayAnimation(hideStateName, animatorLayer);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="animationName"></param>
+        /// <param name="animatorLayer"></param>
+        protected virtual void PlayAnimation(string animationName, int animatorLayer)
+        {
+            if (rebindOnPlay)
+                animator.Rebind();
+
+            if (!string.IsNullOrEmpty(animationName))
+                animator.Play(animationName, animatorLayer);
+        }
+
+        /// <inheritdoc/>
+        protected override IEnumerator WaitForUIToComplete() => animator.WaitForStateToComplete(animatorLayer);
+
+
+        /// <inheritdoc/>
+        public virtual void ToTitleScreen()
+        {
+            if (hideOnTitleScreen)
+                Hide();
+
+            if (rebindOnTitleScreen)
+                animator.Rebind();
+        }
+    }
+}

package/AnimatorUIVisibility.cs.meta

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

package/CanvasUIVisibility.cs

@@ -0,0 +1,103 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Services;
+using System.Collections;
+using UnityEngine;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(UIVisibilityComponent) + ", " + nameof(IUIVisibility) + ", " + nameof(IToTitleScreen) +
+        "\n\n")]
+    public class CanvasUIVisibility : UIVisibilityComponent, IToTitleScreen
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Canvas canvas = null;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected bool debug = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool setVisibilityOnTitleScreen = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool visibilityOnTitleScreen = false;
+
+
+        protected virtual void Awake() => CheckInitializeCanvas();
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected virtual void CheckInitializeCanvas()
+        {
+            if (canvas == null)
+                TryGetComponent(out canvas);
+
+            if (canvas == null)
+                canvas = transform.parent.GetComponentInParent<Canvas>();
+        }
+
+
+        /// <inheritdoc/>
+        protected override void ShowUI() => SetCanvasTo(true);
+
+        /// <inheritdoc/>
+        protected override void HideUI() => SetCanvasTo(false);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="to"></param>
+        protected virtual void SetCanvasTo(bool to)
+        {
+            if (debug)
+                UnityEngine.Debug.LogWarning($"REPORT: Set Canvas {gameObject.name} to {to}.");
+
+            CheckInitializeCanvas();
+
+            canvas.enabled = to;
+        }
+
+        /// <inheritdoc/>
+        protected override IEnumerator WaitForUIToComplete()
+        {
+            yield break;
+        }
+
+        /// <inheritdoc/>
+        public virtual void ToTitleScreen()
+        {
+            if (setVisibilityOnTitleScreen)
+                ChangeVisibilityOnTitleScreen();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void ChangeVisibilityOnTitleScreen() => SetCanvasTo(visibilityOnTitleScreen);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="canvas"></param>
+        /// <remarks></remarks>
+        public void SetCanvas(Canvas canvas) => this.canvas = canvas;
+    }
+}

package/CanvasUIVisibility.cs.meta

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

package/CenterReticleOnSafeState.cs

@@ -0,0 +1,20 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using UnityEngine;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public class CenterReticleOnSafeState : ConditionOnSceneEvent
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Transform reticle = null;
+
+        /// <inheritdoc/>
+        protected override void OnPassedCondition() => reticle.localPosition = Vector3.zero;
+    }
+}

package/CenterReticleOnSafeState.cs.meta

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

package/ColorUIVisibility.cs

@@ -0,0 +1,134 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+#if DOTWEEN
+using DG.Tweening;
+#endif
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using UnityEngine.UI;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(UIVisibilityComponent) +
+        "\n\n")]
+    public class ColorUIVisibility : UIVisibilityComponent
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected List<Graphic> graphics = null;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected Color showColor = new();
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected float colorShowDuration = 0.5f;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Color hideColor = new();
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected float colorHideDuration = 0.5f;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected bool ignoreTimeScale = false;
+#if DOTWEEN
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Ease easeCurve = Ease.Linear;
+#endif
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected int loops = 0;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected float delay = 0f;
+
+#if DOTWEEN
+        /// <summary>
+        ///
+        /// </summary>
+        protected List<Tween> activeTweens = new();
+#endif
+
+        /// <inheritdoc/>
+        protected override void ShowUI()
+        {
+#if DOTWEEN
+            graphics.ForEach(component =>
+            RegisterTween(component.DOColor(showColor, colorShowDuration)
+            .SetUpdate(ignoreTimeScale)
+            .SetEase(easeCurve)
+            .SetLoops(loops)
+            .SetDelay(delay))
+            );
+#endif
+        }
+
+        /// <inheritdoc/>
+        protected override void HideUI()
+        {
+#if DOTWEEN
+            graphics.ForEach(component =>
+            RegisterTween(component.DOColor(hideColor, colorHideDuration)
+            .SetUpdate(ignoreTimeScale)
+            .SetEase(easeCurve)
+            .SetLoops(loops)
+            .SetDelay(delay))
+            );
+#endif
+        }
+#if DOTWEEN
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="tween"></param>
+        protected virtual void RegisterTween(Tween tween)
+        {
+            tween.onComplete = () => { activeTweens.Remove(tween); };
+
+            activeTweens.Add(tween);
+        }
+#endif
+        /// <inheritdoc/>
+        protected override IEnumerator WaitForUIToComplete()
+        {
+#if DOTWEEN
+            while (activeTweens.Count != 0)
+#endif
+                yield return null;
+        }
+    }
+}

package/ColorUIVisibility.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: 337b1cd779f3d3d41865ba7b02c1d5d4

package/ConditionOnSceneEvent.cs

@@ -0,0 +1,43 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.EventObjects;
+using UnityEngine;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public abstract class ConditionOnSceneEvent : SceneEventListener
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+
+        [Tooltip("")]
+        [SerializeField] protected EvaluateCondition condition = null;
+
+
+        /// <inheritdoc/>
+        public override void OnEventRaised()
+        {
+            base.OnEventRaised();
+
+            OnCheckCondition();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void OnCheckCondition()
+        {
+            if (condition == null || condition.Evaluate())
+                OnPassedCondition();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected abstract void OnPassedCondition();
+    }
+}

package/ConditionOnSceneEvent.cs.meta

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

package/ConditionVisibilityEntry.cs

@@ -0,0 +1,33 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using System;
+using UnityEngine;
+
+namespace DREditor.UIHandling
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [Serializable]
+    public class ConditionVisibilityEntry : VisibilityEntryBase
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected EvaluateCondition condition;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool invert = false;
+
+
+        /// <inheritdoc/>
+        protected override void EvaluateInState(bool inState)
+        {
+            if (condition != null && condition.Evaluate())
+                setVisibility(invert ? inState : !inState);
+        }
+    }
+}

package/ConditionVisibilityEntry.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: 5a7ddba913022884c87f6430ec928dc7

package/DREditor.UIHandling.asmdef

@@ -0,0 +1,21 @@
+{
+    "name": "DREditor.UIHandling",
+    "rootNamespace": "",
+    "references": [
+        "Unity.TextMeshPro",
+        "Unity.InputSystem",
+        "DREditor",
+        "DREditor.Controls",
+        "DREditor.Fading",
+        "DG.Tweening"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

package/DREditor.UIHandling.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 129f5e48f1af4c946af372b8cb81568d
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: