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

35 lines
1.6 KiB
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var GetTilesWithin = require('./GetTilesWithin');
/**
* Sets a collision callback for the given rectangular area (in tile coordinates) within the layer.
* If a callback is already set for the tile index it will be replaced. Set the callback to null to
* remove it.
*
* @function Phaser.Tilemaps.Components.SetTileLocationCallback
* @since 3.0.0
*
* @param {integer} [tileX=0] - The left most tile index (in tile coordinates) to use as the origin of the area.
* @param {integer} [tileY=0] - The top most tile index (in tile coordinates) to use as the origin of the area.
* @param {integer} [width=max width based on tileX] - How many tiles wide from the `tileX` index the area will be.
* @param {integer} [height=max height based on tileY] - How many tiles tall from the `tileY` index the area will be.
* @param {function} callback - The callback that will be invoked when the tile is collided with.
* @param {object} callbackContext - The context under which the callback is called.
* @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
*/
var SetTileLocationCallback = function (tileX, tileY, width, height, callback, callbackContext, layer)
{
var tiles = GetTilesWithin(tileX, tileY, width, height, null, layer);
for (var i = 0; i < tiles.length; i++)
{
tiles[i].setCollisionCallback(callback, callbackContext);
}
};
module.exports = SetTileLocationCallback;