Final batch of typedefs

Author: photonstorm

src/tilemaps/Tilemap.js

@@ -838,14 +838,6 @@ var Tilemap = new Class({
         return objectLayer.objects.filter(callback, context);
     },
 
-    /**
-     * @typedef {object} FilteringOptions
-     * 
-     * @property {boolean} [isNotEmpty=false] - If true, only return tiles that don't have -1 for an index.
-     * @property {boolean} [isColliding=false] - If true, only return tiles that collide on at least one side.
-     * @property {boolean} [hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.
-     */
-
     /**
      * For each tile in the given rectangular area (in tile coordinates) of the layer, run the given
      * filter callback function. Any tiles that pass the filter test (i.e. where the callback returns
@@ -863,7 +855,7 @@ var Tilemap = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area to filter.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
      *
      * @return {?Phaser.Tilemaps.Tile[]} Returns an array of Tiles, or null if the layer given was invalid.
@@ -951,7 +943,7 @@ var Tilemap = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area to search.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The Tile layer to run the search on. If not provided will use the current layer.
      *
      * @return {?Phaser.Tilemaps.Tile} Returns a Tiles, or null if the layer given was invalid.
@@ -980,7 +972,7 @@ var Tilemap = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area to search.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The Tile layer to run the search on. If not provided will use the current layer.
      *
      * @return {?Phaser.Tilemaps.Tilemap} Returns this, or null if the layer given was invalid.
@@ -1191,7 +1183,7 @@ var Tilemap = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
      *
      * @return {?Phaser.Tilemaps.Tile[]} Returns an array of Tiles, or null if the layer given was invalid.
@@ -1214,7 +1206,7 @@ var Tilemap = new Class({
      * @since 3.0.0
      *
      * @param {(Phaser.Geom.Circle|Phaser.Geom.Line|Phaser.Geom.Rectangle|Phaser.Geom.Triangle)} shape - A shape in world (pixel) coordinates
-     * @param {FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
      *
@@ -1240,7 +1232,7 @@ var Tilemap = new Class({
      * @param {number} worldY - The world y coordinate for the top-left of the area.
      * @param {number} width - The width of the area.
      * @param {number} height - The height of the area.
-     * @param {FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
      *
@@ -1633,14 +1625,6 @@ var Tilemap = new Class({
         return TilemapComponents.RemoveTileAtWorldXY(worldX, worldY, replaceWithNull, recalculateFaces, camera, layer);
     },
 
-    /**
-     * @typedef {object} StyleConfig
-     * 
-     * @property {?number} [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.
-     * @property {?number} [collidingTileColor=orange] - Color to use for drawing a filled rectangle at colliding tile locations. If set to null, colliding tiles will not be drawn.
-     * @property {?number} [faceColor=grey] - Color to use for drawing a line at interesting tile faces. If set to null, interesting tile faces will not be drawn.
-     */
-
     /**
      * Draws a debug representation of the layer to the given Graphics. This is helpful when you want to
      * get a quick idea of which of your tiles are colliding and which have interesting faces. The tiles
@@ -1653,7 +1637,7 @@ var Tilemap = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.
-     * @param {StyleConfig} styleConfig - An object specifying the colors to use for the debug drawing.
+     * @param {Phaser.Tilemaps.Types.StyleConfig} styleConfig - An object specifying the colors to use for the debug drawing.
      * @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
      *
      * @return {?Phaser.Tilemaps.Tilemap} Return this Tilemap object, or null if the layer given was invalid.

src/tilemaps/TilemapCreator.js

@@ -7,23 +7,6 @@
 var GameObjectCreator = require('../gameobjects/GameObjectCreator');
 var ParseToTilemap = require('./ParseToTilemap');
 
-/**
- * @typedef {object} TilemapConfig
- * 
- * @property {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.
- * @property {integer[][]} [data] - Instead of loading from the cache, you can also load directly from a 2D array of tile indexes.
- * @property {integer} [tileWidth=32] - The width of a tile in pixels.
- * @property {integer} [tileHeight=32] - The height of a tile in pixels.
- * @property {integer} [width=10] - The width of the map in tiles.
- * @property {integer} [height=10] - The height of the map in tiles.
- * @property {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.
- */
-
 /**
  * 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
@@ -33,7 +16,7 @@ var ParseToTilemap = require('./ParseToTilemap');
  * @method Phaser.GameObjects.GameObjectCreator#tilemap
  * @since 3.0.0
  * 
- * @param {TilemapConfig} [config] - The config options for the Tilemap.
+ * @param {Phaser.Tilemaps.Types.TilemapConfig} [config] - The config options for the Tilemap.
  * 
  * @return {Phaser.Tilemaps.Tilemap}
  */

src/tilemaps/components/GetTilesWithin.js

@@ -6,14 +6,6 @@
 
 var GetFastValue = require('../../utils/object/GetFastValue');
 
-/**
- * @typedef {object} GetTilesWithinFilteringOptions
- *
- * @property {boolean} [isNotEmpty=false] - If true, only return tiles that don't have -1 for an index.
- * @property {boolean} [isColliding=false] - If true, only return tiles that collide on at least one side.
- * @property {boolean} [hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.
- */
-
 /**
  * Gets the tiles in the given rectangular area (in tile coordinates) of the layer.
  *
@@ -25,7 +17,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {integer} tileY - The top most tile index (in tile coordinates) to use as the origin of the area.
  * @param {integer} width - How many tiles wide from the `tileX` index the area will be.
  * @param {integer} height - How many tiles tall from the `tileY` index the area will be.
- * @param {object} GetTilesWithinFilteringOptions - Optional filters to apply when getting the tiles.
+ * @param {Phaser.Tilemaps.Types.GetTilesWithinFilteringOptions} GetTilesWithinFilteringOptions - Optional filters to apply when getting the tiles.
  * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  * 
  * @return {Phaser.Tilemaps.Tile[]} Array of Tile objects.

src/tilemaps/dynamiclayer/DynamicTilemapLayer.js

@@ -513,7 +513,7 @@ var DynamicTilemapLayer = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area to filter.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {object} [FilteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      *
      * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.
      */
@@ -558,7 +558,7 @@ var DynamicTilemapLayer = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area to search.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {object} [FilteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      *
      * @return {?Phaser.Tilemaps.Tile}
      */
@@ -580,7 +580,7 @@ var DynamicTilemapLayer = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area to search.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {object} [FilteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      *
      * @return {Phaser.Tilemaps.DynamicTilemapLayer} This Tilemap Layer object.
      */
@@ -637,7 +637,7 @@ var DynamicTilemapLayer = new Class({
      * @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area.
      * @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
      * @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
-     * @param {object} [FilteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      *
      * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.
      */
@@ -654,7 +654,7 @@ var DynamicTilemapLayer = new Class({
      * @since 3.0.0
      *
      * @param {(Phaser.Geom.Circle|Phaser.Geom.Line|Phaser.Geom.Rectangle|Phaser.Geom.Triangle)} shape - A shape in world (pixel) coordinates
-     * @param {object} [FilteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
      *
      * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.
@@ -674,7 +674,7 @@ var DynamicTilemapLayer = new Class({
      * @param {number} worldY - The world y coordinate for the top-left of the area.
      * @param {number} width - The width of the area.
      * @param {number} height - The height of the area.
-     * @param {object} [FilteringOptions] - Optional filters to apply when getting the tiles.
+     * @param {Phaser.Tilemaps.Types.FilteringOptions} [filteringOptions] - Optional filters to apply when getting the tiles.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
      *
      * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.
@@ -860,7 +860,7 @@ var DynamicTilemapLayer = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.GameObjects.Graphics} graphics - The target Graphics object to draw upon.
-     * @param {StyleConfig} styleConfig - An object specifying the colors to use for the debug drawing.
+     * @param {Phaser.Tilemaps.Types.StyleConfig} styleConfig - An object specifying the colors to use for the debug drawing.
      *
      * @return {Phaser.Tilemaps.DynamicTilemapLayer} This Tilemap Layer object.
      */

src/tilemaps/mapdata/MapData.js

@@ -7,29 +7,6 @@
 var Class = require('../../utils/Class');
 var GetFastValue = require('../../utils/object/GetFastValue');
 
-/**
- * @typedef {object} MapDataConfig
- * @property {string} [name] - The key in the Phaser cache that corresponds to the loaded tilemap data.
- * @property {number} [width=0] - The width of the entire tilemap.
- * @property {number} [height=0] - The height of the entire tilemap.
- * @property {number} [tileWidth=0] - The width of the tiles.
- * @property {number} [tileHeight=0] - The height of the tiles.
- * @property {number} [widthInPixels] - The width in pixels of the entire tilemap.
- * @property {number} [heightInPixels] - The height in pixels of the entire tilemap.
- * @property {integer} [format] - The format of the Tilemap, as defined in Tiled.
- * @property {string} [orientation] - The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.
- * @property {string} [renderOrder] - Determines the draw order of tilemap. Default is right-down.
- * @property {number} [version] - The version of Tiled the map uses.
- * @property {number} [properties] - Map specific properties (can be specified in Tiled).
- * @property {Phaser.Tilemaps.LayerData[]} [layers] - The layers of the tilemap.
- * @property {array} [images] - An array with all the layers configured to the MapData.
- * @property {object} [objects] - An array of Tiled Image Layers.
- * @property {object} [collision] - An object of Tiled Object Layers.
- * @property {Phaser.Tilemaps.Tileset[]} [tilesets] - The tilesets the map uses.
- * @property {array} [imageCollections] - The collection of images the map uses(specified in Tiled).
- * @property {array} [tiles] - [description]
- */
-
 /**
  * @classdesc
  * A class for representing data about a map. Maps are parsed from CSV, Tiled, etc. into this
@@ -41,7 +18,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @constructor
  * @since 3.0.0
  *
- * @param {MapDataConfig} [config] - [description]
+ * @param {Phaser.Tilemaps.Types.MapDataConfig} [config] - The Map configuration object.
  */
 var MapData = new Class({