Class: Vector2

Lightweight mutable 2D vector. Math methods return this for chaining and mutate in place unless they're explicitly named with *Of (which create a new vector from inputs) or have a separate static counterpart.

For per-frame hot paths, prefer reusing one Vector2 (v.Set(x, y).Add(...)) over allocating fresh ones — the GC pressure of small object churn dominates real workloads.

Constructors

Constructor

new Vector2(x?, y?): Vector2;

Parameters

Parameter	Type	Default value
x	number	0
y	number	0

Returns

Vector2

Properties

Property	Modifier	Type
x	public	number
y	public	number

Methods

Add()

Add(v): this;

Parameters

Parameter	Type
v	Vector2

Returns

this

---

AddOf()

static AddOf(a, b): Vector2;

Parameters

Parameter	Type
a	Vector2
b	Vector2

Returns

Vector2

---

AngleOf()

AngleOf(): number;

Signed angle of this vector in radians, atan2 of (y, x). 0 = +X axis.

Returns

number

---

AngleTo()

AngleTo(v): number;

Signed shortest angle from this → v, in [-PI, PI]. Sign matches CCW convention.

Parameters

Parameter	Type
v	Vector2

Returns

number

---

ClampLength()

ClampLength(max): this;

Clamp this vector's length to max (in place). No-op if already shorter.

Parameters

Parameter	Type
max	number

Returns

this

---

Clone()

Clone(): Vector2;

Returns

Vector2

---

Copy()

Copy(v): this;

Parameters

Parameter	Type
v	Vector2

Returns

this

---

Cross()

Cross(v): number;

2D pseudo-cross — scalar z-component of the 3D cross product.

Parameters

Parameter	Type
v	Vector2

Returns

number

---

DistanceTo()

DistanceTo(v): number;

Parameters

Parameter	Type
v	Vector2

Returns

number

---

DistanceToSq()

DistanceToSq(v): number;

Parameters

Parameter	Type
v	Vector2

Returns

number

---

Dot()

Dot(v): number;

Parameters

Parameter	Type
v	Vector2

Returns

number

---

Equals()

Equals(v, epsilon?): boolean;

Parameters

Parameter	Type	Default value
v	Vector2	undefined
epsilon	number	0

Returns

boolean

---

FromAngle()

static FromAngle(radians, length?): Vector2;

Build a unit vector pointing at radians. Allocates — prefer SetFromAngle in hot loops.

Parameters

Parameter	Type	Default value
radians	number	undefined
length	number	1

Returns

Vector2

---

Length()

Length(): number;

Returns

number

---

LengthSq()

LengthSq(): number;

Returns

number

---

Lerp()

Lerp(v, t): this;

Linear interpolation toward v by t in [0, 1].

Parameters

Parameter	Type
v	Vector2
t	number

Returns

this

---

LerpOf()

static LerpOf(
   a, 
   b, 
   t
): Vector2;

Parameters

Parameter	Type
a	Vector2
b	Vector2
t	number

Returns

Vector2

---

Negate()

Negate(): this;

Returns

this

---

Normalize()

Normalize(): this;

Returns

this

---

One()

static One(): Vector2;

Returns

Vector2

---

Right()

static Right(): Vector2;

Returns

Vector2

---

Rotate()

Rotate(radians): this;

Rotate this vector by radians around the origin (in place).

Parameters

Parameter	Type
radians	number

Returns

this

---

Scale()

Scale(s): this;

Parameters

Parameter	Type
s	number

Returns

this

---

Set()

Set(x, y): this;

Parameters

Parameter	Type
x	number
y	number

Returns

this

---

SetFromAngle()

SetFromAngle(radians, length?): this;

Set this vector to (cos a, sin a) * length. Length defaults to 1 (unit direction).

Parameters

Parameter	Type	Default value
radians	number	undefined
length	number	1

Returns

this

---

Sub()

Sub(v): this;

Parameters

Parameter	Type
v	Vector2

Returns

this

---

SubOf()

static SubOf(a, b): Vector2;

Returns a new vector (a - b). Allocates — prefer in-place a.Sub(b) in hot loops.

Parameters

Parameter	Type
a	Vector2
b	Vector2

Returns

Vector2

---

Up()

static Up(): Vector2;

Returns

Vector2

---

Zero()

static Zero(): Vector2;

Returns

Vector2