Tidying up linting, notes and comments

Author: mikewesthad

v3/src/gameobjects/tilemap/Tile.js

@@ -3,8 +3,6 @@ var Components = require('../components');
 
 var Tile = new Class({
 
-    // TODO: custom rotation or use transform component
-    // TODO: Add in bounds mixin, or custom replacement
     Mixins: [
         Components.Alpha,
         Components.Flip,
@@ -37,7 +35,7 @@ var Tile = new Class({
         this.collisionCallbackContext = this;
         this.scanned = false;
 
-        // TODO: update renders to allow for using Components.Tint
+        // Note: tint is currently a single color value instead of the 4 corner tint component
         this.tint = 0xFFFFFF;
     },
 

v3/src/gameobjects/tilemap/Tilemap.js

@@ -38,8 +38,6 @@ var Tilemap = new Class({
         this.tiles = mapData.tiles;
         this.objects = mapData.objects;
         this.currentLayerIndex = 0;
-
-        // TODO: debugging methods
     },
 
     addTilesetImage: function (tilesetName, key, tileWidth, tileHeight, tileMargin, tileSpacing, gid)
@@ -57,8 +55,6 @@ var Tilemap = new Class({
 
         var texture = this.scene.sys.textures.get(key);
 
-        // TODO: potentially add in v2 support for bitmap data
-
         var index = this.getTilesetIndex(tilesetName);
 
         if (index === null && this.format === Formats.TILEMAP_TILED_JSON)
@@ -83,8 +79,6 @@ var Tilemap = new Class({
         tileset.setImage(texture);
         this.tilesets.push(tileset);
         return tileset;
-
-        // TODO: add in GID & master list of tiles
     },
 
     // Creates & selects
@@ -127,8 +121,6 @@ var Tilemap = new Class({
         this.layers.push(layerData);
         this.currentLayerIndex = this.layers.length - 1;
 
-        // TODO: decide about v2 trimming to game width/height
-
         var dynamicLayer = new DynamicTilemapLayer(this.scene, this, this.currentLayerIndex, tileset, x, y);
         this.scene.sys.displayList.add(dynamicLayer);
 
@@ -238,9 +230,6 @@ var Tilemap = new Class({
             return null;
         }
 
-        // TODO: new feature, allow multiple CSV layers
-        // TODO: display dimension
-
         this.currentLayerIndex = index;
 
         var layer = new StaticTilemapLayer(this.scene, this, index, tileset, x, y);
@@ -266,9 +255,6 @@ var Tilemap = new Class({
             return null;
         }
 
-        // TODO: new feature, allow multiple CSV layers
-        // TODO: display dimension
-
         this.currentLayerIndex = index;
 
         var layer = new DynamicTilemapLayer(this.scene, this, index, tileset, x, y);

v3/src/gameobjects/tilemap/components/ForEachTile.js

@@ -2,20 +2,20 @@ var GetTilesWithin = require('./GetTilesWithin');
 
 /**
  * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given
- * callback.
+ * callback. Similar to Array.prototype.forEach in vanilla JS.
  *
  * @param {number} callback - The callback. Each tile in the given area will be passed to this
  * callback as the first and only parameter.
- * @param {number} context - The context under which the callback should be run.
+ * @param {number} [context] - The context under which the callback should be run.
  * @param {number} [tileX=0] - [description]
  * @param {number} [tileY=0] - [description]
  * @param {number} [width=max width based on tileX] - [description]
  * @param {number} [height=max height based on tileY] - [description]
  * @param {object} [filteringOptions] - Optional filters to apply when getting the tiles.
  * @param {boolean} [filteringOptions.isNotEmpty=false] - If true, only return tiles that don't have
  * -1 for an index.
- * @param {boolean} [filteringOptions.isColliding=false] - If true, only return tiles that collide on
- * at least one side.
+ * @param {boolean} [filteringOptions.isColliding=false] - If true, only return tiles that collide
+ * on at least one side.
  * @param {boolean} [filteringOptions.hasInterestingFace=false] - If true, only return tiles that
  * have at least one interesting face.
  * @param {LayerData} layer - [description]

v3/src/gameobjects/tilemap/components/GetTilesWithin.js

@@ -1,5 +1,3 @@
-
-
 var GetFastValue = require('../../../utils/object/GetFastValue');
 
 /**

v3/src/gameobjects/tilemap/parsers/parsetiledjson/index.js

@@ -139,7 +139,7 @@ var ParseJSONTiled = function (key, json, insertNull)
             y: GetFastValue(curi, 'offsety', 0) + curi.y,
             alpha: curi.opacity,
             visible: curi.visible,
-            properties: GetFastValue(curi, "properties", {})
+            properties: GetFastValue(curi, 'properties', {})
         });
     }