mirror of
https://github.com/photonstorm/phaser
synced 2024-12-24 12:03:36 +00:00
32 lines
1.6 KiB
JavaScript
32 lines
1.6 KiB
JavaScript
|
var GetTilesWithin = require('./GetTilesWithin');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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
|
||
|
|
* true. Similar to Array.prototype.find in vanilla JS.
|
||
|
|
*
|
||
|
|
* @param {function} 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]
|
||
|
|
* @param {integer} [tileY=0] - [description]
|
||
|
|
* @param {integer} [width=max width based on tileX] - [description]
|
||
|
|
* @param {integer} [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.hasInterestingFace=false] - If true, only return tiles that
|
||
|
|
* have at least one interesting face.
|
||
|
|
* @param {LayerData} layer - [description]
|
||
|
|
* @return {Tile|null} A Tile that matches the search, or null if no Tile found
|
||
|
|
*/
|
||
|
|
var FindTile = function (callback, context, tileX, tileY, width, height, filteringOptions, layer)
|
||
|
|
{
|
||
|
|
var tiles = GetTilesWithin(tileX, tileY, width, height, filteringOptions, layer);
|
||
|
|
return tiles.find(callback, context) || null;
|
||
|
|
};
|
||
|
|
|
||
|
|
module.exports = FindTile;
|