More documentation

Author: CoffeeVampir3

BehaviourGraph/BehaviourGraph.cs

@@ -18,6 +18,11 @@ public class BehaviourGraph : NodeGraph, ISerializationCallbackReceiver
  [SerializeField]
  internal BaseNode root = null;
 
+ /// <summary>
+ /// Generates an executable behaviour tree from this behaviour graph.
+ /// </summary>
+ /// <param name="executingOn">Which object to create the tree for</param>
+ /// <returns>A behaviour tree for the input game object.</returns>
  public BehaviourTree.BehaviourTree GenerateBehaviourTree(GameObject executingOn)
  {
  var cloneTree = new BehaviourTree.BehaviourTree(executingOn);

BehaviourTree/BehaviourTree.cs

@@ -12,7 +12,7 @@ public partial class BehaviourTree
  internal GameObject owner;
  private TreeBaseNode root;
  internal ContextWalker contextWalker;
-
+ 
  public BehaviourTree(GameObject owner)
  {
  this.owner = owner;
@@ -26,6 +26,9 @@ internal void RuntimeSetup(TreeBaseNode newRoot, GameObject owningObject)
  contextWalker.SetContextPointer(newRoot.context);
  }
 
+ /// <summary>
+ /// Performs an evaluation of the behaviour tree.
+ /// </summary>
  public void Evaluate()
  {
  ExecuteTree();

Examples/ThingyController.cs

@@ -33,11 +33,12 @@ public class ThingyController : MonoBehaviour
  private float chaseRadius = 150;
 
  private float currentRadius;
- WaitForEndOfFrame cachedWait = new WaitForEndOfFrame();
 
  private void Awake()
  {
+ /*This is the only important line of code*/
  tree = graph.GenerateBehaviourTree(gameObject);
+
  speed = Random.Range(.5f*speed, 1.5f*speed);
  chaseSpeed = Random.Range(.5f*chaseSpeed, 1.5f*chaseSpeed);
 
@@ -49,6 +50,7 @@ private void Awake()
 
  public void Update()
  {
+ /*This one is slightly important as well... It runs the tree code. Sorta important.*/
  tree.Evaluate();
  }