mirror of
https://github.com/photonstorm/phaser
synced 2024-11-28 15:41:37 +00:00
fixes the typedef for the layer parameter
The layer parameter is used to call getLayer() so the parameter type for the parent function should match the on of getLayer().
This commit is contained in:
Thomas Felix
parent
6f8759c186
commit
bd5f2b3bf5
1 changed files with 54 additions and 52 deletions
|
|
@ -124,14 +124,14 @@ var Tilemap = new Class({
|
|||
|
||||
/**
|
||||
* The render (draw) order of the map data (as specified in Tiled), usually 'right-down'.
|
||||
*
|
||||
*
|
||||
* The draw orders are:
|
||||
*
|
||||
*
|
||||
* right-down
|
||||
* left-down
|
||||
* right-up
|
||||
* left-up
|
||||
*
|
||||
*
|
||||
* This can be changed via the `setRenderOrder` method.
|
||||
*
|
||||
* @name Phaser.Tilemaps.Tilemap#renderOrder
|
||||
|
|
@ -241,22 +241,22 @@ var Tilemap = new Class({
|
|||
|
||||
/**
|
||||
* Sets the rendering (draw) order of the tiles in this map.
|
||||
*
|
||||
*
|
||||
* The default is 'right-down', meaning it will order the tiles starting from the top-left,
|
||||
* drawing to the right and then moving down to the next row.
|
||||
*
|
||||
*
|
||||
* The draw orders are:
|
||||
*
|
||||
*
|
||||
* 0 = right-down
|
||||
* 1 = left-down
|
||||
* 2 = right-up
|
||||
* 3 = left-up
|
||||
*
|
||||
*
|
||||
* Setting the render order does not change the tiles or how they are stored in the layer,
|
||||
* it purely impacts the order in which they are rendered.
|
||||
*
|
||||
*
|
||||
* You can provide either an integer (0 to 3), or the string version of the order.
|
||||
*
|
||||
*
|
||||
* Calling this method _after_ creating Static or Dynamic Tilemap Layers will **not** automatically
|
||||
* update them to use the new render order. If you call this method after creating layers, use their
|
||||
* own `setRenderOrder` methods to change them as needed.
|
||||
|
|
@ -408,12 +408,12 @@ var Tilemap = new Class({
|
|||
* Copies the tiles in the source rectangular area to a new destination (all specified in tile
|
||||
* coordinates) within the layer. This copies all tile properties & recalculates collision
|
||||
* information in the destination region.
|
||||
*
|
||||
*
|
||||
* If no layer specified, the map's current layer is used. This cannot be applied to StaticTilemapLayers.
|
||||
*
|
||||
* @method Phaser.Tilemaps.Tilemap#copy
|
||||
* @since 3.0.0
|
||||
*
|
||||
*
|
||||
* @param {integer} srcTileX - The x coordinate of the area to copy from, in tiles, not pixels.
|
||||
* @param {integer} srcTileY - The y coordinate of the area to copy from, in tiles, not pixels.
|
||||
* @param {integer} width - The width of the area to copy, in tiles, not pixels.
|
||||
|
|
@ -421,7 +421,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} destTileX - The x coordinate of the area to copy to, in tiles, not pixels.
|
||||
* @param {integer} destTileY - The y coordinate of the area to copy to, in tiles, not pixels.
|
||||
* @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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} Returns this, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -458,7 +458,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} [height] - The height of the layer in tiles. If not specified, it will default to the map's height.
|
||||
* @param {integer} [tileWidth] - The width of the tiles the layer uses for calculations. If not specified, it will default to the map's tileWidth.
|
||||
* @param {integer} [tileHeight] - The height of the tiles the layer uses for calculations. If not specified, it will default to the map's tileHeight.
|
||||
*
|
||||
*
|
||||
* @return {?Phaser.Tilemaps.DynamicTilemapLayer} Returns the new layer was created, or null if it failed.
|
||||
*/
|
||||
createBlankDynamicLayer: function (name, tileset, x, y, width, height, tileWidth, tileHeight)
|
||||
|
|
@ -688,7 +688,7 @@ var Tilemap = new Class({
|
|||
* @param {SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e. scene.make.sprite).
|
||||
* @param {Phaser.Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.GameObjects.Sprite[]} Returns an array of Tiles, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -788,7 +788,7 @@ var Tilemap = new Class({
|
|||
* @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 {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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} Returns this, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -859,7 +859,7 @@ var Tilemap = new Class({
|
|||
* @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.hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The Tile layer to apply the filter on. If not provided will use the current layer.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -886,7 +886,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} index - The tile index value to search for.
|
||||
* @param {integer} [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 {Phaser.Tilemaps.LayerData} [layer] - The Tile layer to run the search on. If not provided will use the current layer.
|
||||
* @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 a Tiles, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -950,7 +950,7 @@ var Tilemap = new Class({
|
|||
* @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.hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The Tile layer to run the search on. If not provided will use the current layer.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -982,7 +982,7 @@ var Tilemap = new Class({
|
|||
* @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.hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The Tile layer to run the search on. If not provided will use the current layer.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1139,7 +1139,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} tileX - X position to get the tile from (given in tile units, not pixels).
|
||||
* @param {integer} 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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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 a Tile, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1163,7 +1163,7 @@ var Tilemap = new Class({
|
|||
* @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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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 a Tile, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1196,7 +1196,7 @@ var Tilemap = new Class({
|
|||
* @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.hasInterestingFace=false] - If true, only return tiles that have at least one interesting face.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1223,7 +1223,7 @@ var Tilemap = new Class({
|
|||
* @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 {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to search. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1252,7 +1252,7 @@ var Tilemap = new Class({
|
|||
* @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 {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to search. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1309,7 +1309,7 @@ var Tilemap = new Class({
|
|||
*
|
||||
* @param {integer} tileX - The x coordinate, in tiles, not pixels.
|
||||
* @param {integer} tileY - The y coordinate, in tiles, not pixels.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to search. If not given the current layer is used.
|
||||
* @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
*
|
||||
* @return {?boolean} Returns a boolean, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1334,7 +1334,7 @@ var Tilemap = new Class({
|
|||
* @param {number} worldX - The x coordinate, in pixels.
|
||||
* @param {number} worldY - The y coordinate, in pixels.
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to search. If not given the current layer is used.
|
||||
* @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
*
|
||||
* @return {?boolean} Returns a boolean, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1384,7 +1384,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} tileX - The x coordinate, in tiles, not pixels.
|
||||
* @param {integer} tileY - The y coordinate, in tiles, not pixels.
|
||||
* @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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 a Tile, or null if the layer given was invalid or the coordinates were out of bounds.
|
||||
*/
|
||||
|
|
@ -1416,7 +1416,7 @@ var Tilemap = new Class({
|
|||
* @param {number} worldY - The y coordinate, in pixels.
|
||||
* @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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 a Tile, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1448,7 +1448,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} tileX - The x coordinate, in tiles, not pixels.
|
||||
* @param {integer} tileY - The y coordinate, in tiles, not pixels.
|
||||
* @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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} Returns this, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1484,7 +1484,7 @@ var Tilemap = new Class({
|
|||
* @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 {integer[]} [indexes] - An array of indexes to randomly draw from during randomization.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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} Returns this, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1514,7 +1514,7 @@ var Tilemap = new Class({
|
|||
*
|
||||
* @param {integer} tileX - The x coordinate, in tiles, not pixels.
|
||||
* @param {integer} tileY - The y coordinate, in tiles, not pixels.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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} Returns this, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1543,7 +1543,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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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} Returns this, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1598,7 +1598,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} tileY - The y coordinate, in tiles, not pixels.
|
||||
* @param {boolean} [replaceWithNull=true] - If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.
|
||||
* @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to search. If not given the current layer is used.
|
||||
* @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 a Tile, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1628,7 +1628,7 @@ var Tilemap = new Class({
|
|||
* @param {boolean} [replaceWithNull=true] - If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1.
|
||||
* @param {boolean} [recalculateFaces=true] - `true` if the faces data should be recalculated.
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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 a Tile, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -1659,7 +1659,7 @@ var Tilemap = new Class({
|
|||
* @param {?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} [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} [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 tile layer to search. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1691,7 +1691,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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1722,7 +1722,7 @@ var Tilemap = new Class({
|
|||
* @param {(integer|array)} indexes - Either a single tile index, or an array of tile indexes.
|
||||
* @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
|
||||
* @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1752,7 +1752,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} stop - The last index of the tile to be set for collision.
|
||||
* @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
|
||||
* @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1784,7 +1784,7 @@ var Tilemap = new Class({
|
|||
* @param {object} properties - An object with tile properties and corresponding values that should be checked.
|
||||
* @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
|
||||
* @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1812,7 +1812,7 @@ var Tilemap = new Class({
|
|||
* @param {integer[]} indexes - An array of the tile indexes to not be counted for collision.
|
||||
* @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
|
||||
* @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1840,7 +1840,7 @@ var Tilemap = new Class({
|
|||
*
|
||||
* @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
|
||||
* @param {boolean} [recalculateFaces=true] - Whether or not to recalculate the tile faces after the update.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1869,7 +1869,7 @@ var Tilemap = new Class({
|
|||
* @param {(integer|array)} indexes - Either a single tile index, or an array of tile indexes to have a collision callback set for.
|
||||
* @param {function} callback - The callback that will be invoked when the tile is collided with.
|
||||
* @param {object} callbackContext - The context under which the callback is called.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -1900,7 +1900,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} height - How many tiles tall from the `tileY` index the area will be.
|
||||
* @param {function} callback - The callback that will be invoked when the tile is collided with.
|
||||
* @param {object} [callbackContext] - The context under which the callback is called.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -2043,7 +2043,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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -2078,7 +2078,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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -2107,7 +2107,7 @@ var Tilemap = new Class({
|
|||
*
|
||||
* @param {integer} tileX - The x 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.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
*
|
||||
* @return {?number} Returns a number, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -2131,7 +2131,8 @@ var Tilemap = new Class({
|
|||
*
|
||||
* @param {integer} 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.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer
|
||||
* to use. If not given the current layer is used.
|
||||
*
|
||||
* @return {?number} Returns a number, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -2158,7 +2159,7 @@ var Tilemap = new Class({
|
|||
* @param {integer} 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.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.Math.Vector2} Returns a point, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -2199,7 +2200,7 @@ var Tilemap = new Class({
|
|||
* @param {object[]} [weightedIndexes] - An array of objects to randomly draw from during
|
||||
* randomization. They should be in the form: { index: 0, weight: 4 } or
|
||||
* { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.
|
||||
* @param {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.
|
||||
*/
|
||||
|
|
@ -2229,7 +2230,8 @@ var Tilemap = new Class({
|
|||
* @param {number} worldX - The x 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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer
|
||||
* to use. If not given the current layer is used.
|
||||
*
|
||||
* @return {?number} Returns a number, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -2254,7 +2256,7 @@ var Tilemap = new Class({
|
|||
* @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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @param {(string|integer|Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
*
|
||||
* @return {?number} Returns a number, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
@ -2282,7 +2284,7 @@ var Tilemap = new Class({
|
|||
* @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 {Phaser.Tilemaps.LayerData} [layer] - The tile layer to use. If not given the current layer is used.
|
||||
* @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.Math.Vector2} Returns a point, or null if the layer given was invalid.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in a new issue