phaser/src/tilemaps/components/GetTileAtWorldXY.js
2020-02-06 11:02:44 +01:00

34 lines
1.3 KiB
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var GetTileAt = require('./GetTileAt');
var WorldToTileXY = require('./WorldToTileXY');
/**
* Gets a tile at the given world coordinates from the given layer.
*
* @function Phaser.Tilemaps.Components.GetTileAtWorldXY
* @private
* @since 3.0.0
*
* @param {number} worldX - X position to get the tile from (given in pixels)
* @param {number} worldY - Y position to get the tile from (given in pixels)
* @param {boolean} [nonNull=false] - If true, function won't return null for empty tiles, but a Tile object with an index of -1.
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when calculating the tile index from the world values.
* @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
*
* @return {Phaser.Tilemaps.Tile} The tile at the given coordinates or null if no tile was found or the coordinates
* were invalid.
*/
var GetTileAtWorldXY = function (worldX, worldY, nonNull, camera, layer)
{
var point = WorldToTileXY(worldX, worldY, true, camera, layer);
var tileX = point.x;
var tileY = point.y;
return GetTileAt(tileX, tileY, nonNull, layer);
};
module.exports = GetTileAtWorldXY;