From 85d4b036b3850aa788ec6d5334d323614d0667a0 Mon Sep 17 00:00:00 2001 From: Richard Davey Date: Sat, 17 Mar 2018 17:18:28 +0000 Subject: [PATCH] Actions.IncY has 3 new arguments: `step`, `index` and `direction`. --- src/actions/IncY.js | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/src/actions/IncY.js b/src/actions/IncY.js index 377dea5ed..db202246f 100644 --- a/src/actions/IncY.js +++ b/src/actions/IncY.js @@ -4,25 +4,30 @@ * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} */ +var PropertyValueInc = require('./PropertyValueInc'); + /** - * [description] + * Takes an array of Game Objects, or any objects that have a public `y` property, + * and then adds the given value to each of their `y` properties. + * + * The optional `step` property is applied incrementally, multiplied by each item in the array. + * + * To use this with a Group: `IncY(group.getChildren(), value, step)` * * @function Phaser.Actions.IncY * @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 {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action. + * @param {number} value - The amount to be added to the `y` property. + * @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 IncY = function (items, value) +var IncY = function (items, value, step, index, direction) { - for (var i = 0; i < items.length; i++) - { - items[i].y += value; - } - - return items; + return PropertyValueInc(items, 'y', value, step, index, direction); }; module.exports = IncY;