phaser/src/actions/PlaceOnRectangle.js

53 lines
1.6 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2020-01-15 12:07:09 +00:00
* @copyright 2020 Photon Storm Ltd.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2018-02-12 16:01:20 +00:00
*/
var MarchingAnts = require('../geom/rectangle/MarchingAnts');
var RotateLeft = require('../utils/array/RotateLeft');
var RotateRight = require('../utils/array/RotateRight');
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 on evenly spaced points around the perimeter of a Rectangle.
*
* Placement starts from the top-left of the rectangle, and proceeds in a clockwise direction.
* If the `shift` parameter is given you can offset where placement begins.
2017-10-04 16:05:26 +00:00
*
* @function Phaser.Actions.PlaceOnRectangle
* @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.Rectangle} rect - The Rectangle to position the Game Objects on.
* @param {integer} [shift=1] - An optional positional offset.
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
*/
var PlaceOnRectangle = function (items, rect, shift)
{
if (shift === undefined) { shift = 0; }
var points = MarchingAnts(rect, false, items.length);
if (shift > 0)
{
RotateLeft(points, shift);
}
else if (shift < 0)
{
RotateRight(points, Math.abs(shift));
}
for (var i = 0; i < items.length; i++)
{
items[i].x = points[i].x;
items[i].y = points[i].y;
}
return items;
};
module.exports = PlaceOnRectangle;