phaser/src/actions/RandomEllipse.js

35 lines
1.1 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
2017-03-28 13:57:42 +00:00
var Random = require('../geom/ellipse/Random');
2017-10-04 16:05:26 +00:00
/**
2018-10-01 11:01:59 +00:00
* Takes an array of Game Objects and positions them at random locations within the Ellipse.
*
* If you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.
2017-10-04 16:05:26 +00:00
*
* @function Phaser.Actions.RandomEllipse
* @since 3.0.0
2018-03-20 14:57:12 +00:00
*
2018-03-27 11:14:08 +00:00
* @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
*
2018-03-20 14:57:12 +00:00
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
2018-10-01 11:01:59 +00:00
* @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to position the Game Objects within.
2017-10-06 02:05:01 +00:00
*
2018-03-27 11:14:08 +00:00
* @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.
2017-10-04 16:05:26 +00:00
*/
2017-03-28 13:57:42 +00:00
var RandomEllipse = function (items, ellipse)
{
for (var i = 0; i < items.length; i++)
{
Random(ellipse, items[i]);
}
return items;
};
module.exports = RandomEllipse;