Actions.SetVisible has 2 new arguments: index and direction.

This commit is contained in:
Richard Davey 2018-03-17 17:49:23 +00:00
parent 8f0ee99f23
commit 7052f981b5

View file

@ -4,25 +4,27 @@
* @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 property `visible`
* and then sets it to the given value.
*
* To use this with a Group: `SetVisible(group.getChildren(), value)`
*
* @function Phaser.Actions.SetVisible
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {boolean} value - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
* @param {boolean} value - The value to set the property to.
* @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 SetVisible = function (items, value)
var SetVisible = function (items, value, index, direction)
{
for (var i = 0; i < items.length; i++)
{
items[i].visible = value;
}
return items;
return PropertyValueSet(items, 'visible', value, 0, index, direction);
};
module.exports = SetVisible;