Vector4

Defined in: server/api.d.ts:2178

Mutable four-dimensional vector exposed as Core.Vector4.

Constructors

Constructor

new Vector4(x, y, z, w): Vector4

Defined in: server/api.d.ts:2186

Creates a vector from four numeric components.

Parameters

x

number

Initial X component.

y

number

Initial Y component.

z

number

Initial Z component.

w

number

Initial W component.

Returns

Vector4

Methods

add()

add(other): this

Defined in: server/api.d.ts:2223

Adds another vector to this vector in place.

Parameters

other

Vector4

Vector to add component-wise.

Returns

this

This mutated vector for chaining.

---

clone()

clone(): Vector4

Defined in: server/api.d.ts:2288

Creates an independent copy of this vector.

Returns

Vector4

New vector with the same components.

---

distance()

distance(other): number

Defined in: server/api.d.ts:2258

Computes Euclidean distance to another vector.

Parameters

other

Vector4

Vector to measure from this vector.

Returns

number

Distance between the two vectors.

---

div()

div(scalar): this

Defined in: server/api.d.ts:2244

Divides this vector by a scalar in place.

Parameters

scalar

number

Divisor applied to every component; must be non-zero.

Returns

this

This mutated vector for chaining.

---

dot()

dot(other): number

Defined in: server/api.d.ts:2251

Computes the dot product without changing either vector.

Parameters

other

Vector4

Vector used for the dot product.

Returns

number

Scalar dot product.

---

lerp()

lerp(target, t): this

Defined in: server/api.d.ts:2272

Linearly interpolates this vector toward a target in place.

Parameters

target

Vector4

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: server/api.d.ts:2237

Multiplies this vector by a scalar in place.

Parameters

scalar

number

Multiplier applied to every component.

Returns

this

This mutated vector for chaining.

---

normalize()

normalize(): this

Defined in: server/api.d.ts:2264

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

Returns

this

This mutated vector for chaining.

---

set()

set(x, y, z, w): this

Defined in: server/api.d.ts:2282

Replaces all components in place.

Parameters

x

number

Replacement X component.

y

number

Replacement Y component.

z

number

Replacement Z component.

w

number

Replacement W component.

Returns

this

This mutated vector for chaining.

---

sub()

sub(other): this

Defined in: server/api.d.ts:2230

Subtracts another vector from this vector in place.

Parameters

other

Vector4

Vector to subtract component-wise.

Returns

this

This mutated vector for chaining.

---

toJSON()

toJSON(): object

Defined in: server/api.d.ts:2300

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

Returns

object

Object containing the current components.

w

w: number

x

x: number

y

y: number

z

z: number

---

toString()

toString(): string

Defined in: server/api.d.ts:2294

Formats this vector for logging and debugging.

Returns

string

Text in Vector4(x, y, z, w) form.

---

one()

static one(): Vector4

Defined in: server/api.d.ts:2312

Creates a vector whose components are one.

Returns

Vector4

New Vector4(1, 1, 1, 1).

---

zero()

static zero(): Vector4

Defined in: server/api.d.ts:2306

Creates a zero vector.

Returns

Vector4

New Vector4(0, 0, 0, 0).

Properties

length

readonly length: number

Defined in: server/api.d.ts:2211

Read-only Euclidean magnitude of this vector.

---

lengthSquared

readonly lengthSquared: number

Defined in: server/api.d.ts:2216

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

---

w

w: number

Defined in: server/api.d.ts:2206

Mutable W component.

---

x

x: number

Defined in: server/api.d.ts:2191

Mutable X component.

---

y

y: number

Defined in: server/api.d.ts:2196

Mutable Y component.

---

z

z: number

Defined in: server/api.d.ts:2201

Mutable Z component.