JSDoc fixes

Author: photonstorm

src/tilemaps/components/FindByIndex.js

@@ -15,9 +15,8 @@
  * @since 3.0.0
  *
  * @param {number} index - The tile index value to search for.
- * @param {number} [skip=0] - The number of times to skip a matching tile before returning.
- * @param {boolean} [reverse=false] - If true it will scan the layer in reverse, starting at the
- * bottom-right. Otherwise it scans from the top-left.
+ * @param {number} skip - The number of times to skip a matching tile before returning.
+ * @param {boolean} reverse - If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {?Phaser.Tilemaps.Tile} The first (or n skipped) tile with the matching index.

src/tilemaps/components/GetTileAt.js

@@ -14,7 +14,7 @@ var IsInLayerBounds = require('./IsInLayerBounds');
  *
  * @param {number} tileX - X position to get the tile from (given in tile units, not pixels).
  * @param {number} tileY - Y position to get the tile from (given in tile units, not pixels).
- * @param {boolean} [nonNull=false] - If true getTile won't return null for empty tiles, but a Tile object with an index of -1.
+ * @param {boolean} nonNull - If true getTile won't return null for empty tiles, but a Tile object with an index of -1.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates were invalid.

src/tilemaps/components/GetTileAtWorldXY.js

@@ -17,12 +17,11 @@ var point = new Vector2();
  *
  * @param {number} worldX - X position to get the tile from (given in pixels)
  * @param {number} worldY - Y position to get the tile from (given in pixels)
- * @param {boolean} [nonNull=false] - If true, function won't return null for empty tiles, but a Tile object with an index of -1.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {boolean} nonNull - If true, function won't return null for empty tiles, but a Tile object with an index of -1.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
- * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates
- * were invalid.
+ * @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates were invalid.
  */
 var GetTileAtWorldXY = function (worldX, worldY, nonNull, camera, layer)
 {

src/tilemaps/components/HasTileAtWorldXY.js

@@ -18,7 +18,7 @@ var point = new Vector2();
  *
  * @param {number} worldX - The X coordinate of the world position.
  * @param {number} worldY - The Y coordinate of the world position.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when factoring in which tiles to return.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {?boolean} Returns a boolean, or null if the layer given was invalid.

src/tilemaps/components/HexagonalTileToWorldXY.js

@@ -16,15 +16,15 @@ var Vector2 = require('../../math/Vector2');
  *
  * @param {number} tileX - The x coordinate, in tiles, not pixels.
  * @param {number} tileY - The y coordinate, in tiles, not pixels.
- * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {Phaser.Math.Vector2} The XY location in world coordinates.
  */
 var HexagonalTileToWorldXY = function (tileX, tileY, point, camera, layer)
 {
-    if (point === undefined) { point = new Vector2(); }
+    if (!point) { point = new Vector2(); }
 
     var tileWidth = layer.baseTileWidth;
     var tileHeight = layer.baseTileHeight;
@@ -35,7 +35,7 @@ var HexagonalTileToWorldXY = function (tileX, tileY, point, camera, layer)
 
     if (tilemapLayer)
     {
-        if (camera === undefined) { camera = tilemapLayer.scene.cameras.main; }
+        if (!camera) { camera = tilemapLayer.scene.cameras.main; }
 
         layerWorldX = tilemapLayer.x + camera.scrollX * (1 - tilemapLayer.scrollFactorX);
 

src/tilemaps/components/HexagonalTileToWorldY.js

@@ -12,7 +12,7 @@
  * @since 3.50.0
  *
  * @param {number} tileY - The y coordinate, in tiles, not pixels.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {number} The Y location in world coordinates.

src/tilemaps/components/HexagonalWorldToTileXY.js

@@ -16,25 +16,24 @@ var Vector2 = require('../../math/Vector2');
  *
  * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.
  * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.
- * @param {boolean} [snapToFloor=true] - Whether or not to round the tile coordinates down to the nearest integer.
- * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {boolean} snapToFloor - Whether or not to round the tile coordinates down to the nearest integer.
+ * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {Phaser.Math.Vector2} The XY location in tile units.
  */
 var HexagonalWorldToTileXY = function (worldX, worldY, snapToFloor, point, camera, layer)
 {
-    if (snapToFloor === undefined) { snapToFloor = true; }
-    if (point === undefined) { point = new Vector2(); }
+    if (!point) { point = new Vector2(); }
 
     var tileWidth = layer.baseTileWidth;
     var tileHeight = layer.baseTileHeight;
     var tilemapLayer = layer.tilemapLayer;
 
     if (tilemapLayer)
     {
-        if (camera === undefined) { camera = tilemapLayer.scene.cameras.main; }
+        if (!camera) { camera = tilemapLayer.scene.cameras.main; }
 
         // Find the world position relative to the static or dynamic layer's top left origin,
         // factoring in the camera's vertical scroll

src/tilemaps/components/HexagonalWorldToTileY.js

@@ -12,22 +12,20 @@
  * @since 3.50.0
  *
  * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.
- * @param {boolean} [snapToFloor=true] - Whether or not to round the tile coordinate down to the nearest integer.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {number} The Y location in tile units.
  */
 var HexagonalWorldToTileY = function (worldY, snapToFloor, camera, layer)
 {
-    if (snapToFloor === undefined) { snapToFloor = true; }
-
     var tileHeight = layer.baseTileHeight;
     var tilemapLayer = layer.tilemapLayer;
 
     if (tilemapLayer)
     {
-        if (camera === undefined) { camera = tilemapLayer.scene.cameras.main; }
+        if (!camera) { camera = tilemapLayer.scene.cameras.main; }
 
         //  Find the world position relative to the static or dynamic layer's top left origin,
         //  factoring in the camera's vertical scroll

src/tilemaps/components/IsometricTileToWorldXY.js

@@ -16,15 +16,15 @@ var Vector2 = require('../../math/Vector2');
  *
  * @param {number} tileX - The x coordinate, in tiles, not pixels.
  * @param {number} tileY - The y coordinate, in tiles, not pixels.
- * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {Phaser.Math.Vector2} The XY location in world coordinates.
  */
 var IsometricTileToWorldXY = function (tileX, tileY, point, camera, layer)
 {
-    if (point === undefined) { point = new Vector2(); }
+    if (!point) { point = new Vector2(); }
 
     var tileWidth = layer.baseTileWidth;
     var tileHeight = layer.baseTileHeight;
@@ -35,7 +35,7 @@ var IsometricTileToWorldXY = function (tileX, tileY, point, camera, layer)
 
     if (tilemapLayer)
     {
-        if (camera === undefined) { camera = tilemapLayer.scene.cameras.main; }
+        if (!camera) { camera = tilemapLayer.scene.cameras.main; }
 
         layerWorldX = tilemapLayer.x + camera.scrollX * (1 - tilemapLayer.scrollFactorX);
 

src/tilemaps/components/IsometricWorldToTileXY.js

@@ -16,25 +16,24 @@ var Vector2 = require('../../math/Vector2');
  *
  * @param {number} worldX - The x coordinate to be converted, in pixels, not tiles.
  * @param {number} worldY - The y coordinate to be converted, in pixels, not tiles.
- * @param {boolean} [snapToFloor=true] - Whether or not to round the tile coordinate down to the nearest integer.
- * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
+ * @param {boolean} snapToFloor - Whether or not to round the tile coordinate down to the nearest integer.
+ * @param {Phaser.Math.Vector2} point - A Vector2 to store the coordinates in. If not given a new Vector2 is created.
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use when calculating the tile index from the world values.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  *
  * @return {Phaser.Math.Vector2} The XY location in tile units.
  */
 var IsometricWorldToTileXY = function (worldX, worldY, snapToFloor, point, camera, layer)
 {
-    if (snapToFloor === undefined) { snapToFloor = true; }
-    if (point === undefined) { point = new Vector2(); }
+    if (!point) { point = new Vector2(); }
 
     var tileWidth = layer.baseTileWidth;
     var tileHeight = layer.baseTileHeight;
     var tilemapLayer = layer.tilemapLayer;
 
     if (tilemapLayer)
     {
-        if (camera === undefined) { camera = tilemapLayer.scene.cameras.main; }
+        if (!camera) { camera = tilemapLayer.scene.cameras.main; }
 
         // Find the world position relative to the static or dynamic layer's top left origin,
         // factoring in the camera's vertical scroll