Skip to content

Commit 7052f98

Browse files
committed
Actions.SetVisible has 2 new arguments: index and direction.
1 parent 8f0ee99 commit 7052f98

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

src/actions/SetVisible.js

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,27 @@
44
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
55
*/
66

7+
var PropertyValueSet = require('./PropertyValueSet');
8+
79
/**
8-
* [description]
10+
* Takes an array of Game Objects, or any objects that have the public property `visible`
11+
* and then sets it to the given value.
12+
*
13+
* To use this with a Group: `SetVisible(group.getChildren(), value)`
914
*
1015
* @function Phaser.Actions.SetVisible
1116
* @since 3.0.0
1217
*
13-
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
14-
* @param {boolean} value - [description]
18+
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
19+
* @param {boolean} value - The value to set the property to.
20+
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
21+
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
1522
*
16-
* @return {array} The array of Game Objects that was passed to this Action.
23+
* @return {array} The array of objects that were passed to this Action.
1724
*/
18-
var SetVisible = function (items, value)
25+
var SetVisible = function (items, value, index, direction)
1926
{
20-
for (var i = 0; i < items.length; i++)
21-
{
22-
items[i].visible = value;
23-
}
24-
25-
return items;
27+
return PropertyValueSet(items, 'visible', value, 0, index, direction);
2628
};
2729

2830
module.exports = SetVisible;

0 commit comments

Comments
 (0)