Skip to content

Commit c67882e

Browse files
committed
Actions.SetY has 2 new arguments: index and direction.
1 parent 80560b7 commit c67882e

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

src/actions/SetY.js

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,30 @@
44
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
55
*/
66

7+
var PropertyValueSet = require('./PropertyValueSet');
8+
79
/**
8-
* [description]
10+
* Takes an array of Game Objects, or any objects that have the public property `y`
11+
* and then sets it to the given value.
12+
*
13+
* The optional `step` property is applied incrementally, multiplied by each item in the array.
14+
*
15+
* To use this with a Group: `SetY(group.getChildren(), value, step)`
916
*
1017
* @function Phaser.Actions.SetY
1118
* @since 3.0.0
1219
*
13-
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
14-
* @param {number} value - [description]
15-
* @param {number} [step=0] - [description]
20+
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
21+
* @param {number} value - The amount to set the property to.
22+
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
23+
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
24+
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
1625
*
17-
* @return {array} The array of Game Objects that was passed to this Action.
26+
* @return {array} The array of objects that were passed to this Action.
1827
*/
19-
var SetY = function (items, value, step)
28+
var SetY = function (items, value, step, index, direction)
2029
{
21-
if (step === undefined) { step = 0; }
22-
23-
for (var i = 0; i < items.length; i++)
24-
{
25-
items[i].y = value + (i * step);
26-
}
27-
28-
return items;
30+
return PropertyValueSet(items, 'y', value, step, index, direction);
2931
};
3032

3133
module.exports = SetY;

0 commit comments

Comments
 (0)