Skip to content

Commit 2d09f69

Browse files
committed
Actions.IncX has 3 new arguments: step, index and direction.
1 parent 7005839 commit 2d09f69

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

src/actions/IncX.js

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

7+
var PropertyValueInc = require('./PropertyValueInc');
8+
79
/**
8-
* [description]
10+
* Takes an array of Game Objects, or any objects that have a public `x` property,
11+
* and then adds the given value to each of their `x` properties.
12+
*
13+
* The optional `step` property is applied incrementally, multiplied by each item in the array.
14+
*
15+
* To use this with a Group: `IncX(group.getChildren(), value, step)`
916
*
1017
* @function Phaser.Actions.IncX
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]
20+
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
21+
* @param {number} value - The amount to be added to the `x` property.
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.
1525
*
16-
* @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.
1727
*/
18-
var IncX = function (items, value)
28+
var IncX = function (items, value, step, index, direction)
1929
{
20-
for (var i = 0; i < items.length; i++)
21-
{
22-
items[i].x += value;
23-
}
24-
25-
return items;
30+
return PropertyValueInc(items, 'x', value, step, index, direction);
2631
};
2732

2833
module.exports = IncX;

0 commit comments

Comments
 (0)