phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
58 lines (49 loc) • 1.63 kB
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2025 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var SafeRange = require('./SafeRange');
/**
* Removes the item within the given range in the array.
*
* The array is modified in-place.
*
* You can optionally specify a callback to be invoked for the item/s successfully removed from the array.
*
* @function Phaser.Utils.Array.RemoveBetween
* @since 3.4.0
*
* @param {array} array - The array to be modified.
* @param {number} startIndex - The start index to remove from.
* @param {number} endIndex - The end index to remove to.
* @param {function} [callback] - A callback to be invoked for the item removed from the array.
* @param {object} [context] - The context in which the callback is invoked.
*
* @return {Array.<*>} An array of items that were removed.
*/
var RemoveBetween = function (array, startIndex, endIndex, callback, context)
{
if (startIndex === undefined) { startIndex = 0; }
if (endIndex === undefined) { endIndex = array.length; }
if (context === undefined) { context = array; }
if (SafeRange(array, startIndex, endIndex))
{
var size = endIndex - startIndex;
var removed = array.splice(startIndex, size);
if (callback)
{
for (var i = 0; i < removed.length; i++)
{
var entry = removed[i];
callback.call(context, entry);
}
}
return removed;
}
else
{
return [];
}
};
module.exports = RemoveBetween;