Actions.SetScaleY has 2 new arguments: index and direction.

This commit is contained in:
Richard Davey 2018-03-17 17:47:37 +00:00
parent fe7d72b326
commit 8f0ee99f23

View file

@ -4,28 +4,30 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
var PropertyValueSet = require('./PropertyValueSet');
/**
* [description]
* Takes an array of Game Objects, or any objects that have the public property `scaleY`
* and then sets it to the given value.
*
* The optional `step` property is applied incrementally, multiplied by each item in the array.
*
* To use this with a Group: `SetScaleY(group.getChildren(), value, step)`
*
* @function Phaser.Actions.SetScaleY
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {number} value - [description]
* @param {number} [step=0] - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
* @param {number} value - The amount to set the property to.
* @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.
*
* @return {array} The array of Game Objects that was passed to this Action.
* @return {array} The array of objects that were passed to this Action.
*/
var SetScaleY = function (items, value, step)
var SetScaleY = function (items, value, step, index, direction)
{
if (step === undefined) { step = 0; }
for (var i = 0; i < items.length; i++)
{
items[i].scaleY = value + (i * step);
}
return items;
return PropertyValueSet(items, 'scaleY', value, step, index, direction);
};
module.exports = SetScaleY;