phaser/src/actions/Shuffle.js
2019-05-10 16:15:04 +01:00

27 lines
833 B
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2019 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var ArrayShuffle = require('../utils/array/Shuffle');
/**
* Shuffles the array in place. The shuffled array is both modified and returned.
*
* @function Phaser.Actions.Shuffle
* @since 3.0.0
* @see Phaser.Utils.Array.Shuffle
*
* @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
*
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
*
* @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.
*/
var Shuffle = function (items)
{
return ArrayShuffle(items);
};
module.exports = Shuffle;