Fix types in Tilemaps

Author: orblazer

src/tilemaps/Tile.js

@@ -42,7 +42,7 @@ var Tileset = new Class({
 
         /**
          * The name of the Tileset.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#name
          * @type {string}
          * @since 3.0.0
@@ -51,7 +51,7 @@ var Tileset = new Class({
 
         /**
          * The starting index of the first tile index this Tileset contains.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#firstgid
          * @type {integer}
          * @since 3.0.0
@@ -60,7 +60,7 @@ var Tileset = new Class({
 
         /**
          * The width of each tile (in pixels). Use setTileSize to change.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#tileWidth
          * @type {integer}
          * @readOnly
@@ -70,7 +70,7 @@ var Tileset = new Class({
 
         /**
          * The height of each tile (in pixels). Use setTileSize to change.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#tileHeight
          * @type {integer}
          * @readOnly
@@ -80,7 +80,7 @@ var Tileset = new Class({
 
         /**
          * The margin around the tiles in the sheet (in pixels). Use `setSpacing` to change.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#tileMargin
          * @type {integer}
          * @readOnly
@@ -90,7 +90,7 @@ var Tileset = new Class({
 
         /**
          * The spacing between each the tile in the sheet (in pixels). Use `setSpacing` to change.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#tileSpacing
          * @type {integer}
          * @readOnly
@@ -101,7 +101,7 @@ var Tileset = new Class({
         /**
          * Tileset-specific properties per tile that are typically defined in the Tiled editor in the
          * Tileset editor.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#tileProperties
          * @type {object}
          * @since 3.0.0
@@ -111,7 +111,7 @@ var Tileset = new Class({
         /**
          * Tileset-specific data per tile that are typically defined in the Tiled editor, e.g. within
          * the Tileset collision editor. This is where collision objects and terrain are stored.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#tileData
          * @type {object}
          * @since 3.0.0
@@ -120,17 +120,17 @@ var Tileset = new Class({
 
         /**
          * The cached image that contains the individual tiles. Use setImage to set.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#image
-         * @type {Phaser.Textures.Texture|null}
+         * @type {?Phaser.Textures.Texture}
          * @readOnly
          * @since 3.0.0
          */
         this.image = null;
 
         /**
          * The number of tile rows in the the tileset.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#rows
          * @type {integer}
          * @readOnly
@@ -140,7 +140,7 @@ var Tileset = new Class({
 
         /**
          * The number of tile columns in the tileset.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#columns
          * @type {integer}
          * @readOnly
@@ -150,7 +150,7 @@ var Tileset = new Class({
 
         /**
          * The total number of tiles in the tileset.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#total
          * @type {integer}
          * @readOnly
@@ -161,7 +161,7 @@ var Tileset = new Class({
         /**
          * The look-up table to specific tile image texture coordinates (UV in pixels). Each element
          * contains the coordinates for a tile in an object of the form {x, y}.
-         * 
+         *
          * @name Phaser.Tilemaps.Tileset#texCoordinates
          * @type {object[]}
          * @readOnly
@@ -178,8 +178,8 @@ var Tileset = new Class({
      * @since 3.0.0
      *
      * @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
-     * 
-     * @return {object|undefined|null}
+     *
+     * @return {?(object|undefined)}
      */
     getTileProperties: function (tileIndex)
     {
@@ -197,8 +197,8 @@ var Tileset = new Class({
      * @since 3.0.0
      *
      * @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
-     * 
-     * @return {object|undefined|null}
+     *
+     * @return {?object|undefined}
      */
     getTileData: function (tileIndex)
     {
@@ -215,8 +215,8 @@ var Tileset = new Class({
      * @since 3.0.0
      *
      * @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
-     * 
-     * @return {object|null}
+     *
+     * @return {?object}
      */
     getTileCollisionGroup: function (tileIndex)
     {
@@ -232,7 +232,7 @@ var Tileset = new Class({
      * @since 3.0.0
      *
      * @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
-     * 
+     *
      * @return {boolean}
      */
     containsTileIndex: function (tileIndex)
@@ -251,8 +251,8 @@ var Tileset = new Class({
      * @since 3.0.0
      *
      * @param {integer} tileIndex - The unique id of the tile across all tilesets in the map.
-     * 
-     * @return {object|null} Object in the form { x, y } representing the top-left UV coordinate
+     *
+     * @return {?object} Object in the form { x, y } representing the top-left UV coordinate
      * within the Tileset image.
      */
     getTileTextureCoordinates: function (tileIndex)
@@ -269,7 +269,7 @@ var Tileset = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.Textures.Texture} texture - The image that contains the tiles.
-     * 
+     *
      * @return {Phaser.Tilemaps.Tileset} This Tileset object.
      */
     setImage: function (texture)
@@ -289,7 +289,7 @@ var Tileset = new Class({
      *
      * @param {integer} [tileWidth] - The width of a tile in pixels.
      * @param {integer} [tileHeight] - The height of a tile in pixels.
-     * 
+     *
      * @return {Phaser.Tilemaps.Tileset} This Tileset object.
      */
     setTileSize: function (tileWidth, tileHeight)
@@ -313,7 +313,7 @@ var Tileset = new Class({
      *
      * @param {integer} [margin] - The margin around the tiles in the sheet (in pixels).
      * @param {integer} [spacing] - The spacing between the tiles in the sheet (in pixels).
-     * 
+     *
      * @return {Phaser.Tilemaps.Tileset} This Tileset object.
      */
     setSpacing: function (margin, spacing)
@@ -337,7 +337,7 @@ var Tileset = new Class({
      *
      * @param {integer} imageWidth - The (expected) width of the image to slice.
      * @param {integer} imageHeight - The (expected) height of the image to slice.
-     * 
+     *
      * @return {Phaser.Tilemaps.Tileset} This Tileset object.
      */
     updateTileData: function (imageWidth, imageHeight)

src/tilemaps/Tilemap.js

@@ -19,8 +19,8 @@
  * @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 {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
- * 
- * @return {Phaser.Tilemaps.Tile|null} The first (or n skipped) tile with the matching index.
+ *
+ * @return {?Phaser.Tilemaps.Tile} The first (or n skipped) tile with the matching index.
  */
 var FindByIndex = function (findIndex, skip, reverse, layer)
 {

src/tilemaps/Tileset.js

@@ -6,6 +6,16 @@
 
 var GetTilesWithin = require('./GetTilesWithin');
 
+/**
+ * @callback FindTileCallback
+ *
+ * @param {Phaser.Tilemaps.Tile} value - [description]
+ * @param {number} index - [description]
+ * @param {Phaser.Tilemaps.Tile[]} array - [description]
+ *
+ * @return {boolean} [description]
+ */
+
 /**
  * Find the first tile in the given rectangular area (in tile coordinates) of the layer that
  * satisfies the provided testing function. I.e. finds the first tile for which `callback` returns
@@ -14,7 +24,7 @@ var GetTilesWithin = require('./GetTilesWithin');
  * @function Phaser.Tilemaps.Components.FindTile
  * @since 3.0.0
  *
- * @param {function} callback - The callback. Each tile in the given area will be passed to this
+ * @param {FindTileCallback} callback - The callback. Each tile in the given area will be passed to this
  * callback as the first and only parameter.
  * @param {object} [context] - The context under which the callback should be run.
  * @param {integer} [tileX=0] - [description]
@@ -29,8 +39,8 @@ var GetTilesWithin = require('./GetTilesWithin');
  * @param {boolean} [filteringOptions.hasInterestingFace=false] - If true, only return tiles that
  * have at least one interesting face.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
- * 
- * @return {Phaser.Tilemaps.Tile|null} A Tile that matches the search, or null if no Tile found
+ *
+ * @return {?Phaser.Tilemaps.Tile} A Tile that matches the search, or null if no Tile found
  */
 var FindTile = function (callback, context, tileX, tileY, width, height, filteringOptions, layer)
 {

src/tilemaps/components/FindByIndex.js

@@ -6,14 +6,22 @@
 
 var GetTilesWithin = require('./GetTilesWithin');
 
+/**
+ * @callback EachTileCallback
+ *
+ * @param {Phaser.Tilemaps.Tile} value - [description]
+ * @param {number} index - [description]
+ * @param {Phaser.Tilemaps.Tile[]} array - [description]
+ */
+
 /**
  * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given
  * callback. Similar to Array.prototype.forEach in vanilla JS.
  *
  * @function Phaser.Tilemaps.Components.ForEachTile
  * @since 3.0.0
  *
- * @param {function} callback - The callback. Each tile in the given area will be passed to this
+ * @param {EachTileCallback} callback - The callback. Each tile in the given area will be passed to this
  * callback as the first and only parameter.
  * @param {object} [context] - The context under which the callback should be run.
  * @param {integer} [tileX=0] - [description]

src/tilemaps/components/FindTile.js

@@ -18,11 +18,11 @@ var Color = require('../../display/color');
  *
  * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.
  * @param {object} styleConfig - An object specifying the colors to use for the debug drawing.
- * @param {Color|null} [styleConfig.tileColor=blue] - Color to use for drawing a filled rectangle at
+ * @param {?Phaser.Display.Color} [styleConfig.tileColor=blue] - Color to use for drawing a filled rectangle at
  * non-colliding tile locations. If set to null, non-colliding tiles will not be drawn.
- * @param {Color|null} [styleConfig.collidingTileColor=orange] - Color to use for drawing a filled
+ * @param {?Phaser.Display.Color} [styleConfig.collidingTileColor=orange] - Color to use for drawing a filled
  * rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.
- * @param {Color|null} [styleConfig.faceColor=grey] - Color to use for drawing a line at interesting
+ * @param {?Phaser.Display.Color} [styleConfig.faceColor=grey] - Color to use for drawing a line at interesting
  * tile faces. If set to null, interesting tile faces will not be drawn.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  */