phaser/src/tilemaps/components/RemoveTileAtWorldXY.js

31 lines
1.3 KiB
JavaScript
Raw Normal View History

var RemoveTileAt = require('./RemoveTileAt');
var WorldToTileX = require('./WorldToTileX');
var WorldToTileY = require('./WorldToTileY');
2017-11-27 13:33:30 +00:00
/**
* Removes the tile at the given world coordinates in the specified layer and updates the layer's
* collision information.
*
2018-02-08 01:08:59 +00:00
* @function Phaser.Tilemaps.Components.RemoveTileAtWorldXY
* @since 3.0.0
*
* @param {integer|Phaser.Tilemaps.Tile} tile - The index of this tile to set or a Tile object.
2017-11-27 13:33:30 +00:00
* @param {number} worldX - [description]
* @param {number} worldY - [description]
* @param {boolean} [replaceWithNull=true] - If true, this will replace the tile at the specified
* location with null instead of a Tile with an index of -1.
* @param {boolean} [recalculateFaces=true] - [description]
2018-02-08 01:08:59 +00:00
* @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - [description]
* @param {Phaser.Tilemaps.LayerData} layer - [description]
*
* @return {Phaser.Tilemaps.Tile} The Tile object that was removed.
2017-11-27 13:33:30 +00:00
*/
var RemoveTileAtWorldXY = function (worldX, worldY, replaceWithNull, recalculateFaces, camera, layer)
{
var tileX = WorldToTileX(worldX, true, camera, layer);
var tileY = WorldToTileY(worldY, true, camera, layer);
return RemoveTileAt(tileX, tileY, replaceWithNull, recalculateFaces, layer);
};
module.exports = RemoveTileAtWorldXY;