Class Vector2

constructor

• new Vector2(x: number, y: number): Vector2

  Constructs a new Vector2.

  Parameters

  • x: number

    The X component.
  • y: number

    The Y component.

  Returns Vector2

x

y

add

• add(vector: Readonly<Vector2>): this

  Adds another vector to this vector.

  Parameters

  • vector: Readonly<Vector2>

    The vector to add to this vector.

  Returns this

  This instance.

addMultiply

• addMultiply(vector: Readonly<Vector2>, scale: number): this

  Scales another vector and adds it to this vector.

  Parameters

  • vector: Readonly<Vector2>

    The vector to add to this vector.
  • scale: number

    The scaling to apply to the input vector.

  Returns this

  This instance.

addMultiplyXY

• addMultiplyXY(x: number, y: number, scale: number): this

  Scales another vector and adds it to this vector.

  Parameters

  • x: number

    The value to add to the X component.
  • y: number

    The value to add to the Y component.
  • scale: number

    The scaling to apply to the input vector.

  Returns this

  This instance.

addXY

• addXY(x: number, y: number): this

  Adds another vector to this vector.

  Parameters

  • x: number

    The value to add to the X component.
  • y: number

    The value to add to the Y component.

  Returns this

  This instance.

asArray

• asArray(): [number, number]

  Return the components of this vector as an array.

  Returns [number, number]

  The components of this vector as an array.

clamp

• clamp(floor: number, ceil: number): this

  Clamps the components of the vector at the given boundary.

  Parameters

  • floor: number

    The lowest value to allow.
  • ceil: number

    The largest value to allow.

  Returns this

  This instance.

compare

• compare(vector: Readonly<Vector2>): boolean

  Compares two vectors.

  Parameters

  • vector: Readonly<Vector2>

    The vector to compare this vector to.

  Returns boolean

  true if the vectors are idently, false otherwise.

divide

• divide(vector: Readonly<Vector2>): this

  Divides this vector by another vector.

  Parameters

  • vector: Readonly<Vector2>

    The vector to divide this vector with.

  Returns this

  This instance.

divideScale

• divideScale(scale: number): this

  Divides the vector by the given scale.

  Parameters

  • scale: number

    The scaling to apply to the vector.

  Returns this

  This instance.

divideXY

• divideXY(x: number, y: number): this

  Divides this vector by another vector.

  Parameters

  • x: number

    The value to divide the X component with.
  • y: number

    The value to divide the Y component with.

  Returns this

  This instance.

dot

• dot(vector: Readonly<Vector2>): number

  Returns the dot product between two vectors.

  Parameters

  • vector: Readonly<Vector2>

    The other vector.

  Returns number

  The dot product between the two vectors.

dotXY

• dotXY(x: number, y: number): number

  Returns the dot product between two vectors.

  Parameters

  • x: number

    The X component of the other vector.
  • y: number

    The Y component of the other vector.

  Returns number

  The dot product between the two vectors.

invertAdd

• invertAdd(): this

  Inverts the direction of the vector.

  Returns this

  This instance.

invertMultiply

• invertMultiply(): this

  Inverts the vectors scale.

  Returns this

  This instance.

length

• length(): number

  Calculates the length of the vector.

  Returns number

  The length of the vector.

lerp

• lerp(vector: Readonly<Vector2>, t: number): this

  Linearly moves this vector towards a target vector.

  Parameters

  • vector: Readonly<Vector2>

    The target vector.
  • t: number

    The location on the scale, from 0 to 1.

  Returns this

  This instance.

multiply

• multiply(vector: Readonly<Vector2>): this

  Multiplies this vector by another vector.

  Parameters

  • vector: Readonly<Vector2>

    The vector to multiply with this vector.

  Returns this

  This instance.

multiplyScale

• multiplyScale(scale: number): this

  Multiplies the vector by the given scale.

  Parameters

  • scale: number

    The scaling to apply to the vector.

  Returns this

  This instance.

multiplyXY

• multiplyXY(x: number, y: number): this

  Multiplies this vector by another vector.

  Parameters

  • x: number

    The value to multiply with the X component.
  • y: number

    The value to multiply with the Y component.

  Returns this

  This instance.

normalize

• normalize(): this

  Normalizes the vector.

  Returns this

  This instance.

rotate

• rotate(angle: number): this

  Rotates the vector by the given angle.

  Parameters

  • angle: number

    The angle in degrees.

  Returns this

  This instance.

set

• set(vector: Readonly<Vector2>): this

  Sets the vector to new coordinates.

  Parameters

  • vector: Readonly<Vector2>

    The coordinates to set the vector to.

  Returns this

  This instance.

setXY

• setXY(x: number, y: number): this

  Sets the vector to new coordinates.

  Parameters

  • x: number

    The new X component for the vector.
  • y: number

    The new Y component for the vector.

  Returns this

  This instance.

subtract

• subtract(vector: Readonly<Vector2>): this

  Subtracts another vector from this vector.

  Parameters

  • vector: Readonly<Vector2>

    The vector to subtract from this vector.

  Returns this

  This instance.

subtractXY

• subtractXY(x: number, y: number): this

  Subtracts another vector from this vector.

  Parameters

  • x: number

    The value to subtract from the X component.
  • y: number

    The value to subtract from the Y component.

  Returns this

  This instance.

StaticfromVector2

• fromVector2(vector: Readonly<Vector2>): Vector2

  Creates a copy of another Vector2.

  Parameters

  • vector: Readonly<Vector2>

    The vector to copy.

  Returns Vector2

  A new vector.