Class Vec3

constructor

• new Vec3(x, y, z): Vec3

• Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

• new Vec3(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• new Vec3(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• new Vec3(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• new Vec3(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

Readonly x

Readonly y

Readonly z

Static Readonly Down

Static Readonly East

Static Readonly North

Static Readonly South

Static Readonly Up

Static Readonly West

Static Readonly Zero

add

• add(x, y, z): Vec3

• Adds another vector to the current vector.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  The updated vector after addition.
• add(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• add(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• add(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• add(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

almostEqual

• almostEqual(x, y, z, delta): boolean

• Checks if the current vector is equal to another vector.

  Parameters

  • x: number

  • y: number

  • z: number

  • delta: number

  Returns boolean
• almostEqual(x, delta): boolean

• Parameters

  • x: Vec3

  • delta: number

  Returns boolean

• almostEqual(x, delta): boolean

• Parameters

  • x: Vector3

  • delta: number

  Returns boolean

• almostEqual(x, delta): boolean

• Parameters

  • x: Direction

  • delta: number

  Returns boolean

• almostEqual(x, delta): boolean

• Parameters

  • x: number[]

  • delta: number

  Returns boolean

angleBetween

• angleBetween(x, y, z): number

• Computes the angle (in radians) between the current vector and another vector.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns number

  The angle in radians between the two vectors.
• angleBetween(x): number

• Parameters

  • x: Vec3

  Returns number

• angleBetween(x): number

• Parameters

  • x: Vector3

  Returns number

• angleBetween(x): number

• Parameters

  • x: Direction

  Returns number

• angleBetween(x): number

• Parameters

  • x: number[]

  Returns number

ceil

• ceil(): Vec3

• Ceils the X, Y, and Z components of the vector.

  Returns Vec3

  A new vector with the ceiled components.

ceilX

• ceilX(): Vec3

• Ceils the X component of the vector.

  Returns Vec3

  A new vector with the ceiled X component.

ceilY

• ceilY(): Vec3

• Ceils the Y component of the vector.

  Returns Vec3

  A new vector with the ceiled Y component.

ceilZ

• ceilZ(): Vec3

• Ceils the Z component of the vector.

  Returns Vec3

  A new vector with the ceiled Z component.

copy

• copy(): Vec3

• Creates a copy of the current vector.

  Returns Vec3

  A new vector with the same values as the current vector.

cross

• cross(x, y, z): Vec3

• Computes the cross product of the current vector with another vector.

  A cross product is a vector that is perpendicular to both vectors.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  A new vector representing the cross product.
• cross(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• cross(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• cross(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• cross(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

distance

• distance(x, y, z): number

• Computes the distance between the current vector and another vector.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns number

  The distance between the two vectors.
• distance(x): number

• Parameters

  • x: Vec3

  Returns number

• distance(x): number

• Parameters

  • x: Vector3

  Returns number

• distance(x): number

• Parameters

  • x: Direction

  Returns number

• distance(x): number

• Parameters

  • x: number[]

  Returns number

distanceSquared

• distanceSquared(x, y, z): number

• Computes the squared distance between the current vector and another vector. This is faster than computing the actual distance and can be useful for comparison purposes.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns number

  The squared distance between the two vectors.
• distanceSquared(x): number

• Parameters

  • x: Vec3

  Returns number

• distanceSquared(x): number

• Parameters

  • x: Vector3

  Returns number

• distanceSquared(x): number

• Parameters

  • x: Direction

  Returns number

• distanceSquared(x): number

• Parameters

  • x: number[]

  Returns number

distanceToLineSegment

• distanceToLineSegment(start, end): number

• Calculates the shortest distance between a point (represented by this Vector3 instance) and a line segment.

  This method finds the perpendicular projection of the point onto the line defined by the segment. If this projection lies outside the line segment, then the method calculates the distance from the point to the nearest segment endpoint.

  Parameters

  • start: Vector3

    The starting point of the line segment.

  • end: Vector3

    The ending point of the line segment.

  Returns number

  The shortest distance between the point and the line segment.

divide

• divide(x, y, z): Vec3

• Divides the current vector by another vector or scalar.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  The updated vector after division.
• divide(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• divide(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• divide(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• divide(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

• divide(x): Vec3

• Parameters

  • x: number

  Returns Vec3

dot

• dot(x, y, z): number

• Computes the dot product of the current vector with another vector.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns number

  The dot product of the two vectors.
• dot(x): number

• Parameters

  • x: Vec3

  Returns number

• dot(x): number

• Parameters

  • x: Vector3

  Returns number

• dot(x): number

• Parameters

  • x: Direction

  Returns number

• dot(x): number

• Parameters

  • x: number[]

  Returns number

down

• down(): Vec3

• Returns a new vector offset from the current vector down by 1 block.

  Returns Vec3

  A new vector offset from the current vector down by 1 block.

east

• east(): Vec3

• Returns a new vector offset from the current vector east by 1 block.

  Returns Vec3

  A new vector offset from the current vector east by 1 block.

equals

• equals(x, y, z): boolean

• Checks if the current vector is equal to another vector.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns boolean
• equals(x): boolean

• Parameters

  • x: Vec3

  Returns boolean

• equals(x): boolean

• Parameters

  • x: Vector3

  Returns boolean

• equals(x): boolean

• Parameters

  • x: Direction

  Returns boolean

• equals(x): boolean

• Parameters

  • x: number[]

  Returns boolean

floor

• floor(): Vec3

• Floors the X, Y, and Z components of the vector.

  Returns Vec3

  A new vector with the floored components.

floorX

• floorX(): Vec3

• Floors the X component of the vector.

  Returns Vec3

  A new vector with the floored X component.

floorY

• floorY(): Vec3

• Floors the Y component of the vector.

  Returns Vec3

  A new vector with the floored Y component.

floorZ

• floorZ(): Vec3

• Floors the Z component of the vector.

  Returns Vec3

  A new vector with the floored Z component.

isZero

• isZero(): boolean

• Checks if the current vector is equal to the zero vector.

  Returns boolean

  true if the vector is equal to the zero vector, else returns false.

length

• length(): number

• Computes the length (magnitude) of the vector.

  Returns number

  The length of the vector.

lengthSquared

• lengthSquared(): number

• Computes the squared length of the vector. This is faster than computing the actual length and can be useful for comparison purposes.

  Returns number

  The squared length of the vector.

lerp

• lerp(v, t): Vec3

• Computes the linear interpolation between the current vector and another vector, when t is in the range [0, 1]. Computes the extrapolation when t is outside this range.

  Parameters

  • v: Vector3

    The other vector.

  • t: number

    The interpolation factor.

  Returns Vec3

  A new vector after performing the lerp operation.

multiply

• multiply(x, y, z): Vec3

• Multiplies the current vector by another vector or scalar.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  The updated vector after multiplication.
• multiply(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• multiply(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• multiply(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• multiply(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

• multiply(x): Vec3

• Parameters

  • x: number

  Returns Vec3

normalize

• normalize(): Vec3

• Normalizes the vector to have a length (magnitude) of 1. Normalized vectors are often used as a direction vectors.

  Returns Vec3

  The normalized vector.

north

• north(): Vec3

• Returns a new vector offset from the current vector north by 1 block.

  Returns Vec3

  A new vector offset from the current vector north by 1 block.

projectOnto

• projectOnto(x, y, z): Vec3

• Computes the projection of the current vector onto another vector. This method finds how much of the current vector lies in the direction of vector v.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  A new vector representing the projection of the current vector onto v.
• projectOnto(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• projectOnto(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• projectOnto(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• projectOnto(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

reflect

• reflect(x, y, z): Vec3

• Computes the reflection of the current vector against a normal vector. Useful for simulating light reflections or bouncing objects.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  A new vector representing the reflection of the current vector.
• reflect(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• reflect(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• reflect(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• reflect(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

rotate

• rotate(axis, angle): Vec3

• Rotates the current normalized vector by a given angle around a given axis.

  Parameters

  • axis: Vector3

    The axis of rotation.

  • angle: number

    The angle of rotation in degrees.

  Returns Vec3

  The rotated vector.

round

• round(): Vec3

• Rounds the X, Y, and Z components of the vector.

  Returns Vec3

  A new vector with the rounded components.

roundX

• roundX(): Vec3

• Rounds the X component of the vector.

  Returns Vec3

  A new vector with the rounded X component.

roundY

• roundY(): Vec3

• Rounds the Y component of the vector.

  Returns Vec3

  A new vector with the rounded Y component.

roundZ

• roundZ(): Vec3

• Rounds the Z component of the vector.

  Returns Vec3

  A new vector with the rounded Z component.

setX

• setX(value): Vec3

• Sets the X component of the vector.

  Parameters

  • value: number

    The new X value.

  Returns Vec3

  The updated vector with the new X value.

setY

• setY(value): Vec3

• Sets the Y component of the vector.

  Parameters

  • value: number

    The new Y value.

  Returns Vec3

  The updated vector with the new Y value.

setZ

• setZ(value): Vec3

• Sets the Z component of the vector.

  Parameters

  • value: number

    The new Z value.

  Returns Vec3

  The updated vector with the new Z value.

slerp

• slerp(v, t): Vec3

• Computes the spherical linear interpolation between the current vector and another vector, when t is in the range [0, 1]. Computes the extrapolation when t is outside this range.

  Parameters

  • v: Vector3

    The other vector.

  • t: number

    The interpolation factor.

  Returns Vec3

  A new vector after performing the slerp operation.

south

• south(): Vec3

• Returns a new vector offset from the current vector south by 1 block.

  Returns Vec3

  A new vector offset from the current vector south by 1 block.

subtract

• subtract(x, y, z): Vec3

• Subtracts another vector from the current vector.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3

  The updated vector after subtraction.
• subtract(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• subtract(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• subtract(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• subtract(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

toArray

• toArray(): number[]

• Converts the vector to an array containing the X, Y, and Z components of the vector.

  Returns number[]

  An array containing the X, Y, and Z components of the vector.

toBlockLocation

• toBlockLocation(): Vec3

• Returns a new vector with the X, Y, and Z components rounded to the nearest block location.

  Returns Vec3

toDirection

• toDirection(): Direction

• Converts the vector to a direction. If the vector is not a unit vector, then it will be normalized and rounded to the nearest direction.

  Returns Direction

toString

• toString(format?, separator?): string

• Parameters

  • Optional format: "long" | "short"

  • Optional separator: string

  Returns string

up

• up(): Vec3

• Returns a new vector offset from the current vector up by 1 block.

  Returns Vec3

  A new vector offset from the current vector up by 1 block.

west

• west(): Vec3

• Returns a new vector offset from the current vector west by 1 block.

  Returns Vec3

  A new vector offset from the current vector west by 1 block.

Static from

• from(x, y, z): Vec3

• Creates a new vector from the given values.

  Parameters

  • x: number

  • y: number

  • z: number

  Returns Vec3
• from(x): Vec3

• Parameters

  • x: Vec3

  Returns Vec3

• from(x): Vec3

• Parameters

  • x: Vector3

  Returns Vec3

• from(x): Vec3

• Parameters

  • x: Direction

  Returns Vec3

• from(x): Vec3

• Parameters

  • x: number[]

  Returns Vec3

Static fromYawPitch

• fromYawPitch(yaw, pitch): Vec3

• Creates a new direction vector from yaw and pitch values.

  Parameters

  • yaw: number

    The yaw value in degrees.

  • pitch: number

    The pitch value in degrees.

  Returns Vec3

  A new vector representing the direction.