docs: ITrigger.StateEnable Documentation Updated

Box2DColliderTrigger.cs

@@ -1,25 +0,0 @@
-using UnityEngine;
-
-namespace Syntriax.Modules.Trigger
-{
-
-    public class Box2DColliderTrigger : Trigger, IColliderTrigger
-    {
-        private Collider2D[] results = new Collider2D[8];
-
-        public LayerMask ColliderMask { get => colliderMask; set => colliderMask = value; }
-        [SerializeField] private LayerMask colliderMask = 0;
-
-        protected void FixedUpdate()
-            => IsTrigerred = Physics2D.OverlapBoxNonAlloc(transform.position, transform.localScale, 0, results, ColliderMask) > 0;
-
-
-#if UNITY_EDITOR
-        private void OnDrawGizmosSelected()
-        {
-            Gizmos.color = IsTrigerred ? Color.green : Color.red;
-            Gizmos.DrawWireCube(transform.position, transform.lossyScale);
-        }
-#endif
-    }
-}

Ground/Box2DGroundTrigger.cs

@@ -1,4 +0,0 @@
-namespace Syntriax.Modules.Trigger
-{
-    public class Box2DGroundTrigger : Box2DColliderTrigger, IGroundTrigger { }
-}

Ground/IGroundTrigger.cs

@@ -1,4 +0,0 @@
-namespace Syntriax.Modules.Trigger
-{
-    public interface IGroundTrigger : IColliderTrigger { }
-}

IColliderTrigger.cs

@@ -1,9 +0,0 @@
-using UnityEngine;
-
-namespace Syntriax.Modules.Trigger
-{
-    public interface IColliderTrigger : ITrigger
-    {
-        LayerMask ColliderMask { get; set; }
-    }
-}

ITrigger.cs

@@ -1,10 +0,0 @@
-using System;
-
-namespace Syntriax.Modules.Trigger
-{
-    public interface ITrigger
-    {
-        bool IsTrigerred { get; }
-        Action<bool> OnTriggered { get; set; }
-    }
-}

ITriggerExtensions.cs

@@ -1,14 +0,0 @@
-namespace Syntriax.Modules.Trigger
-{
-    public static class ITriggerExtensions
-    {
-        /// <summary>
-        /// Checks if the provided parameter ITrigger is toggled, if the parameter is null returns the nullValue parameter
-        /// </summary>
-        /// <param name="trigger">ITrigger to be checked if toggled or not</param>
-        /// <param name="nullValue">The value that will be returned if toggleState is null. Default value: true</param>
-        /// <returns>ITrigger's toggle value, or if null return nullValue parameter</returns>
-        public static bool IsTriggeredNullChecked(this ITrigger trigger, bool nullValue = true)
-            => trigger == null ? nullValue : trigger.IsTrigerred;
-    }
-}

README.md

@@ -1,2 +1,4 @@
 # Trigger
 
+## Dependencies
+1. [State Module](https://git.syntriax.com/Syntriax/State)

Runtime.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 683853ebcef1bb84b90211ef5f0a6e5f
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Runtime/Collider.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 09a25591637cbdf45ad71415d94bf641
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Runtime/Collider/Box2DColliderTriggerArea.cs

@@ -0,0 +1,21 @@
+using UnityEngine;
+
+namespace Syntriax.Modules.Trigger
+{
+    public class Box2DColliderTriggerArea : ColliderTriggerAreaBase<Collider2D>
+    {
+        protected override int TriggerCount
+            => Physics2D.OverlapBoxNonAlloc(transform.position, transform.localScale, 0, nonAllocResults, ColliderMask);
+
+#if UNITY_EDITOR
+        private void OnDrawGizmosSelected()
+        {
+            if (UnityEditor.EditorApplication.isPlaying)
+                Gizmos.color = previousTriggerCount > 0 && StateEnable.IsEnabled ? Color.green : Color.red;
+            else
+                Gizmos.color = TriggerCount > 0 ? Color.green : Color.red;
+            Gizmos.DrawWireCube(transform.position, transform.lossyScale);
+        }
+#endif
+    }
+}

Runtime/Collider/Box2DColliderTriggerArea.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: e199ccade2250b646abfd859e4aa1e7a
+guid: 13b8a72003d46b24fa2e67093c42c49d
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Runtime/Collider/Box2DColliderTriggerAreaWithRotation.cs

@@ -0,0 +1,22 @@
+using UnityEngine;
+
+namespace Syntriax.Modules.Trigger
+{
+    public class Box2DColliderTriggerAreaWithRotation : ColliderTriggerAreaBase<Collider2D>
+    {
+        protected override int TriggerCount
+            => Physics2D.OverlapBoxNonAlloc(transform.position, transform.localScale, transform.rotation.eulerAngles.z, nonAllocResults, ColliderMask);
+
+#if UNITY_EDITOR
+        private void OnDrawGizmosSelected()
+        {
+            if (UnityEditor.EditorApplication.isPlaying)
+                Gizmos.color = previousTriggerCount > 0 && StateEnable.IsEnabled ? Color.green : Color.red;
+            else
+                Gizmos.color = TriggerCount > 0 ? Color.green : Color.red;
+            Gizmos.matrix = transform.localToWorldMatrix;
+            Gizmos.DrawWireCube(Vector3.zero, Vector3.one);
+        }
+#endif
+    }
+}

Runtime/Collider/Box2DColliderTriggerAreaWithRotation.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: 20a6baf9a256917448a4d7ad09d0c51a
+guid: b2d9ae6bcc3b69a4093f8c740f040229
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Runtime/Collider/BoxColliderTriggerArea.cs

@@ -0,0 +1,23 @@
+using UnityEngine;
+
+namespace Syntriax.Modules.Trigger
+{
+    public class BoxColliderTriggerArea : ColliderTriggerAreaBase<Collider>
+    {
+        protected override int TriggerCount
+            => Physics.OverlapBoxNonAlloc(transform.position, transform.localScale * .5f, nonAllocResults, transform.rotation, ColliderMask);
+
+#if UNITY_EDITOR
+        private void OnDrawGizmosSelected()
+        {
+            if (UnityEditor.EditorApplication.isPlaying)
+                Gizmos.color = previousTriggerCount > 0 && StateEnable.IsEnabled ? Color.green : Color.red;
+            else
+                Gizmos.color = TriggerCount > 0 ? Color.green : Color.red;
+
+            Gizmos.matrix = transform.localToWorldMatrix;
+            Gizmos.DrawWireCube(Vector3.zero, Vector3.one);
+        }
+#endif
+    }
+}

Runtime/Collider/BoxColliderTriggerArea.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: 1e3718079b1e1024a997ca7eaa425903
+guid: 850a555be97ed9b4a86942b21a6a25e4
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Runtime/Collider/ColliderTrigger.cs

@@ -0,0 +1,22 @@
+using Syntriax.Modules.State;
+
+namespace Syntriax.Modules.Trigger
+{
+    public class ColliderTrigger : TriggerBase
+    {
+        protected IColliderTriggerArea colliderTrigger = null;
+
+        private void Awake()
+        {
+            colliderTrigger = GetComponent<IColliderTriggerArea>();
+        }
+
+        private void FixedUpdate()
+        {
+            if (!StateEnable.IsEnabledNullChecked())
+                return;
+
+            IsTrigerred = colliderTrigger.Check();
+        }
+    }
+}

Runtime/Collider/ColliderTrigger.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: 7804f3e8384c7a54482f585b4f43264a
+guid: 7302d5358a0cd4a4c9a2c8dd9a4a7697
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Runtime/Collider/ColliderTriggerAreaBase.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace Syntriax.Modules.Trigger
+{
+    public abstract class ColliderTriggerAreaBase<T> : MonoBehaviour, IColliderTriggerArea where T : Component
+    {
+        [SerializeField] private LayerMask colliderMask = ~0;
+
+        protected T[] nonAllocResults = new T[32];
+        protected int previousTriggerCount = 0;
+
+        public LayerMask ColliderMask { get => colliderMask; set => colliderMask = value; }
+        public Action<List<Transform>> OnTriggeredTransformsUpdated { get; set; } = null;
+        public List<Transform> TriggeredTransforms { get; protected set; } = new List<Transform>(32);
+
+        protected abstract int TriggerCount { get; }
+
+        public virtual bool Check()
+        {
+            int triggerCount = TriggerCount;
+
+            if (!IsArrayAndListIdentical(triggerCount))
+            {
+                TriggeredTransforms.Clear();
+                for (int i = 0; i < triggerCount; i++)
+                    TriggeredTransforms.Add(nonAllocResults[i].transform);
+
+                OnTriggeredTransformsUpdated?.Invoke(TriggeredTransforms);
+            }
+
+            previousTriggerCount = triggerCount;
+            return triggerCount > 0;
+        }
+
+        private bool IsArrayAndListIdentical(int triggerCount)
+        {
+            if (previousTriggerCount != triggerCount)
+                return false;
+
+            for (int i = 0; i < triggerCount; i++)
+                if (!TriggeredTransforms.Contains(nonAllocResults[i].transform))
+                    return false;
+
+            return true;
+        }
+
+#if UNITY_EDITOR
+        private State.IStateEnable _stateEnable = null;
+        public State.IStateEnable StateEnable
+        {
+            get
+            {
+                _stateEnable = _stateEnable ?? GetComponent<State.IStateEnable>() ?? gameObject.AddComponent<State.StateEnableMonoBehaviour>();
+                return _stateEnable;
+            }
+        }
+#endif
+    }
+}

Runtime/Collider/ColliderTriggerAreaBase.cs.meta

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

Runtime/Collider/Ground/Box2DGroundTriggerArea.cs

@@ -0,0 +1,4 @@
+namespace Syntriax.Modules.Trigger
+{
+    public class Box2DGroundTriggerArea : Box2DColliderTriggerArea, IGroundTriggerArea { }
+}

Runtime/Collider/Ground/Box2DGroundTriggerArea.cs.meta

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

Runtime/Collider/Ground/Box2DGroundTriggerAreaWithRotation.cs

@@ -0,0 +1,4 @@
+namespace Syntriax.Modules.Trigger
+{
+    public class Box2DGroundTriggerAreaWithRotation : Box2DColliderTriggerAreaWithRotation, IGroundTriggerArea { }
+}

Runtime/Collider/Ground/Box2DGroundTriggerAreaWithRotation.cs.meta

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

Runtime/Collider/Ground/BoxGroundTriggerArea.cs

@@ -0,0 +1,4 @@
+namespace Syntriax.Modules.Trigger
+{
+    public class BoxGroundTriggerArea : BoxColliderTriggerArea, IGroundTriggerArea { }
+}

Runtime/Collider/Ground/BoxGroundTriggerArea.cs.meta

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

Runtime/Collider/Ground/GroundTrigger.cs

@@ -0,0 +1,4 @@
+namespace Syntriax.Modules.Trigger
+{
+    public class GroundTrigger : ColliderTrigger, IGroundTrigger { }
+}

Runtime/Collider/Ground/GroundTrigger.cs.meta

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

Runtime/Collider/Ground/IGroundTrigger.cs

@@ -0,0 +1,4 @@
+namespace Syntriax.Modules.Trigger
+{
+    public interface IGroundTrigger : ITrigger { }
+}

Runtime/Collider/Ground/IGroundTriggerArea.cs

@@ -0,0 +1,4 @@
+namespace Syntriax.Modules.Trigger
+{
+    public interface IGroundTriggerArea : ITriggerArea { }
+}

Runtime/Collider/Ground/IGroundTriggerArea.cs.meta

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

Runtime/Collider/IColliderTriggerArea.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace Syntriax.Modules.Trigger
+{
+    public interface IColliderTriggerArea : ITriggerArea
+    {
+        /// <summary>
+        /// <see cref="LayerMask"/> value for checking triggers
+        /// </summary>
+        LayerMask ColliderMask { get; set; }
+
+        /// <summary>
+        /// Called whenever the list of <see cref="Transform"/> changes
+        /// </summary>
+        /// <value>List of <see cref="Transform"/> that their colliders triggered the <see cref="IColliderTriggerArea"/></value>
+        Action<List<Transform>> OnTriggeredTransformsUpdated { get; set; }
+
+        /// <value>List of <see cref="Transform"/> that their colliders triggered the <see cref="IColliderTriggerArea"/></value>
+        List<Transform> TriggeredTransforms { get; }
+    }
+}

Runtime/Collider/IColliderTriggerArea.cs.meta

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

Runtime/Collider/ITriggerArea.cs

@@ -0,0 +1,11 @@
+namespace Syntriax.Modules.Trigger
+{
+    public interface ITriggerArea
+    {
+        /// <summary>
+        /// Check if the <see cref="ITriggerArea"/> is Triggered
+        /// </summary>
+        /// <returns>true if <see cref="ITriggerArea"/> is triggered, false if not</returns>
+        bool Check();
+    }
+}

Runtime/Collider/ITriggerArea.cs.meta

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

Runtime/ITrigger.cs

@@ -0,0 +1,21 @@
+using System;
+using Syntriax.Modules.State;
+
+namespace Syntriax.Modules.Trigger
+{
+    public interface ITrigger
+    {
+        /// <summary>
+        /// <see cref="IStateEnable"/> to control the state of the <see cref="ITrigger"/> is on or off
+        /// </summary>
+        IStateEnable StateEnable { get; }
+
+        /// <summary>
+        /// Called everytime the IsTrigerred field is changed
+        /// </summary>
+        /// <value>The new value of IsTrigerred</value>
+        Action<bool> OnTriggerStateChanged { get; set; }
+
+        bool IsTrigerred { get; }
+    }
+}

Runtime/ITriggerExtensions.cs

@@ -0,0 +1,14 @@
+namespace Syntriax.Modules.Trigger
+{
+    public static class ITriggerExtensions
+    {
+        /// <summary>
+        /// Checks if the provided parameter <see cref="ITrigger"/> is toggled, if the parameter is null returns the nullValue parameter
+        /// </summary>
+        /// <param name="trigger"><see cref="ITrigger"/> to be checked if toggled or not</param>
+        /// <param name="nullValue">The value that will be returned if trigger is null. Default value: true</param>
+        /// <returns><see cref="ITrigger"/>'s toggle value, or if null return nullValue parameter</returns>
+        public static bool IsTriggeredNullChecked(this ITrigger trigger, bool nullValue = true)
+            => trigger == null ? nullValue : trigger.IsTrigerred;
+    }
+}

Runtime/Syntriax.Modules.Trigger.asmdef

@@ -0,0 +1,16 @@
+{
+    "name": "Syntriax.Modules.Trigger",
+    "rootNamespace": "",
+    "references": [
+        "GUID:efa9a9bc94c60c74684aafb7428fbf61"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Runtime/Syntriax.Modules.Trigger.asmdef.meta

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

Runtime/TriggerBase.cs

@@ -0,0 +1,48 @@
+using System;
+using Syntriax.Modules.State;
+using UnityEngine;
+
+namespace Syntriax.Modules.Trigger
+{
+    public class TriggerBase : MonoBehaviour, ITrigger
+    {
+        public Action<bool> OnTriggerStateChanged { get; set; } = null;
+
+        private IStateEnable _stateEnable = null;
+        public IStateEnable StateEnable
+        {
+            get
+            {
+                if (_stateEnable == null)
+                {
+                    _stateEnable = GetComponent<IStateEnable>() ?? gameObject.AddComponent<StateEnableMonoBehaviour>();
+                    _stateEnable.OnEnabledChanged += OnEnabledChanged;
+                }
+                return _stateEnable;
+            }
+        }
+
+        private void OnEnabledChanged(bool enabled)
+        {
+            if (enabled)
+                return;
+
+            _isTrigerred = false;
+            OnTriggerStateChanged?.Invoke(false);
+        }
+
+        private bool _isTrigerred = false;
+        public bool IsTrigerred
+        {
+            get => _isTrigerred;
+            protected set
+            {
+                if (value == _isTrigerred || !StateEnable.IsEnabledNullChecked())
+                    return;
+
+                _isTrigerred = value;
+                OnTriggerStateChanged?.Invoke(value);
+            }
+        }
+    }
+}

Runtime/TriggerBase.cs.meta

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

Trigger.cs

@@ -1,29 +0,0 @@
-using System;
-using UnityEngine;
-
-namespace Syntriax.Modules.Trigger
-{
-    public class Trigger : MonoBehaviour, ITrigger
-    {
-        /// <summary>
-        /// Called everytime the IsTrigerred field is changed
-        /// </summary>
-        /// <value>The new value of IsTrigerred</value>
-        public Action<bool> OnTriggered { get; set; } = null;
-
-        private bool _isTrigerred = false;
-        public bool IsTrigerred
-        {
-            get => _isTrigerred;
-            protected set
-            {
-                bool oldValue = _isTrigerred;
-
-                _isTrigerred = value;
-
-                if (oldValue != value)
-                    OnTriggered?.Invoke(value);
-            }
-        }
-    }
-}

package.json

@@ -0,0 +1,14 @@
+{
+  "name": "com.syntriax.trigger",
+  "version": "0.3.0",
+  "displayName": "Trigger Module",
+  "unity": "2019.1",
+  "documentationUrl": "https://git.syntriax.com/Syntriax/Trigger.git",
+  "dependencies": {},
+  "keywords": ["Trigger"],
+  "author": {
+    "name": "Syntriax",
+    "email": "Syntriax@gmail.com",
+    "url": "https://syntriax.com"
+  }
+}

package.json.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: e2ae9625f2d620848ac1dc03ad1d513f
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: