Jsdocs: ParseToTilemap

Author: mikewesthad

v3/src/gameobjects/tilemap/ParseToTilemap.js

@@ -3,7 +3,28 @@ var Parse = require('./parsers/Parse');
 var MapData = require('./mapdata/MapData');
 var Tilemap = require('./Tilemap');
 
-// Parse from key or data and create a Tilemap. If neither is given, make an empty Tilemap.
+/**
+ * Create a Tilemap from the given key or data. If neither is given, make a blank Tilemap. When
+ * loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from
+ * a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For
+ * an empty map, you should specify tileWidth, tileHeight, width & height.
+ *
+ * @param {Scene} scene - [description]
+ * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.
+ * @param {number} [tileWidth=32] - The width of a tile in pixels.
+ * @param {number} [tileHeight=32] - The height of a tile in pixels.
+ * @param {number} [width=10] - The width of the map in tiles.
+ * @param {number} [height=10] - The height of the map in tiles.
+ * @param {array} [data] - Instead of loading from the cache, you can also load directly from a 2D
+ * array of tile indexes.
+ * @param {boolean} [insertNull=false] - 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.
+ * @returns {Tilemap}
+ */
 var ParseToTilemap = function (scene, key, tileWidth, tileHeight, width, height, data, insertNull)
 {
     if (tileWidth === undefined) { tileWidth = 32; }

v3/src/gameobjects/tilemap/TilemapCreator.js

@@ -4,7 +4,10 @@ var ParseToTilemap = require('./ParseToTilemap');
 //  When registering a factory function 'this' refers to the GameObjectCreator context.
 
 /**
- * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.
+ * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data
+ * provided. When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When
+ * parsing from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the
+ * map data. For an empty map, you should specify tileWidth, tileHeight, width & height.
  *
  * @param {object} [config] - The config options for the Tilemap.
  * @param {string} [config.key] - The key in the Phaser cache that corresponds to the loaded tilemap

v3/src/gameobjects/tilemap/TilemapFactory.js

@@ -11,6 +11,9 @@ var ParseToTilemap = require('./ParseToTilemap');
 
 /**
  * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.
+ * When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing
+ * from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map
+ * data. For an empty map, you should specify tileWidth, tileHeight, width & height.
  *
  * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.
  * @param {number} [tileWidth=32] - The width of a tile in pixels. Pass in `null` to leave as the