Vector2

Defined in: client/api.d.ts:1311

Mutable two-dimensional vector exposed as Core.Vector2.

Constructors

Constructor

new Vector2(x, y): Vector2

Defined in: client/api.d.ts:1317

Creates a vector from two numeric components.

Parameters

x

number

Initial X component.

y

number

Initial Y component.

Returns

Vector2

Methods

add()

add(other): this

Defined in: client/api.d.ts:1344

Adds another vector to this vector in place.

Parameters

other

Vector2

Vector to add component-wise.

Returns

this

This mutated vector for chaining.

---

clone()

clone(): Vector2

Defined in: client/api.d.ts:1407

Creates an independent copy of this vector.

Returns

Vector2

New vector with the same components.

---

distance()

distance(other): number

Defined in: client/api.d.ts:1401

Computes Euclidean distance to another vector.

Parameters

other

Vector2

Vector to measure from this vector.

Returns

number

Distance between the two vectors.

---

div()

div(scalar): this

Defined in: client/api.d.ts:1365

Divides this vector by a scalar in place.

Parameters

scalar

number

Divisor applied to both components; must be non-zero.

Returns

this

This mutated vector for chaining.

---

dot()

dot(other): number

Defined in: client/api.d.ts:1372

Computes the dot product without changing either vector.

Parameters

other

Vector2

Vector used for the dot product.

Returns

number

Scalar dot product.

---

lerp()

lerp(target, t): this

Defined in: client/api.d.ts:1386

Linearly interpolates this vector toward a target in place.

Parameters

target

Vector2

Destination vector.

t

number

Interpolation factor; 0 keeps the current value and 1 reaches target.

Returns

this

This mutated vector for chaining.

---

mul()

mul(scalar): this

Defined in: client/api.d.ts:1358

Multiplies this vector by a scalar in place.

Parameters

scalar

number

Multiplier applied to both components.

Returns

this

This mutated vector for chaining.

---

normalize()

normalize(): this

Defined in: client/api.d.ts:1378

Normalizes this vector in place; a zero vector remains unchanged.

Returns

this

This mutated vector for chaining.

---

set()

set(x, y): this

Defined in: client/api.d.ts:1394

Replaces both components in place.

Parameters

x

number

Replacement X component.

y

number

Replacement Y component.

Returns

this

This mutated vector for chaining.

---

sub()

sub(other): this

Defined in: client/api.d.ts:1351

Subtracts another vector from this vector in place.

Parameters

other

Vector2

Vector to subtract component-wise.

Returns

this

This mutated vector for chaining.

---

toJSON()

toJSON(): object

Defined in: client/api.d.ts:1419

Converts this vector to a plain object for JSON.stringify.

Returns

object

Object containing the current components.

x

x: number

y

y: number

---

toString()

toString(): string

Defined in: client/api.d.ts:1413

Formats this vector for logging and debugging.

Returns

string

Text in Vector2(x, y) form.

---

one()

static one(): Vector2

Defined in: client/api.d.ts:1431

Creates a vector whose components are one.

Returns

Vector2

New Vector2(1, 1).

---

zero()

static zero(): Vector2

Defined in: client/api.d.ts:1425

Creates a vector whose components are zero.

Returns

Vector2

New Vector2(0, 0).

Properties

length

readonly length: number

Defined in: client/api.d.ts:1332

Read-only Euclidean magnitude of this vector.

---

lengthSquared

readonly lengthSquared: number

Defined in: client/api.d.ts:1337

Read-only squared magnitude, avoiding a square-root calculation.

---

x

x: number

Defined in: client/api.d.ts:1322

Mutable X component.

---

y

y: number

Defined in: client/api.d.ts:1327

Mutable Y component.