phaser/src/tilemaps/components/HasTileAtWorldXY.js

35 lines
1.3 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2019-01-15 16:20:22 +00:00
* @copyright 2019 Photon Storm Ltd.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2018-02-12 16:01:20 +00:00
*/
var HasTileAt = require('./HasTileAt');
var WorldToTileX = require('./WorldToTileX');
var WorldToTileY = require('./WorldToTileY');
2017-11-27 13:33:30 +00:00
/**
* Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns
* false if there is no tile or if the tile at that location has an index of -1.
*
2018-02-08 01:08:59 +00:00
* @function Phaser.Tilemaps.Components.HasTileAtWorldXY
* @private
2018-02-08 01:08:59 +00:00
* @since 3.0.0
*
2018-09-24 22:20:43 +00:00
* @param {number} worldX - The X coordinate of the world position.
* @param {number} worldY - The Y coordinate of the world position.
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when factoring in which tiles to return.
2018-02-08 02:02:37 +00:00
* @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
2018-02-08 01:08:59 +00:00
*
* @return {?boolean} Returns a boolean, or null if the layer given was invalid.
2017-11-27 13:33:30 +00:00
*/
var HasTileAtWorldXY = function (worldX, worldY, camera, layer)
{
var tileX = WorldToTileX(worldX, true, camera, layer);
var tileY = WorldToTileY(worldY, true, camera, layer);
return HasTileAt(tileX, tileY, layer);
};
module.exports = HasTileAtWorldXY;