Merge pull request #9 from AkiKurisu/dev_blackboard_component

Dev blackboard component
AkiKurisu · Jul 7, 2024 · 1644ed9 · 1644ed9
2 parents 345f33b + 39b9ca5
commit 1644ed9
Show file tree

Hide file tree

Showing 22 changed files with 481 additions and 255 deletions.
diff --git a/Editor/Core/Editor/BehaviorTreeEditor.cs b/Editor/Core/Editor/BehaviorTreeEditor.cs
@@ -27,7 +27,11 @@ public override VisualElement CreateInspectorGUI()
             myInspector.Add(field);
             if (instance.SharedVariables.Count(x => x.IsExposed) != 0)
             {
-                myInspector.Add(new SharedVariablesFoldout(instance, target, this));
+                myInspector.Add(new SharedVariablesFoldout(instance.BlackBoard, () =>
+                {
+                    tree.SetBehaviorTreeData(instance.GetData());
+                    EditorUtility.SetDirty(target);
+                }));
             }
             myInspector.Add(new BehaviorTreeDebugButton(tree));
             return myInspector;
@@ -58,7 +62,11 @@ public override VisualElement CreateInspectorGUI()
             myInspector.Add(description);
             if (instance.SharedVariables.Count(x => x.IsExposed) != 0)
             {
-                myInspector.Add(new SharedVariablesFoldout(instance, target, this));
+                myInspector.Add(new SharedVariablesFoldout(instance.BlackBoard, () =>
+                {
+                    tree.SetBehaviorTreeData(instance.GetData());
+                    EditorUtility.SetDirty(target);
+                }));
             }
             myInspector.Add(new BehaviorTreeDebugButton(tree));
             return myInspector;

diff --git a/Editor/Core/Editor/BlackBoardComponentEditor.cs b/Editor/Core/Editor/BlackBoardComponentEditor.cs
@@ -0,0 +1,35 @@
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+namespace Kurisu.AkiBT.Editor
+{
+    [CustomEditor(typeof(BlackBoardComponent))]
+    public class BlackBoardComponentEditor : UnityEditor.Editor
+    {
+        private AdvancedBlackBoardController controller;
+        public override VisualElement CreateInspectorGUI()
+        {
+            var source = target as BlackBoardComponent;
+            var bb = source.GetBlackBoard();
+            var myInspector = new VisualElement();
+            myInspector.style.flexDirection = FlexDirection.Column;
+            controller = new AdvancedBlackBoardController(bb,
+             new AdvancedBlackBoard.BlackBoardSettings()
+             {
+                 showIsExposed = true,
+                 showIsGlobalToggle = true,
+             },
+             () =>
+             {
+                 // commit to component
+                 source.SetBlackBoardVariables(controller.SharedVariables);
+                 EditorUtility.SetDirty(source);
+                 AssetDatabase.SaveAssets();
+             });
+            myInspector.Add(controller.GetBlackBoard());
+            if (Application.isPlaying) return myInspector;
+            myInspector.RegisterCallback<DetachFromPanelEvent>(_ => controller.UpdateIfDirty());
+            return myInspector;
+        }
+    }
+}
diff --git a/Editor/Core/Editor/BlackBoardComponentEditor.cs.meta b/Editor/Core/Editor/BlackBoardComponentEditor.cs.meta
diff --git a/Editor/Core/Editor/GameVariableScopeEditor.cs b/Editor/Core/Editor/GameVariableScopeEditor.cs
@@ -1,100 +1,55 @@
 using UnityEditor;
 using UnityEngine.UIElements;
 using UnityEditor.UIElements;
-using UnityEditor.Experimental.GraphView;
 using UnityEngine;
-using System.Collections.Generic;
 namespace Kurisu.AkiBT.Editor
 {
-    internal class VirtualGraphView : GraphView { }
-    internal class VariableSourceProxy : IVariableSource
-    {
-        public List<SharedVariable> SharedVariables { get; } = new();
-        private readonly IVariableSource source;
-        private readonly Object dirtyObject;
-        public VariableSourceProxy(IVariableSource source, Object dirtyObject)
-        {
-            this.source = source;
-            this.dirtyObject = dirtyObject;
-        }
-        public void Update()
-        {
-            source.SharedVariables.Clear();
-            source.SharedVariables.AddRange(SharedVariables);
-            EditorUtility.SetDirty(dirtyObject);
-            AssetDatabase.SaveAssets();
-        }
-    }
     [CustomEditor(typeof(GameVariableScope))]
     public class GameVariableScopeEditor : UnityEditor.Editor
     {
-        private bool isDirty;
         public override VisualElement CreateInspectorGUI()
         {
             var source = target as GameVariableScope;
             var myInspector = new VisualElement();
             myInspector.style.flexDirection = FlexDirection.Column;
-            var proxy = new VariableSourceProxy(source, source);
-            //Need attached to a virtual graphView to send event
-            //It's an interesting hack so that you can use blackBoard outside of graphView
-            var blackBoard = new AdvancedBlackBoard(proxy, new VirtualGraphView()) { AlwaysExposed = true };
-            foreach (var variable in source.SharedVariables)
+            var controller = new AdvancedBlackBoardController(source,
+            new AdvancedBlackBoard.BlackBoardSettings()
             {
-                //In play mode, use original variable to observe value change
-                if (Application.isPlaying)
-                {
-                    blackBoard.AddSharedVariable(variable);
-                }
-                else
-                {
-                    blackBoard.AddSharedVariable(variable.Clone());
-                }
-            }
-            blackBoard.style.position = Position.Relative;
-            blackBoard.style.width = Length.Percent(100f);
-            myInspector.Add(blackBoard);
-
+                autoExposed = true
+            },
+             () =>
+            {
+                EditorUtility.SetDirty(source);
+                AssetDatabase.SaveAssets();
+            });
+            myInspector.Add(controller.GetBlackBoard());
             if (Application.isPlaying) return myInspector;
-
-            myInspector.RegisterCallback<DetachFromPanelEvent>(_ => { if (isDirty) proxy.Update(); });
-            blackBoard.RegisterCallback<VariableChangeEvent>(_ => isDirty = true);
+            myInspector.RegisterCallback<DetachFromPanelEvent>(_ => controller.UpdateIfDirty());
             myInspector.Add(new PropertyField(serializedObject.FindProperty("parentScope"), "Parent Scope"));
             return myInspector;
         }
     }
     [CustomEditor(typeof(SceneVariableScope))]
     public class SceneVariableScopeEditor : UnityEditor.Editor
     {
-        private bool isDirty;
         public override VisualElement CreateInspectorGUI()
         {
             var source = target as SceneVariableScope;
             var myInspector = new VisualElement();
             myInspector.style.flexDirection = FlexDirection.Column;
-            var proxy = new VariableSourceProxy(source, source);
-            //Need attached to a virtual graphView to send event
-            //It's an interesting hack so that you can use blackBoard outside of graphView
-            var blackBoard = new AdvancedBlackBoard(proxy, new VirtualGraphView()) { AlwaysExposed = true };
-            foreach (var variable in source.SharedVariables)
+            var controller = new AdvancedBlackBoardController(source,
+            new AdvancedBlackBoard.BlackBoardSettings()
+            {
+                autoExposed = true
+            },
+            () =>
             {
-                //In play mode, use original variable to observe value change
-                if (Application.isPlaying)
-                {
-                    blackBoard.AddSharedVariable(variable);
-                }
-                else
-                {
-                    blackBoard.AddSharedVariable(variable.Clone());
-                }
-            }
-            blackBoard.style.position = Position.Relative;
-            blackBoard.style.width = Length.Percent(100f);
-            myInspector.Add(blackBoard);
-
+                EditorUtility.SetDirty(source);
+                AssetDatabase.SaveAssets();
+            });
+            myInspector.Add(controller.GetBlackBoard());
             if (Application.isPlaying) return myInspector;
-
-            myInspector.RegisterCallback<DetachFromPanelEvent>(_ => { if (isDirty) proxy.Update(); });
-            blackBoard.RegisterCallback<VariableChangeEvent>(_ => isDirty = true);
+            myInspector.RegisterCallback<DetachFromPanelEvent>(_ => controller.UpdateIfDirty());
             myInspector.Add(new PropertyField(serializedObject.FindProperty("parentScope"), "Parent Scope"));
             return myInspector;
         }

diff --git a/Editor/Core/GraphView/AdvancedBlackBoard.cs b/Editor/Core/GraphView/AdvancedBlackBoard.cs
@@ -11,15 +11,31 @@ namespace Kurisu.AkiBT.Editor
 {
     public class AdvancedBlackBoard : Blackboard, IBlackBoard
     {
+        public struct BlackBoardSettings
+        {
+            /// <summary>
+            /// Show IsExposed toggle for shared variable
+            /// </summary>
+            public bool showIsExposed;
+            /// <summary>
+            /// Automatically set IsExposed for variables
+            /// </summary>
+            public bool autoExposed;
+            /// <summary>
+            /// Show IsGlobal toggle for shared variable
+            /// </summary>
+            public bool showIsGlobalToggle;
+        }
         public Blackboard View => this;
-        public bool AlwaysExposed { get; set; }
+        public BlackBoardSettings settings;
         private readonly FieldResolverFactory fieldResolverFactory = FieldResolverFactory.Instance;
         private readonly ScrollView scrollView;
         public VisualElement RawContainer => scrollView;
         private readonly List<SharedVariable> sharedVariables;
-        private readonly HashSet<ObserveProxyVariable> observeProxies = new();
-        public AdvancedBlackBoard(IVariableSource variableSource, GraphView graphView) : base(graphView)
+        private readonly HashSet<ObservableVariable> observeProxies = new();
+        public AdvancedBlackBoard(IVariableSource variableSource, GraphView graphView, BlackBoardSettings settings = default) : base(graphView)
         {
+            this.settings = settings;
             var header = this.Q("header");
             header.style.height = new StyleLength(50);
             Add(scrollView = new());
@@ -94,7 +110,7 @@ public void AddSharedVariable(SharedVariable variable)
                 localPropertyName = $"{variable.Name}{index++}";
             }
             variable.Name = localPropertyName;
-            if (AlwaysExposed) variable.IsExposed = true;
+            if (settings.autoExposed) variable.IsExposed = true;
             sharedVariables.Add(variable);
             var container = new VisualElement();
             var field = new BlackboardField { text = localPropertyName, typeText = variable.GetType().Name };
@@ -128,7 +144,7 @@ public void AddSharedVariable(SharedVariable variable)
                 }
             }
             var placeHolder = new VisualElement();
-            if (!AlwaysExposed)
+            if (settings.showIsExposed)
             {
                 var toggle = new Toggle("Exposed")
                 {
@@ -149,6 +165,27 @@ public void AddSharedVariable(SharedVariable variable)
                 }
                 placeHolder.Add(toggle);
             }
+            if (settings.showIsGlobalToggle)
+            {
+                var toggle = new Toggle("Global")
+                {
+                    value = variable.IsGlobal
+                };
+                if (Application.isPlaying)
+                {
+                    toggle.SetEnabled(false);
+                }
+                else
+                {
+                    toggle.RegisterValueChangedCallback(x =>
+                    {
+                        var index = sharedVariables.FindIndex(x => x.Name == variable.Name);
+                        sharedVariables[index].IsGlobal = x.newValue;
+                        NotifyVariableChanged(variable, VariableChangeType.ValueChange);
+                    });
+                }
+                placeHolder.Add(toggle);
+            }
             placeHolder.Add(valueField);
             if (variable is SharedObject sharedObject)
             {

diff --git a/Editor/Core/GraphView/AdvancedBlackBoardController.cs b/Editor/Core/GraphView/AdvancedBlackBoardController.cs
@@ -0,0 +1,53 @@
+using UnityEngine.UIElements;
+using UnityEditor.Experimental.GraphView;
+using UnityEngine;
+using System.Collections.Generic;
+namespace Kurisu.AkiBT.Editor
+{
+    internal class AdvancedBlackBoardController : IVariableSource
+    {
+        private class VirtualGraphView : GraphView { }
+        private readonly AdvancedBlackBoard blackBoard;
+        public List<SharedVariable> SharedVariables { get; } = new();
+        private readonly IVariableSource source;
+        private bool isDirty;
+        private readonly System.Action onUpdate;
+        public AdvancedBlackBoardController(IVariableSource source, AdvancedBlackBoard.BlackBoardSettings settings = default, System.Action onUpdate = null)
+        {
+            this.source = source;
+            this.onUpdate = onUpdate;
+            //Need attached to a virtual graphView to send event
+            //It's an interesting hack so that you can use blackBoard outside of graphView
+            blackBoard = new AdvancedBlackBoard(this, new VirtualGraphView(), settings);
+            blackBoard.style.position = Position.Relative;
+            blackBoard.style.width = Length.Percent(100f);
+            foreach (var variable in source.SharedVariables)
+            {
+                if (Application.isPlaying)
+                {
+                    blackBoard.AddSharedVariable(variable);
+                }
+                else
+                {
+                    blackBoard.AddSharedVariable(variable.Clone());
+                }
+            }
+            blackBoard.RegisterCallback<VariableChangeEvent>(_ => isDirty = true);
+        }
+        public AdvancedBlackBoard GetBlackBoard() => blackBoard;
+        public void Update()
+        {
+            source.SharedVariables.Clear();
+            source.SharedVariables.AddRange(SharedVariables);
+            onUpdate?.Invoke();
+        }
+        public void UpdateIfDirty()
+        {
+            if (isDirty)
+            {
+                Update();
+                isDirty = false;
+            }
+        }
+    }
+}
diff --git a/Editor/Core/GraphView/AdvancedBlackBoardController.cs.meta b/Editor/Core/GraphView/AdvancedBlackBoardController.cs.meta
diff --git a/Editor/Core/GraphView/BehaviorTreeView.cs b/Editor/Core/GraphView/BehaviorTreeView.cs
@@ -66,7 +66,11 @@ private void RegisterSerializationCallBack()
         }
         private void AddBlackBoard()
         {
-            var blackboard = new AdvancedBlackBoard(this, View);
+            var blackboard = new AdvancedBlackBoard(this, View, new AdvancedBlackBoard.BlackBoardSettings()
+            {
+                showIsExposed = true,
+                showIsGlobalToggle = true,
+            });
             blackboard.SetPosition(new Rect(10, 100, 300, 400));
             Add(blackboard);
             BlackBoard = blackboard;