Class Vector3

An immutable-by-convention 3D vector with common math operations.

Remarks

Every operation returns a new Vector3 rather than mutating in place, so instances are safe to share. Because the public x/y/z fields satisfy IVector3, an instance can be passed directly to any native that expects a coordinate shape (e.g. SetEntityCoords).

Example

const a = new Vector3(0, 0, 0);
const b = new Vector3(10, 0, 0);

a.distanceTo(b);          // 10
a.lerp(b, 0.5);           // Vector3(5, 0, 0)
a.add(new Vector3(0, 0, 5)); // Vector3(0, 0, 5)

Implements

IVector3

Index

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
Creates a vector from its components.
Parameters
- x: number = 0
  X component.
- y: number = 0
  Y component.
- z: number = 0
  Z component.
Returns Vector3
Default Value
```
0
```
Default Value
```
0
```
Default Value
```
0
```
- Defined in shared/math/vector3.ts:57

Properties

x

x: number = 0

X component.

y

y: number = 0

Y component.

z

z: number = 0

Z component.

Accessors

length

get length(): number
The magnitude (Euclidean length) of the vector.

Returns number

Remarks
Involves a square root. If you only need to compare magnitudes, prefer Vector3.lengthSquared to avoid the Math.sqrt call.
- Defined in shared/math/vector3.ts:162

lengthSquared

get lengthSquared(): number
The squared magnitude of the vector.

Returns number

Remarks
Cheaper than Vector3.length because it skips the square root. Order is preserved, so it is ideal for "which is closer" comparisons.
- Defined in shared/math/vector3.ts:173

Methods

add

add(value: number | Vector3): Vector3
Adds a vector or a scalar to this vector.
Parameters
- value: number | Vector3
  A Vector3 (component-wise) or a number (added to every component).
Returns Vector3
The resulting vector.
- Defined in shared/math/vector3.ts:97

clone

clone(): Vector3
Creates an independent copy of this vector.

Returns Vector3
A new Vector3 with the same components.
- Defined in shared/math/vector3.ts:230

cross

cross(value: Vector3): Vector3
Cross product with another vector.
Parameters
- value: Vector3
  The other vector.
Returns Vector3
A new vector perpendicular to both inputs.
- Defined in shared/math/vector3.ts:147

distanceTo

distanceTo(v: Vector3): number
Euclidean distance to another point.
Parameters
- v: Vector3
  The other point.
Returns number
The distance.

See
Vector3.distanceToSquared for a cheaper comparison-only variant.
- Defined in shared/math/vector3.ts:195

distanceToSquared

distanceToSquared(v: Vector3): number
Squared Euclidean distance to another point.
Parameters
- v: Vector3
  The other point.
Returns number
The squared distance.

Remarks
Skips the square root, so use this when ranking or thresholding distances (compare against a squared radius) rather than reporting an actual distance.
- Defined in shared/math/vector3.ts:209

dot

dot(value: Vector3): number
Dot product with another vector.
Parameters
- value: Vector3
  The other vector.
Returns number
The scalar dot product. 0 means the vectors are perpendicular.
- Defined in shared/math/vector3.ts:137

equals

equals(v: Vector3, epsilon?: number): boolean
Compares two vectors for approximate equality.
Parameters
- v: Vector3
  The vector to compare against.
- epsilon: number = 1e-6
  Maximum allowed per-component difference.
Returns boolean
true if every component is within epsilon of v.
Remarks
Uses a tolerance because floating-point math rarely produces exactly equal components after arithmetic.
Default Value
```
1e-6
```
- Defined in shared/math/vector3.ts:245

lerp

lerp(v: Vector3, t: number): Vector3
Linearly interpolates from this vector toward another.
Parameters
- v: Vector3
  The target vector.
- t: number
  Interpolation factor. 0 returns this vector, 1 returns v; values outside [0, 1] extrapolate.
Returns Vector3
The interpolated vector.
- Defined in shared/math/vector3.ts:221

multiply

multiply(value: number | Vector3): Vector3
Multiplies this vector by a vector or a scalar.
Parameters
- value: number | Vector3
  A Vector3 (component-wise) or a number (scales every component).
Returns Vector3
The resulting vector.

Remarks
Vector input is a component-wise (Hadamard) product, not a dot or cross product. Pass a scalar to uniformly scale — e.g. v.multiply(2) doubles the length.
- Defined in shared/math/vector3.ts:125

normalize

normalize(): Vector3
Returns a unit vector pointing in the same direction.

Returns Vector3
A new vector with length 1, or Vector3.zero if this vector has zero length (avoids dividing by zero).
- Defined in shared/math/vector3.ts:183

subtract

subtract(value: number | Vector3): Vector3
Subtracts a vector or a scalar from this vector.
Parameters
- value: number | Vector3
  A Vector3 (component-wise) or a number (subtracted from every component).
Returns Vector3
The resulting vector.
- Defined in shared/math/vector3.ts:109

toArray

toArray(): [number, number, number]
Converts to a plain [x, y, z] tuple.

Returns [number, number, number]
The components as a fixed-length array.
- Defined in shared/math/vector3.ts:258

toString

toString(): string
A human-readable representation, e.g. "Vector3(1, 2, 3)".

Returns string
The formatted string.
- Defined in shared/math/vector3.ts:267

`Static`from

from(value: number[] | IVector3): Vector3
Builds a Vector3 from a plain object or a [x, y, z] tuple.
Parameters
- value: number[] | IVector3
  Either an { x, y, z } object or a numeric array in [x, y, z] order.
Returns Vector3
A new Vector3.
Example
```
Vector3.from({ x: 1, y: 2, z: 3 });
Vector3.from(GetEntityCoords(ped, true)); // wrap a native result
Vector3.from([1, 2, 3]);
```
- Defined in shared/math/vector3.ts:76

`Static`zero

zero(): Vector3
The zero vector, (0, 0, 0).

Returns Vector3
A new zero Vector3.
- Defined in shared/math/vector3.ts:87

Class Vector3

Remarks

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector3

Default Value

Default Value

Default Value

Properties

x

y

z

Accessors

length

Returns number

Remarks

lengthSquared

Returns number

Remarks

Methods

add

Parameters

Returns Vector3

clone

Returns Vector3

cross

Parameters

Returns Vector3

distanceTo

Parameters

Returns number

See

distanceToSquared

Parameters

Returns number

Remarks

dot

Parameters

Returns number

equals

Parameters

Returns boolean

Remarks

Default Value

lerp

Parameters

Returns Vector3

multiply

Parameters

Returns Vector3

Remarks

normalize

Returns Vector3

subtract

Parameters

Returns Vector3

toArray

Returns [number, number, number]

toString

Returns string

Staticfrom

Parameters

Returns Vector3

Example

Staticzero

Returns Vector3

Settings

On This Page

`Static`from

`Static`zero