@woosh/meep-engine 2.100.3 → 2.101.0

package/package.json

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

package/src/engine/graphics/FrameRunner.d.ts

@@ -1,5 +1,6 @@
 /**
- *
+ * Fires a given function every frame. Typical usage is to create an instance, invoke {@link #startup} and once no longer required - invoke {@link #shutdown}
+ * Wraps {@link requestAnimationFrame}
  */
 export class FrameRunner {
     /**
@@ -13,22 +14,12 @@ export class FrameRunner {
      */
     action: Function;
     /**
-     *
-     * @type {boolean}
-     */
-    running: boolean;
-    /**
-     *
-     * @type {number}
-     */
-    animationFrameId: number;
-    /**
-     *
+     * Begins animation loop. Does nothing and returns false if already running.
      * @returns {boolean}
      */
     startup(): boolean;
     /**
-     *
+     * Stops animation loop. Does nothing and returns false if not currently running.
      * @returns {boolean}
      */
     shutdown(): boolean;
@@ -37,5 +28,6 @@ export class FrameRunner {
      * @returns {boolean}
      */
     isRunning(): boolean;
+    #private;
 }
 //# sourceMappingURL=FrameRunner.d.ts.map

package/src/engine/graphics/FrameRunner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrameRunner.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics/FrameRunner.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IACI;;;OAGG;IACH,8BAgBC;IAfG;;;OAGG;IACH,iBAAoB;IACpB;;;OAGG;IACH,SAFU,OAAO,CAEG;IACpB;;;OAGG;IACH,kBAFU,MAAM,CAEU;IAG9B;;;OAGG;IACH,WAFa,OAAO,CA2BnB;IAED;;;OAGG;IACH,YAFa,OAAO,CAiBnB;IAED;;;OAGG;IACH,aAFa,OAAO,CAInB;CACJ"}
+{"version":3,"file":"FrameRunner.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics/FrameRunner.js"],"names":[],"mappings":"AAMA;;;GAGG;AACH;IAYI;;;OAGG;IACH,8BAMC;IALG;;;OAGG;IACH,iBAAoB;IAGxB;;;OAGG;IACH,WAFa,OAAO,CA2BnB;IAED;;;OAGG;IACH,YAFa,OAAO,CAiBnB;IAED;;;OAGG;IACH,aAFa,OAAO,CAInB;;CACJ"}

package/src/engine/graphics/FrameRunner.js

@@ -1,9 +1,25 @@
+/**
+ *
+ * @type {number}
+ */
 let global_count = 0;
 
 /**
- *
+ * Fires a given function every frame. Typical usage is to create an instance, invoke {@link #startup} and once no longer required - invoke {@link #shutdown}
+ * Wraps {@link requestAnimationFrame}
  */
 export class FrameRunner {
+    /**
+     *
+     * @type {boolean}
+     */
+    #running = false;
+    /**
+     *
+     * @type {number}
+     */
+    #animationFrameId = -1;
+
     /**
      *
      * @param {function} action
@@ -14,66 +30,56 @@ export class FrameRunner {
          * @type {Function}
          */
         this.action = action;
-        /**
-         *
-         * @type {boolean}
-         */
-        this.running = false;
-        /**
-         *
-         * @type {number}
-         */
-        this.animationFrameId = -1;
     }
 
     /**
-     *
+     * Begins animation loop. Does nothing and returns false if already running.
      * @returns {boolean}
      */
     startup() {
-        if (this.running) {
+        if (this.#running) {
             return false;
         }
 
-        console.warn(`FrameFunner.started[${global_count}]`);
+        // console.warn(`FrameFunner.started[${global_count}]`);
 
         global_count++;
 
-        this.running = true;
+        this.#running = true;
 
         const cycle = () => {
-            if (!this.running) {
+            if (!this.#running) {
                 //not supposed to be running, bail
                 return;
             }
 
             this.action();
 
-            this.animationFrameId = requestAnimationFrame(cycle);
+            this.#animationFrameId = requestAnimationFrame(cycle);
         }
 
-        this.animationFrameId = requestAnimationFrame(cycle);
+        this.#animationFrameId = requestAnimationFrame(cycle);
 
         return true;
     }
 
     /**
-     *
+     * Stops animation loop. Does nothing and returns false if not currently running.
      * @returns {boolean}
      */
     shutdown() {
-        if (!this.running) {
+        if (!this.#running) {
             return false;
         }
 
         global_count--;
 
-        console.warn(`FrameFunner.stopped[${global_count}]`);
+        // console.warn(`FrameFunner.stopped[${global_count}]`);
 
-        this.running = false;
-        cancelAnimationFrame(this.animationFrameId);
+        this.#running = false;
+        cancelAnimationFrame(this.#animationFrameId);
 
-        this.animationFrameId = -1;
+        this.#animationFrameId = -1;
 
         return true;
     }
@@ -83,6 +89,6 @@ export class FrameRunner {
      * @returns {boolean}
      */
     isRunning() {
-        return this.running;
+        return this.#running;
     }
 }