@vpmedia/phaser 1.95.0 → 1.97.0

package/types/phaser/geom/circle.d.ts

@@ -1,9 +1,9 @@
 export class Circle {
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} diameter - TBD.
+     * Creates a new Circle instance.
+     * @param {number} x - The x coordinate of the center point (default: 0).
+     * @param {number} y - The y coordinate of the center point (default: 0).
+     * @param {number} diameter - The diameter of the circle (default: 0).
      */
     constructor(x?: number, y?: number, diameter?: number);
     /** @type {number} */
@@ -17,152 +17,152 @@ export class Circle {
     /** @type {number} */
     type: number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Calculates the circumference of this circle.
+     * @returns {number} The circumference of this circle.
      */
     circumference(): number;
     /**
-     * TBD.
-     * @param {Point} output - TBD.
-     * @returns {Point} TBD.
+     * Returns a random point within this circle.
+     * @param {Point} output - The point to store the result in (optional).
+     * @returns {Point} A random point within this circle.
      */
     random(output?: Point): Point;
     /**
-     * TBD.
-     * @returns {Rectangle} TBD.
+     * Gets the bounding rectangle of this circle.
+     * @returns {Rectangle} The bounding rectangle of this circle.
      */
     getBounds(): Rectangle;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} diameter - TBD.
-     * @returns {Circle} TBD.
+     * Sets the position and size of this circle to new values.
+     * @param {number} x - The new x coordinate of the center point.
+     * @param {number} y - The new y coordinate of the center point.
+     * @param {number} diameter - The new diameter of the circle.
+     * @returns {Circle} This circle instance for chaining.
      */
     setTo(x: number, y: number, diameter: number): Circle;
     /**
-     * TBD.
-     * @param {Circle} source - TBD.
-     * @returns {Circle} TBD.
+     * Copies the values from another circle to this circle.
+     * @param {Circle} source - The circle to copy values from.
+     * @returns {Circle} This circle instance for chaining.
      */
     copyFrom(source: Circle): Circle;
     /**
-     * TBD.
-     * @param {Circle} dest - TBD.
-     * @returns {Circle} TBD.
+     * Copies the values of this circle to another circle.
+     * @param {Circle} dest - The circle to copy values to.
+     * @returns {Circle} The destination circle.
      */
     copyTo(dest: Circle): Circle;
     /**
-     * TBD.
-     * @param {Circle} dest - TBD.
-     * @param {boolean} round - TBD.
-     * @returns {number} TBD.
+     * Calculates the distance between this circle and another circle.
+     * @param {Circle} dest - The other circle to calculate the distance to.
+     * @param {boolean} round - Whether to round the result (default: false).
+     * @returns {number} The distance between the circles.
      */
     distance(dest: Circle, round?: boolean): number;
     /**
-     * TBD.
-     * @returns {Circle} TBD.
+     * Creates a clone of this circle.
+     * @returns {Circle} A new circle with the same values as this one.
      */
     clone(): Circle;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {boolean} TBD.
+     * Checks if the specified point is contained within this circle.
+     * @param {number} x - The x coordinate of the point to check.
+     * @param {number} y - The y coordinate of the point to check.
+     * @returns {boolean} True if the point is contained within this circle, false otherwise.
      */
     contains(x: number, y: number): boolean;
     /**
-     * TBD.
-     * @param {number} angle - TBD.
-     * @param {boolean} asDegrees - TBD.
-     * @param {Point} out - TBD.
-     * @returns {Point} TBD.
+     * Gets a point at a specific angle on the circumference of this circle.
+     * @param {number} angle - The angle in radians (or degrees if asDegrees is true) to get the point for.
+     * @param {boolean} asDegrees - Whether the angle is provided in degrees (default: false).
+     * @param {Point} out - The point to store the result in (optional).
+     * @returns {Point} A point at the specified angle on the circumference of this circle.
      */
     circumferencePoint(angle: number, asDegrees: boolean, out: Point): Point;
     /**
-     * TBD.
-     * @param {number} dx - TBD.
-     * @param {number} dy - TBD.
-     * @returns {Circle} TBD.
+     * Offsets the position of this circle by the specified amounts.
+     * @param {number} dx - The amount to offset the x coordinate by.
+     * @param {number} dy - The amount to offset the y coordinate by.
+     * @returns {Circle} This circle instance for chaining.
      */
     offset(dx: number, dy: number): Circle;
     /**
-     * TBD.
-     * @param {Point} point - TBD.
-     * @returns {Circle} TBD.
+     * Offsets the position of this circle by the specified point coordinates.
+     * @param {Point} point - The point to offset the circle by.
+     * @returns {Circle} This circle instance for chaining.
      */
     offsetPoint(point: Point): Circle;
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Returns a string representation of this circle.
+     * @returns {string} A string representation of the circle.
      */
     toString(): string;
     /**
-     * TBD.
+     * Sets the diameter of this circle.
      */
     set diameter(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the diameter of this circle.
+     * @returns {number} The diameter of this circle.
      */
     get diameter(): number;
     /**
-     * TBD.
+     * Sets the radius of this circle.
      */
     set radius(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the radius of this circle.
+     * @returns {number} The radius of this circle.
      */
     get radius(): number;
     /**
-     * TBD.
+     * Sets the left coordinate of this circle.
      */
     set left(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the left coordinate of this circle.
+     * @returns {number} The left coordinate of this circle.
      */
     get left(): number;
     /**
-     * TBD.
+     * Sets the right coordinate of this circle.
      */
     set right(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the right coordinate of this circle.
+     * @returns {number} The right coordinate of this circle.
      */
     get right(): number;
     /**
-     * TBD.
+     * Sets the top coordinate of this circle.
      */
     set top(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the top coordinate of this circle.
+     * @returns {number} The top coordinate of this circle.
      */
     get top(): number;
     /**
-     * TBD.
+     * Sets the bottom coordinate of this circle.
      */
     set bottom(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the bottom coordinate of this circle.
+     * @returns {number} The bottom coordinate of this circle.
      */
     get bottom(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the area of this circle.
+     * @returns {number} The area of this circle.
      */
     get area(): number;
     /**
-     * TBD.
+     * Sets whether this circle is empty (zero diameter).
      */
     set empty(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Checks if this circle is empty (has zero diameter).
+     * @returns {boolean} True if the circle is empty, false otherwise.
      */
     get empty(): boolean;
 }

package/types/phaser/geom/ellipse.d.ts

@@ -1,10 +1,10 @@
 export class Ellipse {
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
+     * Creates a new Ellipse instance.
+     * @param {number} x - The x coordinate of the center point (default: 0).
+     * @param {number} y - The y coordinate of the center point (default: 0).
+     * @param {number} width - The width of the ellipse (default: 0).
+     * @param {number} height - The height of the ellipse (default: 0).
      */
     constructor(x?: number, y?: number, width?: number, height?: number);
     /** @type {number} */
@@ -18,47 +18,47 @@ export class Ellipse {
     /** @type {number} */
     type: number;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
-     * @returns {Ellipse} TBD.
+     * Sets the position and size of this ellipse to new values.
+     * @param {number} x - The new x coordinate of the center point.
+     * @param {number} y - The new y coordinate of the center point.
+     * @param {number} width - The new width of the ellipse.
+     * @param {number} height - The new height of the ellipse.
+     * @returns {Ellipse} This ellipse instance for chaining.
      */
     setTo(x: number, y: number, width: number, height: number): Ellipse;
     /**
-     * TBD.
-     * @returns {Rectangle} TBD.
+     * Gets the bounding rectangle of this ellipse.
+     * @returns {Rectangle} The bounding rectangle of this ellipse.
      */
     getBounds(): Rectangle;
     /**
-     * TBD.
-     * @param {Ellipse} source - TBD.
-     * @returns {Ellipse} TBD.
+     * Copies the values from another ellipse to this ellipse.
+     * @param {Ellipse} source - The ellipse to copy values from.
+     * @returns {Ellipse} This ellipse instance for chaining.
      */
     copyFrom(source: Ellipse): Ellipse;
     /**
-     * TBD.
-     * @param {Ellipse} dest - TBD.
-     * @returns {Ellipse} TBD.
+     * Copies the values of this ellipse to another ellipse.
+     * @param {Ellipse} dest - The ellipse to copy values to.
+     * @returns {Ellipse} The destination ellipse.
      */
     copyTo(dest: Ellipse): Ellipse;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {boolean} TBD.
+     * Checks if the specified point is contained within this ellipse.
+     * @param {number} x - The x coordinate of the point to check.
+     * @param {number} y - The y coordinate of the point to check.
+     * @returns {boolean} True if the point is contained within this ellipse, false otherwise.
      */
     contains(x: number, y: number): boolean;
     /**
-     * TBD.
-     * @param {Point} output - TBD.
-     * @returns {Point} TBD.
+     * Returns a random point within this ellipse.
+     * @param {Point} output - The point to store the result in (optional).
+     * @returns {Point} A random point within this ellipse.
      */
     random(output?: Point): Point;
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Returns a string representation of this ellipse.
+     * @returns {string} A string representation of the ellipse.
      */
     toString(): string;
 }

package/types/phaser/geom/line.d.ts

@@ -1,10 +1,10 @@
 export class Line {
     /**
-     * TBD.
-     * @param {number} x1 - TBD.
-     * @param {number} y1 - TBD.
-     * @param {number} x2 - TBD.
-     * @param {number} y2 - TBD.
+     * Creates a new Line instance.
+     * @param {number} x1 - The x coordinate of the start point (default: 0).
+     * @param {number} y1 - The y coordinate of the start point (default: 0).
+     * @param {number} x2 - The x coordinate of the end point (default: 0).
+     * @param {number} y2 - The y coordinate of the end point (default: 0).
      */
     constructor(x1?: number, y1?: number, x2?: number, y2?: number);
     /** @type {Point} */
@@ -14,178 +14,178 @@ export class Line {
     /** @type {number} */
     type: number;
     /**
-     * TBD.
-     * @param {number} x1 - TBD.
-     * @param {number} y1 - TBD.
-     * @param {number} x2 - TBD.
-     * @param {number} y2 - TBD.
-     * @returns {Line} TBD.
+     * Sets the coordinates of this line to new values.
+     * @param {number} x1 - The new x coordinate of the start point.
+     * @param {number} y1 - The new y coordinate of the start point.
+     * @param {number} x2 - The new x coordinate of the end point.
+     * @param {number} y2 - The new y coordinate of the end point.
+     * @returns {Line} This line instance for chaining.
      */
     setTo(x1: number, y1: number, x2: number, y2: number): Line;
     /**
-     * TBD.
-     * @param {object} startSprite - TBD.
-     * @param {object} endSprite - TBD.
-     * @param {boolean} useCenter - TBD.
-     * @returns {Line} TBD.
+     * Sets the coordinates of this line to match the positions of two sprites.
+     * @param {object} startSprite - The starting sprite to get the position from.
+     * @param {object} endSprite - The ending sprite to get the position from.
+     * @param {boolean} useCenter - Whether to use the center of the sprites (default: false).
+     * @returns {Line} This line instance for chaining.
      */
     fromSprite(startSprite: object, endSprite: object, useCenter?: boolean): Line;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} angle - TBD.
-     * @param {number} length - TBD.
-     * @returns {Line} TBD.
+     * Sets the coordinates of this line to a point at a specific angle and distance.
+     * @param {number} x - The x coordinate of the starting point.
+     * @param {number} y - The y coordinate of the starting point.
+     * @param {number} angle - The angle in radians to set the line at.
+     * @param {number} length - The length of the line.
+     * @returns {Line} This line instance for chaining.
      */
     fromAngle(x: number, y: number, angle: number, length: number): Line;
     /**
-     * TBD.
-     * @param {number} angle - TBD.
-     * @param {boolean} asDegrees - TBD.
-     * @returns {Line} TBD.
+     * Rotates this line around its center point by the specified angle.
+     * @param {number} angle - The angle in radians (or degrees if asDegrees is true) to rotate by.
+     * @param {boolean} asDegrees - Whether the angle is provided in degrees (default: false).
+     * @returns {Line} This line instance for chaining.
      */
     rotate(angle: number, asDegrees?: boolean): Line;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} angle - TBD.
-     * @param {boolean} asDegrees - TBD.
-     * @returns {Line} TBD.
+     * Rotates this line around a specific point by the specified angle.
+     * @param {number} x - The x coordinate of the center point to rotate around.
+     * @param {number} y - The y coordinate of the center point to rotate around.
+     * @param {number} angle - The angle in radians (or degrees if asDegrees is true) to rotate by.
+     * @param {boolean} asDegrees - Whether the angle is provided in degrees (default: false).
+     * @returns {Line} This line instance for chaining.
      */
     rotateAround(x: number, y: number, angle: number, asDegrees?: boolean): Line;
     /**
-     * TBD.
-     * @param {Line} line - TBD.
-     * @param {boolean} asSegment - TBD.
-     * @param {Point} result - TBD.
-     * @returns {Point} TBD.
+     * Checks if this line intersects with another line.
+     * @param {Line} line - The other line to check for intersection with.
+     * @param {boolean} asSegment - Whether to treat the lines as segments (default: false).
+     * @param {Point} result - The point to store the intersection in (optional).
+     * @returns {Point} The intersection point, or null if no intersection occurs.
      */
     intersects(line: Line, asSegment: boolean, result: Point): Point;
     /**
-     * TBD.
-     * @param {Line} line - TBD.
-     * @returns {number} TBD.
+     * Calculates the reflection of this line off another line.
+     * @param {Line} line - The line to reflect off.
+     * @returns {number} The angle of reflection in radians.
      */
     reflect(line: Line): number;
     /**
-     * TBD.
-     * @param {Point} output - TBD.
-     * @returns {Point} TBD.
+     * Returns the midpoint of this line.
+     * @param {Point} output - The point to store the result in (optional).
+     * @returns {Point} The midpoint of this line.
      */
     midPoint(output?: Point): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
+     * Centers this line on the specified point.
+     * @param {number} x - The x coordinate to center the line on.
+     * @param {number} y - The y coordinate to center the line on.
      */
     centerOn(x: number, y: number): void;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {boolean} TBD.
+     * Checks if the specified point lies on this line (not necessarily on the segment).
+     * @param {number} x - The x coordinate of the point to check.
+     * @param {number} y - The y coordinate of the point to check.
+     * @returns {boolean} True if the point lies on this line, false otherwise.
      */
     pointOnLine(x: number, y: number): boolean;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {boolean} TBD.
+     * Checks if the specified point lies on this line segment.
+     * @param {number} x - The x coordinate of the point to check.
+     * @param {number} y - The y coordinate of the point to check.
+     * @returns {boolean} True if the point lies on this line segment, false otherwise.
      */
     pointOnSegment(x: number, y: number): boolean;
     /**
-     * TBD.
-     * @param {Point} output - TBD.
-     * @returns {Point} TBD.
+     * Returns a random point on this line.
+     * @param {Point} output - The point to store the result in (optional).
+     * @returns {Point} A random point on this line.
      */
     random(output?: Point): Point;
     /**
-     * TBD.
-     * @param {number} stepRate - TBD.
-     * @param {number[][]} results - TBD.
-     * @returns {number[][]} TBD.
+     * Gets coordinates of points along this line at regular intervals.
+     * @param {number} stepRate - The interval between points (default: 1).
+     * @param {number[][]} results - The array to store the results in (optional).
+     * @returns {number[][]} An array of coordinate pairs representing points along this line.
      */
     coordinatesOnLine(stepRate?: number, results?: number[][]): number[][];
     /**
-     * TBD.
-     * @returns {Line} TBD.
+     * Creates a clone of this line.
+     * @returns {Line} A new line with the same values as this one.
      */
     clone(): Line;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the length of this line.
+     * @returns {number} The length of this line.
      */
     get length(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the angle of this line in radians.
+     * @returns {number} The angle of this line in radians.
      */
     get angle(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the slope of this line.
+     * @returns {number} The slope of this line.
      */
     get slope(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the perpendicular slope of this line.
+     * @returns {number} The perpendicular slope of this line.
      */
     get perpSlope(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the x coordinate of the leftmost point on this line.
+     * @returns {number} The x coordinate of the leftmost point on this line.
      */
     get x(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the y coordinate of the topmost point on this line.
+     * @returns {number} The y coordinate of the topmost point on this line.
      */
     get y(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the x coordinate of the leftmost point on this line.
+     * @returns {number} The x coordinate of the leftmost point on this line.
      */
     get left(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the x coordinate of the rightmost point on this line.
+     * @returns {number} The x coordinate of the rightmost point on this line.
      */
     get right(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the y coordinate of the topmost point on this line.
+     * @returns {number} The y coordinate of the topmost point on this line.
      */
     get top(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the y coordinate of the bottommost point on this line.
+     * @returns {number} The y coordinate of the bottommost point on this line.
      */
     get bottom(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the width of this line (absolute difference between x coordinates).
+     * @returns {number} The width of this line.
      */
     get width(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the height of this line (absolute difference between y coordinates).
+     * @returns {number} The height of this line.
      */
     get height(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the normal vector x component of this line (perpendicular to the line).
+     * @returns {number} The normal vector x component of this line.
      */
     get normalX(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the normal vector y component of this line (perpendicular to the line).
+     * @returns {number} The normal vector y component of this line.
      */
     get normalY(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the angle of the normal vector of this line in radians.
+     * @returns {number} The angle of the normal vector of this line in radians.
      */
     get normalAngle(): number;
 }