@woosh/meep-engine 2.123.8 → 2.124.0

package/src/engine/intelligence/behavior/primitive/SucceedingBehavior.js

@@ -8,26 +8,10 @@ import { BehaviorStatus } from "../BehaviorStatus.js";
  */
 export class SucceedingBehavior extends Behavior {
 
-    constructor() {
-        super();
-    }
-
     initialize(context) {
         this.onInitialized.send2(this, context);
     }
 
-    finalize() {
-        this.onFinalized.send1(this);
-    }
-
-    /**
-     * @deprecated use static INSTANCE instead
-     * @return {SucceedingBehavior}
-     */
-    static from() {
-        throw new Error(`Deprecated, use INSTANCE instead`)
-    }
-
     tick(timeDelta) {
         return BehaviorStatus.Succeeded;
     }
@@ -37,6 +21,7 @@ export class SucceedingBehavior extends Behavior {
      * @type {SucceedingBehavior}
      */
     static INSTANCE = Object.freeze(new SucceedingBehavior());
+
 }
 
 SucceedingBehavior.typeName = "SucceedingBehavior";

package/src/engine/intelligence/behavior/selector/WeightedElement.d.ts

@@ -5,10 +5,10 @@ export class WeightedElement<T> {
     /**
      * @template T
      * @param {T} element
-     * @param {number} weight
+     * @param {number} [weight]
      * @returns {WeightedElement<T>}
      */
-    static from<T_1>(element: T_1, weight: number): WeightedElement<T_1>;
+    static from<T_1>(element: T_1, weight?: number): WeightedElement<T_1>;
     /**
      * @template X
      * @param {WeightedElement<X>} object

package/src/engine/intelligence/behavior/selector/WeightedElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WeightedElement.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/selector/WeightedElement.js"],"names":[],"mappings":"AAMA;;GAEG;AACH,6BAFa,CAAC;IAaV;;;;;OAKG;IACH,0BAJW,GAAC,UACD,MAAM,GACJ,eAAe,CAAC,GAAC,CAAC,CAW9B;IAED;;;;OAIG;IACH,iBAJa,CAAC,UACH,eAAe,CAAC,CAAC,CAAC,GACjB,MAAM,CAIjB;IAhCD,eAAW;IAEX;;;OAGG;IACH,MAFU,CAAC,CAEC;IA4BZ;;;;OAIG;IACH,cAHW,CAAC,GACA,OAAO,CAKlB;IAED;;;OAGG;IACH,QAFY,MAAM,CAOjB;IAGL;;;OAGG;IACH,4BAFU,OAAO,CAE0B;CAN1C"}
+{"version":3,"file":"WeightedElement.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/selector/WeightedElement.js"],"names":[],"mappings":"AAMA;;GAEG;AACH,6BAFa,CAAC;IAaV;;;;;OAKG;IACH,0BAJW,GAAC,WACD,MAAM,GACJ,eAAe,CAAC,GAAC,CAAC,CAgB9B;IAED;;;;OAIG;IACH,iBAJa,CAAC,UACH,eAAe,CAAC,CAAC,CAAC,GACjB,MAAM,CAIjB;IArCD,eAAW;IAEX;;;OAGG;IACH,MAFU,CAAC,CAEC;IAiCZ;;;;OAIG;IACH,cAHW,CAAC,GACA,OAAO,CAKlB;IAED;;;OAGG;IACH,QAFY,MAAM,CAOjB;IAGL;;;OAGG;IACH,4BAFU,OAAO,CAE0B;CAN1C"}

package/src/engine/intelligence/behavior/selector/WeightedElement.js

@@ -21,11 +21,16 @@ export class WeightedElement {
     /**
      * @template T
      * @param {T} element
-     * @param {number} weight
+     * @param {number} [weight]
      * @returns {WeightedElement<T>}
      */
-    static from(element, weight) {
+    static from(element, weight = 1) {
+        assert.defined(element, 'element');
+
         assert.isNumber(weight, 'weight');
+        assert.notNaN(weight, 'weight');
+        assert.isFinite(weight, 'weight');
+        assert.greaterThanOrEqual(weight, 0, 'weight');
 
         const r = new WeightedElement();
 

package/src/engine/intelligence/behavior/selector/WeightedRandomBehavior.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Picks a random behavior to execute.
+ * The selection is done during initialization, and that selected behavior will then run to completion.
+ * NOTE: Weights are relative, so they don't need to add up to any specific value.
+ *
+ * @example
+ *  const behavior = WeightedRandomBehavior.from([
+ *      WeightedElement.from(A, 1), // A is some behavior
+ *      WeightedElement.from(B, 70), // B is some behavior
+ *  ]); // B will be 70 times more likely to be picked than A
+ *
+ */
 export class WeightedRandomBehavior extends Behavior<any> {
     /**
      *
@@ -31,7 +43,7 @@ export class WeightedRandomBehavior extends Behavior<any> {
     setRandomSeed(v: number): void;
     /**
      *
-     * @param {WeightedElement<Behavior>[]} elements
+     * @param {WeightedElement<Behavior>[]} elements Must not be empty
      */
     setElements(elements: WeightedElement<Behavior<any>>[]): void;
     /**

package/src/engine/intelligence/behavior/selector/WeightedRandomBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WeightedRandomBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/selector/WeightedRandomBehavior.js"],"names":[],"mappings":"AAMA;IA0DI;;;;OAIG;IACH,sBAHW,eAAe,eAAU,EAAE,GACzB,sBAAsB,CAQlC;;IAnED;;;;OAIG;IACH,mBAAgB;IAEhB;;;;OAIG;IACH,iBAA+B;IAE/B;;;;OAIG;IACH,mBAAuB;IAEvB;;;OAGG;IACH,iBAFW,MAAM,QAIhB;IAED;;;OAGG;IACH,sBAFW,eAAe,eAAU,EAAE,QAMrC;IAED;;;OAGG;IACH,cAFW,eAAe,eAAU,QAanC;IAeD,iBAQC;IAED,+BAMC;IAUD,oEAEC;CACJ;yBAvGwB,gBAAgB;gCACT,sBAAsB"}
+{"version":3,"file":"WeightedRandomBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/selector/WeightedRandomBehavior.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;GAWG;AACH;IAkEI;;;;OAIG;IACH,sBAHW,eAAe,eAAU,EAAE,GACzB,sBAAsB,CAUlC;;IA7ED;;;;OAIG;IACH,mBAAgB;IAEhB;;;;OAIG;IACH,iBAA+B;IAE/B;;;;OAIG;IACH,mBAAuB;IAEvB;;;OAGG;IACH,iBAFW,MAAM,QAIhB;IAED;;;OAGG;IACH,sBAFW,eAAe,eAAU,EAAE,QAcrC;IAED;;;OAGG;IACH,cAFW,eAAe,eAAU,QAanC;IAiBD,iBAYC;IAED,+BAMC;IAUD,oEAEC;CACJ;yBAjIwB,gBAAgB;gCACT,sBAAsB"}

package/src/engine/intelligence/behavior/selector/WeightedRandomBehavior.js

@@ -4,6 +4,18 @@ import { seededRandom } from "../../../../core/math/random/seededRandom.js";
 import { Behavior } from "../Behavior.js";
 import { WeightedElement } from "./WeightedElement.js";
 
+/**
+ * Picks a random behavior to execute.
+ * The selection is done during initialization, and that selected behavior will then run to completion.
+ * NOTE: Weights are relative, so they don't need to add up to any specific value.
+ *
+ * @example
+ *  const behavior = WeightedRandomBehavior.from([
+ *      WeightedElement.from(A, 1), // A is some behavior
+ *      WeightedElement.from(B, 70), // B is some behavior
+ *  ]); // B will be 70 times more likely to be picked than A
+ *
+ */
 export class WeightedRandomBehavior extends Behavior {
 
     /**
@@ -37,12 +49,20 @@ export class WeightedRandomBehavior extends Behavior {
 
     /**
      *
-     * @param {WeightedElement<Behavior>[]} elements
+     * @param {WeightedElement<Behavior>[]} elements Must not be empty
      */
     setElements(elements) {
+        assert.defined(elements, 'elements');
+        assert.isArray(elements, 'elements');
+        assert.greaterThan(elements.length, 0, 'elements.length === 0');
+
         this.__elements = [];
 
-        elements.forEach(this.addElement, this);
+        const count = elements.length;
+        for (let i = 0; i < count; i++) {
+            const element = elements[i];
+            this.addElement(element);
+        }
     }
 
     /**
@@ -68,6 +88,8 @@ export class WeightedRandomBehavior extends Behavior {
      * @returns {WeightedRandomBehavior}
      */
     static from(elements) {
+        assert.defined(elements, 'elements');
+
         const r = new WeightedRandomBehavior();
 
         r.setElements(elements);
@@ -82,7 +104,11 @@ export class WeightedRandomBehavior extends Behavior {
          */
         const weightedElement = weightedRandomFromArray(this.__elements, this.__random, WeightedElement.getWeight);
 
-        this.__selected = weightedElement.data;
+        const selected = weightedElement.data;
+
+        assert.equal(selected.isBehavior, true, 'selected.isBehavior !== true');
+
+        this.__selected = selected;
     }
 
     initialize(context) {