Added Weltmeister support to Loader & Tilemap API

Author: mikewesthad

src/gameobjects/tilemap/parsers/Parse.js

@@ -2,6 +2,7 @@
 var Parse2DArray = require('./Parse2DArray');
 var ParseCSV = require('./ParseCSV');
 var ParseTiledJSON = require('./parsetiledjson/');
+var ParseWeltmister = require('./parseweltmeister/');
 var Formats = require('../Formats');
 
 /**
@@ -39,6 +40,9 @@ var Parse = function (name, mapFormat, data, tileWidth, tileHeight, insertNull)
         case (Formats.TILED_JSON):
             newMap = ParseTiledJSON(name, data, insertNull);
             break;
+        case (Formats.WELTMEISTER):
+            newMap = ParseWeltmister(name, data, insertNull);
+            break;
         default:
             console.warn('Unrecognized tilemap data format: ' + mapFormat);
             newMap = null;

src/gameobjects/tilemap/parsers/parseweltmeister/ParseTileLayers.js

@@ -0,0 +1,61 @@
+var LayerData = require('../../mapdata/LayerData');
+var Tile = require('../../Tile');
+
+var ParseTileLayers = function (json, insertNull)
+{
+    var tileLayers = [];
+
+    for (var i = 0; i < json.layer.length; i++)
+    {
+        var layer = json.layer[i];
+
+        var layerData = new LayerData({
+            name: layer.name,
+            width: layer.width,
+            height: layer.height,
+            tileWidth: layer.tilesize,
+            tileHeight: layer.tilesize,
+            visible: layer.visible === 1
+        });
+
+        var row = [];
+        var tileGrid = [];
+
+        //  Loop through the data field in the JSON. This is a 2D array containing the tile indexes,
+        //  one after the other. The indexes are relative to the tileset that contains the tile.
+        for (var y = 0; y < layer.data.length; y++)
+        {
+            for (var x = 0; x < layer.data[y].length; x++)
+            {
+                // In Weltmeister, 0 = no tile, but the Tilemap API expects -1 = no tile.
+                var index = layer.data[y][x] - 1;
+
+                var tile;
+
+                if (index > -1)
+                {
+                    tile = new Tile(layerData, index, x, y, layer.tilesize, layer.tilesize);
+                }
+                else
+                {
+                    tile = insertNull
+                        ? null
+                        : new Tile(layerData, -1, x, y, layer.tilesize, layer.tilesize);
+                }
+
+                row.push(tile);
+            }
+
+            tileGrid.push(row);
+            row = [];
+        }
+
+        layerData.data = tileGrid;
+
+        tileLayers.push(layerData);
+    }
+
+    return tileLayers;
+};
+
+module.exports = ParseTileLayers;

src/gameobjects/tilemap/parsers/parseweltmeister/ParseTilesets.js

@@ -0,0 +1,29 @@
+var Tileset = require('../../Tileset');
+
+var ParseTilesets = function (json)
+{
+    var tilesets = [];
+    var tilesetsNames = [];
+
+    for (var i = 0; i < json.layer.length; i++)
+    {
+        var layer = json.layer[i];
+
+        // A relative filepath to the source image (within Weltmeister) is used for the name
+        var tilesetName = layer.tilesetName;
+
+        // Only add unique tilesets that have a valid name. Collision layers will have a blank name.
+        if (tilesetName !== '' && tilesetsNames.indexOf(tilesetName) === -1)
+        {
+            tilesetsNames.push(tilesetName);
+
+            // Tiles are stored with an ID relative to the tileset, rather than a globally unique ID
+            // across all tilesets. Also, tilesets in Weltmeister have no margin or padding.
+            tilesets.push(new Tileset(tilesetName, 0, layer.tilesize, layer.tilesize, 0, 0));
+        }
+    }
+
+    return tilesets;
+};
+
+module.exports = ParseTilesets;

src/gameobjects/tilemap/parsers/parseweltmeister/index.js

@@ -0,0 +1,49 @@
+var Formats = require('../../Formats');
+var MapData = require('../../mapdata/MapData');
+var ParseTilesets = require('./ParseTilesets');
+var ParseTileLayers = require('./ParseTileLayers');
+
+/**
+ * Parses a Weltmeister JSON object into a new MapData object.
+ *
+ * @param {string} name - The name of the tilemap, used to set the name on the MapData.
+ * @param {object} json - The Weltmeister JSON object.
+ * @param {boolean} insertNull - Controls how empty tiles, tiles with an index of -1, in the map
+ * data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty
+ * location will get a Tile object with an index of -1. If you've a large sparsely populated map and
+ * the tile data doesn't need to change then setting this value to `true` will help with memory
+ * consumption. However if your map is small or you need to update the tiles dynamically, then leave
+ * the default value set.
+ */
+var ParseWeltmeister = function (name, json, insertNull)
+{
+    if (json.layer.length === 0)
+    {
+        console.warn('No layers found in the Weltmeister map: ' + name);
+        return null;
+    }
+
+    var width = 0;
+    var height = 0;
+    for (var i = 0; i < json.layer.length; i++)
+    {
+        if (json.layer.width > width) { width = json.layer.width; }
+        if (json.layer.height > height) { height = json.layer.height; }
+    }
+
+    var mapData = new MapData({
+        width: width,
+        height: height,
+        name: name,
+        tileWidth: json.layer[0].tilesize,
+        tileHeight: json.layer[0].tilesize,
+        format: Formats.WELTMEISTER
+    });
+
+    mapData.layers = ParseTileLayers(json, insertNull);
+    mapData.tilesets = ParseTilesets(json);
+
+    return mapData;
+};
+
+module.exports = ParseWeltmeister;

src/loader/Loader.js

@@ -133,11 +133,16 @@ var Loader = new Class({
         return TilemapCSVFile.create(this, key, url, TILEMAP_FORMATS.CSV, xhrSettings);
     },
 
-    tilemapJSON: function (key, url, xhrSettings)
+    tilemapTiledJSON: function (key, url, xhrSettings)
     {
         return TilemapJSONFile.create(this, key, url, TILEMAP_FORMATS.TILED_JSON, xhrSettings);
     },
 
+    tilemapWeltmeister: function (key, url, xhrSettings)
+    {
+        return TilemapJSONFile.create(this, key, url, TILEMAP_FORMATS.WELTMEISTER, xhrSettings);
+    },
+
     //  ---------------------------------------------------
     //  Multi-File Loaders
     //  ---------------------------------------------------