Finished conversion to Rx on behaviors

Author: MystikalPooka

Assets/Scripts/AI/BehaviorTreeElement.cs

@@ -9,21 +9,10 @@
 namespace Assets.Scripts.AI
 {
     [Serializable]
-    public class BehaviorTreeElement : TreeElement
+    public class BehaviorTreeElement : TreeElement, IDisposable
     {
-        private string _ElementType;
-        public string ElementType
-        {
-            get
-            {
-                return _ElementType;
-            }
-
-            set
-            {
-                _ElementType = value;
-            }
-        }
+        protected static readonly UniRx.Diagnostics.Logger BehaviorLogger = new UniRx.Diagnostics.Logger("Behavior Debugger");
+        public string ElementType { get; set; }
 
         [Newtonsoft.Json.JsonIgnore]
         [SerializeField]
@@ -72,7 +61,9 @@ public virtual void Initialize()
             foreach(var ch in allChildrenToRun)
             {
                 //TODO: will be changed to an actual debugger instead of just unity logs. Issue #3
-                ch.ObserveEveryValueChanged(x => x.CurrentState).Subscribe(x => Debug.Log(ElementType + " state changed: " + x));
+                ch.ObserveEveryValueChanged(x => x.CurrentState)
+                    .Subscribe(x => BehaviorLogger.Log(ElementType + " state changed: " + x))
+                    .AddTo(Disposables);
             }
 
             Initialized = true;
@@ -103,5 +94,37 @@ public override string ToString()
             return retString;
 
         }
+
+        #region IDisposable Support
+
+        // CompositeDisposable is similar with List<IDisposable>, manage multiple IDisposable
+        protected CompositeDisposable Disposables = new CompositeDisposable(); // field
+        private bool disposedValue = false; // To detect redundant calls
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    Disposables.Clear();
+                }
+
+                // TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
+                // TODO: set large fields to null.
+                Children.Clear();
+                Children = null;
+
+                disposedValue = true;
+            }
+        }
+
+        // This code added to correctly implement the disposable pattern.
+        public void Dispose()
+        {
+            // Do not change this code. Put cleanup code in Dispose(bool disposing) above.
+            Dispose(true);
+        }
+        #endregion
     }
 }

Assets/Scripts/AI/Components/BehaviorComponent.cs

@@ -17,8 +17,6 @@ public BehaviorComponent(string name, int depth, int id)
         public virtual void AddChild(BehaviorTreeElement element)
         {
             element.Parent = this;
-
-            element.BehaviorTreeManager = BehaviorTreeManager;
             Children.Add(element);
         }
     }

Assets/Scripts/AI/Components/ParallelRunner.cs

@@ -9,10 +9,10 @@
 namespace Assets.Scripts.AI.Components
 {
     [Serializable]
-    [Description("Runs all children at the same time.")]
+    [Description("Runs all children at same time. Fails if NumFailures are >0 and children failed reach that number. Succeeds otherwise.")]
     public class ParallelRunner : BehaviorComponent
     {
-        private static readonly UniRx.Diagnostics.Logger logger = new UniRx.Diagnostics.Logger("RunnerDebug");
+       
         /// <summary>
         /// Number of times the children return fail before the parallel runner returns in a fail state.
         /// 0 means ignore number of failures.
@@ -37,16 +37,16 @@ public override IEnumerator Tick(WaitForSeconds delayStart = null)
             //Initialize and start tick
             base.Tick(delayStart).ToObservable().Subscribe(xb => Debug.Log("Subscribed to ParallelRunner at start (base.tick()"));
             CurrentState = (BehaviorState.Running);
-            if (Children == null || Children.Count <= 0)
+            if (Children == null || Children.Count == 0)
             {
                 Debug.LogWarning("Children Null in parallel runner");
-                CurrentState = (BehaviorState.Null);
+                CurrentState = (BehaviorState.Fail);
                 yield break;
             }
 
             foreach(var ch in Children)
             {
-                ((BehaviorTreeElement)ch).Tick().ToObservable().Debug().Subscribe(_ =>
+                ((BehaviorTreeElement)ch).Tick().ToObservable().Subscribe(_ =>
                 {
                     Debug.Log("parallel? Num Succeed: " + NumberOfSuccesses.Value);
                     Debug.Log("parallel? Num Fail: " + NumberOfFailures.Value);
@@ -63,6 +63,7 @@ public override IEnumerator Tick(WaitForSeconds delayStart = null)
                     }
                 });
             }
+            CurrentState = BehaviorState.Success;
         }
 
         public override void Initialize()
@@ -77,8 +78,7 @@ public override void Initialize()
                 //TODO: will be changed to an actual debugger instead of just unity logs. Issue #3
                 ch.ObserveEveryValueChanged(x => x.CurrentState).Subscribe(x =>
                 {
-                    
-                    logger.Warning(ElementType + " state changed: " + x);
+                    BehaviorLogger.Warning(ElementType + " state changed: " + x);
                     if (x == BehaviorState.Fail)
                     {
                         NumberOfFailures.SetValueAndForceNotify(NumberOfFailures.Value + 1);
@@ -87,7 +87,7 @@ public override void Initialize()
                     {
                         NumberOfSuccesses.SetValueAndForceNotify(NumberOfSuccesses.Value + 1);
                     }
-                });
+                }).AddTo(Disposables);
             }
 
             Initialized = true;

Assets/Scripts/AI/Components/Selector.cs

@@ -12,7 +12,7 @@ namespace Assets.Scripts.AI.Components
     /// Returns and is in success state if a child was successful, otherwise returns in fail state
     /// </summary>
     [Serializable]
-    [Description("Runs children in order. Succeeds on first child that succeeds.")]
+    [Description("Runs children in order. Succeeds on first child that succeeds. Fails if no children succeed.")]
     public class Selector : BehaviorComponent
     {
         public Selector(string name, int depth, int id) 
@@ -36,7 +36,6 @@ public override IEnumerator Tick(WaitForSeconds delayStart = null)
                         return;
                     }
                 });
-
             }
             //if it gets here, it went through all subbehaviors and had no successes
             CurrentState = BehaviorState.Fail;

Assets/Scripts/AI/Components/Sequencer.cs

@@ -1,4 +1,6 @@
 using System.Collections;
+using System.ComponentModel;
+using UniRx;
 using UnityEngine;
 
 namespace Assets.Scripts.AI.Components
@@ -7,6 +9,7 @@ namespace Assets.Scripts.AI.Components
     /// Runs until a child returns in a fail state
     /// </summary>
     [System.Serializable]
+    [Description("Continually runs children in sequence until a child fails. Succeeds if no children fail. Fails if any child fails.")]
     public class Sequencer : BehaviorComponent
     {
         public Sequencer(string name, int depth, int id) 
@@ -17,23 +20,21 @@ public Sequencer(string name, int depth, int id)
         public override IEnumerator Tick(WaitForSeconds delayStart = null)
         {
             yield return delayStart;
-            CurrentState = BehaviorState.Running;
+            CurrentState = (BehaviorState.Running);
             foreach (BehaviorTreeElement behavior in Children)
             {
-                yield return BehaviorTreeManager.StartCoroutine(behavior.Tick());
+                if (CurrentState != BehaviorState.Running) yield break;
 
-                if (behavior.CurrentState != BehaviorState.Success)
+                yield return behavior.Tick().ToObservable().Subscribe(_ =>
                 {
-                    this.CurrentState = behavior.CurrentState;
-
-                    if (this.CurrentState == BehaviorState.Fail)
+                    if (behavior.CurrentState == BehaviorState.Fail)
                     {
-                        //This selector has completed, break out of the operation
-                        yield break;
+                        this.CurrentState = BehaviorState.Fail;
+                        return;
                     }
-                }
+                }).AddTo(Disposables);
             }
-            //if it gets here, it went through all subbehaviors and had no fails
+            //if it gets here, it went through all subbehaviors and had no failures
             CurrentState = BehaviorState.Success;
             yield break;
         }

Assets/Scripts/AI/Decorators/Inverter.cs

@@ -13,7 +13,7 @@ public Inverter(string name, int depth, int id)
 
         public override IEnumerator Tick(WaitForSeconds delayStart = null)
         {
-            base.Tick(delayStart).ToObservable().Subscribe(xb => Debug.Log("Subscribed to ParallelRunner at start (base.tick()"));
+            base.Tick(delayStart).ToObservable().Subscribe(xb => Debug.Log("OnNext Inverter at start (base.tick()"));
 
             CurrentState = BehaviorState.Null;
             if (Children == null) yield return null;
@@ -38,7 +38,7 @@ public override IEnumerator Tick(WaitForSeconds delayStart = null)
                         Debug.LogError("Something went wrong in an inverter.");
                         break;
                 }
-            });
+            }).AddTo(Disposables);
         }
     }
 }