Vector3

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

Mutable three-dimensional vector exposed as Core.Vector3 for positions, directions, and Euler angles.

Constructors

Constructor

new Vector3(x, y, z): Vector3

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

Creates a vector from three numeric components.

Parameters

x

number

Initial X component.

y

number

Initial Y component.

z

number

Initial Z component.

Returns

Vector3

Methods

add()

add(other): this

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

Adds another vector to this vector in place.

Parameters

other

Vector3

Vector to add component-wise.

Returns

this

This mutated vector for chaining.

---

clone()

clone(): Vector3

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

Creates an independent copy of this vector.

Returns

Vector3

New vector with the same components.

---

cross()

cross(other): this

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

Replaces this vector with its cross product against another vector.

Parameters

other

Vector3

Second vector in the cross product.

Returns

this

This mutated perpendicular vector for chaining.

---

distance()

distance(other): number

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

Computes Euclidean distance to another vector.

Parameters

other

Vector3

Vector to measure from this vector.

Returns

number

Distance between the two vectors.

---

div()

div(scalar): this

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

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: client/api.d.ts:1504

Computes the dot product without changing either vector.

Parameters

other

Vector3

Vector used for the dot product.

Returns

number

Scalar dot product.

---

lerp()

lerp(target, t): this

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

Linearly interpolates this vector toward a target in place.

Parameters

target

Vector3

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:1490

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: client/api.d.ts:1517

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

Returns

this

This mutated vector for chaining.

---

set()

set(x, y, z): this

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

Replaces all components in place.

Parameters

x

number

Replacement X component.

y

number

Replacement Y component.

z

number

Replacement Z component.

Returns

this

This mutated vector for chaining.

---

sub()

sub(other): this

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

Subtracts another vector from this vector in place.

Parameters

other

Vector3

Vector to subtract component-wise.

Returns

this

This mutated vector for chaining.

---

toJSON()

toJSON(): object

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

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

Returns

object

Object containing the current components.

x

x: number

y

y: number

z

z: number

---

toString()

toString(): string

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

Formats this vector for logging and debugging.

Returns

string

Text in Vector3(x, y, z) form.

---

forward()

static forward(): Vector3

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

Creates the framework’s positive-Z unit direction.

Returns

Vector3

New Vector3(0, 0, 1).

---

one()

static one(): Vector3

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

Creates a vector whose components are one.

Returns

Vector3

New Vector3(1, 1, 1).

---

right()

static right(): Vector3

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

Creates the framework’s positive-X unit direction.

Returns

Vector3

New Vector3(1, 0, 0).

---

up()

static up(): Vector3

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

Creates the framework’s positive-Y unit direction.

Returns

Vector3

New Vector3(0, 1, 0).

---

zero()

static zero(): Vector3

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

Creates a zero vector.

Returns

Vector3

New Vector3(0, 0, 0).

Properties

length

readonly length: number

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

Read-only Euclidean magnitude of this vector.

---

lengthSquared

readonly lengthSquared: number

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

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

---

x

x: number

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

Mutable X component.

---

y

y: number

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

Mutable Y component.

---

z

z: number

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

Mutable Z component.