@makefully/platypus 4.1.9 → 4.1.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/platypus",
-    "version": "4.1.9",
+    "version": "4.1.10",
     "description": "2D tile-based HTML5 game engine with a component-based entity model",
     "license": "MIT",
     "contributors": [

package/src/AssetManager.js

@@ -26,6 +26,9 @@ const
             'src', path,
             'data', asset.data ?? null
         );
+    },
+    isRegisteredWithPixi = function (alias, src) {
+        return Assets.resolver.hasKey(alias) || (src && src !== alias && Assets.resolver.hasKey(src));
     };
 
 export default class AssetManager {
@@ -71,7 +74,18 @@ export default class AssetManager {
      * @return {Object} Returns the asset if defined.
      */
     get (alias) {
-        return this.assets.get(alias);
+        if (this.assets.has(alias)) {
+            return this.assets.get(alias);
+        }
+
+        const
+            fileId = this.getFileId(alias);
+
+        if (fileId !== alias && this.assets.has(fileId)) {
+            return this.assets.get(fileId);
+        }
+
+        return undefined;
     }
 
     /**
@@ -131,6 +145,7 @@ export default class AssetManager {
         const
             counts = this.counts,
             needsLoading = arrayCache.setUp(),
+            needsRelink = arrayCache.setUp(),
             adds = Data.setUp();
 
         if (platypus.game?.options?.images ?? platypus.game?.options?.audio) {
@@ -154,13 +169,39 @@ export default class AssetManager {
                 adds[alias] += 1;
             } else {
                 adds[alias] = 1;
+                if (isRegisteredWithPixi(alias, item.src)) {
+                    needsRelink.push(item);
+                } else {
+                    needsLoading.push(item);
+                }
+            }
+        }
+
+        for (let i = needsRelink.length - 1; i >= 0; i--) {
+            const
+                item = needsRelink[i],
+                alias = item.alias[0],
+                asset = Assets.get(alias) ?? Assets.get(item.src);
+
+            if (asset) {
+                this.set(alias, asset, adds[alias]);
+                needsRelink.splice(i, 1);
+            } else {
                 needsLoading.push(item);
+                needsRelink.splice(i, 1);
             }
         }
 
         if (needsLoading.length) {
             // Do this first to pass `data` property if needed
-            needsLoading.forEach((asset) => Assets.add(asset));
+            needsLoading.forEach((asset) => {
+                const
+                    alias = asset.alias[0];
+
+                if (!isRegisteredWithPixi(alias, asset.src)) {
+                    Assets.add(asset);
+                }
+            });
 
             const
                 aliases = needsLoading.map((asset) => asset.alias[0]),
@@ -188,6 +229,7 @@ export default class AssetManager {
         }
 
         arrayCache.recycle(needsLoading);
+        arrayCache.recycle(needsRelink);
     }
 
     /**

package/src/VOPlayer.js

@@ -662,7 +662,7 @@ class VOPlayer extends Messenger {
      * @public
      */
     unloadSound (sound) {
-        this.assetCache.delete(sound);
+        this.assetCache.delete(this.assetCache.getFileId(sound));
     }
 
     /**

package/src/components/LevelBuilder.js

@@ -1,5 +1,6 @@
 /* global atob, platypus */
 import {arrayCache, greenSlice, greenSplice, union} from '../utils/array.js';
+import {cloneDefinition} from '../utils/clone.js';
 import createComponentClass from '../factory.js';
 import {inflate} from 'pako';
 import TiledLoader from './TiledLoader.js';
@@ -31,6 +32,21 @@ const
         }
         return layer;
     },
+    cloneLevelDefinition = cloneDefinition,
+    copySegmentProperty = function (target, source, key) {
+        if (target[key]) {
+            return;
+        }
+
+        const
+            value = source[key];
+
+        if (value != null && typeof value === 'object') {
+            target[key] = cloneDefinition(value);
+        } else {
+            target[key] = value;
+        }
+    },
     mergeData = function (levelData, levelMergeAxisLength, segmentData, segmentMergeAxisLength, nonMergeAxisLength, mergeAxis) {
         const
             combined = greenSlice(levelData);
@@ -54,9 +70,7 @@ const
 
         for (let i = 0; i < obj2s.length; i++) {
             const
-                obj = {
-                    ...obj2s[i]
-                };
+                obj = cloneLevelDefinition(obj2s[i]);
 
             if (mergeAxis === 'horizontal') {
                 obj.x += mergeAxisLength;
@@ -68,6 +82,8 @@ const
         return list;
     },
     mergeSegment  = function (level, segment, mergeAxis) {
+        segment = cloneLevelDefinition(segment);
+
         if (!level.tilewidth && !level.tileheight) {
             //set level tile size data if it's not already set.
             level.tilewidth  = segment.tilewidth;
@@ -96,9 +112,7 @@ const
                 decodeLayer(segment.layers[i]);
                 
                 const
-                    layer = level.layers[i] = {
-                        ...segment.layers[i]
-                    };
+                    layer = level.layers[i] = cloneLevelDefinition(segment.layers[i]);
 
                 // If we're adding objects, make sure that they're offset correctly.
                 if (layer.objects) {
@@ -149,9 +163,7 @@ const
                 const
                     key = keys[i];
 
-                if (!level[key]) {
-                    level[key] = segment[key];
-                }
+                copySegmentProperty(level, segment, key);
             }
         }
     },
@@ -200,6 +212,8 @@ const
         return level;
     },
     mirrorSegment = function (segment) {
+        segment = cloneLevelDefinition(segment);
+
         const
             newSegment = {
                 layers: []
@@ -211,9 +225,7 @@ const
 
             const
                 fromLayer = segment.layers[i],
-                toLayer = newSegment.layers[i] = {
-                    ...fromLayer
-                };
+                toLayer = newSegment.layers[i] = cloneLevelDefinition(fromLayer);
 
             if (fromLayer.data) {
                 const
@@ -237,9 +249,7 @@ const
                 for (let j = 0; j < fromObjects.length; j++) {
                     const
                         fromObject = fromObjects[j],
-                        toObject = toObjects[j] = {
-                            ...fromObject
-                        };
+                        toObject = toObjects[j] = cloneLevelDefinition(fromObject);
 
                     toObject.x = width - fromObject.x - (fromObject.width || 0); // subtract object width since its top-left corner is the origin.
                     if (fromObject.rotation) {
@@ -265,9 +275,7 @@ const
                 const
                     key = keys[i];
 
-                if (!newSegment[key]) {
-                    newSegment[key] = segment[key];
-                }
+                copySegmentProperty(newSegment, segment, key);
             }
         }
 
@@ -351,6 +359,10 @@ export default createComponentClass(/** @lends platypus.components.LevelBuilder.
 
     events: {
         "layer-loaded": function (data) {
+            if (data?.level && typeof data.level === 'object') {
+                return;
+            }
+
             const
                 piecesToCopy = data?.levelPieces ?? this.levelPieces;
             
@@ -417,7 +429,10 @@ export default createComponentClass(/** @lends platypus.components.LevelBuilder.
                  * @param data.persistentData.levelPieces {Object} An object of key/value pairs listing the pieces that map to an id in the level template.
                  * @param data.persistentData.useUniques {Boolean} If true, no single map piece is used twice in the creation of the combined map.
                  */
-                this.owner.triggerEvent('created-level', this.levelMessage);
+                this.owner.triggerEvent('created-level', {
+                    level: cloneLevelDefinition(this.levelMessage.level),
+                    persistentData: this.levelMessage.persistentData
+                });
 
                 /**
                  * Dispatched when the scene has loaded and the level has been composited so TileLoader can begin loading the level.
@@ -462,6 +477,9 @@ export default createComponentClass(/** @lends platypus.components.LevelBuilder.
                 throw new Error(`Level Builder: There are no level pieces of type: ${type}`);
             }
         },
+        cloneLevel: function (level) {
+            return cloneLevelDefinition(level);
+        },
         destroy: function () {
             this.levelMessage.level = null;
             this.levelMessage.persistentData = null;

package/src/components/Render.js

@@ -98,8 +98,18 @@ export default createComponentClass(/** @lends platypus.components.RenderSprite.
     initialize () {
         const
             {image, images, localRotation, localScaleX, localScaleY, offsetX, offsetY, offsetZ, options, owner, spriteType} = this,
+            resolveTexture = (path) => {
+                const
+                    texture = platypus.assetCache.get(path);
+
+                if (!texture) {
+                    platypus.debug.warn(`Render: Image is not a loaded asset: ${path}`);
+                }
+
+                return texture;
+            },
             sprite = this.sprite = new spriteTypes[spriteType === 'Sprite' && images && !images ? 'AnimatedSprite' : spriteType]({
-                ...(image ? {texture: platypus.assetCache.get(image)} : {textures: images.map((image) => platypus.assetCache.get(image))}),
+                ...(image ? {texture: resolveTexture(image)} : {textures: images.map((path) => resolveTexture(path))}),
                 ...options ?? {}
             }),
             matchEntity = this.matchEntity ? {

package/src/components/TiledLoader.js

@@ -1,5 +1,6 @@
 /* global atob, platypus */
 import {arrayCache, greenSlice, union} from '../utils/array.js';
+import {cloneDefinition} from '../utils/clone.js';
 import AABB from '../AABB.js';
 import Data from '../Data.js';
 import DataMap from '../DataMap.js';
@@ -336,6 +337,7 @@ const
     },
     checkLevel = function (levelOrLevelId, ss) {
         const
+            cacheAssetsOnLevel = typeof levelOrLevelId === 'string',
             addObjectGroupAssets = (assets, objectGroup, tilesets) => {
                 const objects = objectGroup.objects;
 
@@ -356,7 +358,7 @@ const
                 level.tilesets = importTilesetData(level.tilesets);
             }
 
-            if (level.assets) { // Property added by a previous parse (so that this algorithm isn't run on the same level multiple times)
+            if (cacheAssetsOnLevel && level.assets) { // Property added by a previous parse (so that this algorithm isn't run on the same level multiple times)
                 union(assets, level.assets);
             } else if (level.layers) {
                 for (let i = 0; i < level.layers.length; i++) {
@@ -405,7 +407,7 @@ const
                                             tile = tiles[l];
 
                                         if (((tile.id + firstgid) === id) && tile.objectgroup) {
-                                            addObjectGroupAssets(assets, tile.objectgroup);
+                                            addObjectGroupAssets(assets, tile.objectgroup, level.tilesets);
                                         }
                                     }
                                 }
@@ -452,7 +454,9 @@ const
                     union(assets, tilesets);
                     arrayCache.recycle(tilesets);
                 }
-                level.assets = greenSlice(assets); // Save for later in case this level is checked again.
+                if (cacheAssetsOnLevel) {
+                    level.assets = greenSlice(assets); // Save for later in case this level is checked again.
+                }
             }
         }
         
@@ -746,7 +750,7 @@ export default createComponentClass(/** @lends platypus.components.TiledLoader.p
                 } = layerProperties ? checkParallax(layer) : layer,
                 mapOffsetX = offsetX + layerOffsetX,
                 mapOffsetY = offsetY + layerOffsetY,
-                layerDefinition = JSON.parse(JSON.stringify(platypus.game.settings.entities[entityKind] ?? standardEntityLayers[entityKind])), //TODO: a bit of a hack to copy an object instead of overwrite values
+                layerDefinition = cloneDefinition(platypus.game.settings.entities[entityKind] ?? standardEntityLayers[entityKind]),
                 layerDefinitionProperties = layerDefinition.properties = layerDefinition.properties ?? {},
                 {components} = layerDefinition,
                 importAnimation = {},

package/src/utils/clone.js

@@ -0,0 +1,11 @@
+/**
+ * Deep-clones plain JSON-like definitions (level pieces, entity templates, etc.)
+ * without sharing nested arrays or objects with the source.
+ *
+ * @method cloneDefinition
+ * @param {*} definition
+ * @return {*}
+ */
+export function cloneDefinition (definition) {
+    return structuredClone(definition);
+}