Phaser API Documentation

findByIndex(index, [skip], [reverse], [layer])


Searches the entire map layer for the first tile matching the given index, then returns that Tile object. If no match is found, it returns null. The search starts from the top-left tile and continues horizontally until it hits the end of the row, then it drops down to the next column. If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to the top-left. If no layer specified, the map's current layer is used.


name type arguments Default description
index number

The tile index value to search for.

skip number <optional> 0

The number of times to skip a matching tile before returning.

reverse boolean <optional> false

If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.

layer string | number | Phaser.Tilemaps.TilemapLayer <optional>

The tile layer to use. If not given the current layer is used.


Returns a Tiles, or null if the layer given was invalid.

Since: 3.0.0
Source: src/tilemaps/Tilemap.js (Line 1007)