@woosh/meep-engine 2.131.11 → 2.131.13

package/package.json

@@ -5,7 +5,7 @@
   "description": "Pure JavaScript game engine. Fully featured and production ready.",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.131.11",
+  "version": "2.131.13",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/engine/asset/preloader/AssetPreloader.d.ts

@@ -12,7 +12,7 @@
  *  const assetManager:AssetManager = ...; // Obtain your asset manager
  *
  *  loader.on.progress.add(({global}) => console.log(`loaded ${global.ratio*100}%`));
- *  loader.on.completed.add(()=> console.log("preload complete"));
+ *  loader.on.succeeded.add(()=> console.log("preload complete"));
  *
  *  loader.load(assetManager);
  */
@@ -31,17 +31,40 @@ export class AssetPreloader {
      * @readonly
      */
     readonly on: {
-        added: Signal<any, any, any, any, any, any, any, any>;
-        progress: Signal<any, any, any, any, any, any, any, any>;
-        levelFinished: Signal<any, any, any, any, any, any, any, any>;
+        /**
+         * @type {Signal<AssetLoadSpec,number>}
+         */
+        added: Signal<AssetLoadSpec, number>;
+        /**
+         * Progress event.
+         * Note that the numbers are arbitrary and just signify overall progress and not specific quantifies such as bytes or asset counts.
+         * @type {Signal<{global:{current:number, total:number, progress: number}}>}
+         */
+        progress: Signal<{
+            global: {
+                current: number;
+                total: number;
+                progress: number;
+            };
+        }>;
+        /**
+         * Single priority has finished loading
+         * @type {Signal}
+         */
+        levelFinished: Signal;
+        /**
+         * An asset has failed to load
+         */
         error: Signal<any, any, any, any, any, any, any, any>;
         started: Signal<any, any, any, any, any, any, any, any>;
         /**
+         * Dispatched when all scheduled assets have been successfully loaded (no errors).
          * @type {Signal<number>}
          */
-        completed: Signal<number>;
+        succeeded: Signal<number>;
         /**
-         * All assets are processed, even if some have errored out
+         * All assets are processed, even if some have errored out.
+         * This is a more permissive version of {@link succeeded} signal.
          * @type {Signal<number,number>}
          */
         resolved: Signal<number, number>;

package/src/engine/asset/preloader/AssetPreloader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AssetPreloader.d.ts","sourceRoot":"","sources":["../../../../../src/engine/asset/preloader/AssetPreloader.js"],"names":[],"mappings":"AAsDA;;;;;;;;;;;;;;;;;GAiBG;AACH;IACI;;;OAGG;IACH,iBAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,iBAFU,aAAa,EAAE,EAAE,CAEf;IAEZ;;OAEG;IACH;;;;;;QAMI;;WAEG;mBADO,OAAO,MAAM,CAAC;QAGxB;;;WAGG;kBADO,OAAO,MAAM,EAAC,MAAM,CAAC;MAGjC;IAaF;;;;;;;OAOG;IACH,SANW,MAAM,QACN,MAAM,UACN,MAAM,aACN,MAAM,GACL,cAAc,CAqCzB;IAED;;;OAGG;IACH,aAFW;QAAC,GAAG,EAAC,MAAM,CAAC;QAAC,IAAI,EAAC,MAAM,CAAC;QAAC,KAAK,CAAC,EAAC,MAAM,CAAA;KAAC,EAAE,QAQpD;IAED;;;;OAIG;IACH,kCAFY,cAAc,CA+JzB;CACJ;AAED;;;GAGG;AACH,wBAFU,cAAc,CAEgB;AAhVxC;;GAEG;AACH;IA+BI;;;;OAIG;IACH,4BAFY,aAAa,CAQxB;IAxCG;;;OAGG;IACH,YAAe;IACf;;;OAGG;IACH,aAAgB;IAChB;;;OAGG;IACH,OAFU,MAAM,GAAC,UAAU,CAEK;IAChC;;;OAGG;IACH,UAFU,MAAM,CAEC;IAGrB;;;;;aAKC;CAcJ;mBAlDkB,uCAAuC;uBAEnC,iBAAiB"}
+{"version":3,"file":"AssetPreloader.d.ts","sourceRoot":"","sources":["../../../../../src/engine/asset/preloader/AssetPreloader.js"],"names":[],"mappings":"AAsDA;;;;;;;;;;;;;;;;;GAiBG;AACH;IACI;;;OAGG;IACH,iBAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,iBAFU,aAAa,EAAE,EAAE,CAEf;IAEZ;;OAEG;IACH;QACI;;WAEG;eADO,OAAO,aAAa,EAAC,MAAM,CAAC;QAGtC;;;;WAIG;kBADO,OAAO;YAAC,QAAO;gBAAC,OAAO,EAAC,MAAM,CAAC;gBAAC,KAAK,EAAC,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAC,CAAA;SAAC,CAAC;QAG3E;;;WAGG;uBADO,MAAM;QAGhB;;WAEG;;;QAGH;;;WAGG;mBADO,OAAO,MAAM,CAAC;QAGxB;;;;WAIG;kBADO,OAAO,MAAM,EAAC,MAAM,CAAC;MAGjC;IAaF;;;;;;;OAOG;IACH,SANW,MAAM,QACN,MAAM,UACN,MAAM,aACN,MAAM,GACL,cAAc,CAqCzB;IAED;;;OAGG;IACH,aAFW;QAAC,GAAG,EAAC,MAAM,CAAC;QAAC,IAAI,EAAC,MAAM,CAAC;QAAC,KAAK,CAAC,EAAC,MAAM,CAAA;KAAC,EAAE,QAQpD;IAED;;;;OAIG;IACH,kCAFY,cAAc,CAkKzB;CACJ;AAED;;;GAGG;AACH,wBAFU,cAAc,CAEgB;AApWxC;;GAEG;AACH;IA+BI;;;;OAIG;IACH,4BAFY,aAAa,CAQxB;IAxCG;;;OAGG;IACH,YAAe;IACf;;;OAGG;IACH,aAAgB;IAChB;;;OAGG;IACH,OAFU,MAAM,GAAC,UAAU,CAEK;IAChC;;;OAGG;IACH,UAFU,MAAM,CAEC;IAGrB;;;;;aAKC;CAcJ;mBAlDkB,uCAAuC;uBAEnC,iBAAiB"}

package/src/engine/asset/preloader/AssetPreloader.js

@@ -66,7 +66,7 @@ class AssetLoadSpec {
  *  const assetManager:AssetManager = ...; // Obtain your asset manager
  *
  *  loader.on.progress.add(({global}) => console.log(`loaded ${global.ratio*100}%`));
- *  loader.on.completed.add(()=> console.log("preload complete"));
+ *  loader.on.succeeded.add(()=> console.log("preload complete"));
  *
  *  loader.load(assetManager);
  */
@@ -87,17 +87,34 @@ export class AssetPreloader {
      * @readonly
      */
     on = {
+        /**
+         * @type {Signal<AssetLoadSpec,number>}
+         */
         added: new Signal(),
+        /**
+         * Progress event.
+         * Note that the numbers are arbitrary and just signify overall progress and not specific quantifies such as bytes or asset counts.
+         * @type {Signal<{global:{current:number, total:number, progress: number}}>}
+         */
         progress: new Signal(),
+        /**
+         * Single priority has finished loading
+         * @type {Signal}
+         */
         levelFinished: new Signal(),
+        /**
+         * An asset has failed to load
+         */
         error: new Signal(),
         started: new Signal(),
         /**
+         * Dispatched when all scheduled assets have been successfully loaded (no errors).
          * @type {Signal<number>}
          */
-        completed: new Signal(),
+        succeeded: new Signal(),
         /**
-         * All assets are processed, even if some have errored out
+         * All assets are processed, even if some have errored out.
+         * This is a more permissive version of {@link succeeded} signal.
          * @type {Signal<number,number>}
          */
         resolved: new Signal(),
@@ -209,13 +226,13 @@ export class AssetPreloader {
 
             const totalProcessed = numAssetsLoaded + numAssetsFailed;
 
-            if (totalProcessed <= numAssets) {
+            if (totalProcessed < numAssets) {
                 // not done yet
                 return;
             }
 
             if (numAssetsFailed === 0) {
-                on.completed.send1(numAssetsLoaded);
+                on.succeeded.send1(numAssetsLoaded);
             }
 
             on.resolved.send2(numAssetsLoaded, numAssetsFailed);
@@ -242,6 +259,7 @@ export class AssetPreloader {
             }
 
             let batchElementLoadedCount = 0;
+            let batchElementFailedCount = 0;
 
             function assetLoadSuccess(asset) {
                 batchElementLoadedCount++;
@@ -267,7 +285,7 @@ export class AssetPreloader {
                 });
 
                 //monitor completion
-                if (batchElementLoadedCount >= batchElementCount) {
+                if ((batchElementLoadedCount + batchElementFailedCount) >= batchElementCount) {
                     on.levelFinished.dispatch(level);
                 }
 
@@ -276,6 +294,8 @@ export class AssetPreloader {
 
             function assetLoadFailed(e) {
                 numAssetsFailed++;
+                batchElementFailedCount++;
+
                 on.error.dispatch(e);
 
                 try_finish();

package/src/engine/ecs/storage/BinaryBufferDeSerializer.js

@@ -61,7 +61,7 @@ class BinaryBufferDeSerializer {
             task = deserializeTask(numSerializedTypes, buffer, context, dataset, this.registry);
         }
 
-        task.on.completed.add(function () {
+        task.on.succeeded.add(function () {
             const entity_count_after = dataset.entityCount;
 
             const execution_time = task.getExecutedCpuTime();

package/src/view/asset/PreloaderView.d.ts

@@ -1,6 +1,10 @@
 export default PreloaderView;
 declare class PreloaderView extends View<HTMLElement> {
-    constructor(preloader: any);
+    /**
+     *
+     * @param {AssetPreloader} preloader
+     */
+    constructor(preloader: AssetPreloader);
     el: HTMLDivElement;
 }
 import View from "../View.js";

package/src/view/asset/PreloaderView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PreloaderView.d.ts","sourceRoot":"","sources":["../../../../src/view/asset/PreloaderView.js"],"names":[],"mappings":";AAGA;IACI,4BAiDC;IA9Cc,mBAAuC;CA+CzD;iBArDgB,YAAY"}
+{"version":3,"file":"PreloaderView.d.ts","sourceRoot":"","sources":["../../../../src/view/asset/PreloaderView.js"],"names":[],"mappings":";AAGA;IACI;;;OAGG;IACH,uCAiDC;IA9Cc,mBAAuC;CA+CzD;iBAzDgB,YAAY"}

package/src/view/asset/PreloaderView.js

@@ -2,6 +2,10 @@ import SmoothProgressBar from "../elements/progress/SmoothProgressBar.js";
 import View from "../View.js";
 
 class PreloaderView extends View {
+    /**
+     *
+     * @param {AssetPreloader} preloader
+     */
     constructor(preloader) {
         super();