phaser/src/actions/Call.js

38 lines
1 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* @callback CallCallback
*
* @param {Phaser.GameObjects.GameObject} item - [description]
*/
2017-10-04 16:05:26 +00:00
/**
2018-03-17 17:16:26 +00:00
* Takes an array of objects and passes each of them to the given callback.
2017-10-04 16:05:26 +00:00
*
* @function Phaser.Actions.Call
* @since 3.0.0
*
2018-03-20 14:57:12 +00:00
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
* @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
2018-03-17 17:16:26 +00:00
* @param {object} context - The scope in which the callback will be invoked.
2017-10-06 02:05:01 +00:00
*
2018-03-17 17:16:26 +00:00
* @return {array} The array of objects that was passed to this Action.
2017-10-04 16:05:26 +00:00
*/
2018-03-17 17:16:26 +00:00
var Call = function (items, callback, context)
{
for (var i = 0; i < items.length; i++)
{
var item = items[i];
2018-03-17 17:16:26 +00:00
callback.call(context, item);
}
return items;
};
module.exports = Call;