@vpmedia/phaser 1.95.0 → 1.96.0

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

@@ -1,12 +1,12 @@
 export class Matrix {
     /**
-     * TBD.
-     * @param {number} a - TBD.
-     * @param {number} b - TBD.
-     * @param {number} c - TBD.
-     * @param {number} d - TBD.
-     * @param {number} tx - TBD.
-     * @param {number} ty - TBD.
+     * Creates a new Matrix instance.
+     * @param {number} a - The a component of the matrix (default: 1).
+     * @param {number} b - The b component of the matrix (default: 0).
+     * @param {number} c - The c component of the matrix (default: 0).
+     * @param {number} d - The d component of the matrix (default: 1).
+     * @param {number} tx - The tx component of the matrix (default: 0).
+     * @param {number} ty - The ty component of the matrix (default: 0).
      */
     constructor(a?: number, b?: number, c?: number, d?: number, tx?: number, ty?: number);
     /** @type {number} */
@@ -24,89 +24,89 @@ export class Matrix {
     /** @type {number} */
     type: number;
     /**
-     * TBD.
-     * @param {number[]} array - TBD.
-     * @returns {Matrix} TBD.
+     * Sets the matrix components from an array.
+     * @param {number[]} array - The array to read the matrix components from (should have 6 elements).
+     * @returns {Matrix} This matrix instance for chaining.
      */
     fromArray(array: number[]): Matrix;
     /**
-     * TBD.
-     * @param {number} a - TBD.
-     * @param {number} b - TBD.
-     * @param {number} c - TBD.
-     * @param {number} d - TBD.
-     * @param {number} tx - TBD.
-     * @param {number} ty - TBD.
-     * @returns {Matrix} TBD.
+     * Sets the matrix components to new values.
+     * @param {number} a - The new a component of the matrix.
+     * @param {number} b - The new b component of the matrix.
+     * @param {number} c - The new c component of the matrix.
+     * @param {number} d - The new d component of the matrix.
+     * @param {number} tx - The new tx component of the matrix.
+     * @param {number} ty - The new ty component of the matrix.
+     * @returns {Matrix} This matrix instance for chaining.
      */
     setTo(a: number, b: number, c: number, d: number, tx: number, ty: number): Matrix;
     /**
-     * TBD.
-     * @returns {Matrix} TBD.
+     * Creates a clone of this matrix.
+     * @returns {Matrix} A new matrix with the same values as this one.
      */
     clone(): Matrix;
     /**
-     * TBD.
-     * @param {Matrix} matrix - TBD.
-     * @returns {Matrix} TBD.
+     * Copies the values of this matrix to another matrix.
+     * @param {Matrix} matrix - The matrix to copy values to.
+     * @returns {Matrix} The destination matrix.
      */
     copyTo(matrix: Matrix): Matrix;
     /**
-     * TBD.
-     * @param {Matrix} matrix - TBD.
-     * @returns {Matrix} TBD.
+     * Copies the values from another matrix to this matrix.
+     * @param {Matrix} matrix - The matrix to copy values from.
+     * @returns {Matrix} This matrix instance for chaining.
      */
     copyFrom(matrix: Matrix): Matrix;
     /**
-     * TBD.
-     * @param {boolean} transpose - TBD.
-     * @param {Float32Array} output - TBD.
-     * @returns {Float32Array} TBD.
+     * Converts this matrix to a Float32Array.
+     * @param {boolean} transpose - Whether to transpose the matrix (default: false).
+     * @param {Float32Array} output - The array to store the result in (optional).
+     * @returns {Float32Array} A Float32Array containing the matrix elements.
      */
     toArray(transpose?: boolean, output?: Float32Array): Float32Array;
     /**
-     * TBD.
-     * @param {Point} pos - TBD.
-     * @param {Point} output - TBD.
-     * @returns {Point} TBD.
+     * Applies this matrix to a point.
+     * @param {Point} pos - The point to apply the matrix to.
+     * @param {Point} output - The point to store the result in (optional).
+     * @returns {Point} The transformed point.
      */
     apply(pos: Point, output?: Point): Point;
     /**
-     * TBD.
-     * @param {Point} pos - TBD.
-     * @param {Point} output - TBD.
-     * @returns {Point} TBD.
+     * Applies the inverse of this matrix to a point.
+     * @param {Point} pos - The point to apply the inverse matrix to.
+     * @param {Point} output - The point to store the result in (optional).
+     * @returns {Point} The transformed point.
      */
     applyInverse(pos: Point, output?: Point): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Matrix} TBD.
+     * Translates this matrix by the specified amounts.
+     * @param {number} x - The amount to translate in the x direction.
+     * @param {number} y - The amount to translate in the y direction.
+     * @returns {Matrix} This matrix instance for chaining.
      */
     translate(x: number, y: number): Matrix;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Matrix} TBD.
+     * Scales this matrix by the specified amounts.
+     * @param {number} x - The amount to scale in the x direction.
+     * @param {number} y - The amount to scale in the y direction.
+     * @returns {Matrix} This matrix instance for chaining.
      */
     scale(x: number, y: number): Matrix;
     /**
-     * TBD.
-     * @param {number} angle - TBD.
-     * @returns {Matrix} TBD.
+     * Rotates this matrix by the specified angle.
+     * @param {number} angle - The angle in radians to rotate by.
+     * @returns {Matrix} This matrix instance for chaining.
      */
     rotate(angle: number): Matrix;
     /**
-     * TBD.
-     * @param {Matrix} matrix - TBD.
-     * @returns {Matrix} TBD.
+     * Appends another matrix to this matrix (multiplying matrices).
+     * @param {Matrix} matrix - The matrix to append.
+     * @returns {Matrix} This matrix instance for chaining.
      */
     append(matrix: Matrix): Matrix;
     /**
-     * TBD.
-     * @returns {Matrix} TBD.
+     * Sets this matrix to an identity matrix (no transformation).
+     * @returns {Matrix} This matrix instance for chaining.
      */
     identity(): Matrix;
 }

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

@@ -1,8 +1,8 @@
 export class Point {
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
+     * Creates a new Point instance.
+     * @param {number} x - The x coordinate of the point (default: 0).
+     * @param {number} y - The y coordinate of the point (default: 0).
      */
     constructor(x?: number, y?: number);
     /** @type {number} */
@@ -12,186 +12,186 @@ export class Point {
     /** @type {number} */
     type: number;
     /**
-     * TBD.
-     * @param {Point} source - TBD.
-     * @returns {Point} TBD.
+     * Copies the coordinates from another point to this point.
+     * @param {Point} source - The point to copy coordinates from.
+     * @returns {Point} This point instance for chaining.
      */
     copyFrom(source: Point): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Returns a new point with the x and y coordinates swapped.
+     * @returns {Point} A new point instance with swapped coordinates.
      */
     invert(): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Point} TBD.
+     * Sets the coordinates of this point to new values.
+     * @param {number} x - The new x coordinate for the point.
+     * @param {number} y - The new y coordinate for the point.
+     * @returns {Point} This point instance for chaining.
      */
     setTo(x: number, y: number): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Point} TBD.
-     * @deprecated
+     * Sets the coordinates of this point to new values.
+     * @param {number} x - The new x coordinate for the point.
+     * @param {number} y - The new y coordinate for the point.
+     * @returns {Point} This point instance for chaining.
+     * @deprecated Use setTo instead.
      */
     set(x: number, y: number): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Point} TBD.
+     * Adds the given x and y values to the point's coordinates.
+     * @param {number} x - The amount to add to the x coordinate.
+     * @param {number} y - The amount to add to the y coordinate.
+     * @returns {Point} This point instance for chaining.
      */
     add(x: number, y: number): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Point} TBD.
+     * Subtracts the given x and y values from the point's coordinates.
+     * @param {number} x - The amount to subtract from the x coordinate.
+     * @param {number} y - The amount to subtract from the y coordinate.
+     * @returns {Point} This point instance for chaining.
      */
     subtract(x: number, y: number): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Point} TBD.
+     * Multiplies the point's coordinates by the given x and y values.
+     * @param {number} x - The amount to multiply the x coordinate by.
+     * @param {number} y - The amount to multiply the y coordinate by.
+     * @returns {Point} This point instance for chaining.
      */
     multiply(x: number, y: number): Point;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {Point} TBD.
+     * Divides the point's coordinates by the given x and y values.
+     * @param {number} x - The amount to divide the x coordinate by.
+     * @param {number} y - The amount to divide the y coordinate by.
+     * @returns {Point} This point instance for chaining.
      */
     divide(x: number, y: number): Point;
     /**
-     * TBD.
-     * @param {number} min - TBD.
-     * @param {number} max - TBD.
-     * @returns {Point} TBD.
+     * Constrains the x coordinate of this point to the given range.
+     * @param {number} min - The minimum value for the x coordinate.
+     * @param {number} max - The maximum value for the x coordinate.
+     * @returns {Point} This point instance for chaining.
      */
     clampX(min: number, max: number): Point;
     /**
-     * TBD.
-     * @param {number} min - TBD.
-     * @param {number} max - TBD.
-     * @returns {Point} TBD.
+     * Constrains the y coordinate of this point to the given range.
+     * @param {number} min - The minimum value for the y coordinate.
+     * @param {number} max - The maximum value for the y coordinate.
+     * @returns {Point} This point instance for chaining.
      */
     clampY(min: number, max: number): Point;
     /**
-     * TBD.
-     * @param {number} min - TBD.
-     * @param {number} max - TBD.
-     * @returns {Point} TBD.
+     * Constrains both coordinates of this point to the given range.
+     * @param {number} min - The minimum value for both coordinates.
+     * @param {number} max - The maximum value for both coordinates.
+     * @returns {Point} This point instance for chaining.
      */
     clamp(min: number, max: number): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Creates a clone of this point.
+     * @returns {Point} A new point with the same coordinates as this one.
      */
     clone(): Point;
     /**
-     * TBD.
-     * @param {Point} dest - TBD.
-     * @returns {Point} TBD.
+     * Copies the coordinates of this point to another point.
+     * @param {Point} dest - The point to copy coordinates to.
+     * @returns {Point} The destination point.
      */
     copyTo(dest: Point): Point;
     /**
-     * TBD.
-     * @param {Point} b - TBD.
-     * @returns {number} TBD.
+     * Calculates the distance between this point and another point.
+     * @param {Point} b - The other point to calculate the distance to.
+     * @returns {number} The distance between the two points.
      */
     distance(b: Point): number;
     /**
-     * TBD.
-     * @param {Point} a - TBD.
-     * @returns {boolean} TBD.
+     * Checks if this point is equal to another point.
+     * @param {Point} a - The other point to compare with.
+     * @returns {boolean} True if the points have the same coordinates, false otherwise.
      */
     equals(a: Point): boolean;
     /**
-     * TBD.
-     * @param {Point} a - TBD.
-     * @param {boolean} asDegrees - TBD.
-     * @returns {number} TBD.
+     * Calculates the angle between this point and another point.
+     * @param {Point} a - The other point to calculate the angle to.
+     * @param {boolean} asDegrees - Whether to return the result in degrees (default: false).
+     * @returns {number} The angle between the two points in radians or degrees.
      */
     angle(a: Point, asDegrees?: boolean): number;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @param {number} angle - TBD.
-     * @param {boolean} asDegrees - TBD.
-     * @param {number | null | undefined} dist - TBD.
-     * @returns {Point} TBD.
+     * Rotates this point around another point by a given 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 to rotate by.
+     * @param {boolean} asDegrees - Whether the angle is provided in degrees (default: false).
+     * @param {number | null | undefined} dist - The distance to rotate from (default: null).
+     * @returns {Point} This point instance for chaining.
      */
     rotate(x: number, y: number, angle: number, asDegrees: boolean, dist?: number | null | undefined): Point;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Calculates the magnitude (length) of this point from the origin.
+     * @returns {number} The magnitude of the point.
      */
     getMagnitude(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Calculates the square of the magnitude (length) of this point from the origin.
+     * @returns {number} The square of the magnitude of the point.
      */
     getMagnitudeSq(): number;
     /**
-     * TBD.
-     * @param {number} magnitude - TBD.
-     * @returns {Point} TBD.
+     * Sets the magnitude (length) of this point while preserving its direction.
+     * @param {number} magnitude - The new magnitude for the point.
+     * @returns {Point} This point instance for chaining.
      */
     setMagnitude(magnitude: number): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Normalizes this point to have a magnitude of 1 while preserving its direction.
+     * @returns {Point} This point instance for chaining.
      */
     normalize(): Point;
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Checks if this point has zero magnitude (is at the origin).
+     * @returns {boolean} True if both x and y coordinates are zero, false otherwise.
      */
     isZero(): boolean;
     /**
-     * TBD.
-     * @param {Point} a - TBD.
-     * @returns {number} TBD.
+     * Calculates the dot product of this point and another point.
+     * @param {Point} a - The other point to calculate the dot product with.
+     * @returns {number} The dot product of the two points.
      */
     dot(a: Point): number;
     /**
-     * TBD.
-     * @param {Point} a - TBD.
-     * @returns {number} TBD.
+     * Calculates the cross product of this point and another point.
+     * @param {Point} a - The other point to calculate the cross product with.
+     * @returns {number} The cross product of the two points.
      */
     cross(a: Point): number;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Returns a perpendicular point (rotated 90 degrees counter-clockwise).
+     * @returns {Point} A new point that is perpendicular to this one.
      */
     perp(): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Returns a perpendicular point (rotated 90 degrees clockwise).
+     * @returns {Point} A new point that is perpendicular to this one (rotated clockwise).
      */
     rperp(): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Returns a point with the same direction as this one but with y coordinate negated.
+     * @returns {Point} A new point with the same x coordinate but negated y coordinate.
      */
     normalRightHand(): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Returns a new point with the x and y coordinates rounded down to the nearest integer.
+     * @returns {Point} A new point with floored coordinates.
      */
     floor(): Point;
     /**
-     * TBD.
-     * @returns {Point} TBD.
+     * Returns a new point with the x and y coordinates rounded up to the nearest integer.
+     * @returns {Point} A new point with ceiled coordinates.
      */
     ceil(): Point;
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Returns a string representation of this point.
+     * @returns {string} A string representation of the point in the format "[Point (x=value y=value)]".
      */
     toString(): string;
 }

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

@@ -1,7 +1,7 @@
 export class Polygon {
     /**
-     * TBD.
-     * @param {object[]} points - TBD.
+     * Creates a new Polygon instance.
+     * @param {object[]} points - The array of points to define the polygon (optional).
      */
     constructor(points?: object[]);
     /** @type {number} */
@@ -15,47 +15,47 @@ export class Polygon {
     /** @type {number} */
     type: number;
     /**
-     * TBD.
-     * @param {number[]} output - TBD.
-     * @returns {number[]} TBD.
+     * Converts the polygon's points to a number array.
+     * @param {number[]} output - The array to store the result in (optional).
+     * @returns {number[]} An array of numbers representing the polygon's points.
      */
     toNumberArray(output?: number[]): number[];
     /**
-     * TBD.
-     * @returns {Polygon} TBD.
+     * Flattens the polygon's point array to a simple numeric array.
+     * @returns {Polygon} This polygon instance for chaining.
      */
     flatten(): Polygon;
     /**
-     * TBD.
-     * @returns {Polygon} TBD.
+     * Creates a clone of this polygon.
+     * @returns {Polygon} A new polygon with the same values as this one.
      */
     clone(): Polygon;
     /**
-     * TBD.
-     * @param {number} x - TBD.
-     * @param {number} y - TBD.
-     * @returns {boolean} TBD.
+     * Checks if the specified point is contained within this polygon.
+     * @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 polygon, false otherwise.
      */
     contains(x: number, y: number): boolean;
     /**
-     * TBD.
-     * @param {object[]} points - TBD.
-     * @returns {Polygon} TBD.
+     * Sets the polygon's points to new values.
+     * @param {object[]} points - The array of points to define the polygon.
+     * @returns {Polygon} This polygon instance for chaining.
      */
     setTo(points: object[]): Polygon;
     /**
-     * TBD.
-     * @param {number} y0 - TBD.
-     * @returns {number} TBD.
+     * Calculates the area of this polygon.
+     * @param {number} y0 - The y coordinate of the lowest boundary (internal use).
+     * @returns {number} The area of this polygon.
      */
     calculateArea(y0: number): number;
     /**
-     * TBD.
+     * Sets the points of this polygon.
      */
     set points(value: object[]);
     /**
-     * TBD.
-     * @returns {object[]} TBD.
+     * Gets the points of this polygon.
+     * @returns {object[]} The array of points that define this polygon.
      */
     get points(): object[];
 }