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}
|
|
|
|
*/
|
|
|
|
|
2018-03-17 17:33:02 +00:00
|
|
|
var PropertyValueInc = require('./PropertyValueInc');
|
|
|
|
|
2017-10-04 16:05:26 +00:00
|
|
|
/**
|
2018-03-17 17:33:02 +00:00
|
|
|
* Takes an array of Game Objects, or any objects that have a public `rotation` property,
|
|
|
|
* and then adds the given value to each of their `rotation` properties.
|
|
|
|
*
|
|
|
|
* The optional `step` property is applied incrementally, multiplied by each item in the array.
|
|
|
|
*
|
|
|
|
* To use this with a Group: `Rotate(group.getChildren(), value, step)`
|
2017-10-04 16:05:26 +00:00
|
|
|
*
|
|
|
|
* @function Phaser.Actions.Rotate
|
|
|
|
* @since 3.0.0
|
|
|
|
*
|
2018-03-17 17:33:02 +00:00
|
|
|
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
|
|
|
* @param {number} value - The amount to be added to the `rotation` property (in radians).
|
|
|
|
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
|
|
|
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
|
|
|
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
|
2017-10-06 02:05:01 +00:00
|
|
|
*
|
2018-03-17 17:33:02 +00:00
|
|
|
* @return {array} The array of objects that were passed to this Action.
|
2017-10-04 16:05:26 +00:00
|
|
|
*/
|
2018-03-17 17:33:02 +00:00
|
|
|
var Rotate = function (items, value, step, index, direction)
|
2017-03-28 12:20:39 +00:00
|
|
|
{
|
2018-03-17 17:33:02 +00:00
|
|
|
return PropertyValueInc(items, 'rotation', value, step, index, direction);
|
2017-03-28 12:20:39 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
module.exports = Rotate;
|