phaser/src/tilemaps/components/RemoveTileAt.js

57 lines
1.7 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2020-01-15 12:07:09 +00:00
* @copyright 2020 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
*/
2017-11-16 19:09:07 +00:00
var Tile = require('../Tile');
var IsInLayerBounds = require('./IsInLayerBounds');
var CalculateFacesAt = require('./CalculateFacesAt');
2017-11-16 19:09:07 +00:00
2017-11-27 13:33:30 +00:00
/**
* Removes the tile at the given tile coordinates in the specified layer and updates the layer's
* collision information.
*
2018-02-08 01:08:59 +00:00
* @function Phaser.Tilemaps.Components.RemoveTileAt
* @since 3.0.0
*
2018-08-20 11:20:23 +00:00
* @param {integer} tileX - The x coordinate.
* @param {integer} tileY - The y coordinate.
* @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] - `true` if the faces data should be recalculated.
2018-02-08 02:02:37 +00:00
* @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
2018-03-20 15:11:33 +00:00
*
2018-02-08 01:08:59 +00:00
* @return {Phaser.Tilemaps.Tile} The Tile object that was removed.
2017-11-27 13:33:30 +00:00
*/
var RemoveTileAt = function (tileX, tileY, replaceWithNull, recalculateFaces, layer)
2017-11-16 19:09:07 +00:00
{
if (replaceWithNull === undefined) { replaceWithNull = false; }
if (recalculateFaces === undefined) { recalculateFaces = true; }
2017-11-16 19:09:07 +00:00
2019-03-05 14:41:35 +00:00
if (!IsInLayerBounds(tileX, tileY, layer))
{
return null;
}
var tile = layer.data[tileY][tileX];
if (!tile)
2017-11-16 19:09:07 +00:00
{
return null;
}
else
{
2019-03-05 14:41:35 +00:00
layer.data[tileY][tileX] = (replaceWithNull) ? null : new Tile(layer, -1, tileX, tileY, tile.width, tile.height);
2017-11-16 19:09:07 +00:00
}
2019-03-05 14:41:35 +00:00
// Recalculate faces only if the removed tile was a colliding tile
if (recalculateFaces && tile && tile.collides)
{
CalculateFacesAt(tileX, tileY, layer);
}
2017-11-16 19:09:07 +00:00
return tile;
};
2017-11-18 22:11:51 +00:00
module.exports = RemoveTileAt;