@woosh/meep-engine 2.120.5 → 2.121.1

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;;;GAGG;AACH,4BAHa,GAAG;IAIZ;;;;OAIG;IACH,iCAFW,GAAC,EAcX;IAPG,cAAoB;IAGhB,eAAqB;IAM7B,uEAcC;CACJ;yBA3CwB,gBAAgB;+BACV,sBAAsB"}
+{"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"}

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

@@ -1,25 +1,27 @@
+import { assert } from "../../../../core/assert.js";
 import { Behavior } from "../Behavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
-import { assert } from "../../../../core/assert.js";
 
 /**
+ * Single-shot behavior that executes the given function and resolves {@link BehaviorStatus.SUCCESS}
  * @template CTX
  * @extends {Behavior<CTX>}
  */
 export class ActionBehavior extends Behavior {
     /**
      *
-     * @param {function(timeDelta:number, context:CTX)} func
+     * @param {function(timeDelta:number, context:CTX)} action
      * @param {*} [thisArg] defaults to behavior itself if not specified
      */
-    constructor(func, thisArg) {
+    constructor(action, thisArg) {
         super();
 
-        assert.typeOf(func, 'function', "action");
+        assert.isFunction(action, "action");
 
-        this.__action = func;
+        this.__action = action;
 
         if (thisArg === undefined) {
+            // if thisArg is not supplied, will bind to behavior instead
             this.__context = this;
         } else {
             this.__context = thisArg;

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

@@ -1,21 +1,22 @@
 /**
- * Behavior that always succeeds
+ * Behavior that always succeeds.
+ * Useful when you need to specify a behavior to fulfill the API, but you don't actually want to perform any action.
+ * You usually want to use {@link INSTANCE} singleton
  */
 export class SucceedingBehavior extends Behavior<any> {
     /**
      * @deprecated use static INSTANCE instead
-     * @param {number} delayTicks
      * @return {SucceedingBehavior}
      */
-    static from(delayTicks?: number): SucceedingBehavior;
-    static INSTANCE: SucceedingBehavior;
-    constructor(delayTicks?: number);
+    static from(): SucceedingBehavior;
     /**
-     * @deprecated
-     * @type {number}
+     * @readonly
+     * @type {SucceedingBehavior}
      */
-    delayTicks: number;
-    tick(timeDelta: any): BehaviorStatus.Running | BehaviorStatus.Succeeded;
+    static readonly INSTANCE: SucceedingBehavior;
+    constructor();
+    initialize(context: any): void;
+    tick(timeDelta: any): BehaviorStatus;
 }
 export namespace SucceedingBehavior {
     let typeName: string;

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;;GAEG;AACH;IAeI;;;;OAIG;IACH,yBAHW,MAAM,GACL,kBAAkB,CAI7B;IAWD,oCAA2C;IAhC3C,iCAYC;IALG;;;OAGG;IACH,YAFU,MAAM,CAEY;IAYhC,wEAOC;CAGJ;;;;yBAxCwB,gBAAgB;+BACV,sBAAsB"}
+{"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"}

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

@@ -2,42 +2,41 @@ import { Behavior } from "../Behavior.js";
 import { BehaviorStatus } from "../BehaviorStatus.js";
 
 /**
- * Behavior that always succeeds
+ * Behavior that always succeeds.
+ * Useful when you need to specify a behavior to fulfill the API, but you don't actually want to perform any action.
+ * You usually want to use {@link INSTANCE} singleton
  */
 export class SucceedingBehavior extends Behavior {
-    constructor(delayTicks = 0) {
+
+    constructor() {
         super();
+    }
 
-        if (delayTicks !== 0) {
-            console.warn('delayTicks mechanic has been deprecated and will be removed in the future, if you need this functionality, please consider using RepeatBehavior.from(SucceedingBehavior.INSTANCE, delayTicks+1)');
-        }
+    initialize(context) {
+        this.onInitialized.send2(this, context);
+    }
 
-        /**
-         * @deprecated
-         * @type {number}
-         */
-        this.delayTicks = delayTicks;
+    finalize() {
+        this.onFinalized.send1(this);
     }
 
     /**
      * @deprecated use static INSTANCE instead
-     * @param {number} delayTicks
      * @return {SucceedingBehavior}
      */
-    static from(delayTicks = 0) {
-        return new SucceedingBehavior(delayTicks);
+    static from() {
+        throw new Error(`Deprecated, use INSTANCE instead`)
     }
 
     tick(timeDelta) {
-        if (this.delayTicks === 0) {
-            return BehaviorStatus.Succeeded;
-        } else {
-            this.delayTicks--;
-            return BehaviorStatus.Running;
-        }
+        return BehaviorStatus.Succeeded;
     }
 
-    static INSTANCE = new SucceedingBehavior();
+    /**
+     * @readonly
+     * @type {SucceedingBehavior}
+     */
+    static INSTANCE = Object.freeze(new SucceedingBehavior());
 }
 
 SucceedingBehavior.typeName = "SucceedingBehavior";

package/src/engine/physics/fluid/prototype.js

@@ -60,7 +60,7 @@ function main(engine) {
 
 
     new Entity()
-        .add(BehaviorComponent.looping_function(time_delta => {
+        .add(BehaviorComponent.loop(time_delta => {
 
             const t0 = performance.now();
 

package/src/engine/physics/inverse_kinematics/fabrik/prototype.js

@@ -70,7 +70,7 @@ EngineHarness.bootstrap({
         const lengths = chain.map(x => 0.1);
 
         new Entity()
-            .add(BehaviorComponent.looping_function(timeDelta => {
+            .add(BehaviorComponent.loop(timeDelta => {
                 const last = joints[joints.length - 1];
                 const target = last.position.clone();
 

package/src/view/View.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"View.d.ts","sourceRoot":"","sources":["../../../src/view/View.js"],"names":[],"mappings":"wBAsBU,MAAM;;;;;;;AAchB;;;GAGG;AACH;IAEI;;;;OAIG;IACH,iBAAc;IAEd;;;OAGG;IACH,OAFU,SAAS,GAAC,MAAM,CAEJ;IAEtB;;;OAGG;IACH,mBAFU,OAAO,CAEY;IAE7B;;;OAGG;IACH,mBAFU,OAAO,CAES;IAE1B;;;OAGG;IACH,gBAFU,OAAO,CAES;IAE1B;;;OAGG;IACH,eAFU,OAAO,CAEQ;IAEzB;;;;OAIG;IACH,0BAFU,OAAO,CAEuB;IAExC;;;MAGE;IAEF;;;OAGG;IACH,UAFU,IAAI,EAAE,CAEF;IAEd;;;OAGG;IACH,QAFU,IAAI,GAAC,IAAI,CAEL;IAUV;;;OAGG;IACH,IAFU,OAAO,GAAC,eAAe,GAAC,IAAI,CAExB;IAUlB;;OAEG;IACH,gBAFa,OAAO,CAInB;IAED;;;OAGG;IACH,mBAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,eAFW,OAAO,EAWjB;IAED;;;OAGG;IACH,eAFY,OAAO,CAIlB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,SAAS,GACd,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,SAAS,GACd,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,SAAS,SAChB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,SAAS,GACd,OAAO,CAInB;IAED;;;;;OAKG;IACH,6BAIC;IAED;;;;;OAKG;IACH,wBAKC;IAED;;;OAGG;IACH,0BAQC;IA8BD;;OAEG;IACH,aA+BC;IAED;;OAEG;IACH,eA6BC;IAED;;;OAGG;IACH,sBAFW,IAAI,EAAE,QAMhB;IAED;;;;OAIG;IACH,gBAHW,IAAI,GACF,IAAI,CAqBhB;IAED;;;;;;;;OAQG;IACH,uBAPW,OAAO,WACP,MAAM,WACN,MAAM,cACN,MAAM,cACN,MAAM,UACN,OAAO,QAYjB;IAED;;;;;;;OAOG;IACH,kBANW,IAAI,WACJ,MAAM,WACN,MAAM,cACN,MAAM,cACN,MAAM,QAahB;IAED;;;;OAIG;IACH,mBAHW,IAAI,GACF,OAAO,CAmBnB;IAED;;;;OAIG;IACH,gBAHW,IAAI,GACF,OAAO,CAInB;IAED,0BAUC;IAED;;;;;OAKG;IACH,kBAJW,KAAK,WACL,MAAM,WACN,MAAM,QAkBhB;IAED;;;;OAIG;IACH,4BAHW,KAAK,GACH,KAAK,CAUjB;IAED,4BAaC;IAED;;;;;OAKG;IACH,6BAJW,OAAO,UACP,OAAO,GACL,OAAO,CAanB;IAED;;;;;OAKG;IACH,6BAJW,OAAO,UACP,OAAO,GACL,OAAO,CAanB;IAED;;;OAGG;IACH,2BAFW,OAAO,QAgBjB;IAED,gBAeC;IAED;;;;;;;OAOG;IACH,mBALW,MAAM,+BAEN,GAAC,GACC,IAAI,CAWhB;IAED;;;;;;OAMG;IACH,qBALW,MAAM,+BAEN,GAAC,GACC,OAAO,CAwBnB;IAED;;;;;;OAMG;IACH,eAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,kBAFW,MAAM,EAAE,QAalB;IAED;;;;;;OAMG;IACH,kBAFW,MAAM,QAIhB;IAED;;;;OAIG;IACH,2BAHW,MAAM,GACJ,MAAM,EAAE,CA0BpB;IAED;;;;;;;;OAQG;IACH,eAJW,MAAM,QACN,OAAO,GACL,IAAI,CAMhB;IAED;;;OAGG;IACH,qBAMC;IAED;;;OAGG;IACH,sBAMC;IAED;;;;OAIG;IACH,8BAHW,OAAO,QA6BjB;IAGL;;;OAGG;IACH,iBAFU,OAAO,CAEI;;CANpB;oBApwBmB,yBAAyB;oBADzB,yBAAyB;mBAN1B,iCAAiC;kBAGlC,+BAA+B"}
+{"version":3,"file":"View.d.ts","sourceRoot":"","sources":["../../../src/view/View.js"],"names":[],"mappings":"wBAsBU,MAAM;;;;;;;AAchB;;;;;GAKG;AACH;IAEI;;;;;OAKG;IACH,0BAAc;IAEd;;;OAGG;IACH,OAFU,SAAS,GAAC,MAAM,CAEJ;IAEtB;;;OAGG;IACH,mBAFU,OAAO,CAEY;IAE7B;;;OAGG;IACH,mBAFU,OAAO,CAES;IAE1B;;;OAGG;IACH,gBAFU,OAAO,CAES;IAE1B;;;OAGG;IACH,eAFU,OAAO,CAEQ;IAEzB;;;;OAIG;IACH,0BAFU,OAAO,CAEuB;IAExC;;OAEG;IACH;QACI;;WAEG;;QAEH;;WAEG;;MAEL;IAEF;;;;OAIG;IACH,mBAHU,IAAI,EAAE,CAGF;IAEd;;;OAGG;IACH,QAFU,IAAI,GAAC,IAAI,CAEL;IAUV;;;OAGG;IACH,IAFU,OAAO,GAAC,eAAe,GAAC,IAAI,CAExB;IAUlB;;OAEG;IACH,gBAFa,OAAO,CAInB;IAED;;;OAGG;IACH,mBAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,eAFW,OAAO,EAWjB;IAED;;;OAGG;IACH,eAFY,OAAO,CAIlB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,SAAS,GACd,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,SAAS,GACd,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,SAAS,SAChB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,SAAS,GACd,OAAO,CAInB;IAED;;;;;OAKG;IACH,6BAIC;IAED;;;;;OAKG;IACH,wBAKC;IAED;;;OAGG;IACH,0BAQC;IA8BD;;OAEG;IACH,aA+BC;IAED;;OAEG;IACH,eA6BC;IAED;;;OAGG;IACH,sBAFW,IAAI,EAAE,QAMhB;IAED;;;;OAIG;IACH,gBAHW,IAAI,GACF,IAAI,CAqBhB;IAED;;;;;;;;OAQG;IACH,uBAPW,OAAO,WACP,MAAM,WACN,MAAM,cACN,MAAM,cACN,MAAM,UACN,OAAO,QAYjB;IAED;;;;;;;OAOG;IACH,kBANW,IAAI,WACJ,MAAM,WACN,MAAM,cACN,MAAM,cACN,MAAM,QAahB;IAED;;;;OAIG;IACH,mBAHW,IAAI,GACF,OAAO,CAmBnB;IAED;;;;OAIG;IACH,gBAHW,IAAI,GACF,OAAO,CAInB;IAED,0BAUC;IAED;;;;;OAKG;IACH,kBAJW,KAAK,WACL,MAAM,WACN,MAAM,QAkBhB;IAED;;;;OAIG;IACH,4BAHW,KAAK,GACH,KAAK,CAUjB;IAED,4BAaC;IAED;;;;;OAKG;IACH,6BAJW,OAAO,UACP,OAAO,GACL,OAAO,CAanB;IAED;;;;;OAKG;IACH,6BAJW,OAAO,UACP,OAAO,GACL,OAAO,CAanB;IAED;;;OAGG;IACH,2BAFW,OAAO,QAgBjB;IAED,gBAeC;IAED;;;;;;;OAOG;IACH,mBALW,MAAM,+BAEN,GAAC,GACC,IAAI,CAWhB;IAED;;;;;;OAMG;IACH,qBALW,MAAM,+BAEN,GAAC,GACC,OAAO,CAwBnB;IAED;;;;;;OAMG;IACH,eAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,kBAFW,MAAM,EAAE,QAalB;IAED;;;;;;OAMG;IACH,kBAFW,MAAM,QAIhB;IAED;;;;OAIG;IACH,2BAHW,MAAM,GACJ,MAAM,EAAE,CA0BpB;IAED;;;;;;;;OAQG;IACH,eAJW,MAAM,QACN,OAAO,GACL,IAAI,CAMhB;IAED;;;OAGG;IACH,qBAMC;IAED;;;OAGG;IACH,sBAMC;IAED;;;;OAIG;IACH,8BAHW,OAAO,QA6BjB;IAGL;;;OAGG;IACH,iBAFU,OAAO,CAEI;;CANpB;oBAjxBmB,yBAAyB;oBADzB,yBAAyB;mBAN1B,iCAAiC;kBAGlC,+BAA+B"}

package/src/view/View.js

@@ -35,7 +35,9 @@ export const ViewFlags = {
 const INITIAL_FLAGS = ViewFlags.Visible;
 
 /**
- * Base View class
+ * Building block for UI elements.
+ * Implements a DOM model, built around HTML elements (svg and XML is allowed as well)
+ * Base View class.
  * @class
  */
 class View {
@@ -43,6 +45,7 @@ class View {
     /**
      * Signal bindings, these will be linked and unlinked along with the view
      * @private
+     * @readonly
      * @type {SignalBinding[]}
      */
     bindings = [];
@@ -84,14 +87,24 @@ class View {
      */
     transformOrigin = new Vector2(0.5, 0.5);
 
+    /**
+     * @readonly
+     */
     on = {
+        /**
+         * @readonly
+         */
         linked: new Signal(),
+        /**
+         * @readonly
+         */
         unlinked: new Signal()
     };
 
     /**
      *
      * @type {View[]}
+     * @readonly
      */
     children = [];