phaser/src/tilemaps/components/HasTileAt.js
2020-09-18 17:16:52 +02:00

36 lines
1.1 KiB
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var IsInLayerBounds = require('./IsInLayerBounds');
/**
* Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns
* false if there is no tile or if the tile at that location has an index of -1.
*
* @function Phaser.Tilemaps.Components.HasTileAt
* @since 3.0.0
*
* @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 {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
*
* @return {?boolean} Returns a boolean, or null if the layer given was invalid.
*/
var HasTileAt = function (tileX, tileY, layer)
{
if (IsInLayerBounds(tileX, tileY, layer))
{
var tile = layer.data[tileY][tileX];
return (tile !== null && tile.index > -1);
}
else
{
return false;
}
};
module.exports = HasTileAt;