phaser/src/actions/SetScaleX.js

36 lines
1.4 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2019-01-15 16:20:22 +00:00
* @copyright 2019 Photon Storm Ltd.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2018-02-12 16:01:20 +00:00
*/
var PropertyValueSet = require('./PropertyValueSet');
2017-10-04 16:05:26 +00:00
/**
* Takes an array of Game Objects, or any objects that have the public property `scaleX`
* and then sets it to the given value.
2018-03-20 14:57:12 +00:00
*
* The optional `step` property is applied incrementally, multiplied by each item in the array.
2018-03-20 14:57:12 +00:00
*
* To use this with a Group: `SetScaleX(group.getChildren(), value, step)`
2017-10-04 16:05:26 +00:00
*
* @function Phaser.Actions.SetScaleX
* @since 3.0.0
2018-03-20 14:57:12 +00:00
*
2018-03-27 11:14:08 +00:00
* @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
*
2018-03-20 14:57:12 +00:00
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
* @param {number} value - The amount to set the property to.
* @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.
2017-10-06 02:05:01 +00:00
*
2018-03-27 11:14:08 +00:00
* @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.
2017-10-04 16:05:26 +00:00
*/
var SetScaleX = function (items, value, step, index, direction)
2017-03-28 13:30:43 +00:00
{
return PropertyValueSet(items, 'scaleX', value, step, index, direction);
2017-03-28 13:30:43 +00:00
};
module.exports = SetScaleX;