|
4 | 4 | * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} |
5 | 5 | */ |
6 | 6 |
|
| 7 | +var PropertyValueInc = require('./PropertyValueInc'); |
| 8 | + |
7 | 9 | /** |
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)` |
9 | 16 | * |
10 | 17 | * @function Phaser.Actions.IncX |
11 | 18 | * @since 3.0.0 |
12 | 19 | * |
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. |
15 | 25 | * |
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. |
17 | 27 | */ |
18 | | -var IncX = function (items, value) |
| 28 | +var IncX = function (items, value, step, index, direction) |
19 | 29 | { |
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); |
26 | 31 | }; |
27 | 32 |
|
28 | 33 | module.exports = IncX; |
0 commit comments