Merge pull request #3 from AkiKurisu/dev-1.4.4

Merge dev
AkiKurisu · Jun 8, 2024 · 7fee665 · 7fee665
2 parents fe34111 + 77b7907
commit 7fee665
Show file tree

Hide file tree

Showing 251 changed files with 1,017 additions and 842 deletions.
diff --git a/Docs.meta b/Docs.meta
diff --git a/Images.meta → Docs/Images.meta b/Images.meta → Docs/Images.meta
diff --git a/Images/AkiGroup.png → Docs/Images/AkiGroup.png b/Images/AkiGroup.png → Docs/Images/AkiGroup.png
diff --git a/Images/AkiGroup.png.meta → Docs/Images/AkiGroup.png.meta b/Images/AkiGroup.png.meta → Docs/Images/AkiGroup.png.meta
diff --git a/Images/AkiLabel.png → Docs/Images/AkiLabel.png b/Images/AkiLabel.png → Docs/Images/AkiLabel.png
diff --git a/Images/AkiLabel.png.meta → Docs/Images/AkiLabel.png.meta b/Images/AkiLabel.png.meta → Docs/Images/AkiLabel.png.meta
diff --git a/Images/ChangeVariableInInspector.png → Docs/Images/ChangeVariableInInspector.png b/Images/ChangeVariableInInspector.png → Docs/Images/ChangeVariableInInspector.png
diff --git a/Images/ChangeVariableInInspector.png.meta → ...Images/ChangeVariableInInspector.png.meta b/Images/ChangeVariableInInspector.png.meta → ...Images/ChangeVariableInInspector.png.meta
diff --git a/Images/CompositeStack.gif → Docs/Images/CompositeStack.gif b/Images/CompositeStack.gif → Docs/Images/CompositeStack.gif
diff --git a/Images/CompositeStack.gif.meta → Docs/Images/CompositeStack.gif.meta b/Images/CompositeStack.gif.meta → Docs/Images/CompositeStack.gif.meta
diff --git a/Images/DebugVariable.png → Docs/Images/DebugVariable.png b/Images/DebugVariable.png → Docs/Images/DebugVariable.png
diff --git a/Images/DebugVariable.png.meta → Docs/Images/DebugVariable.png.meta b/Images/DebugVariable.png.meta → Docs/Images/DebugVariable.png.meta
diff --git a/Images/DragDrop.gif → Docs/Images/DragDrop.gif b/Images/DragDrop.gif → Docs/Images/DragDrop.gif
diff --git a/Images/DragDrop.gif.meta → Docs/Images/DragDrop.gif.meta b/Images/DragDrop.gif.meta → Docs/Images/DragDrop.gif.meta
diff --git a/Images/External.png → Docs/Images/External.png b/Images/External.png → Docs/Images/External.png
diff --git a/Images/External.png.meta → Docs/Images/External.png.meta b/Images/External.png.meta → Docs/Images/External.png.meta
diff --git a/Images/GameScope.png → Docs/Images/GameScope.png b/Images/GameScope.png → Docs/Images/GameScope.png
diff --git a/Images/GameScope.png.meta → Docs/Images/GameScope.png.meta b/Images/GameScope.png.meta → Docs/Images/GameScope.png.meta
diff --git a/Images/InfoAttribute.png → Docs/Images/InfoAttribute.png b/Images/InfoAttribute.png → Docs/Images/InfoAttribute.png
diff --git a/Images/InfoAttribute.png.meta → Docs/Images/InfoAttribute.png.meta b/Images/InfoAttribute.png.meta → Docs/Images/InfoAttribute.png.meta
diff --git a/Images/OpenSO.png → Docs/Images/OpenSO.png b/Images/OpenSO.png → Docs/Images/OpenSO.png
diff --git a/Images/OpenSO.png.meta → Docs/Images/OpenSO.png.meta b/Images/OpenSO.png.meta → Docs/Images/OpenSO.png.meta
diff --git a/Images/Operator.png → Docs/Images/Operator.png b/Images/Operator.png → Docs/Images/Operator.png
diff --git a/Images/Operator.png.meta → Docs/Images/Operator.png.meta b/Images/Operator.png.meta → Docs/Images/Operator.png.meta
diff --git a/Images/ReferenceVariable.png → Docs/Images/ReferenceVariable.png b/Images/ReferenceVariable.png → Docs/Images/ReferenceVariable.png
diff --git a/Images/ReferenceVariable.png.meta → Docs/Images/ReferenceVariable.png.meta b/Images/ReferenceVariable.png.meta → Docs/Images/ReferenceVariable.png.meta
diff --git a/Images/SceneScope.png → Docs/Images/SceneScope.png b/Images/SceneScope.png → Docs/Images/SceneScope.png
diff --git a/Images/SceneScope.png.meta → Docs/Images/SceneScope.png.meta b/Images/SceneScope.png.meta → Docs/Images/SceneScope.png.meta
diff --git a/Images/SerializeService.png → Docs/Images/SerializeService.png b/Images/SerializeService.png → Docs/Images/SerializeService.png
diff --git a/Images/SerializeService.png.meta → Docs/Images/SerializeService.png.meta b/Images/SerializeService.png.meta → Docs/Images/SerializeService.png.meta
diff --git a/Images/SetGlobal.png → Docs/Images/SetGlobal.png b/Images/SetGlobal.png → Docs/Images/SetGlobal.png
diff --git a/Images/SetGlobal.png.meta → Docs/Images/SetGlobal.png.meta b/Images/SetGlobal.png.meta → Docs/Images/SetGlobal.png.meta
diff --git a/Images/Setting.png → Docs/Images/Setting.png b/Images/Setting.png → Docs/Images/Setting.png
diff --git a/Images/Setting.png.meta → Docs/Images/Setting.png.meta b/Images/Setting.png.meta → Docs/Images/Setting.png.meta
diff --git a/Images/SharedObject.png → Docs/Images/SharedObject.png b/Images/SharedObject.png → Docs/Images/SharedObject.png
diff --git a/Images/SharedObject.png.meta → Docs/Images/SharedObject.png.meta b/Images/SharedObject.png.meta → Docs/Images/SharedObject.png.meta
diff --git a/Images/SharedVariable.png → Docs/Images/SharedVariable.png b/Images/SharedVariable.png → Docs/Images/SharedVariable.png
diff --git a/Images/SharedVariable.png.meta → Docs/Images/SharedVariable.png.meta b/Images/SharedVariable.png.meta → Docs/Images/SharedVariable.png.meta
diff --git a/Images/SubCategories.png → Docs/Images/SubCategories.png b/Images/SubCategories.png → Docs/Images/SubCategories.png
diff --git a/Images/SubCategories.png.meta → Docs/Images/SubCategories.png.meta b/Images/SubCategories.png.meta → Docs/Images/SubCategories.png.meta
diff --git a/Images/conditional1.jpg → Docs/Images/conditional1.jpg b/Images/conditional1.jpg → Docs/Images/conditional1.jpg
diff --git a/Images/conditional1.jpg.meta → Docs/Images/conditional1.jpg.meta b/Images/conditional1.jpg.meta → Docs/Images/conditional1.jpg.meta
diff --git a/Images/conditional2.jpg → Docs/Images/conditional2.jpg b/Images/conditional2.jpg → Docs/Images/conditional2.jpg
diff --git a/Images/conditional2.jpg.meta → Docs/Images/conditional2.jpg.meta b/Images/conditional2.jpg.meta → Docs/Images/conditional2.jpg.meta
diff --git a/Images/demo.jpg → Docs/Images/demo.jpg b/Images/demo.jpg → Docs/Images/demo.jpg
diff --git a/Images/demo.jpg.meta → Docs/Images/demo.jpg.meta b/Images/demo.jpg.meta → Docs/Images/demo.jpg.meta
diff --git a/Images/started1.png → Docs/Images/started1.png b/Images/started1.png → Docs/Images/started1.png
diff --git a/Images/started1.png.meta → Docs/Images/started1.png.meta b/Images/started1.png.meta → Docs/Images/started1.png.meta
diff --git a/Images/started2.gif → Docs/Images/started2.gif b/Images/started2.gif → Docs/Images/started2.gif
diff --git a/Images/started2.gif.meta → Docs/Images/started2.gif.meta b/Images/started2.gif.meta → Docs/Images/started2.gif.meta
diff --git a/Images/started3.png → Docs/Images/started3.png b/Images/started3.png → Docs/Images/started3.png
diff --git a/Images/started3.png.meta → Docs/Images/started3.png.meta b/Images/started3.png.meta → Docs/Images/started3.png.meta
diff --git a/Images/started4.png → Docs/Images/started4.png b/Images/started4.png → Docs/Images/started4.png
diff --git a/Images/started4.png.meta → Docs/Images/started4.png.meta b/Images/started4.png.meta → Docs/Images/started4.png.meta
diff --git a/Docs/editor-extensions.md b/Docs/editor-extensions.md
@@ -0,0 +1,78 @@
+<div align="center">
+
+# Editor Extensions
+
+This document contains notice for extending and customizing Editor.
+
+</div>
+
+## How to change font
+
+For visual effects such as fonts, colors, layout, etc, you can change the uss style file in `BehaviorTreeSetting`.
+
+## How to customize node
+
+For many reason, you may want to customize node like adding a button to preview effect.
+
+You can write an editor class to provide your node which is similar to customize `Editor` in `UnityEditor`.
+
+```C#
+[Ordered]
+public class SampleResolver : INodeResolver
+{
+    //Create custom node
+    public IBehaviorTreeNode CreateNodeInstance(Type type)
+    {
+        return new SampleNode();
+    }
+    //Identify node type
+    public static bool IsAcceptable(Type behaviorType) => behaviorType == typeof(SampleClass);
+
+    //Your custom node
+    private class SampleNode : ActionNode
+    {
+    }
+}
+```
+
+## How to customize field
+
+Since AkiBT use GraphView as frontend which is powered by UIElement, it can not support all fields.
+
+If you want to customize field or want to support some fields AkiBT currently not support (eg. `UnityEngine.Localization.LocalizedString`), you can write an editor class to provide your field which is similar to customize `PropertyDrawer` in `UnityEditor`.
+
+```C#
+[Ordered]
+public class LocalizedStringResolver : FieldResolver<LocalizedStringField,LocalizedString>
+{
+    public LocalizedStringResolver(FieldInfo fieldInfo) : base(fieldInfo)
+    {
+    }
+    protected override LocalizedStringField CreateEditorField(FieldInfo fieldInfo)
+    {
+        return new LocalizedStringField(fieldInfo.Name);
+    }
+    public static bool IsAcceptable(Type infoType, FieldInfo _) => infoType == typeof(LocalizedString);
+
+}
+public class LocalizedStringField : BaseField<LocalizedString>
+{
+
+}
+```
+
+## How to use IMGUI in graph editor
+
+If you don't want to use ui element, you can notify the field with `WarpFieldAttribute` to let editor use IMGUI as field's frontend.
+
+```C#
+public class EventAction : Action
+{
+    [WarpField]
+    public UnityEvent myEvent;
+}
+```
+
+## How to customize graph editor
+
+TODO
diff --git a/README_EN.md.meta → Docs/editor-extensions.md.meta b/README_EN.md.meta → Docs/editor-extensions.md.meta
diff --git a/API.md → Docs/runtime-extensions.md b/API.md → Docs/runtime-extensions.md
@@ -1,33 +1,17 @@
-# API
+<div align="center">
+
+# Runtime Extensions
+
+This document contains notice for using and extending nodes, SharedVariables and attributes.
+
+</div>
+
   - [Behavior Node Type](#behavior-node-type)
   - [Built In Composite Node](#built-in-composite-node)
-    - [Sequence](#sequence)
-    - [Selector](#selector)
-    - [Parallel](#parallel)
-    - [Random](#random)
-    - [Rotator](#rotator)
   - [Create New Behaviors](#create-new-behaviors)
-    - [Create Action](#create-action)
-    - [Create Conditional](#create-conditional)
-    - [Create Composite](#create-composite)
-    - [Create Decorator](#create-decorator)
   - [Attributes](#attributes)
-    - [AkiInfoAttribute](#akiinfoattribute)
-    - [AkiLabelAttribute](#akilabelattribute)
-    - [AkiGroupAttribute](#akigroupattribute)
-    - [ForceSharedAttribute](#forcesharedattribute)
-    - [WrapFieldAttribute](#wrapfieldattribute)
-  - [Runtime Build BehaviorTree](#runtime-build-behaviortree)
+  - [BehaviorTree Builder](#behaviortree-builder)
   - [SharedVariable](#sharedvariable)
-    - [How to use](#how-to-use)
-    - [API Reference](#api-reference)
-  - [Editor Extend](#editor-extend)
-    - [How to change font](#how-to-change-font)
-    - [How to customize node](#how-to-customize-node)
-    - [How to customize field](#how-to-customize-field)
-    - [How to use IMGUI in Graph Editor](#how-to-use-imgui-in-graph-editor)
-
-
 
 ## Behavior Node Type
 
@@ -38,9 +22,6 @@
 | Conditional Node | It has one child node and check the condition whether child is updatable. when having no child, Conditional Node is the leaf node like Action Node. |
 | Decorator Node   | It has one child node and will modify the return value according to the return value of the child node                                              |
 
-| Name              | Description                                                               |
-| ----------------- | ------------------------------------------------------------------------- |
-| evaluateOnRunning | true : evaluate the condition if the previous status is `Status.Running`. |
 
 ## Built In Composite Node
 
@@ -138,7 +119,11 @@ public class Wait : Action
 * Override `OnAwake` called by `AkiBT.BehaviorTree.Awake` if needed.
 * Override `OnStart` called by `AkiBT.BehaviorTree.Start` if needed.
 * Conditional Node has `gameObject` field with `AkiBT.BehaviorTree` attached.
-* Private [SerializeField] field and public field can be set on Behavior Tree editor window.
+* Private `[SerializeField]` field and public field can be set on Behavior Tree editor window.
+
+| Name              | Description                                                               |
+| ----------------- | ------------------------------------------------------------------------- |
+| evaluateOnRunning | true : evaluate the condition if the previous status is `Status.Running`. |
 
 ```c#
 public class IsHateGt: Conditional
@@ -329,16 +314,17 @@ public class SetFloat : Action
 }
 ```
 
-## Runtime Build BehaviorTree
+## BehaviorTree Builder
 
 Use `BehaviorTreeBuilder` to build a behaviorTree on the builder pattern.
 
 Use `BeginChild` to start writing child or children.
 
 Use `EndChild` to end writing.
 
-Example:
+Use `New{VariableType}` to get a reference of SharedVariable, if not exist before, it will create new one.
 ```C#
+    // Example code 
     var builder = new BehaviorTreeBuilder(gameObject);
     //Create and set value of local variable
     builder.NewObject<NavMeshAgent>("NavAgent",navmeshAgent);
@@ -411,64 +397,4 @@ Example:
     | GetValue | Get variable value              |
     | Bind     | Bind to other sharedVariable    |
     | Unbind   | Unbind self                     |
-    | Observe  | Create a observe proxy variable |
-
-## Editor Extend
-
-### How to change font
-
-For visual effects such as fonts, colors, layout, etc, you can change the uss style file in `BehaviorTreeSetting`.
-
-### How to customize node
-
-For many reason, you may want to customize node like adding a button to preview effect.
-
-You can write an editor class to provide your node which is similar to customize `Editor` in `UnityEditor`.
-```C#
-[Ordered]
-public class SampleResolver : INodeResolver
-{
-    //Create custom node
-    public IBehaviorTreeNode CreateNodeInstance(Type type)
-    {
-        return new SampleNode();
-    }
-    //Identify node type
-    public static bool IsAcceptable(Type behaviorType) => behaviorType == typeof(SampleClass);
-
-    //Your custom node
-    private class SampleNode : ActionNode
-    {
-    }
-}
-```
-
-### How to customize field
-
-Since AkiBT use GraphView as frontend which is powered by UIElement, it can not support all fields.
-
-If you want to customize field or want to support some fields AkiBT currently not support (eg. Array), you can write an editor class to provide your field which is similar to customize `PropertyDrawer` in `UnityEditor`.
-
-```C#
-[Ordered]
-public class LocalizedStringResolver : FieldResolver<LocalizedStringField,LocalizedString>
-{
-    public LocalizedStringResolver(FieldInfo fieldInfo) : base(fieldInfo)
-    {
-    }
-    protected override LocalizedStringField CreateEditorField(FieldInfo fieldInfo)
-    {
-        return new LocalizedStringField(fieldInfo.Name);
-    }
-    public static bool IsAcceptable(Type infoType, FieldInfo _) => infoType == typeof(LocalizedString);
-
-}
-public class LocalizedStringField : BaseField<LocalizedString>
-{
-
-}
-```
-
-### How to use IMGUI in Graph Editor
-
-If you don't want to use ui element, you can notify the field with `WarpFieldAttribute` to let editor use IMGUI as field's frontend.
+    | Observe  | Create an observe proxy variable |
diff --git a/API.md.meta → Docs/runtime-extensions.md.meta b/API.md.meta → Docs/runtime-extensions.md.meta
diff --git a/Editor/Core/Editor/BehaviorTreeDebugButton.cs b/Editor/Core/Editor/BehaviorTreeDebugButton.cs
@@ -0,0 +1,26 @@
+using UnityEngine;
+using UnityEngine.UIElements;
+namespace Kurisu.AkiBT.Editor
+{
+    internal class BehaviorTreeDebugButton : Button
+    {
+        private const string ButtonText = "Edit BehaviorTree";
+        private const string DebugText = "Debug BehaviorTree";
+        public BehaviorTreeDebugButton(IBehaviorTree tree) : base(() => GraphEditorWindow.Show(tree))
+        {
+            style.fontSize = 15;
+            style.unityFontStyleAndWeight = FontStyle.Bold;
+            style.color = Color.white;
+            if (!Application.isPlaying)
+            {
+                style.backgroundColor = new StyleColor(new Color(140 / 255f, 160 / 255f, 250 / 255f));
+                text = ButtonText;
+            }
+            else
+            {
+                text = DebugText;
+                style.backgroundColor = new StyleColor(new Color(253 / 255f, 163 / 255f, 255 / 255f));
+            }
+        }
+    }
+}
diff --git a/Editor/Core/Editor/BehaviorTreeDebugButton.cs.meta b/Editor/Core/Editor/BehaviorTreeDebugButton.cs.meta
diff --git a/Editor/Core/Editor/BehaviorTreeEditor.cs b/Editor/Core/Editor/BehaviorTreeEditor.cs
@@ -8,13 +8,11 @@ namespace Kurisu.AkiBT.Editor
     [CustomEditor(typeof(BehaviorTree))]
     public class BehaviorTreeEditor : UnityEditor.Editor
     {
-        private const string LabelText = "AkiBT BehaviorTree <size=12>V1.4.3</size>";
-        private const string ButtonText = "Edit BehaviorTree";
-        private const string DebugText = "Debug BehaviorTree";
-        private IBehaviorTree Tree => target as IBehaviorTree;
+        private static readonly string LabelText = $"AkiBT BehaviorTree <size=12>{BehaviorTreeSetting.Version}</size>";
         public override VisualElement CreateInspectorGUI()
         {
             var myInspector = new VisualElement();
+            var tree = target as IBehaviorTree;
             var label = new Label(LabelText);
             label.style.fontSize = 20;
             label.style.unityTextAlign = TextAnchor.MiddleCenter;
@@ -25,58 +23,40 @@ public override VisualElement CreateInspectorGUI()
             var field = new PropertyField(serializedObject.FindProperty("externalBehaviorTree"), "External BehaviorTree");
             field.SetEnabled(!Application.isPlaying);
             myInspector.Add(field);
-            if (Tree.SharedVariables.Count(x => x.IsExposed) != 0)
+            if (tree.SharedVariables.Count(x => x.IsExposed) != 0)
             {
-                myInspector.Add(new SharedVariablesFoldout(Tree, target, this));
+                myInspector.Add(new SharedVariablesFoldout(tree, target, this));
             }
-            var button = BehaviorTreeEditorUtility.GetButton(() => { GraphEditorWindow.Show(Tree); });
-            if (!Application.isPlaying)
-            {
-                button.style.backgroundColor = new StyleColor(new Color(140 / 255f, 160 / 255f, 250 / 255f));
-                button.text = ButtonText;
-            }
-            else
-            {
-                button.text = DebugText;
-                button.style.backgroundColor = new StyleColor(new Color(253 / 255f, 163 / 255f, 255 / 255f));
-            }
-            myInspector.Add(button);
+            myInspector.Add(new BehaviorTreeDebugButton(tree));
             return myInspector;
         }
     }
     [CustomEditor(typeof(BehaviorTreeSO))]
     public class BehaviorTreeSOEditor : UnityEditor.Editor
     {
-        private IBehaviorTree Tree => target as IBehaviorTree;
-        private const string LabelText = "AkiBT BehaviorTreeSO <size=12>V1.4.3</size>";
-        private const string ButtonText = "Edit BehaviorTreeSO";
-        private const string DebugText = "Debug BehaviorTreeSO";
+        private static readonly string LabelText = $"AkiBT BehaviorTreeSO <size=12>{BehaviorTreeSetting.Version}</size>";
         public override VisualElement CreateInspectorGUI()
         {
             var myInspector = new VisualElement();
+            var tree = target as IBehaviorTree;
             var label = new Label(LabelText);
             label.style.fontSize = 20;
             label.style.unityTextAlign = TextAnchor.MiddleCenter;
             myInspector.Add(label);
             myInspector.styleSheets.Add(BehaviorTreeSetting.GetInspectorStyle("AkiBT"));
-            var description = new PropertyField(serializedObject.FindProperty("Description"), string.Empty);
-            myInspector.Add(description);
-            if (Tree.SharedVariables.Count(x => x.IsExposed) != 0)
+            myInspector.Add(new Label("Editor Description"));
+            var description = new TextField(string.Empty)
             {
-                myInspector.Add(new SharedVariablesFoldout(Tree, target, this));
-            }
-            var button = BehaviorTreeEditorUtility.GetButton(() => { GraphEditorWindow.Show(Tree); });
-            if (!Application.isPlaying)
-            {
-                button.style.backgroundColor = new StyleColor(new Color(140 / 255f, 160 / 255f, 250 / 255f));
-                button.text = ButtonText;
-            }
-            else
+                multiline = true
+            };
+            description.style.minHeight = 60;
+            description.BindProperty(serializedObject.FindProperty("description"));
+            myInspector.Add(description);
+            if (tree.SharedVariables.Count(x => x.IsExposed) != 0)
             {
-                button.text = DebugText;
-                button.style.backgroundColor = new StyleColor(new Color(253 / 255f, 163 / 255f, 255 / 255f));
+                myInspector.Add(new SharedVariablesFoldout(tree, target, this));
             }
-            myInspector.Add(button);
+            myInspector.Add(new BehaviorTreeDebugButton(tree));
             return myInspector;
         }
     }