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.
If no layer specified, the maps current layer is used.
name | type | arguments | description |
---|---|---|---|
callback | FindTileCallback |
The callback. Each tile in the given area will be passed to this callback as the first and only parameter. |
|
context | object | <optional> |
The context under which the callback should be run. |
tileX | number | <optional> |
The left most tile index (in tile coordinates) to use as the origin of the area to search. |
tileY | number | <optional> |
The top most tile index (in tile coordinates) to use as the origin of the area to search. |
width | number | <optional> |
How many tiles wide from the |
height | number | <optional> |
How many tiles tall from the |
filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | <optional> |
Optional filters to apply when getting the tiles. |
layer | string | number | Phaser.Tilemaps.TilemapLayer | <optional> |
The Tile layer to run the search on. If not provided will use the current layer. |
Returns a Tiles, or null if the layer given was invalid.