Phaser API Documentation

  Version: 
calculateFacesWithin([tileX], [tileY], [width], [height], [layer])

Description:

Calculates interesting faces within the rectangular area specified (in tile coordinates) of the layer. Interesting faces are used internally for optimizing collisions against tiles. This method is mostly used internally.

If no layer is specified, the maps current layer is used.

Parameters:

name type arguments description
tileX number <optional>

The left most tile index (in tile coordinates) to use as the origin of the area.

tileY number <optional>

The top most tile index (in tile coordinates) to use as the origin of the area.

width number <optional>

How many tiles wide from the tileX index the area will be.

height number <optional>

How many tiles tall from the tileY index the area will be.

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

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

Returns:
Description:

Returns this, or null if the layer given was invalid.

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