Actions.SetOrigin has 4 new arguments: stepX, stepY, index and direction.

This commit is contained in:
Richard Davey 2018-03-17 17:46:26 +00:00
parent fa6b3bba64
commit 6f3b2cf9a5

View file

@ -4,26 +4,36 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
var PropertyValueSet = require('./PropertyValueSet');
/**
* [description]
* Takes an array of Game Objects, or any objects that have the public properties `originX` and `originY`
* and then sets them to the given values.
*
* The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.
*
* To use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`
*
* @function Phaser.Actions.SetOrigin
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {number} x - [description]
* @param {number} y - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
* @param {number} originX - The amount to set the `originX` property to.
* @param {number} [originY] - The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.
* @param {number} [stepX=0] - This is added to the `originX` amount, multiplied by the iteration counter.
* @param {number} [stepY=0] - This is added to the `originY` 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 SetOrigin = function (items, x, y)
var SetOrigin = function (items, originX, originY, stepX, stepY, index, direction)
{
for (var i = 0; i < items.length; i++)
{
items[i].setOrigin(x, y);
}
if (originY === undefined || originY === null) { originY = originX; }
return items;
PropertyValueSet(items, 'originX', originX, stepX, index, direction);
return PropertyValueSet(items, 'originY', originY, stepY, index, direction);
};
module.exports = SetOrigin;