@woosh/meep-engine 2.98.1 → 2.98.3

package/build/meep.module.js

@@ -888,6 +888,13 @@ function m4_multiply(out, a, b) {
     out[15] = b0 * a03 + b1 * a13 + b2 * a23 + b3 * a33;
 }
 
+const SignalFlags = {
+    /**
+     * If set - signal will not invoke handlers when dispatched
+     */
+    Silent: 1
+};
+
 /**
  *
  * @enum {number}
@@ -966,18 +973,6 @@ class SignalHandler {
  */
 SignalHandler.prototype.isSignalHandler = true;
 
-const SignalFlags = {
-    /**
-     * If set - signal will not invoke handlers when dispatched
-     */
-    Silent: 1,
-    /**
-     * Is set at the start of the dispatch and cleared at the end
-     * @deprecated
-     */
-    Dispatching: 2
-};
-
 /**
  *
  * @author Alex Goldring
@@ -987,6 +982,7 @@ const SignalFlags = {
 
 /**
  * Common dispatch stack
+ * @readonly
  * @type {SignalHandler[]}
  */
 const dispatch_stack = [];
@@ -999,40 +995,17 @@ let dispatch_stack_top = 0;
  */
 class Signal {
     /**
-     * Event dispatcher dedicated to single event type
-     * @constructor
-     */
-    constructor() {
-        /**
-         * @private
-         * @type {SignalHandler[]}
-         */
-        this.handlers = [];
-
-        /**
-         * Internal flag bitmask
-         * @private
-         * @type {number}
-         */
-        this.flags = 0;
-    }
-
-    /**
-     * @deprecated
-     * @returns {boolean}
+     * @private
+     * @type {SignalHandler[]}
      */
-    get dispatching() {
-        return this.getFlag(SignalFlags.Dispatching);
-    }
+    handlers = [];
 
     /**
-     * @deprecated
-     * @param {boolean} v
+     * Internal flag bitmask
+     * @private
+     * @type {number}
      */
-    set dispatching(v) {
-        this.writeFlag(SignalFlags.Dispatching, v);
-    }
-
+    flags = 0;
 
     /**
      *
@@ -1094,14 +1067,15 @@ class Signal {
 
 
     /**
-     *
-     * @param {function} h
+     * Checks if a given signal handler is present or not
+     * @param {function} handler
+     * @param {*} [thisArg] if not present, will not be considered
      * @returns {boolean}
      */
-    contains(h) {
+    contains(handler, thisArg) {
         const handlers = this.handlers;
 
-        const i = findSignalHandlerIndexByHandle(handlers, h);
+        const i = findSignalHandlerIndexByHandle(handlers, handler, thisArg);
 
         return i !== -1;
     }
@@ -1123,7 +1097,7 @@ class Signal {
     }
 
     /**
-     *
+     * Handler will only be run once, it will be removed automatically after the first execution
      * @param {function} h
      * @param {*} [context]
      */
@@ -1170,7 +1144,10 @@ class Signal {
     }
 
     /**
-     * Remove all handlers
+     * Remove all handlers.
+     * Please note that this will remove even all handlers, irrespective of where they were added from. If another script is attaching to the same signal, using this method will potentially break that code.
+     * For most use cases, prefer to use {@link remove} method instead, or make use of {@link SignalBinding} if you need to keep track of multiple handlers
+     * NOTE: Consider this method to be unsafe, only use it when you understand the implications
      */
     removeAll() {
         const handlers = this.handlers;
@@ -1178,6 +1155,7 @@ class Signal {
     }
 
     /**
+     * NOTE: because of polymorphic call-site nature of this method, it's always better for performance to use monomorphic methods like `send0`, `send1` etc.
      * @param {...*} args
      */
     dispatch(...args) {
@@ -1186,13 +1164,8 @@ class Signal {
             return;
         }
 
-        //mark dispatch process
-        this.setFlag(SignalFlags.Dispatching);
-
         dispatchViaProxy(this.handlers, args);
 
-        //mark end of dispatch process
-        this.clearFlag(SignalFlags.Dispatching);
     }
 
     /**
@@ -1558,14 +1531,6 @@ class Signal {
         dispatch_stack_top = stack_pointer;
     }
 
-    /**
-     * @deprecated do not use
-     * @returns {boolean}
-     */
-    isDispatching() {
-        return this.getFlag(SignalFlags.Dispatching);
-    }
-
     /**
      *
      * @param {Signal} other
@@ -1596,7 +1561,7 @@ Signal.prototype.isSignal = true;
  *
  * @param {SignalHandler[]} handlers
  * @param {function} f
- * @param thisArg
+ * @param {*} [thisArg]
  * @returns {number} index of the handler, or -1 if not found
  */
 function findSignalHandlerIndexByHandle(handlers, f, thisArg) {
@@ -68274,6 +68239,23 @@ class SignalBinding {
         this.#linked = false;
         this.signal.remove(this.handler, this.context);
     }
+
+    /**
+     * Creates a {@link SignalBinding} and links it immediately. Utility method
+     * @param {Signal} signal
+     * @param {function} handler
+     * @param {*} [context]
+     * @return {SignalBinding}
+     */
+    static bind(
+        signal, handler, context
+    ) {
+        const r = new SignalBinding(signal, handler, context);
+
+        r.link();
+
+        return r;
+    }
 }
 
 /**

package/package.json

@@ -5,7 +5,7 @@
   "description": "Fully featured ECS game engine written in JavaScript",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.98.1",
+  "version": "2.98.3",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/core/events/signal/Signal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Signal.d.ts","sourceRoot":"","sources":["../../../../../src/core/events/signal/Signal.js"],"names":[],"mappings":"AAsnBA;;;;;;GAMG;AACH,yDALW,aAAa,EAAE,8BAGb,MAAM,CAoBlB;AAED;;;;;;GAMG;AACH,mEALW,aAAa,EAAE,0BAGb,MAAM,CAclB;AAiDD;;;;GAIG;AACH,2CAHW,aAAa,EAAE,sBA8BzB;AAnuBD;;;;GAIG;AACH;IAMQ;;;OAGG;IACH,iBAAkB;IAElB;;;;OAIG;IACH,cAAc;IAYlB;;;OAGG;IACH,8BAGC;IAhBD;;;OAGG;IACH,2BAGC;IAqBD;;;OAGG;IACH,yBAEC;IAfD;;;OAGG;IACH,sBAEC;IAYD;;;;OAIG;IACH,cAHW,MAAM;;;KAAY,GAChB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM;;;KAAY,GAChB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM;;;KAAY,SAClB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM;;;KAAY,GAChB,OAAO,CAInB;IAGD;;;;OAIG;IACH,uBAFa,OAAO,CAQnB;IAED,aAEC;IAED,eAEC;IAED;;;OAGG;IACH,eAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,yCAQC;IAED;;;;OAIG;IACH,sCAYC;IAED;;;;;OAKG;IACH,oCAFa,OAAO,CAUnB;IAED;;OAEG;IACH,kBAGC;IAED;;OAEG;IACH,+BAaC;IAED;;;OAGG;IACH,cA4CC;IAED;;;;OAIG;IACH,sBA6CC;IAED;;;;OAIG;IACH,4BA4CC;IAED;;;;;OAKG;IACH,oCA4CC;IAED;;;;;;OAMG;IACH,4CA4CC;IAED;;;;;;;;OAQG;IACH,4DA4CC;IAED;;;;;;;;;;OAUG;IACH,4EA4CC;IAED;;;OAGG;IACH,iBAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,aAHW,MAAM,GACJ,MAAM,CAalB;IAIL;;;OAGG;IACH,mBAFU,OAAO,CAEQ;CAPxB;;8BArmBiD,oBAAoB"}
+{"version":3,"file":"Signal.d.ts","sourceRoot":"","sources":["../../../../../src/core/events/signal/Signal.js"],"names":[],"mappings":"AAslBA;;;;;;GAMG;AACH,yDALW,aAAa,EAAE,+BAGb,MAAM,CAoBlB;AAED;;;;;;GAMG;AACH,mEALW,aAAa,EAAE,0BAGb,MAAM,CAclB;AAiDD;;;;GAIG;AACH,2CAHW,aAAa,EAAE,sBA8BzB;AAlsBD;;;;GAIG;AACH;IACI;;;OAGG;IACH,iBAAc;IAEd;;;;OAIG;IACH,cAAU;IAWV;;;OAGG;IACH,yBAEC;IAfD;;;OAGG;IACH,sBAEC;IAYD;;;;OAIG;IACH,cAHW,MAAM;;KAAY,GAChB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM;;KAAY,GAChB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM;;KAAY,SAClB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM;;KAAY,GAChB,OAAO,CAInB;IAGD;;;;;OAKG;IACH,4CAFa,OAAO,CAQnB;IAED,aAEC;IAED,eAEC;IAED;;;OAGG;IACH,eAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,yCAQC;IAED;;;;OAIG;IACH,sCAYC;IAED;;;;;OAKG;IACH,oCAFa,OAAO,CAUnB;IAED;;;;;OAKG;IACH,kBAGC;IAED;;;OAGG;IACH,+BAQC;IAED;;;OAGG;IACH,cA4CC;IAED;;;;OAIG;IACH,sBA6CC;IAED;;;;OAIG;IACH,4BA4CC;IAED;;;;;OAKG;IACH,oCA4CC;IAED;;;;;;OAMG;IACH,4CA4CC;IAED;;;;;;;;OAQG;IACH,4DA4CC;IAED;;;;;;;;;;OAUG;IACH,4EA4CC;IAED;;;;OAIG;IACH,aAHW,MAAM,GACJ,MAAM,CAalB;IAIL;;;OAGG;IACH,mBAFU,OAAO,CAEQ;CAPxB;;8BApkBiD,oBAAoB"}

package/src/core/events/signal/Signal.js

@@ -6,11 +6,12 @@
 
 
 import { assert } from "../../assert.js";
-import { SignalHandler, SignalHandlerFlags } from "./SignalHandler.js";
 import { SignalFlags } from "./SignalFlags.js";
+import { SignalHandler, SignalHandlerFlags } from "./SignalHandler.js";
 
 /**
  * Common dispatch stack
+ * @readonly
  * @type {SignalHandler[]}
  */
 const dispatch_stack = [];
@@ -23,42 +24,17 @@ let dispatch_stack_top = 0;
  */
 export class Signal {
     /**
-     * Event dispatcher dedicated to single event type
-     * @constructor
+     * @private
+     * @type {SignalHandler[]}
      */
-    constructor() {
-        /**
-         * @private
-         * @type {SignalHandler[]}
-         */
-        this.handlers = [];
-
-        /**
-         * Internal flag bitmask
-         * @private
-         * @type {number}
-         */
-        this.flags = 0;
-    }
+    handlers = [];
 
     /**
-     * @deprecated
-     * @returns {boolean}
+     * Internal flag bitmask
+     * @private
+     * @type {number}
      */
-    get dispatching() {
-        console.warn('deprecated, use .isDispatching instead');
-        return this.getFlag(SignalFlags.Dispatching);
-    }
-
-    /**
-     * @deprecated
-     * @param {boolean} v
-     */
-    set dispatching(v) {
-        console.warn('deprecated, flag should not be written to from outside of the signal');
-        this.writeFlag(SignalFlags.Dispatching, v);
-    }
-
+    flags = 0;
 
     /**
      *
@@ -120,14 +96,15 @@ export class Signal {
 
 
     /**
-     *
-     * @param {function} h
+     * Checks if a given signal handler is present or not
+     * @param {function} handler
+     * @param {*} [thisArg] if not present, will not be considered
      * @returns {boolean}
      */
-    contains(h) {
+    contains(handler, thisArg) {
         const handlers = this.handlers;
 
-        const i = findSignalHandlerIndexByHandle(handlers, h);
+        const i = findSignalHandlerIndexByHandle(handlers, handler, thisArg);
 
         return i !== -1;
     }
@@ -149,7 +126,7 @@ export class Signal {
     }
 
     /**
-     *
+     * Handler will only be run once, it will be removed automatically after the first execution
      * @param {function} h
      * @param {*} [context]
      */
@@ -199,7 +176,10 @@ export class Signal {
     }
 
     /**
-     * Remove all handlers
+     * Remove all handlers.
+     * Please note that this will remove even all handlers, irrespective of where they were added from. If another script is attaching to the same signal, using this method will potentially break that code.
+     * For most use cases, prefer to use {@link remove} method instead, or make use of {@link SignalBinding} if you need to keep track of multiple handlers
+     * NOTE: Consider this method to be unsafe, only use it when you understand the implications
      */
     removeAll() {
         const handlers = this.handlers;
@@ -207,6 +187,7 @@ export class Signal {
     }
 
     /**
+     * NOTE: because of polymorphic call-site nature of this method, it's always better for performance to use monomorphic methods like `send0`, `send1` etc.
      * @param {...*} args
      */
     dispatch(...args) {
@@ -215,13 +196,8 @@ export class Signal {
             return;
         }
 
-        //mark dispatch process
-        this.setFlag(SignalFlags.Dispatching);
-
         dispatchViaProxy(this.handlers, args);
 
-        //mark end of dispatch process
-        this.clearFlag(SignalFlags.Dispatching);
     }
 
     /**
@@ -594,14 +570,6 @@ export class Signal {
         dispatch_stack_top = stack_pointer;
     }
 
-    /**
-     * @deprecated do not use
-     * @returns {boolean}
-     */
-    isDispatching() {
-        return this.getFlag(SignalFlags.Dispatching);
-    }
-
     /**
      *
      * @param {Signal} other
@@ -632,7 +600,7 @@ Signal.prototype.isSignal = true;
  *
  * @param {SignalHandler[]} handlers
  * @param {function} f
- * @param thisArg
+ * @param {*} [thisArg]
  * @returns {number} index of the handler, or -1 if not found
  */
 export function findSignalHandlerIndexByHandle(handlers, f, thisArg) {

package/src/core/events/signal/SignalBinding.d.ts

@@ -2,6 +2,14 @@
  * Utility class for managing connection between listeners to signals
  */
 export class SignalBinding {
+    /**
+     * Creates a {@link SignalBinding} and links it immediately. Utility method
+     * @param {Signal} signal
+     * @param {function} handler
+     * @param {*} [context]
+     * @return {SignalBinding}
+     */
+    static bind(signal: Signal, handler: Function, context?: any): SignalBinding;
     /**
      *
      * @param {Signal} signal

package/src/core/events/signal/SignalBinding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SignalBinding.d.ts","sourceRoot":"","sources":["../../../../../src/core/events/signal/SignalBinding.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;IAWI;;;;;;OAMG;IACH,8DA+BC;IA1CD,sBAEC;IAsBG;;;OAGG;IACH,eAAoB;IAEpB;;;OAGG;IACH,kBAAsB;IAEtB;;;OAGG;IACH,aAAsB;IAI1B;;;OAGG;IACH,aAOC;IAED;;;OAGG;IACH,eAOC;;CACJ"}
+{"version":3,"file":"SignalBinding.d.ts","sourceRoot":"","sources":["../../../../../src/core/events/signal/SignalBinding.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;IA6EI;;;;;;OAMG;IACH,+DAFY,aAAa,CAUxB;IAjFD;;;;;;OAMG;IACH,8DA+BC;IA1CD,sBAEC;IAsBG;;;OAGG;IACH,eAAoB;IAEpB;;;OAGG;IACH,kBAAsB;IAEtB;;;OAGG;IACH,aAAsB;IAI1B;;;OAGG;IACH,aAOC;IAED;;;OAGG;IACH,eAOC;;CAkBJ"}

package/src/core/events/signal/SignalBinding.js

@@ -77,4 +77,21 @@ export class SignalBinding {
         this.#linked = false;
         this.signal.remove(this.handler, this.context);
     }
+
+    /**
+     * Creates a {@link SignalBinding} and links it immediately. Utility method
+     * @param {Signal} signal
+     * @param {function} handler
+     * @param {*} [context]
+     * @return {SignalBinding}
+     */
+    static bind(
+        signal, handler, context
+    ) {
+        const r = new SignalBinding(signal, handler, context);
+
+        r.link();
+
+        return r;
+    }
 }

package/src/core/events/signal/SignalFlags.d.ts

@@ -1,5 +1,4 @@
 export namespace SignalFlags {
     let Silent: number;
-    let Dispatching: number;
 }
 //# sourceMappingURL=SignalFlags.d.ts.map

package/src/core/events/signal/SignalFlags.js

@@ -2,10 +2,5 @@ export const SignalFlags = {
     /**
      * If set - signal will not invoke handlers when dispatched
      */
-    Silent: 1,
-    /**
-     * Is set at the start of the dispatch and cleared at the end
-     * @deprecated
-     */
-    Dispatching: 2
+    Silent: 1
 }

package/src/core/model/node-graph/node/NodeDescription.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NodeDescription.d.ts","sourceRoot":"","sources":["../../../../../../src/core/model/node-graph/node/NodeDescription.js"],"names":[],"mappings":"AAyCA;IACI;;;OAGG;IACH,MAFU,MAAM,CAEN;IAEV;;;;;;OAMG;IACH,IAFU,MAAM,CAEO;IAEvB;;;OAGG;IACH,iBAFU,IAAI,EAAE,CAEL;IAEX;;;OAGG;IACH,YAFU,wBAAwB,EAAE,CAEpB;IAEhB;;OAEG;IACH;QACI;;;WAGG;4BADO,OAAO,IAAI,CAAC;QAGtB;;;WAGG;8BADO,OAAO,IAAI,CAAC;MAGxB;IAEF;;;;OAIG;IACH,4CAEC;IAED;;;OAGG;IACH,uBAEC;IAED;;;OAGG;IACH,sBAEC;IAED;;;;;;OAMG;IACH,sBALW,MAAM,QACN,qBAAqB,iBACrB,MAAM,GAAC,OAAO,GAAC,MAAM,GACnB,MAAM,CA0ClB;IAED;;;;OAIG;IACH,iBAHW,MAAM,GACJ,wBAAwB,CAiBpC;IAGD;;;;;OAKG;IACH,oDAFW,aAAa,UA2BvB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,OAAO,CAsBnB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,IAAI,GAAC,IAAI,CAgBrB;IAED;;;;OAIG;IACH,qBAHW,MAAM,GACL,IAAI,EAAE,CAwBjB;IAED;;;;OAIG;IACH,+BAHW,aAAa,GACZ,IAAI,EAAE,CAuBjB;IAED;;;;;OAKG;IACH,iCAJW,MAAM,aACN,aAAa,GACZ,IAAI,GAAC,SAAS,CAmBzB;IAED;;;OAGG;IACH,YAFa,IAAI,EAAE,CAIlB;IAED;;;;OAIG;IACH,cAHW,eAAe,GACb,OAAO,CAOnB;IAED,mBAEC;IAED;;;;MAMC;IAED;;;;;;OAMG;IACH;;;;qCAIC;IAKL;;;OAGG;IACH,4BAFU,OAAO,CAE0B;CAR1C;;;;qBA/XoB,WAAW;yCADS,yCAAyC;mBAH/D,kCAAkC;sCAEf,sCAAsC;8BAG9C,oBAAoB"}
+{"version":3,"file":"NodeDescription.d.ts","sourceRoot":"","sources":["../../../../../../src/core/model/node-graph/node/NodeDescription.js"],"names":[],"mappings":"AAyCA;IACI;;;OAGG;IACH,MAFU,MAAM,CAEN;IAEV;;;;;;OAMG;IACH,IAFU,MAAM,CAEO;IAEvB;;;OAGG;IACH,iBAFU,IAAI,EAAE,CAEL;IAEX;;;OAGG;IACH,YAFU,wBAAwB,EAAE,CAEpB;IAEhB;;OAEG;IACH;QACI;;;WAGG;4BADO,OAAO,IAAI,CAAC;QAGtB;;;WAGG;8BADO,OAAO,IAAI,CAAC;MAGxB;IAEF;;;;OAIG;IACH,4CAEC;IAED;;;OAGG;IACH,uBAEC;IAED;;;OAGG;IACH,sBAEC;IAED;;;;;;OAMG;IACH,sBALW,MAAM,QACN,qBAAqB,iBACrB,MAAM,GAAC,OAAO,GAAC,MAAM,GACnB,MAAM,CA0ClB;IAED;;;;OAIG;IACH,iBAHW,MAAM,GACJ,wBAAwB,CAiBpC;IAGD;;;;;;OAMG;IACH,oDAHW,aAAa,GACX,MAAM,CA2BlB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,OAAO,CAuBnB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,IAAI,GAAC,IAAI,CAgBrB;IAED;;;;OAIG;IACH,qBAHW,MAAM,GACL,IAAI,EAAE,CAwBjB;IAED;;;;OAIG;IACH,+BAHW,aAAa,GACZ,IAAI,EAAE,CAuBjB;IAED;;;;;OAKG;IACH,iCAJW,MAAM,aACN,aAAa,GACZ,IAAI,GAAC,SAAS,CAmBzB;IAED;;;OAGG;IACH,YAFa,IAAI,EAAE,CAIlB;IAED;;;;OAIG;IACH,cAHW,eAAe,GACb,OAAO,CAOnB;IAED,mBAEC;IAED;;;;MAMC;IAED;;;;;;OAMG;IACH;;;;qCAIC;IAKL;;;OAGG;IACH,4BAFU,OAAO,CAE0B;CAR1C;;;;qBAjYoB,WAAW;yCADS,yCAAyC;mBAH/D,kCAAkC;sCAEf,sCAAsC;8BAG9C,oBAAoB"}

package/src/core/model/node-graph/node/NodeDescription.js

@@ -185,6 +185,7 @@ export class NodeDescription {
      * @param {DataType} type
      * @param {String} name
      * @param {PortDirection} direction
+     * @returns {number} ID of the newly created port
      */
     createPort(type, name, direction) {
         assert.defined(type, 'type');
@@ -237,6 +238,7 @@ export class NodeDescription {
             }
         }
 
+        // port not found
         return false;
     }