Merge pull request #22 from Yecats/new-features

New features

Author: Yecats

.gitignore

@@ -58,3 +58,5 @@ sysinfo.txt
 # Crashlytics generated file
 crashlytics-build.properties
 
+# Release zip files
+*.zip

com.wug.behaviortreevisualizer/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this package will be documented in this file.
 
+## [0.1.3] - 10-04-2020
+
+* [#21](https://github.com/Yecats/UnityBehaviorTreeVisualizer/issues/21) You can now right click on a graph node to launch any of the scripts it represents.
+* [#18](https://github.com/Yecats/UnityBehaviorTreeVisualizer/issues/18) & [#15](https://github.com/Yecats/UnityBehaviorTreeVisualizer/issues/15) Added a hook so that you can request a redraw of the graph. Useful for dynamic trees or to add an inspector button (now included in the samples).
+* [#20](https://github.com/Yecats/UnityBehaviorTreeVisualizer/issues/20) Added a **Community Nodes** sample folder so that anyone can contribute behavior tree nodes! Also added a node - NavigateToDestination, which will take a GameObject or NavMeshAgent and position reference and handle movement.
+
 ## [0.1.2] - 9-29-2020
 
 * Fixed a bug that was causing the layout to be drawn incorrectly (no spaces between sections).

com.wug.behaviortreevisualizer/Editor/Scripts/BehaviorTreeGraphWindow.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 using UnityEditor;
 using UnityEditor.Experimental.GraphView;
@@ -43,6 +44,29 @@ public static void Init()
             Instance.rootVisualElement.styleSheets.Add(AssetDatabase.LoadAssetAtPath<StyleSheet>(c_StylePath));
         }
 
+        /// <summary>
+        /// Gives focus to the behavior tree window 
+        /// </summary>
+        /// <param name="behaviorTree"></param>
+        public static void DrawBehaviorTree(NodeBase behaviorTree, bool focusWindow)
+        {
+            // If this window is not open then nothing will be done
+            if (!HasOpenInstances<BehaviorTreeGraphWindow>())
+            {
+                return;
+            }
+
+            //focus the window if that's what is desired
+            if (focusWindow)
+            {
+                FocusWindowIfItsOpen(typeof(BehaviorTreeGraphWindow));
+            }
+            
+            //Clears any existing nodes that have been drawn and loads the tree
+            GraphView.ClearTree();
+            GraphView.LoadBehaviorTree(behaviorTree);
+        }
+
         private void OnEnable()
         {
             //Loses reference for some reason

com.wug.behaviortreevisualizer/Editor/Scripts/Graph/BTNodeData.cs

@@ -19,15 +19,15 @@ public enum DecoratorTypes
     [Serializable]
     public class BTGNodeData : GraphView.Node
     {
-        public string Id;
-        public Vector2 Position;
-        public bool EntryPoint;
-        public FullNodeInfo MainNodeDetails;
-        private List<FullNodeInfo> m_DecoratorData;
+        public string Id { get; private set; }
+        public Vector2 Position { get; private set; }
+        public bool EntryPoint { get; private set; }
+        public FullNodeInfo MainNodeDetails { get; private set; }
+        public List<FullNodeInfo> DecoratorData { get; private set; }
 
-        public GraphView.Port ParentPort;
+        public GraphView.Port ParentPort { get; private set; }
 
-        public GraphView.Port InputPort;
+        public GraphView.Port InputPort { get; private set; }
         public List<GraphView.Port> OutputPorts = new List<GraphView.Port>();
 
         private VisualElement m_NodeBorder;
@@ -42,7 +42,7 @@ public class BTGNodeData : GraphView.Node
         public BTGNodeData(FullNodeInfo mainNodeDetails, bool entryPoint, GraphView.Port parentPort, List<FullNodeInfo> decoratorData)
         {
             MainNodeDetails = mainNodeDetails;
-            m_DecoratorData = decoratorData;
+            DecoratorData = decoratorData;
             MainNodeDetails.RunTimeNode.NodeStatusChanged += OnNodeStatusChanged;
 
             title = MainNodeDetails.RunTimeNode.Name == null || MainNodeDetails.RunTimeNode.Name.Equals("") ? MainNodeDetails.RunTimeNode.GetType().Name : MainNodeDetails.RunTimeNode.Name;
@@ -74,9 +74,9 @@ public BTGNodeData(FullNodeInfo mainNodeDetails, bool entryPoint, GraphView.Port
             m_NodeTopMessageDecorator = GenerateStatusMessageLabel();
 
             //Add the decorator icon
-            if (m_DecoratorData != null)
+            if (DecoratorData != null)
             {
-                foreach (var decorator in m_DecoratorData)
+                foreach (var decorator in DecoratorData)
                 {
                     decorator.RunTimeNode.NodeStatusChanged += OnNodeStatusChanged;
 
@@ -96,9 +96,9 @@ public BTGNodeData(FullNodeInfo mainNodeDetails, bool entryPoint, GraphView.Port
             //Do an initial call to setup the style of the node in the event that it's already been running (pretty likely)
             OnNodeStatusChanged(MainNodeDetails.RunTimeNode);
 
-            if (m_DecoratorData != null)
+            if (DecoratorData != null)
             {
-                m_DecoratorData.ForEach(x => OnNodeStatusChanged(x.RunTimeNode));
+                DecoratorData.ForEach(x => OnNodeStatusChanged(x.RunTimeNode));
             }
 
         }

com.wug.behaviortreevisualizer/Editor/Scripts/Graph/BehaviorTreeGraphView.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
 using UnityEditor;
@@ -49,6 +50,52 @@ public BehaviorTreeGraphView()
 
         }
 
+        public override void BuildContextualMenu(ContextualMenuPopulateEvent evt)
+        {
+            base.BuildContextualMenu(evt);
+
+            if (evt.target is BTGNodeData)
+            {
+                BTGNodeData nodeData = (evt.target as BTGNodeData);
+
+                int countOfItems = 1;
+
+                for (int i = 0; i < nodeData.DecoratorData.Count; i++)
+                {
+                    var name = nodeData.DecoratorData[0].RunTimeNode.GetType().Name;
+
+                    evt.menu.InsertAction(0, $"Open {name}", (e) => { OpenFile($"{name}.cs"); });
+                    
+                    countOfItems++;
+                }
+
+                string nodeName = nodeData.MainNodeDetails.RunTimeNode.GetType().Name;
+                evt.menu.InsertAction(0, $"Open {nodeName}", (e) => { OpenFile($"{nodeName}.cs"); });
+
+                evt.menu.InsertSeparator("", countOfItems);
+            }
+        }
+
+        /// <summary>
+        /// Open a file at a specified location
+        /// </summary>
+        /// <param name="className">Class name with extension</param>
+        private void OpenFile(string className)
+        {
+
+            string[] res = Directory.GetFiles(Application.dataPath, className, SearchOption.AllDirectories);
+
+            if (res.Length == 0)
+            {
+                $"Unable to locate script path. Please file a bug at https://github.com/Yecats/UnityBehaviorTreeVisualizer".BTDebugLog();
+                return;
+            }
+
+            string path = res[0].Replace("\\", "/");
+
+            UnityEditorInternal.InternalEditorUtility.OpenFileAtLineExternal(path, 1, 0);
+        }
+
         public void ClearTree()
         {
             m_Nodes.ForEach(x => x.parent.Remove(x));
@@ -120,7 +167,7 @@ public void DrawNodes(bool entryPoint, NodeBase currentNode, int columnIndex, Po
 
                 if (currentNode.ChildNodes.Count == 0)
                 {
-                    $"Decorator ({currentNode.GetType().Name}) does not have any children. Nothing will be drawn".BTDebugLog();
+                    $"Decorator ({currentNode.GetType().Name}) does not have any children. Nothing will be drawn.".BTDebugLog();
                 }
                 else
                 {

com.wug.behaviortreevisualizer/Samples~/Community Nodes/Navigation/NavigateToDestination.cs

@@ -0,0 +1,106 @@
+using System;
+using UnityEngine;
+using UnityEngine.AI;
+
+namespace WUG.BehaviorTreeVisualizer.CommunityNodes
+{
+    [Serializable]
+    public class NavigateToDestination : Node
+    {
+        private Func<Vector3> m_DestinationCalculation;
+        private Vector3 m_TargetDestination = Vector3.zero;
+        private NavMeshAgent m_NavMeshAgent;
+        private float m_MaxDistanceToSample = 1f;
+
+        /// <summary>
+        /// Navigate a game object to a specific location using Unity's Navigation. 
+        /// Behavior will get a SamplePosition within 1 meter of the destination to ensure that the location
+        /// provided can be navigated.
+        /// </summary>
+        /// <param name="navMeshAgent">NavMesh on the game object that will be moved</param>
+        /// <param name="destination">Function that can be used to calculate the target destination. Must return a Vector3. </param>
+        /// <param name="maxDistance">Max distance that NavMesh.SamplePosition should check for</param>
+        public NavigateToDestination(NavMeshAgent navMeshAgent, Func<Vector3> destination, float maxDistance = 1f)
+        {
+            Name = "Navigate";
+            m_NavMeshAgent = navMeshAgent;
+            m_DestinationCalculation = destination;
+            m_MaxDistanceToSample = maxDistance;
+        }
+
+        /// <summary>
+        /// Navigate a game object to a specific location using Unity's Navigation. 
+        /// Behavior will get a SamplePosition within 1f of the destination to ensure that the location
+        /// provided can be navigated.
+        /// </summary>
+        /// <param name="gameObject">Game object that will be moved. Must have a NavMeshAgent on it</param>
+        /// <param name="destination">Function that can be used to calculate the target destination. Must return a Vector3. </param>
+        /// <param name="maxDistance">Max distance that NavMesh.SamplePosition should check for</param>
+        public NavigateToDestination(GameObject gameObject, Func<Vector3> destination, float maxDistance = 1f)
+        {
+            Name = "Navigate";
+            m_NavMeshAgent = gameObject.GetComponent<NavMeshAgent>();
+            m_DestinationCalculation = destination;
+            m_MaxDistanceToSample = maxDistance;
+        }
+
+
+        protected override void OnReset() { }
+
+        protected override NodeStatus OnRun()
+        {
+            //Make sure that a reference to NavMeshAgent and a valid destination exists
+            if (m_NavMeshAgent == null)
+            {
+                StatusReason = "NavMeshAgent is null";
+                return NodeStatus.Failure;
+            }
+
+            //First Evaluation will get the official target destination and set it on the NavMeshAgent
+            if (IsFirstEvaluation)
+            {
+                if (m_DestinationCalculation() == null)
+                {
+                    StatusReason = "Unable to calculate a destination position. Did you pass a function in?";
+                    return NodeStatus.Failure;
+                }
+
+                m_TargetDestination = m_DestinationCalculation();
+
+                if (m_TargetDestination  == Vector3.zero)
+                {
+                    StatusReason = "Unable to calculate a destination position. Does the function return a position?";
+                    return NodeStatus.Failure;
+                }
+
+                NavMesh.SamplePosition(m_TargetDestination, out NavMeshHit hit, m_MaxDistanceToSample, 1);
+                m_TargetDestination = hit.position;
+
+                m_NavMeshAgent.SetDestination(m_TargetDestination);
+                StatusReason = $"Starting to navigate to {m_TargetDestination}";
+
+                return NodeStatus.Running;
+            }
+
+            //Evaluate the remaining distance
+            float distanceToTarget = Vector3.Distance(m_TargetDestination, m_NavMeshAgent.transform.position);
+
+            //Reached the destination
+            if (distanceToTarget < .25f)
+            {
+                StatusReason = $"Navigation ended. " +
+                    $"\n - Evaluation Count: {EvaluationCount}. " +
+                    $"\n - Target Destination: {m_TargetDestination}" +
+                    $"\n - Distance to target: {Math.Round(distanceToTarget, 1)}";
+
+                return NodeStatus.Success;
+            }
+
+            //Still moving
+            StatusReason = $"Distance to target: {distanceToTarget}";
+            return NodeStatus.Running;
+
+        }
+    }
+}
+

com.wug.behaviortreevisualizer/Samples~/Community Nodes/README.md

@@ -0,0 +1,13 @@
+
+# Community Nodes
+The goal of the Behavior Tree Visualizer tool is to make writing and debugging AI easier for all! To help with this, our hope is to facilitate a repository of Nodes that interact with various elements of Unity. A full list of the nodes can be found [here](https://github.com/Yecats/UnityBehaviorTreeVisualizer/wiki/Community-Nodes).
+
+## Contribute
+Want to contribute a new community node or fix a bug? You can submit a pull request on the GitHub repository at https://github.com/Yecats/UnityBehaviorTreeVisualizer/. A few things to note:
+
+1. Nodes should be in the **com.wug.behaviortreevisualizer\Samples~\Community Nodes** folder with a sub category folder (i.e. "Navigation").
+2. All community nodes must build off the **Standard Nodes** sample project. In other words, if you are creating a new **Decorator**, make sure it inherits from the `Decorator` node. 
+3. Documentation, documentation, documentation! Make sure to add comments to explain what your node is doing, parameters that need to be passed, etc.
+
+## Get Help
+If you encounter an issue with a community node, please reach out on GitHub and log an issue at https://github.com/Yecats/UnityBehaviorTreeVisualizer/issues or submit a pull request with the fix. 

com.wug.behaviortreevisualizer/Samples~/NPC Sample 2019.4/Scripts/Editor/NonplayerCharacterEditor.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using UnityEditor;
+using UnityEngine;
+using WUG.BehaviorTreeVisualizer;
+
+namespace Assets.Samples.Behavior_Tree_Visualizer__Beta_._0._1._2.NPC_Behavior_Tree___2019._4.Scripts.Editor
+{
+    [CustomEditor(typeof(NonPlayerCharacter))]
+    public class NonplayerCharacterEditor : UnityEditor.Editor
+    {
+        private NonPlayerCharacter m_NPC;
+
+        private void OnEnable()
+        {
+            m_NPC = target as NonPlayerCharacter;
+
+            EditorApplication.update += RedrawView;
+        }
+
+        void RedrawView()
+        {
+            Repaint();
+        }
+
+        public override void OnInspectorGUI()
+        {
+            DrawDefaultInspector();
+
+            if (GUILayout.Button("Draw Behavior Tree"))
+            {
+                m_NPC.ForceDrawingOfTree();
+            }
+        }
+    }
+}

com.wug.behaviortreevisualizer/Samples~/NPC Sample 2019.4/Scripts/NonPlayerCharacter.cs

@@ -80,5 +80,15 @@ private void GenerateBehaviorTree()
                                         new Idle()),
                                     new SetNavigationActivityTo(NavigationActivity.PickupItem)));
         }
+
+        public void ForceDrawingOfTree()
+        {
+            if (BehaviorTree == null)
+            {
+                $"Behavior tree is null - nothing to draw.".BTDebugLog();
+            }
+
+            BehaviorTreeGraphWindow.DrawBehaviorTree(BehaviorTree, true);
+        }        
     }
 }

com.wug.behaviortreevisualizer/Samples~/NPC Sample 2020.1/Scripts/Editor/NonplayerCharacterEditor.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using UnityEditor;
+using UnityEngine;
+using WUG.BehaviorTreeVisualizer;
+
+namespace Assets.Samples.Behavior_Tree_Visualizer__Beta_._0._1._2.NPC_Behavior_Tree___2019._4.Scripts.Editor
+{
+    [CustomEditor(typeof(NonPlayerCharacter))]
+    public class NonplayerCharacterEditor : UnityEditor.Editor
+    {
+        private NonPlayerCharacter m_NPC;
+
+        private void OnEnable()
+        {
+            m_NPC = target as NonPlayerCharacter;
+
+            EditorApplication.update += RedrawView;
+        }
+
+        void RedrawView()
+        {
+            Repaint();
+        }
+
+        public override void OnInspectorGUI()
+        {
+            DrawDefaultInspector();
+
+            if (GUILayout.Button("Draw Behavior Tree"))
+            {
+                m_NPC.ForceDrawingOfTree();
+            }
+        }
+    }
+}