arcade-physics
Version:
Use Arcade Physics without Phaser.
19 lines • 1.16 kB
TypeScript
export default GetPoints;
/**
* Returns an array of Point objects containing the coordinates of the points around the circumference of the Ellipse,
* based on the given quantity or stepRate values.
*
* @function Phaser.Geom.Ellipse.GetPoints
* @since 3.0.0
*
* @generic {Phaser.Geom.Point[]} O - [out,$return]
*
* @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the points from.
* @param {number} quantity - The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.
* @param {number} [stepRate] - Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.
* @param {(array|Phaser.Geom.Point[])} [out] - An array to insert the points in to. If not provided a new array will be created.
*
* @return {(array|Phaser.Geom.Point[])} An array of Point objects pertaining to the points around the circumference of the ellipse.
*/
declare function GetPoints(ellipse: Phaser.Geom.Ellipse, quantity: number, stepRate?: number | undefined, out?: any[] | Phaser.Geom.Point[] | undefined): (any[] | Phaser.Geom.Point[]);
//# sourceMappingURL=GetPoints.d.ts.map