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

This commit is contained in:
Richard Davey 2018-03-17 17:47:07 +00:00
parent 6f3b2cf9a5
commit 84cc2c7aa2

View file

@ -4,34 +4,36 @@
* @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 properties `scaleX` and `scaleY`
* and then sets them to the given values.
*
* The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.
*
* To use this with a Group: `SetScale(group.getChildren(), scaleX, scaleY, stepX, stepY)`
*
* @function Phaser.Actions.SetScale
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {number} x - [description]
* @param {number} y - [description]
* @param {number} [stepX=0] - [description]
* @param {number} [stepY=0] - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
* @param {number} scaleX - The amount to set the `scaleX` property to.
* @param {number} [scaleY] - The amount to set the `scaleY` property to. If `undefined` or `null` it uses the `scaleX` value.
* @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.
* @param {number} [stepY=0] - This is added to the `scaleY` 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 SetScale = function (items, x, y, stepX, stepY)
var SetScale = function (items, scaleX, scaleY, stepX, stepY, index, direction)
{
if (stepX === undefined) { stepX = 0; }
if (stepY === undefined) { stepY = 0; }
if (scaleY === undefined || scaleY === null) { scaleY = scaleX; }
for (var i = 0; i < items.length; i++)
{
items[i].setScale(
x + (i * stepX),
y + (i * stepY)
);
}
PropertyValueSet(items, 'scaleX', scaleX, stepX, index, direction);
return items;
return PropertyValueSet(items, 'scaleY', scaleY, stepY, index, direction);
};
module.exports = SetScale;