Inspector improvements (#15)

* Remove game event null checks on enable and disable. Expose listener enumerable. Draw a list of references to event listeners on events. Implement editor for all built-in event types.

* Update changelog

* Add tests for expose Listeners field

* Update readme

* Fix changelog order

* Fixup changelog, copy over readme

* Make resetting more flexible, update version

* Update package doc

* Update docs

* Flip assert args

Author: Edvinas01

CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2020-10-10
+
+### Added
+- List of references to event listeners on game events will be drawn during play mode.
+- Exposed listener enumerable.
+- Editors for all built-in game event types.
+- More tests!
+
+### Changed
+- `Persisting` flag was changed to `ResetType` enum which allows more customization.
+
+### Removed
+- Game event null checks on enable and disable.
+
 ## [0.6.0] - 2020-10-07
 
 ### Changed

Documentation~/README.md

@@ -41,7 +41,11 @@ Available mutable objects:
 - `MutableVector2` - encapsulates a `Vector2` value.
 - `MutableVector3` - encapsulates a `Vector3` value.
 
-If a mutable object value should be saved between scene loads, check the `Persisting` flag on the `MutableObject` asset.
+Each mutable object has a `ResetType` property. This allows specifying when data in the mutable object should be reset. The following modes are available:
+- `None` - do not reset.
+- `ActiveSceneChange` - when the active (focused) scene changes.
+- `SceneUnloaded` - when the current scene gets unloaded.
+- `SceneLoaded` - when the scene is loaded.
 
 ### Custom game events
 In some situations, built-in game events might not suffice. For example if a custom type needs to be passed as an argument to the event. In this case, custom game event can be created which would carry all the necessary data.
@@ -70,6 +74,21 @@ public class CustomGameEventListener : ArgumentGameEventListener<CustomGameEvent
 }
 ```
 
+Optionally add a custom editor so that the event could be raised, and the listeners which reference the event get displayed in the inspector.
+```cs
+[CustomEditor(typeof(CustomGameEvent))]
+public class GameObjectGameEventEditor : ArgumentGameEventEditor<CustomGameEvent, Custom>
+{
+    protected override Custom DrawArgumentField(Custom value)
+    {
+        var fieldValue = EditorGUILayout
+            .ObjectField(value, typeof(Custom), true);
+
+        return fieldValue as Custom;
+    }
+}
+```
+
 ### Custom mutable objects
 In some cases, littering the script code with loads of `MutableObject` references can be inconvenient. To avoid this, a single object can be used which encompasses multiple fields.
 
@@ -95,7 +114,6 @@ public class MutableCustom : MutableObject
 
     // This will set property values when mutable object is enabled or if the values change in the
     // inspector.
-    // This is also called when MutableObjectExtensions.ResetMutatedObjects() is invoked.
     public override void ResetValues()
     {
         Health = health;

Editor/GameEvents/Game/GameEventEditor.cs

@@ -24,6 +24,14 @@ public override void OnInspectorGUI()
             GUILayout.Space(GroupSpacingPixels);
 
             DrawRaise(gameEvent);
+
+            if (!Application.isPlaying)
+            {
+                return;
+            }
+
+            GUILayout.Space(GroupSpacingPixels);
+            DrawListeners(gameEvent);
         }
 
         private static void DrawRaise(IGameEvent gameEvent)
@@ -34,5 +42,17 @@ private static void DrawRaise(IGameEvent gameEvent)
                 gameEvent.RaiseGameEvent();
             }
         }
+
+        private static void DrawListeners(IGameEvent gameEvent)
+        {
+            GUILayout.Label("Listeners");
+            foreach (var listener in gameEvent.Listeners)
+            {
+                if (listener is MonoBehaviour behaviour)
+                {
+                    EditorGUILayout.ObjectField(behaviour, typeof(Object), true);
+                }
+            }
+        }
     }
 }

Editor/GameEvents/GameObject.meta

@@ -0,0 +1,18 @@
+using GameEvents.Generic;
+using UnityEditor;
+
+namespace GameEvents.GameObject
+{
+    [CustomEditor(typeof(GameObjectGameEvent))]
+    public class GameObjectGameEventEditor
+        : ArgumentGameEventEditor<GameObjectGameEvent, UnityEngine.GameObject>
+    {
+        protected override UnityEngine.GameObject DrawArgumentField(UnityEngine.GameObject value)
+        {
+            var fieldValue = EditorGUILayout
+                .ObjectField(value, typeof(UnityEngine.GameObject), true);
+
+            return fieldValue as UnityEngine.GameObject;
+        }
+    }
+}

Editor/GameEvents/GameObject/GameObjectGameEventEditor.cs

@@ -24,6 +24,14 @@ public override void OnInspectorGUI()
             GUILayout.Space(GroupSpacingPixels);
 
             DrawRaise(gameEvent);
+
+            if (!Application.isPlaying)
+            {
+                return;
+            }
+
+            GUILayout.Space(GroupSpacingPixels);
+            DrawListeners(gameEvent);
         }
 
         private void DrawRaise(TGameEvent gameEvent)
@@ -40,6 +48,18 @@ private void DrawRaise(TGameEvent gameEvent)
             GUILayout.EndHorizontal();
         }
 
+        private static void DrawListeners(TGameEvent gameEvent)
+        {
+            GUILayout.Label("Listeners");
+            foreach (var listener in gameEvent.Listeners)
+            {
+                if (listener is MonoBehaviour behaviour)
+                {
+                    EditorGUILayout.ObjectField(behaviour, typeof(Object), true);
+                }
+            }
+        }
+
         /// <returns>
         ///     Value that is entered in the argument field.
         /// </returns>

Editor/GameEvents/GameObject/GameObjectGameEventEditor.cs.meta

@@ -0,0 +1,18 @@
+using GameEvents.Generic;
+using UnityEditor;
+
+namespace GameEvents.Transform
+{
+    [CustomEditor(typeof(TransformGameEvent))]
+    public class TransformGameEventEditor
+        : ArgumentGameEventEditor<TransformGameEvent, UnityEngine.Transform>
+    {
+        protected override UnityEngine.Transform DrawArgumentField(UnityEngine.Transform value)
+        {
+            var fieldValue = EditorGUILayout
+                .ObjectField(value, typeof(UnityEngine.Transform), true);
+
+            return fieldValue as UnityEngine.Transform;
+        }
+    }
+}