Improved developer description API

Author: DanielEverland

Assets/SO Architecture/DeveloperDescription.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+
+[Serializable]
+public class DeveloperDescription : IEquatable<DeveloperDescription>, IEquatable<string>
+{
+    public DeveloperDescription() { }
+    public DeveloperDescription(string value)
+    {
+        _value = value;
+    }
+
+    [SerializeField]
+    private string _value = string.Empty;
+
+    public static implicit operator string(DeveloperDescription description)
+    {
+        return description._value;
+    }
+    public static implicit operator DeveloperDescription(string value)
+    {
+        return new DeveloperDescription(value);
+    }
+    
+    public override bool Equals(object obj)
+    {
+        return _value.Equals(obj);
+    }
+    public bool Equals(DeveloperDescription other)
+    {
+        if (other == null)
+            return false;
+
+        return _value == other._value;
+    }
+    public bool Equals(string other)
+    {
+        if (other == null)
+            return false;
+
+        return _value == other;
+    }
+    public override int GetHashCode()
+    {
+        return _value.GetHashCode();
+    }
+    public override string ToString()
+    {
+        return _value;
+    }
+}

Assets/SO Architecture/Editor/Inspectors/SOArchitectureBaseObjectEditor.cs.meta renamed to Assets/SO Architecture/DeveloperDescription.cs.meta

@@ -0,0 +1,75 @@
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using UnityEditor;
+
+[CustomPropertyDrawer(typeof(DeveloperDescription))]
+public class DeveloperDescriptionDrawer : PropertyDrawer
+{
+    private SerializedProperty property;
+
+    public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+    {
+        this.property = property;
+
+        DrawTitle();
+        DrawTextArea();
+    }
+    private void DrawTitle()
+    {
+        EditorGUILayout.LabelField(new GUIContent("Description", "Click below this field to add a description"));
+    }
+    private void DrawTextArea()
+    {
+        SerializedProperty stringValue = property.FindPropertyRelative("_value");
+
+        Vector2 fieldSize = Styles.TextAreaStyle.CalcSize(new GUIContent(stringValue.stringValue));
+        Rect textAreaRect = GUILayoutUtility.GetRect(fieldSize.x, fieldSize.y);
+
+
+        EditorGUI.indentLevel++;
+
+        stringValue.stringValue = EditorGUI.TextArea(textAreaRect, stringValue.stringValue, Styles.TextAreaStyle);
+
+        EditorGUI.indentLevel--;
+
+
+        HandleInput(textAreaRect);
+    }
+    private void HandleInput(Rect textAreaRect)
+    {
+        Event e = Event.current;
+        
+        if(e.type == EventType.MouseDown)
+        {
+            if (!textAreaRect.Contains(e.mousePosition))
+                RemoveFocus();
+        }
+        else if(e.type == EventType.KeyDown || e.type == EventType.KeyUp)
+        {
+            if (Event.current.keyCode == (KeyCode.Escape))
+            {
+                RemoveFocus();
+            }
+        }
+    }
+    private void RemoveFocus()
+    {
+        GUI.FocusControl(null);
+        Repaint();
+    }
+    private void Repaint()
+    {
+        EditorUtility.SetDirty(property.serializedObject.targetObject);
+    }
+    private static class Styles
+    {
+        public static GUIStyle TextAreaStyle;
+
+        static Styles()
+        {
+            TextAreaStyle = new GUIStyle(EditorStyles.textArea);
+            TextAreaStyle.normal = EditorStyles.label.normal;
+        }
+    }
+}

Assets/SO Architecture/Editor/Drawers/DeveloperDescriptionDrawer.cs

@@ -4,7 +4,7 @@
 public abstract class BaseGameEventEditor : Editor
 {
     private IStackTraceObject Target { get { return (IStackTraceObject)target; } }
-    private SerializedProperty DeveloperDescrption { get { return serializedObject.FindProperty("DeveloperDescription"); } }
+    private SerializedProperty DeveloperDescription { get { return serializedObject.FindProperty("DeveloperDescription"); } }
 
     private StackTrace _stackTrace;
 
@@ -17,12 +17,10 @@ protected virtual void OnEnable()
     }
     public override void OnInspectorGUI()
     {
-        //EditorGUI.BeginDisabledGroup(!Application.isPlaying);
         DrawRaiseButton();
-        //EditorGUI.EndDisabledGroup();
 
         _stackTrace.Draw();
 
-        SOArchitectureBaseObjectEditor.DrawDescription(DeveloperDescrption);
+        EditorGUILayout.PropertyField(DeveloperDescription);
     }
 }

Assets/SO Architecture/Editor/Drawers/DeveloperDescriptionDrawer.cs.meta

@@ -4,7 +4,7 @@
 public abstract class BaseGameEventListenerEditor : Editor
 {
     private IStackTraceObject Target { get { return (IStackTraceObject)target; } }
-    private SerializedProperty DeveloperDescrption { get { return serializedObject.FindProperty("DeveloperDescription"); } }
+    private SerializedProperty DeveloperDescription { get { return serializedObject.FindProperty("DeveloperDescription"); } }
 
     private StackTrace _stackTrace;
     private SerializedProperty _event;
@@ -32,8 +32,8 @@ public override void OnInspectorGUI()
         DrawRaiseButton();
 
         _stackTrace.Draw();
-
-        SOArchitectureBaseObjectEditor.DrawDescription(DeveloperDescrption);
+        
+        EditorGUILayout.PropertyField(DeveloperDescription);
 
         serializedObject.ApplyModifiedProperties();
     }

Assets/SO Architecture/Editor/Inspectors/BaseGameEventEditor.cs

@@ -21,8 +21,6 @@ public override void OnInspectorGUI()
         _reorderableList.DoLayoutList();
 
         _reorderableList.serializedProperty.serializedObject.ApplyModifiedProperties();
-
-        Target.DeveloperDescription = SOArchitectureBaseObjectEditor.DrawDescription(Target.DeveloperDescription);
     }
     private void DrawElement(Rect rect, int index, bool isActive, bool isFocused)
     {

Assets/SO Architecture/Editor/Inspectors/BaseGameEventListenerEditor.cs

@@ -7,6 +7,7 @@
 public abstract class SOArchitectureBaseMonobehaviour : MonoBehaviour
 {
 #if UNITY_EDITOR
-    public string DeveloperDescription = string.Empty;
+    [SerializeField]
+    private DeveloperDescription DeveloperDescription = new DeveloperDescription();
 #endif
 }

Assets/SO Architecture/Editor/Inspectors/RuntimeSetEditor.cs

@@ -7,6 +7,7 @@
 public abstract class SOArchitectureBaseObject : ScriptableObject
 {
 #if UNITY_EDITOR
-    public string DeveloperDescription = string.Empty;
+    [SerializeField]
+    private DeveloperDescription DeveloperDescription = new DeveloperDescription();
 #endif
 }