Merge pull request phaserjs#2050 from joshpmcghee/dev

Feature: Add support for loading single-layer Pyxel Edit TileMap as an Atlas

Author: photonstorm

src/animation/AnimationParser.js

@@ -144,6 +144,62 @@ Phaser.AnimationParser = {
 
     },
 
+    /**
+    * Parse the JSON data and extract the animation frame data from it.
+    *
+    * @method Phaser.AnimationParser.JSONDataPyxel
+    * @param {Phaser.Game} game - A reference to the currently running game.
+    * @param {object} json - The JSON data from the Texture Atlas. Must be in Pyxel JSON format.
+    * @return {Phaser.FrameData} A FrameData object containing the parsed frames.
+    */
+    JSONDataPyxel: function (game, json) {
+
+        //  Malformed? There are a few keys to check here.
+        var signature = ['layers', 'tilewidth','tileheight','tileswide', 'tileshigh'];
+
+        signature.forEach( function(key) {
+            if (!json[key])
+            {
+                console.warn("Phaser.AnimationParser.JSONDataPyxel: Invalid Pyxel Tilemap JSON given, missing '" + key + "' key.");
+                console.log(json);
+                return;
+            }
+        });
+
+        // For this purpose, I only care about parsing tilemaps with a single layer.
+        if(json['layers'].length != 1) {
+            console.warn("Phaser.AnimationParser.JSONDataPyxel: Too many layers, this parser only supports flat Tilemaps.");
+            console.log(json);
+            return;
+        }
+
+        var data = new Phaser.FrameData();
+
+        var tileheight = json['tileheight'];
+        var tilewidth = json['tilewidth'];
+
+        var frames = json['layers'][0]['tiles'];
+        var newFrame;
+
+        for (var i = 0; i < frames.length; i++)
+        {
+            newFrame = data.addFrame(new Phaser.Frame(
+                i,
+                frames[i].x,
+                frames[i].y,
+                tilewidth,
+                tileheight,
+                "frame_" + i  // No names are included in pyxel tilemap data.
+            ));
+
+            // No trim data is included.
+            newFrame.setTrim(false);
+        }
+
+        return data;
+
+    },
+
     /**
     * Parse the JSON data and extract the animation frame data from it.
     *
@@ -237,7 +293,7 @@ Phaser.AnimationParser = {
         for (var i = 0; i < frames.length; i++)
         {
             frame = frames[i].attributes;
-            
+
             name = frame.name.value;
             x = parseInt(frame.x.value, 10);
             y = parseInt(frame.y.value, 10);

src/loader/Cache.js

@@ -6,12 +6,12 @@
 
 /**
 * Phaser has one single cache in which it stores all assets.
-* 
+*
 * The cache is split up into sections, such as images, sounds, video, json, etc. All assets are stored using
 * a unique string-based key as their identifier. Assets stored in different areas of the cache can have the
 * same key, for example 'playerWalking' could be used as the key for both a sprite sheet and an audio file,
 * because they are unique data types.
-* 
+*
 * The cache is automatically populated by the Phaser.Loader. When you use the loader to pull in external assets
 * such as images they are automatically placed into their respective cache. Most common Game Objects, such as
 * Sprites and Videos automatically query the cache to extract the assets they need on instantiation.
@@ -604,6 +604,10 @@ Phaser.Cache.prototype = {
         {
             obj.frameData = Phaser.AnimationParser.XMLData(this.game, atlasData, key);
         }
+        else if (format === Phaser.Loader.TEXTURE_ATLAS_JSON_PYXEL)
+        {
+            obj.frameData = Phaser.AnimationParser.JSONDataPyxel(this.game, atlasData, key);
+        }
         else
         {
             //  Let's just work it out from the frames array
@@ -986,7 +990,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Get an item from a cache based on the given key and property.
-    * 
+    *
     * This method is mostly used internally by other Cache methods such as `getImage` but is exposed
     * publicly for your own use as well.
     *
@@ -1017,16 +1021,16 @@ Phaser.Cache.prototype = {
                 return this._cacheMap[cache][key][property];
             }
         }
-        
+
         return null;
 
     },
 
     /**
     * Gets a Canvas object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getCanvas
@@ -1041,13 +1045,13 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Image object from the cache. This returns a DOM Image object, not a Phaser.Image object.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
-    * 
+    *
     * Only the Image cache is searched, which covers images loaded via Loader.image, Sprite Sheets and Texture Atlases.
-    * 
+    *
     * If you need the image used by a bitmap font or similar then please use those respective 'get' methods.
     *
     * @method Phaser.Cache#getImage
@@ -1084,7 +1088,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Get a single texture frame by key.
-    * 
+    *
     * You'd only do this to get the default Frame created for a non-atlas / spritesheet image.
     *
     * @method Phaser.Cache#getTextureFrame
@@ -1099,9 +1103,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Phaser.Sound object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getSound
@@ -1116,9 +1120,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a raw Sound data object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getSoundData
@@ -1133,9 +1137,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Text object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getText
@@ -1150,11 +1154,11 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Physics Data object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
-    * 
+    *
     * You can get either the entire data set, a single object or a single fixture of an object from it.
     *
     * @method Phaser.Cache#getPhysicsData
@@ -1212,9 +1216,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a raw Tilemap data object from the cache. This will be in either CSV or JSON format.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getTilemapData
@@ -1229,9 +1233,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a binary object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getBinary
@@ -1246,9 +1250,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a BitmapData object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getBitmapData
@@ -1263,9 +1267,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Bitmap Font object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getBitmapFont
@@ -1280,11 +1284,11 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a JSON object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
-    * 
+    *
     * You can either return the object by reference (the default), or return a clone
     * of it by setting the `clone` argument to `true`.
     *
@@ -1317,9 +1321,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets an XML object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getXML
@@ -1334,9 +1338,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Phaser.Video object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getVideo
@@ -1351,9 +1355,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a fragment shader object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getShader
@@ -1368,9 +1372,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a RenderTexture object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getRenderTexture
@@ -1444,9 +1448,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Phaser.FrameData object from the Image Cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getFrameData
@@ -1580,7 +1584,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a PIXI.BaseTexture by key from the PIXI.BaseTextureCache.
-    * 
+    *
     * If the texture isn't found in the cache, then it searches the Phaser Image Cache.
     *
     * @method Phaser.Cache#getPixiBaseTexture
@@ -1684,7 +1688,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Removes an image from the cache.
-    * 
+    *
     * You can optionally elect to destroy it as well. This calls BaseTexture.destroy on it.
     *
     * Note that this only removes it from the Phaser and PIXI Caches. If you still have references to the data elsewhere