@woosh/meep-engine 2.36.26 → 2.36.29

package/engine/intelligence/behavior/Behavior.js

@@ -1,55 +1,74 @@
 import { BehaviorStatus } from "./BehaviorStatus.js";
-import { assert } from "../../../core/assert.js";
 
+/**
+ * Base class of behavior tree implementation
+ */
 export class Behavior {
     constructor() {
         /**
-         *
+         * Any internal state used by the behavior
          * @type {*}
          */
         this.context = null;
+    }
 
-        /**
-         *
-         * @type {BehaviorStatus}
-         * @protected
-         */
-        this.__status = BehaviorStatus.Initial;
+    /**
+     * @deprecated
+     * @private
+     * @returns {BehaviorStatus}
+     */
+    get __status() {
+        throw new Error('Deprecated');
     }
 
     /**
-     *
+     * @deprecated
+     * @param {BehaviorStatus} v
+     * @private
+     */
+    set __status(v) {
+        throw new Error('Deprecated');
+    }
+
+    /**
+     * @deprecated
      * @returns {BehaviorStatus}
      */
     getStatus() {
-        return this.__status;
+        throw new Error('Deprecated');
     }
 
     /**
-     * NOTE: Be careful when setting this directly, make sure that finalization and initialization are handled properly
+     * @deprecated
      * @param {BehaviorStatus} s
      */
     setStatus(s) {
-        assert.ok(Object.values(BehaviorStatus).includes(s), `'${s}' is not a valid BehaviorStatus`);
-
-        this.__status = s;
+        throw new Error('Deprecated');
     }
 
     /**
-     * @param {number} timeDelta
+     * Main update function
+     * @param {number} timeDelta time step in seconds
      * @returns {BehaviorStatus}
      */
     tick(timeDelta) {
         throw new Error('Abstract method, needs to be overridden');
     }
 
+    /**
+     * Called before behavior gets executed via {@link #tick} for the first time
+     * Used to prepare the behavior for execution
+     * @param {*} [context]
+     */
     initialize(context) {
         this.context = context;
-        this.__status = BehaviorStatus.Running;
     }
 
+    /**
+     * Called when behavior is finished, or interrupted
+     * Used to clean up any resources
+     */
     finalize() {
-        this.__status = BehaviorStatus.Initial;
     }
 }
 

package/engine/intelligence/behavior/SelectorBehavior.js

@@ -21,20 +21,23 @@ export class SelectorBehavior extends CompositeBehavior {
     }
 
     tick(timeDelta) {
+        if (this.__children.length < 1) {
+            // no options, nothing chosen
+            return BehaviorStatus.Failed;
+        }
+
         //keep going until a child behavior says it's running
-        for (;;) {
+        for (; ;) {
             const s = this.__currentBehaviour.tick(timeDelta);
 
             //if child succeeds or keeps running, do the same
             if (s !== BehaviorStatus.Failed) {
-                this.__status = s;
                 return s;
             }
 
             //Continue search for a fallback until the last child
             const children = this.__children;
             if (this.__currentBehaviourIndex + 1 >= children.length) {
-                this.__status = BehaviorStatus.Failed;
                 return BehaviorStatus.Failed;
             }
 
@@ -48,7 +51,5 @@ export class SelectorBehavior extends CompositeBehavior {
         this.__currentBehaviour = this.__children[0];
 
         this.__currentBehaviour.initialize();
-
-        this.__status = BehaviorStatus.Running;
     }
 }

package/engine/intelligence/behavior/composite/ParallelBehavior.js

@@ -1,7 +1,6 @@
 import { CompositeBehavior } from "./CompositeBehavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
 import { BitSet } from "../../../../core/binary/BitSet.js";
-import { ObjectBasedClassSerializationAdapter } from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
 
 /**
  *
@@ -122,7 +121,6 @@ export class ParallelBehavior extends CompositeBehavior {
 
                     this.__finalizeActiveChildren();
 
-                    this.__status = BehaviorStatus.Succeeded;
                     return BehaviorStatus.Succeeded;
 
                 }
@@ -138,14 +136,12 @@ export class ParallelBehavior extends CompositeBehavior {
 
                     this.__finalizeActiveChildren();
 
-                    this.__status = BehaviorStatus.Failed;
                     return BehaviorStatus.Failed;
 
                 } else if (this.successPolicy === ParallelBehaviorPolicy.RequireAll) {
 
                     this.__finalizeActiveChildren();
 
-                    this.__status = BehaviorStatus.Failed;
                     return BehaviorStatus.Failed;
 
                 }
@@ -155,22 +151,18 @@ export class ParallelBehavior extends CompositeBehavior {
 
         if (this.successCount === numChildren && this.successPolicy === ParallelBehaviorPolicy.RequireAll) {
 
-            this.__status = BehaviorStatus.Succeeded;
             return BehaviorStatus.Succeeded;
 
         } else if (this.failureCount === numChildren && this.failurePolicy === ParallelBehaviorPolicy.RequireAll) {
 
-            this.__status = BehaviorStatus.Failed;
             return BehaviorStatus.Failed;
 
         } else if ((this.failureCount + this.successCount) === numChildren) {
 
-            this.__status = BehaviorStatus.Failed;
             return BehaviorStatus.Failed;
 
         } else {
 
-            this.__status = BehaviorStatus.Running;
             return BehaviorStatus.Running;
 
         }
@@ -236,61 +228,3 @@ export class ParallelBehavior extends CompositeBehavior {
 
 ParallelBehavior.typeName = "ParallelBehavior";
 
-export class ParallelBehaviorSerializationAdapter extends ObjectBasedClassSerializationAdapter {
-    constructor() {
-        super();
-
-        this.klass = ParallelBehavior;
-        this.version = 0;
-    }
-
-    /**
-     *
-     * @param {BinaryBuffer} buffer
-     * @param {ParallelBehavior} value
-     */
-    serialize(buffer, value) {
-
-        buffer.writeUint8(value.getSuccessPolicy());
-        buffer.writeUint8(value.getFailurePolicy());
-
-        const children = value.getChildren();
-
-        const n = children.length;
-
-        buffer.writeUintVar(n);
-
-        for (let i = 0; i < n; i++) {
-            const behavior = children[i];
-
-            this.objectAdapter.serialize(buffer, behavior);
-        }
-    }
-
-    /**
-     *
-     * @param {BinaryBuffer} buffer
-     * @param {ParallelBehavior} value
-     */
-    deserialize(buffer, value) {
-        const successPolicy = buffer.readUint8();
-        const failurePolicy = buffer.readUint8();
-
-        const count = buffer.readUintVar();
-
-        value.clearChildren();
-
-        for (let i = 0; i < count; i++) {
-            /**
-             *
-             * @type {Behavior}
-             */
-            const child = this.objectAdapter.deserialize(buffer);
-
-            value.addChild(child);
-        }
-
-        value.setFailurePolicy(failurePolicy);
-        value.setSuccessPolicy(successPolicy);
-    }
-}

package/engine/intelligence/behavior/composite/ParallelBehaviorSerializationAdapter.js

@@ -0,0 +1,63 @@
+import {
+    ObjectBasedClassSerializationAdapter
+} from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
+import { ParallelBehavior } from "./ParallelBehavior.js";
+
+export class ParallelBehaviorSerializationAdapter extends ObjectBasedClassSerializationAdapter {
+    constructor() {
+        super();
+
+        this.klass = ParallelBehavior;
+        this.version = 0;
+    }
+
+    /**
+     *
+     * @param {BinaryBuffer} buffer
+     * @param {ParallelBehavior} value
+     */
+    serialize(buffer, value) {
+
+        buffer.writeUint8(value.getSuccessPolicy());
+        buffer.writeUint8(value.getFailurePolicy());
+
+        const children = value.getChildren();
+
+        const n = children.length;
+
+        buffer.writeUintVar(n);
+
+        for (let i = 0; i < n; i++) {
+            const behavior = children[i];
+
+            this.objectAdapter.serialize(buffer, behavior);
+        }
+    }
+
+    /**
+     *
+     * @param {BinaryBuffer} buffer
+     * @param {ParallelBehavior} value
+     */
+    deserialize(buffer, value) {
+        const successPolicy = buffer.readUint8();
+        const failurePolicy = buffer.readUint8();
+
+        const count = buffer.readUintVar();
+
+        value.clearChildren();
+
+        for (let i = 0; i < count; i++) {
+            /**
+             *
+             * @type {Behavior}
+             */
+            const child = this.objectAdapter.deserialize(buffer);
+
+            value.addChild(child);
+        }
+
+        value.setFailurePolicy(failurePolicy);
+        value.setSuccessPolicy(successPolicy);
+    }
+}

package/engine/intelligence/behavior/composite/SequenceBehavior.js

@@ -1,7 +1,10 @@
 import { Behavior } from "../Behavior.js";
 import { CompositeBehavior } from "./CompositeBehavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
-import { ObjectBasedClassSerializationAdapter } from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
+import {
+    ObjectBasedClassSerializationAdapter
+} from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
+import { assert } from "../../../../core/assert.js";
 
 export class SequenceBehavior extends CompositeBehavior {
     constructor() {
@@ -13,6 +16,12 @@ export class SequenceBehavior extends CompositeBehavior {
          * @protected
          */
         this.__currentBehaviourIndex = -1;
+        /**
+         *
+         * @type {BehaviorStatus|number}
+         * @private
+         */
+        this.__currentBehaviourState = BehaviorStatus.Initial;
 
         /**
          *
@@ -23,32 +32,41 @@ export class SequenceBehavior extends CompositeBehavior {
     }
 
     initialize(context) {
-
+        // console.log('+ SequenceBehavior');
         super.initialize(context);
 
         this.__currentBehaviourIndex = 0;
-        this.__currentBehaviour = this.__children[this.__currentBehaviourIndex];
+        this.__currentBehaviour = this.__children[0];
 
         //initialize first behaviour
         this.__currentBehaviour.initialize(context);
 
+        this.__currentBehaviourState = BehaviorStatus.Running;
     }
 
+
     /**
      *
      * @param {number} timeDelta
      * @returns {BehaviorStatus}
      */
     tick(timeDelta) {
-        const s = this.__currentBehaviour.tick(timeDelta);
+        assert.isNonNegativeInteger(this.__currentBehaviourIndex, 'child index');
+
+        const currentBehaviour = this.__currentBehaviour;
+
+        const s = currentBehaviour.tick(timeDelta);
+
+        this.__currentBehaviourState = s;
 
         if (s !== BehaviorStatus.Succeeded) {
             return s;
         }
 
         //current behaviour succeeded, move onto the next one
-        this.__currentBehaviour.finalize();
+        currentBehaviour.finalize();
 
+        this.__currentBehaviourState = BehaviorStatus.Initial;
         this.__currentBehaviourIndex++;
 
         if (this.__currentBehaviourIndex < this.__children.length) {
@@ -56,24 +74,31 @@ export class SequenceBehavior extends CompositeBehavior {
 
             this.__currentBehaviour.initialize(this.context);
 
+            this.__currentBehaviourState = BehaviorStatus.Running;
+
             return BehaviorStatus.Running;
         } else {
-            this.__status = BehaviorStatus.Succeeded;
-
             //all behaviours completed
-            return this.__status;
+            return BehaviorStatus.Succeeded;
         }
     }
 
     finalize() {
-        if (this.__currentBehaviourIndex !== this.__children.length) {
+
+        const child_count = this.__children.length;
+
+        if (this.__currentBehaviourIndex !== child_count) {
             //sequence has not been finished
 
-            if (this.__currentBehaviour !== undefined && this.__currentBehaviour.getStatus() !== BehaviorStatus.Initial) {
+            if (this.__currentBehaviour !== undefined && this.__currentBehaviourState !== BehaviorStatus.Initial) {
                 this.__currentBehaviour.finalize();
             }
         }
-        this.__status = BehaviorStatus.Initial;
+
+        this.__currentBehaviour = undefined;
+        this.__currentBehaviourIndex = child_count;
+
+        // console.warn('- SequenceBehavior');
     }
 
     /**

package/engine/intelligence/behavior/decorator/AbstractDecoratorBehavior.js

@@ -36,8 +36,6 @@ export class AbstractDecoratorBehavior extends Behavior {
     initialize(context) {
         super.initialize(context);
         this.__source.initialize(context);
-
-        this.__status = this.__source.getStatus();
     }
 
     finalize() {

package/engine/intelligence/behavior/decorator/IgnoreFailureBehavior.js

@@ -19,11 +19,9 @@ export class IgnoreFailureBehavior extends AbstractDecoratorBehavior {
         const behaviorStatus = this.__source.tick(timeDelta);
 
         if (behaviorStatus === BehaviorStatus.Failed) {
-            this.setStatus(BehaviorStatus.Succeeded);
-        } else {
-            this.setStatus(behaviorStatus);
+            return BehaviorStatus.Succeeded;
         }
 
-        return this.getStatus();
+        return behaviorStatus;
     }
 }

package/engine/intelligence/behavior/decorator/InverterBehavior.js

@@ -1,6 +1,8 @@
 import { Behavior } from "../Behavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
-import { ObjectBasedClassSerializationAdapter } from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
+import {
+    ObjectBasedClassSerializationAdapter
+} from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
 import { AbstractDecoratorBehavior } from "./AbstractDecoratorBehavior.js";
 
 /**
@@ -37,8 +39,6 @@ export class InverterBehavior extends AbstractDecoratorBehavior {
             r = BehaviorStatus.Succeeded;
         }
 
-        this.__status = r;
-
         return r;
     }
 }

package/engine/intelligence/behavior/decorator/RepeatBehavior.js

@@ -1,6 +1,5 @@
 import { Behavior } from "../Behavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
-import { ObjectBasedClassSerializationAdapter } from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
 import { AbstractDecoratorBehavior } from "./AbstractDecoratorBehavior.js";
 import { assert } from "../../../../core/assert.js";
 
@@ -65,7 +64,6 @@ export class RepeatBehavior extends AbstractDecoratorBehavior {
         assert.enum(s, BehaviorStatus, 'status');
 
         if (s !== BehaviorStatus.Succeeded && s !== BehaviorStatus.Failed) {
-            this.__status = s;
             return s;
         }
 
@@ -73,7 +71,6 @@ export class RepeatBehavior extends AbstractDecoratorBehavior {
         this.__iterator++;
 
         if (this.__iterator >= this.__limit) {
-            this.__status = BehaviorStatus.Succeeded;
 
             return BehaviorStatus.Succeeded;
         } else {
@@ -87,35 +84,3 @@ export class RepeatBehavior extends AbstractDecoratorBehavior {
 
 RepeatBehavior.typeName = "RepeatBehavior";
 
-export class RepeatBehaviorSerializationAdapter extends ObjectBasedClassSerializationAdapter {
-    constructor() {
-        super();
-
-        this.klass = RepeatBehavior;
-        this.version = 0;
-    }
-
-    /**
-     *
-     * @param {BinaryBuffer} buffer
-     * @param {RepeatBehavior} value
-     */
-    serialize(buffer, value) {
-        buffer.writeUintVar(value.getCount());
-
-        this.objectAdapter.serialize(buffer, value.getSource());
-    }
-
-    /**
-     *
-     * @param {BinaryBuffer} buffer
-     * @param {RepeatBehavior} value
-     */
-    deserialize(buffer, value) {
-        const count = buffer.readUintVar();
-        const source = this.objectAdapter.deserialize(buffer);
-
-        value.setCount(count);
-        value.setSource(source);
-    }
-}

package/engine/intelligence/behavior/decorator/RepeatBehavior.spec.js

@@ -6,11 +6,7 @@ import { jest } from '@jest/globals';
 test("initialization", () => {
     const b = new RepeatBehavior(new SucceedingBehavior(), 1);
 
-    expect(b.getStatus()).toBe(BehaviorStatus.Initial);
-
     b.initialize();
-
-    expect(b.getStatus()).toBe(BehaviorStatus.Running);
 });
 
 test('2 successful repetitions', () => {
@@ -23,12 +19,8 @@ test('2 successful repetitions', () => {
 
     b.initialize();
 
-    expect(b.getStatus()).toBe(BehaviorStatus.Running);
-
     expect(b.tick(3)).toBe(BehaviorStatus.Running);
 
-    expect(b.getStatus()).toBe(BehaviorStatus.Running);
-
     expect(tickSpy).toHaveBeenCalledTimes(1);
     expect(tickSpy).toHaveBeenCalledWith(3);
 
@@ -37,6 +29,4 @@ test('2 successful repetitions', () => {
 
     expect(tickSpy).toHaveBeenCalledTimes(2);
     expect(tickSpy).toHaveBeenLastCalledWith(7);
-
-    expect(b.getStatus()).toBe(BehaviorStatus.Succeeded);
 });

package/engine/intelligence/behavior/decorator/RepeatBehaviorSerializationAdapter.js

@@ -0,0 +1,37 @@
+import {
+    ObjectBasedClassSerializationAdapter
+} from "../../../ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js";
+import { RepeatBehavior } from "./RepeatBehavior.js";
+
+export class RepeatBehaviorSerializationAdapter extends ObjectBasedClassSerializationAdapter {
+    constructor() {
+        super();
+
+        this.klass = RepeatBehavior;
+        this.version = 0;
+    }
+
+    /**
+     *
+     * @param {BinaryBuffer} buffer
+     * @param {RepeatBehavior} value
+     */
+    serialize(buffer, value) {
+        buffer.writeUintVar(value.getCount());
+
+        this.objectAdapter.serialize(buffer, value.getSource());
+    }
+
+    /**
+     *
+     * @param {BinaryBuffer} buffer
+     * @param {RepeatBehavior} value
+     */
+    deserialize(buffer, value) {
+        const count = buffer.readUintVar();
+        const source = this.objectAdapter.deserialize(buffer);
+
+        value.setCount(count);
+        value.setSource(source);
+    }
+}

package/engine/intelligence/behavior/decorator/RepeatUntilFailureBehavior.js

@@ -51,8 +51,6 @@ export class RepeatUntilFailureBehavior extends AbstractDecoratorBehavior {
 
         if (s !== BehaviorStatus.Succeeded) {
 
-            this.__status = s;
-
             return s;
 
         }
@@ -60,7 +58,6 @@ export class RepeatUntilFailureBehavior extends AbstractDecoratorBehavior {
         this.__iterator++;
 
         if (this.__iterator >= this.__limit) {
-            this.__status = BehaviorStatus.Succeeded;
 
             return BehaviorStatus.Succeeded;
         } else {

package/engine/intelligence/behavior/decorator/RepeatUntilSuccessBehavior.js

@@ -40,10 +40,10 @@ export class RepeatUntilSuccessBehavior extends AbstractDecoratorBehavior {
      * @return {RepeatUntilSuccessBehavior}
      */
     static from(source, limit = Infinity) {
-        const r = new RepeatUntilSuccessBehavior();
-
-        r.setSource(source);
-        r.__limit = limit;
+        const r = new RepeatUntilSuccessBehavior(
+            source,
+            limit
+        );
 
         return r;
     }
@@ -52,9 +52,6 @@ export class RepeatUntilSuccessBehavior extends AbstractDecoratorBehavior {
         const s = this.__source.tick(timeDelta);
 
         if (s === BehaviorStatus.Succeeded) {
-
-            this.__status = s;
-
             return s;
 
         } else if (s === BehaviorStatus.Running) {
@@ -64,9 +61,7 @@ export class RepeatUntilSuccessBehavior extends AbstractDecoratorBehavior {
         this.__iterator++;
 
         if (this.__iterator >= this.__limit) {
-            this.__status = BehaviorStatus.Failed;
-
-            return this.__status;
+            return BehaviorStatus.Failed;
         } else {
             //re-initialize the source behavior
             this.__source.initialize(this.context);