@woosh/meep-engine 2.126.69 → 2.126.72

package/package.json

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

package/src/engine/asset/AssetManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AssetManager.d.ts","sourceRoot":"","sources":["../../../../src/engine/asset/AssetManager.js"],"names":[],"mappings":"AA8CA;;;;GAIG;AACH;IAgII;;;;;OAKG;IACH,oCAJW,GAAG,EAYb;IA7ID;;;;OAIG;IACH,eAEG;IAEH;;;OAGG;IACH,aAFU,YAAY,gBAAgB,EAAE,YAAY,CAAC,CAER;IAe7C;;;;;;OAMG;IACH,kBAFU,MAAM,CAEY;IAyB5B;;;;OAIG;IACH,iBAAc;IAEd;;;OAGG;IACH,mBAFU,iBAAiB,CAEiB;IAwE5C,gBAQC;IAED;;;;OAIG;IACH,qBAHW,MAAM,GACL,QAAQ,IAAI,CAAC,CAexB;IAED;;;;;OAKG;IACH,oCAFa,OAAO,CAOnB;IAED;;OAEG;IACH,cAEC;IAED,8BAEC;IAED;;;;;;OAMG;IACH,4DAJW,iBAAiB,GAEf,cAAc,CAY1B;IAED;;;;;;;;;OASG;IACH,qFAsCC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uBAZW,MAAM,QACN,MAAM,gBAEJ,mBAAiB,CA4D7B;IAED;;;;;;;;OAQG;IACH,kBAJW,MAAM,QACN,MAAM,2BAiChB;IA2QD;;;;;OAKG;IACH,sBA2BC;IAGD;;;;OAIG;IACH,uBAHW,MAAM,GACL,OAAO,CAIlB;IAED;;;;OAIG;IACH,sBAHW,MAAM,GACJ,wBAAY,SAAS,CAMjC;IAaD;;;;OAIG;IACH,+BAHW,MAAM,4CAqBhB;IAED;;;;OAIG;IACH,iCAHW,MAAM,+CAyBhB;IAED;;;;;;OAMG;IACH,6BAJW,MAAM,kCAEJ,QAAQ,OAAO,CAAC,CAU5B;IAED;;;;;OAKG;IACH,0BAJW,MAAM,iEAwChB;IAED;;;OAGG;IACH,uBAFW,MAAM,iBAkBhB;IAED;;;;;;OAMG;IACH,yCAFa,aAAS,IAAI,CAYzB;IAED;;;;;OAKG;IACH,eAJW,MAAM,QACN,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,2BAHW,MAAM,GACL,mBAAiB,CAa5B;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACL,gBAAgB,GAAC,SAAS,CAQrC;IAED;;;;;OAKG;IACH,mBAJW,MAAM,QACN,MAAM,QACN,MAAM,QAUhB;IAGL;;;OAGG;IACH,yBAFU,OAAO,CAEoB;;CANpC;4BA78B2B,0CAA0C;iCAOrC,uBAAuB;6BAM3B,mBAAmB;kCAFd,6BAA6B;kCAD7B,wBAAwB;4BAE9B,0BAA0B"}
+{"version":3,"file":"AssetManager.d.ts","sourceRoot":"","sources":["../../../../src/engine/asset/AssetManager.js"],"names":[],"mappings":"AA8CA;;;;GAIG;AACH;IAmII;;;;;OAKG;IACH,oCAJW,GAAG,EAYb;IAhJD;;;;OAIG;IACH,eAEG;IAEH;;;OAGG;IACH,aAFU,YAAY,gBAAgB,EAAE,YAAY,CAAC,CAER;IAe7C;;;;;;OAMG;IACH,kBAFU,MAAM,CAEY;IA4B5B;;;;OAIG;IACH,iBAAc;IAEd;;;OAGG;IACH,mBAFU,iBAAiB,CAEiB;IAwE5C,gBAQC;IAED;;;;OAIG;IACH,qBAHW,MAAM,GACL,QAAQ,IAAI,CAAC,CAexB;IAED;;;;;OAKG;IACH,oCAFa,OAAO,CAOnB;IAED;;OAEG;IACH,cAEC;IAED,8BAEC;IAED;;;;;;OAMG;IACH,4DAJW,iBAAiB,GAEf,cAAc,CAY1B;IAED;;;;;;;;;OASG;IACH,qFAsCC;IAED;;;;;;;OAOG;IACH,gBAJW,MAAM,QACN,MAAM,GACL,OAAO,CAKlB;IAGD;;;;;;OAMG;IACH,eALW,MAAM,QACN,MAAM,GACJ,OAAO,CAOnB;IAED;;;;;;;OAOG;IACH,eAJW,MAAM,QACN,MAAM,GACL,OAAO,CAMlB;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uBAZW,MAAM,QACN,MAAM,gBAEJ,mBAAiB,CA4D7B;IAED;;;;;;;;OAQG;IACH,kBAJW,MAAM,QACN,MAAM,2BAoChB;IA8QD;;;;;OAKG;IACH,sBA2BC;IAGD;;;;OAIG;IACH,uBAHW,MAAM,GACL,OAAO,CAIlB;IAED;;;;OAIG;IACH,sBAHW,MAAM,GACJ,wBAAY,SAAS,CAMjC;IAaD;;;;;;;;;;OAUG;IACH,+BALW,MAAM,uCAEJ,IAAI,CAqBhB;IAED;;;;;;OAMG;IACH,iCALW,MAAM,uCAEJ,OAAO,CAyBnB;IAED;;;;;;OAMG;IACH,6BAJW,MAAM,kCAEJ,QAAQ,OAAO,CAAC,CAU5B;IAED;;;;;OAKG;IACH,0BAJW,MAAM,iEAwChB;IAED;;;OAGG;IACH,uBAFW,MAAM,iBAkBhB;IAED;;;;;;;OAOG;IACH,yCAFa,aAAS,IAAI,CAYzB;IAED;;;;OAIG;IACH,2BAHW,MAAM,GACL,mBAAiB,CAa5B;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACL,gBAAgB,GAAC,SAAS,CAQrC;IAED;;;;;OAKG;IACH,mBAJW,MAAM,QACN,MAAM,QACN,MAAM,QAUhB;IAGL;;;OAGG;IACH,yBAFU,OAAO,CAEoB;;CANpC;4BA5/B2B,0CAA0C;iCAOrC,uBAAuB;6BAM3B,mBAAmB;kCAFd,6BAA6B;kCAD7B,wBAAwB;4BAE9B,0BAA0B"}

package/src/engine/asset/AssetManager.js

@@ -88,14 +88,14 @@ export class AssetManager {
     load_concurrency = Infinity;
 
     /**
-     * Registered #loaders
+     * Registered asset loaders
      * @private
      * @type {Object<AssetLoader>}
      */
     #loaders = {};
 
     /**
-     * After asset is loaded, a chain of transforms can be applied to it, these are registered here
+     * After an asset is loaded, a chain of transforms can be applied to it, these are registered here
      * Transformers are executed in the order in which they are added
      * Identified by asset "type" string
      * @type {Object<AssetTransformer[]>}
@@ -107,6 +107,9 @@ export class AssetManager {
      * Named links to specific assets. Useful to later re-mapping assets and having meaningful names for them
      * @type {Map<string, AssetDescription>}
      * @private
+     * @see resolveAlias
+     * @see assignAlias
+     * @see promiseByAlias
      */
     #aliases = new Map();
 
@@ -316,6 +319,47 @@ export class AssetManager {
         }
     }
 
+    /**
+     * Checks if an asset is currently being loaded.
+     * Useful for avoiding redundant requests.
+     *
+     * @param {string} path
+     * @param {string} type
+     * @return {boolean}
+     */
+    isPending(path, type) {
+        const assetDescription = new AssetDescription(path, type);
+        return this.request_map.has(assetDescription);
+    }
+
+
+    /**
+     *
+     * @param {string} path
+     * @param {string} type
+     * @returns {boolean}
+     * @see isPending
+     */
+    isFailed(path, type) {
+        const ad = new AssetDescription(path, type);
+
+        return this.#failures.has(ad);
+    }
+
+    /**
+     * Checks if an asset is loaded.
+     * If the asset is loaded, calls to {@link tryGet} are guaranteed to succeed.
+     *
+     * @param {string} path
+     * @param {string} type
+     * @return {boolean}
+     */
+    isLoaded(path, type) {
+        const ad = new AssetDescription(path, type);
+
+        return this.assets.has(ad);
+    }
+
     /**
      * Same as {@link insert}, but will register the asset as pending until loader function resolves.
      *
@@ -341,7 +385,7 @@ export class AssetManager {
         const asset_descriptor = new AssetDescription(path, type);
 
         if (this.request_map.get(asset_descriptor)) {
-            throw new Error(`Asset with path ${path} and type ${type} is already pending`);
+            throw new Error(`Asset with path '${path}' and type '${type}' is already pending`);
         }
 
         const pending = new PendingAsset(asset_descriptor);
@@ -379,7 +423,7 @@ export class AssetManager {
 
                 return asset;
             } else {
-                throw new Error(`Race condition. Asset with path ${path} and type ${type} was already resolved somewhere else.`);
+                throw new Error(`Race condition. Asset with path '${path}' and type '${type}' was already resolved somewhere else.`);
             }
         }, error => {
             cleanup();
@@ -411,10 +455,13 @@ export class AssetManager {
             console.warn(`Another asset under ${asset_descritptor} already exists and will be replaced`);
         }
 
+        // clear failures
+        this.#failures.delete(asset_descritptor);
+
         // check for assets in-flight
         const pending = this.request_map.get(asset_descritptor);
         if (pending !== undefined) {
-            console.warn(`Asset with path ${path} and type ${type} is already pending, this operation will squash the asset in-flight`);
+            console.warn(`Asset with path '${path}' and type '${type}' is already pending, this operation will squash the asset in-flight`);
 
             this.request_map.delete(asset_descritptor);
 
@@ -573,7 +620,7 @@ export class AssetManager {
 
             let asset = loaded_asset;
 
-            // apply transform chain
+            // apply the transform chain
             const transformers = this.#transformers[type];
             if (transformers !== undefined) {
                 const transformer_count = transformers.length;
@@ -590,13 +637,16 @@ export class AssetManager {
                 }
             }
 
-            //link asset description
+            // link asset description
             asset.description = assetDescription;
 
-            //register asset
+            // clear possible failure
+            this.#failures.delete(assetDescription);
+
+            // register asset
             assets.set(assetDescription, asset);
 
-            //clear callbacks etc.
+            // clear callbacks etc.
             this.#handle_asset_resolved(pendingAsset);
 
 
@@ -763,9 +813,15 @@ export class AssetManager {
     }
 
     /**
+     * Transformer will be applied to all assets of the given type in order of registration.
+     *
+     * Does not apply retroactively, assets that were already loaded will not be transformed.
+     *
      * @template T
      * @param {string} type
      * @param {AssetTransformer<T>} transformer
+     * @returns {void}
+     * @see removeTransformer
      */
     registerTransformer(type, transformer) {
         let transformers = this.#transformers[type];
@@ -791,6 +847,8 @@ export class AssetManager {
      * @template T
      * @param {string} type
      * @param {AssetTransformer<T>} transformer
+     * @returns {boolean} true if removed, false if not found
+     * @see registerTransformer
      */
     unregisterTransformer(type, transformer) {
 
@@ -821,7 +879,7 @@ export class AssetManager {
      * @template T
      * @param {string} type
      * @param {AssetLoader<T>} loader
-     * @returns {Promise<boolean>} true if registered , false otherwise
+     * @returns {Promise<boolean>} true if registered, false otherwise
      */
     async tryRegisterLoader(type, loader) {
         if (this.hasLoaderForType(type)) {
@@ -837,7 +895,7 @@ export class AssetManager {
      * @template T
      * @param {string} type
      * @param {AssetLoader<T>} loader
-     * @throws if a loader is already registered for the given type
+     * @throws {Error} if a loader is already registered for the given type
      */
     async registerLoader(type, loader) {
         assert.isString(type, 'type');
@@ -900,8 +958,9 @@ export class AssetManager {
     }
 
     /**
+     * Retrieve an asset if it is loaded, returns null if the asset is not loaded.
+     * Does not trigger loading if the asset is not loaded.
      * @template T
-     * Retrieve an asset if it is loaded, returns null if asset is not loaded.
      * @param {String} path
      * @param {String} type
      * @returns {Asset<T>|null}
@@ -918,18 +977,6 @@ export class AssetManager {
         }
     }
 
-    /**
-     *
-     * @param {string} path
-     * @param {string} type
-     * @returns {boolean}
-     */
-    isFailed(path, type) {
-        const ad = new AssetDescription(path, type);
-
-        return this.#failures.has(ad);
-    }
-
     /**
      * @template T
      * @param {string} alias