mirror of
https://github.com/photonstorm/phaser
synced 2024-12-25 20:43:26 +00:00
32 lines
1.2 KiB
JavaScript
32 lines
1.2 KiB
JavaScript
/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2022 Photon Storm Ltd.
|
|
* @license {@link https://opensource.org/licenses/MIT|MIT License}
|
|
*/
|
|
|
|
var PropertyValueSet = require('./PropertyValueSet');
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
|
|
*
|
|
* @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 {number} [index=0] - An optional offset to start searching from within the items array.
|
|
* @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
|
|
*
|
|
* @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.
|
|
*/
|
|
var SetVisible = function (items, value, index, direction)
|
|
{
|
|
return PropertyValueSet(items, 'visible', value, 0, index, direction);
|
|
};
|
|
|
|
module.exports = SetVisible;
|