@woosh/meep-engine 2.123.7 → 2.123.11

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

@@ -1,29 +1,36 @@
+import { assert } from "../../../../core/assert.js";
 import { Behavior } from "../Behavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
 import { AbstractDecoratorBehavior } from "./AbstractDecoratorBehavior.js";
-import { assert } from "../../../../core/assert.js";
 
 /**
- * @extends {Behavior}
+ * Loop decorator. Behavior equivalent of `for(i=0; i<limit; i++)`
+ * @example
+ *  RepeatBehavior.from(
+ *      ActionBehavior.from( () => console.log('A') ),
+ *      3
+ *  ); // will print A three times when executed
  */
 export class RepeatBehavior extends AbstractDecoratorBehavior {
     /**
      *
      * @param {Behavior} source
-     * @param {number} [count=Infinity]
+     * @param {number} [limit=Infinity]
      */
-    constructor(source, count = Infinity) {
+    constructor(source, limit = Infinity) {
         super();
 
+        assert.isNumber(limit, 'count');
+        assert.greaterThanOrEqual(limit, 0, 'count');
+
         /**
-         *
+         * How many times to loop
          * @type {number}
-         * @private
          */
-        this.limit = count;
+        this.limit = limit;
 
         /**
-         *
+         * Current loop iteration index
          * @type {number}
          * @private
          */
@@ -32,22 +39,6 @@ export class RepeatBehavior extends AbstractDecoratorBehavior {
         this.setSource(source);
     }
 
-    /**
-     * @deprecated use .limit directly instead
-     * @param {number} v
-     */
-    setCount(v) {
-        this.limit = v;
-    }
-
-    /**
-     * @deprecated use .limit directly instead
-     * @return {number}
-     */
-    getCount() {
-        return this.limit;
-    }
-
     /**
      *
      * @param {Behavior} source
@@ -72,21 +63,23 @@ export class RepeatBehavior extends AbstractDecoratorBehavior {
 
         assert.enum(s, BehaviorStatus, 'status');
 
-        if (s !== BehaviorStatus.Succeeded && s !== BehaviorStatus.Failed) {
+        if (s !== BehaviorStatus.Succeeded || s === BehaviorStatus.Failed) {
             return s;
         }
 
-
         this.__iterator++;
 
         if (this.__iterator >= this.limit) {
 
             return BehaviorStatus.Succeeded;
+
         } else {
+
             //re-initialize the source behavior
             source.initialize(this.context);
 
             return BehaviorStatus.Running;
+
         }
     }
 }

package/src/engine/intelligence/behavior/ecs/BehaviorComponent.d.ts

@@ -4,7 +4,7 @@
 export class BehaviorComponent {
     /**
      * Executes input function every update cycle.
-     * Will run forever.
+     * Will run forever, or until function throws.
      * @param {function(time_delta_seconds:number)} action function to loop over
      * @param {*} [thisArg]
      * @returns {BehaviorComponent}
@@ -17,7 +17,8 @@ export class BehaviorComponent {
      */
     static from(b: Behavior): BehaviorComponent;
     /**
-     * What clock should be used for ticking associated behavior
+     * What clock should be used for ticking associated behavior.
+     * Some behaviors need to run at world's simulated time, while others will need to be executed in real-world time.
      * @type {ClockChannelType|number}
      */
     clock: ClockChannelType | number;
@@ -57,7 +58,7 @@ export class BehaviorComponent {
      */
     getFlag(flag: number | BehaviorComponentFlag): boolean;
     /**
-     *
+     * Note that swapping behaviors during simulation may have unintended consequences
      * @param {Behavior} v
      */
     set behavior(v: Behavior);

package/src/engine/intelligence/behavior/ecs/BehaviorComponent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BehaviorComponent.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorComponent.js"],"names":[],"mappings":"AAKA;;GAEG;AACH;IA6EI;;;;;;OAMG;IACH,mCAHW,GAAC,GACC,iBAAiB,CAQ7B;IAED;;;;OAIG;IACH,eAHW,QAAQ,GACN,iBAAiB,CAa7B;IA1GD;;;OAGG;IACH,OAFU,gBAAgB,GAAC,MAAM,CAEG;IAEpC;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,mBAAkB;IAElB;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,SAC5B,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,OAAO,CAInB;IAUD;;;OAGG;IACH,gBAFW,QAAQ,EAIlB;IAdD;;;OAGG;IACH,gBAFa,QAAQ,GAAC,IAAI,CAIzB;CA0CJ;;;;;;6BAcS,OAAO;yBAMP,MAAM;;iCAtIiB,uBAAuB"}
+{"version":3,"file":"BehaviorComponent.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorComponent.js"],"names":[],"mappings":"AAKA;;GAEG;AACH;IA8EI;;;;;;OAMG;IACH,mCAHW,GAAC,GACC,iBAAiB,CAQ7B;IAED;;;;OAIG;IACH,eAHW,QAAQ,GACN,iBAAiB,CAa7B;IA3GD;;;;OAIG;IACH,OAFU,gBAAgB,GAAC,MAAM,CAEG;IAEpC;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,mBAAkB;IAElB;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,SAC5B,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,OAAO,CAInB;IAUD;;;OAGG;IACH,gBAFW,QAAQ,EAIlB;IAdD;;;OAGG;IACH,gBAFa,QAAQ,GAAC,IAAI,CAIzB;CA0CJ;;;;;;6BAcS,OAAO;yBAMP,MAAM;;iCAvIiB,uBAAuB"}

package/src/engine/intelligence/behavior/ecs/BehaviorComponent.js

@@ -9,7 +9,8 @@ import { ClockChannelType } from "./ClockChannelType.js";
 export class BehaviorComponent {
 
     /**
-     * What clock should be used for ticking associated behavior
+     * What clock should be used for ticking associated behavior.
+     * Some behaviors need to run at world's simulated time, while others will need to be executed in real-world time.
      * @type {ClockChannelType|number}
      */
     clock = ClockChannelType.Simulation;
@@ -76,7 +77,7 @@ export class BehaviorComponent {
     }
 
     /**
-     *
+     * Note that swapping behaviors during simulation may have unintended consequences
      * @param {Behavior} v
      */
     set behavior(v) {
@@ -85,7 +86,7 @@ export class BehaviorComponent {
 
     /**
      * Executes input function every update cycle.
-     * Will run forever.
+     * Will run forever, or until function throws.
      * @param {function(time_delta_seconds:number)} action function to loop over
      * @param {*} [thisArg]
      * @returns {BehaviorComponent}

package/src/engine/intelligence/behavior/ecs/BehaviorSystem.d.ts

@@ -1,4 +1,7 @@
-export class BehaviorSystem extends System<any, any, any, any, any> {
+/**
+ * @extends System<BehaviorComponent>
+ */
+export class BehaviorSystem extends System<BehaviorComponent, any, any, any, any> {
     /**
      *
      * @param {Engine} engine
@@ -27,7 +30,7 @@ export class BehaviorSystem extends System<any, any, any, any, any> {
     unlink(component: BehaviorComponent, entity: number): void;
     update(timeDelta: any): void;
 }
-import { System } from "../../../ecs/System.js";
 import { BehaviorComponent } from "./BehaviorComponent.js";
+import { System } from "../../../ecs/System.js";
 import Clock from "../../../Clock.js";
 //# sourceMappingURL=BehaviorSystem.d.ts.map

package/src/engine/intelligence/behavior/ecs/BehaviorSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BehaviorSystem.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorSystem.js"],"names":[],"mappings":"AAyBA;IACI;;;OAGG;IACH,oBAFW,MAAM,EAehB;IATG,2CAAuC;IAEvC,mBAA8B;IAE9B;;;OAGG;IACH,QAFU,MAAM,CAEI;IAGxB,0EAIC;IAED,2EAIC;IAED;;;;OAIG;IACH,gBAHW,iBAAiB,UACjB,MAAM,QAiBhB;IAED;;;;OAIG;IACH,kBAHW,iBAAiB,UACjB,MAAM,QAUhB;IAED,6BA2CC;CACJ;uBA1IsB,wBAAwB;kCACb,wBAAwB;kBAExC,mBAAmB"}
+{"version":3,"file":"BehaviorSystem.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorSystem.js"],"names":[],"mappings":"AAyBA;;GAEG;AACH;IACI;;;OAGG;IACH,oBAFW,MAAM,EAehB;IATG,2CAAuC;IAEvC,mBAA8B;IAE9B;;;OAGG;IACH,QAFU,MAAM,CAEI;IAGxB,0EAIC;IAED,2EAIC;IAED;;;;OAIG;IACH,gBAHW,iBAAiB,UACjB,MAAM,QAiBhB;IAED;;;;OAIG;IACH,kBAHW,iBAAiB,UACjB,MAAM,QAUhB;IAED,6BA2CC;CACJ;kCA1IiC,wBAAwB;uBAFnC,wBAAwB;kBAD7B,mBAAmB"}

package/src/engine/intelligence/behavior/ecs/BehaviorSystem.js

@@ -1,9 +1,9 @@
+import Clock from "../../../Clock.js";
 import { System } from "../../../ecs/System.js";
-import { BehaviorComponent } from "./BehaviorComponent.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
-import Clock from "../../../Clock.js";
-import { ClockChannelType } from "./ClockChannelType.js";
+import { BehaviorComponent } from "./BehaviorComponent.js";
 import { BehaviorComponentFlag } from "./BehaviorComponentFlag.js";
+import { ClockChannelType } from "./ClockChannelType.js";
 
 /**
  *
@@ -23,6 +23,9 @@ function updateBehavior(behavior, timeDelta) {
     }
 }
 
+/**
+ * @extends System<BehaviorComponent>
+ */
 export class BehaviorSystem extends System {
     /**
      *

package/src/engine/intelligence/behavior/ecs/DieBehavior.d.ts

@@ -2,6 +2,10 @@
  * Makes the entity destroy itself
  */
 export class DieBehavior extends EntityBehavior {
+    /**
+     * Constructor alias
+     * @return {DieBehavior}
+     */
     static create(): DieBehavior;
     tick(timeDelta: any): BehaviorStatus;
 }

package/src/engine/intelligence/behavior/ecs/DieBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DieBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/DieBehavior.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAGI,6BAEC;IAED,qCASC;CACJ;+BAtB8B,qBAAqB;+BADrB,sBAAsB"}
+{"version":3,"file":"DieBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/DieBehavior.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAEI;;;OAGG;IACH,iBAFY,WAAW,CAItB;IAED,qCASC;CACJ;+BAzB8B,qBAAqB;+BADrB,sBAAsB"}

package/src/engine/intelligence/behavior/ecs/DieBehavior.js

@@ -6,7 +6,10 @@ import { EntityBehavior } from "./EntityBehavior.js";
  */
 export class DieBehavior extends EntityBehavior {
 
-
+    /**
+     * Constructor alias
+     * @return {DieBehavior}
+     */
     static create() {
         return new DieBehavior();
     }

package/src/engine/intelligence/behavior/ecs/SendEventBehavior.d.ts

@@ -1,17 +1,36 @@
+/**
+ * Dispatch an event to an entity via {@link EntityComponentDataset#sendEvent}
+ * @see WaitForEventBehavior
+ */
 export class SendEventBehavior extends EntityBehavior {
-    static fromJSON(j: any): SendEventBehavior;
+    /**
+     *
+     * @param {{event:string, data?:Object, target?:number}} json
+     * @return {SendEventBehavior}
+     */
+    static fromJSON(json: {
+        event: string;
+        data?: any;
+        target?: number;
+    }): SendEventBehavior;
     /**
      * ID of the event
      * @type {string}
      */
     event: string;
     data: {};
+    /**
+     *
+     * @type {number}
+     */
     target: number;
-    fromJSON({ event, data, target }: {
-        event: any;
-        data?: {};
-        target?: number;
-    }): void;
+    /**
+     *
+     * @param {string} event
+     * @param {Object} [data]
+     * @param {number} [target]
+     */
+    fromJSON({ event, data, target }: string): void;
     tick(timeDelta: any): BehaviorStatus;
 }
 import { EntityBehavior } from "./EntityBehavior.js";

package/src/engine/intelligence/behavior/ecs/SendEventBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SendEventBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/SendEventBehavior.js"],"names":[],"mappings":"AAIA;IAkBI,2CAMC;IAtBD;;;OAGG;IACH,OAFU,MAAM,CAEL;IACX,SAAU;IACV,eAAY;IAEZ;;;;aAMC;IAcD,qCAQC;CACJ;+BAzC8B,qBAAqB;+BADrB,sBAAsB"}
+{"version":3,"file":"SendEventBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/SendEventBehavior.js"],"names":[],"mappings":"AAIA;;;GAGG;AACH;IA+BI;;;;OAIG;IACH,sBAHW;QAAC,KAAK,EAAC,MAAM,CAAC;QAAC,IAAI,CAAC,MAAQ;QAAC,MAAM,CAAC,EAAC,MAAM,CAAA;KAAC,GAC3C,iBAAiB,CAQ5B;IAxCD;;;OAGG;IACH,OAFU,MAAM,CAEL;IAEX,SAAU;IAEV;;;OAGG;IACH,QAFU,MAAM,CAEJ;IAEZ;;;;;OAKG;IACH,kCAJW,MAAM,QAWhB;IAmBD,qCAQC;CACJ;+BA/D8B,qBAAqB;+BADrB,sBAAsB"}

package/src/engine/intelligence/behavior/ecs/SendEventBehavior.js

@@ -2,6 +2,10 @@ import { assert } from "../../../../core/assert.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
 import { EntityBehavior } from "./EntityBehavior.js";
 
+/**
+ * Dispatch an event to an entity via {@link EntityComponentDataset#sendEvent}
+ * @see WaitForEventBehavior
+ */
 export class SendEventBehavior extends EntityBehavior {
 
     /**
@@ -9,21 +13,39 @@ export class SendEventBehavior extends EntityBehavior {
      * @type {string}
      */
     event = "";
+
     data = {};
+
+    /**
+     *
+     * @type {number}
+     */
     target = -1;
 
+    /**
+     *
+     * @param {string} event
+     * @param {Object} [data]
+     * @param {number} [target]
+     */
     fromJSON({ event, data = {}, target = -1 }) {
         assert.isString(event, 'event');
+        assert.isInteger(target, 'target');
 
         this.event = event;
         this.data = data;
         this.target = target;
     }
 
-    static fromJSON(j) {
+    /**
+     *
+     * @param {{event:string, data?:Object, target?:number}} json
+     * @return {SendEventBehavior}
+     */
+    static fromJSON(json) {
         const r = new SendEventBehavior();
 
-        r.fromJSON(j);
+        r.fromJSON(json);
 
         return r;
     }

package/src/engine/intelligence/behavior/ecs/WaitForEventBehavior.d.ts

@@ -1,6 +1,7 @@
 /**
  * Wait for a given entity event via {@link EntityComponentDataset#addEntityEventListener}
- * No failure condition, will wait forever until the event is detected
+ * No failure condition, will wait forever until the event is detected.
+ * @see SendEventBehavior
  */
 export class WaitForEventBehavior extends EntityBehavior {
     /**

package/src/engine/intelligence/behavior/ecs/WaitForEventBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WaitForEventBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/WaitForEventBehavior.js"],"names":[],"mappings":"AAIA;;;GAGG;AACH;IA6BI;;;;OAIG;IACH,4BAFY,oBAAoB,CAQ/B;IAtCD;;;OAGG;IACH,OAFU,MAAM,CAEL;IAEX;;;OAGG;IACH,UAFU,OAAO,CAEA;IAEjB;;;;OAIG;IACH,QAFU,MAAM,CAEJ;IAEZ;;;aAMC;IAeD,wEAMC;;CA0BJ;;kBAIS,MAAM;;+BApFe,qBAAqB;+BADrB,sBAAsB"}
+{"version":3,"file":"WaitForEventBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/WaitForEventBehavior.js"],"names":[],"mappings":"AAIA;;;;GAIG;AACH;IA6BI;;;;OAIG;IACH,4BAFY,oBAAoB,CAQ/B;IAtCD;;;OAGG;IACH,OAFU,MAAM,CAEL;IAEX;;;OAGG;IACH,UAFU,OAAO,CAEA;IAEjB;;;;OAIG;IACH,QAFU,MAAM,CAEJ;IAEZ;;;aAMC;IAeD,wEAMC;;CA0BJ;;kBAIS,MAAM;;+BArFe,qBAAqB;+BADrB,sBAAsB"}

package/src/engine/intelligence/behavior/ecs/WaitForEventBehavior.js

@@ -4,7 +4,8 @@ import { EntityBehavior } from "./EntityBehavior.js";
 
 /**
  * Wait for a given entity event via {@link EntityComponentDataset#addEntityEventListener}
- * No failure condition, will wait forever until the event is detected
+ * No failure condition, will wait forever until the event is detected.
+ * @see SendEventBehavior
  */
 export class WaitForEventBehavior extends EntityBehavior {
 

package/src/engine/intelligence/behavior/primitive/ActionBehavior.d.ts

@@ -2,12 +2,20 @@
  * Single-shot behavior that executes the given function and resolves {@link BehaviorStatus.SUCCESS}
  * @template CTX
  * @extends {Behavior<CTX>}
+ * @example
+ *  // will print 'Hello World' in console when executed
+ *  ActionBehavior.from( () => console.log('Hello World') );
  */
 export class ActionBehavior<CTX> extends Behavior<CTX> {
+    /**
+     * Constructor alias
+     * @returns {ActionBehavior}
+     */
+    static from(func: any, thisArg: any): ActionBehavior<any>;
     /**
      *
      * @param {function(timeDelta:number, context:CTX)} action
-     * @param {*} [thisArg] defaults to behavior itself if not specified
+     * @param {*} [thisArg=this] defaults to behavior itself if not specified
      */
     constructor(action: any, thisArg?: any);
     __action: any;

package/src/engine/intelligence/behavior/primitive/ActionBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActionBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/ActionBehavior.js"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,4BAHa,GAAG;IAIZ;;;;OAIG;IACH,mCAFW,GAAC,EAeX;IARG,cAAsB;IAIlB,eAAqB;IAM7B,uEAcC;CACJ;yBA5CwB,gBAAgB;+BACV,sBAAsB"}
+{"version":3,"file":"ActionBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/ActionBehavior.js"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,4BANa,GAAG;IA2BZ;;;OAGG;IACH,0DAEC;IA1BD;;;;OAIG;IACH,mCAFW,GAAC,EAeX;IARG,cAAsB;IAIlB,eAAqB;IAc7B,uEAeC;CACJ;yBAxDwB,gBAAgB;+BACV,sBAAsB"}

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

@@ -6,12 +6,15 @@ import { BehaviorStatus } from "../BehaviorStatus.js";
  * Single-shot behavior that executes the given function and resolves {@link BehaviorStatus.SUCCESS}
  * @template CTX
  * @extends {Behavior<CTX>}
+ * @example
+ *  // will print 'Hello World' in console when executed
+ *  ActionBehavior.from( () => console.log('Hello World') );
  */
 export class ActionBehavior extends Behavior {
     /**
      *
      * @param {function(timeDelta:number, context:CTX)} action
-     * @param {*} [thisArg] defaults to behavior itself if not specified
+     * @param {*} [thisArg=this] defaults to behavior itself if not specified
      */
     constructor(action, thisArg) {
         super();
@@ -28,9 +31,18 @@ export class ActionBehavior extends Behavior {
         }
     }
 
+    /**
+     * Constructor alias
+     * @returns {ActionBehavior}
+     */
+    static from(func, thisArg) {
+        return new ActionBehavior(func, thisArg);
+    }
+
     tick(timeDelta) {
 
         try {
+
             this.__action.call(this.__context, timeDelta, this.context);
 
             return BehaviorStatus.Succeeded;

package/src/engine/intelligence/behavior/primitive/FailingBehavior.d.ts

@@ -1,7 +1,16 @@
 export class FailingBehavior extends Behavior<any> {
-    constructor(delayTicks?: number);
-    delayTicks: number;
-    tick(td: any): BehaviorStatus.Running | BehaviorStatus.Failed;
+    /**
+     * @readonly
+     * @type {FailingBehavior}
+     */
+    static readonly INSTANCE: FailingBehavior;
+    /**
+     *
+     * @param [delayTicks] deprecated, do not use
+     */
+    constructor(delayTicks?: any);
+    initialize(context: any): void;
+    tick(td: any): BehaviorStatus;
 }
 export namespace FailingBehavior {
     let typeName: string;

package/src/engine/intelligence/behavior/primitive/FailingBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FailingBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/FailingBehavior.js"],"names":[],"mappings":"AAGA;IACI,iCAIC;IADG,mBAA4B;IAGhC,8DASC;CACJ;;;;yBApBwB,gBAAgB;+BACV,sBAAsB"}
+{"version":3,"file":"FailingBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/FailingBehavior.js"],"names":[],"mappings":"AAGA;IAuBI;;;OAGG;IACH,0BAFU,eAAe,CAE8B;IAzBvD;;;OAGG;IACH,8BAOC;IAED,+BAEC;IAED,8BAEC;CAQJ;;;;yBAhCwB,gBAAgB;+BACV,sBAAsB"}

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

@@ -2,22 +2,34 @@ import { Behavior } from "../Behavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
 
 export class FailingBehavior extends Behavior {
-    constructor(delayTicks = 0) {
+
+    /**
+     *
+     * @param [delayTicks] deprecated, do not use
+     */
+    constructor(delayTicks) {
         super();
 
-        this.delayTicks = delayTicks;
+        if (delayTicks !== undefined) {
+            throw new Error(`parameters deprecated, use SequenceBehavior to delay the failure instead`)
+        }
+
+    }
+
+    initialize(context) {
+        this.onInitialized.send2(this, context);
     }
 
     tick(td) {
-        if (this.delayTicks === 0) {
+        return BehaviorStatus.Failed;
+    }
 
-            return BehaviorStatus.Failed;
-        } else {
-            this.delayTicks--;
+    /**
+     * @readonly
+     * @type {FailingBehavior}
+     */
+    static INSTANCE = Object.freeze(new FailingBehavior());
 
-            return BehaviorStatus.Running;
-        }
-    }
 }
 
 FailingBehavior.typeName = "FailingBehavior";

package/src/engine/intelligence/behavior/primitive/SucceedingBehavior.d.ts

@@ -4,11 +4,6 @@
  * You usually want to use {@link INSTANCE} singleton
  */
 export class SucceedingBehavior extends Behavior<any> {
-    /**
-     * @deprecated use static INSTANCE instead
-     * @return {SucceedingBehavior}
-     */
-    static from(): SucceedingBehavior;
     /**
      * @readonly
      * @type {SucceedingBehavior}

package/src/engine/intelligence/behavior/primitive/SucceedingBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SucceedingBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/SucceedingBehavior.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH;IAcI;;;OAGG;IACH,eAFY,kBAAkB,CAI7B;IAMD;;;OAGG;IACH,0BAFU,kBAAkB,CAE8B;IA5B1D,cAEC;IAED,+BAEC;IAcD,qCAEC;CAOJ;;;;yBAvCwB,gBAAgB;+BACV,sBAAsB"}
+{"version":3,"file":"SucceedingBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/SucceedingBehavior.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH;IAUI;;;OAGG;IACH,0BAFU,kBAAkB,CAE8B;;IAZ1D,+BAEC;IAED,qCAEC;CAQJ;;;;yBAxBwB,gBAAgB;+BACV,sBAAsB"}

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.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,UACD,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

@@ -25,7 +25,12 @@ export class WeightedElement {
      * @returns {WeightedElement<T>}
      */
     static from(element, weight) {
+        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"}