Class Vec3

Implements

Vector3

Index

Constructors

constructor

new Vec3(x: number, y: number, z: number): Vec3
Parameters
- x: number
- y: number
- z: number
Returns Vec3
- Defined in index.d.ts:16
new Vec3(x: Vec3): Vec3
Parameters
- x: Vec3
Returns Vec3
- Defined in index.d.ts:17
new Vec3(x: Vector3): Vec3
Parameters
- x: Vector3
Returns Vec3
- Defined in index.d.ts:18
new Vec3(x: Direction): Vec3
Parameters
- x: Direction
Returns Vec3
- Defined in index.d.ts:19
new Vec3(x: number[]): Vec3
Parameters
- x: number[]
Returns Vec3
- Defined in index.d.ts:20

Properties

`Readonly`x

x: number

Remarks

X component of this vector.

`Readonly`y

y: number

Remarks

Y component of this vector.

`Readonly`z

z: number

Remarks

Z component of this vector.

`Static` `Readonly`Down

Down: Vec3

`Static` `Readonly`East

East: Vec3

`Static` `Readonly`North

North: Vec3

`Static` `Readonly`South

South: Vec3

`Static` `Readonly`Up

Up: Vec3

`Static` `Readonly`West

West: Vec3

`Static` `Readonly`Zero

Zero: Vec3

Methods

add

add(x: number, y: number, z: number): Vec3
Adds three numbers to the current vector.
Parameters
- x: number
  The x component to be added.
- y: number
  The y component to be added.
- z: number
  The z component to be added.
Returns Vec3
The updated vector after addition.
- Defined in index.d.ts:65
add(x: Vec3): Vec3
Adds another Vec3 to the current vector.
Parameters
- x: Vec3
  The Vec3 to be added.
Returns Vec3
The updated vector after addition.
- Defined in index.d.ts:72
add(x: Vector3): Vec3
Adds another Vector3 to the current vector.
Parameters
- x: Vector3
  The Vector3 to be added.
Returns Vec3
The updated vector after addition.
- Defined in index.d.ts:79
add(x: Direction): Vec3
Adds a Direction to the current vector.
Parameters
- x: Direction
  The Direction to be added.
Returns Vec3
The updated vector after addition.
- Defined in index.d.ts:86
add(x: number[]): Vec3
Adds an array of numbers to the current vector.
Parameters
- x: number[]
  The array of numbers to be added.
Returns Vec3
The updated vector after addition.
- Defined in index.d.ts:93

almostEqual

almostEqual(x: number, y: number, z: number, delta: number): boolean
Checks if the current vector is almost equal to another vector defined by three numbers, within a given tolerance (delta).
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
- delta: number
  The maximum allowed difference between corresponding components.
Returns boolean
True if the vectors are almost equal; otherwise, false.
- Defined in index.d.ts:720
almostEqual(x: Vec3, delta: number): boolean
Checks if the current vector is almost equal to another Vec3 within a given tolerance (delta).
Parameters
- x: Vec3
  The Vec3 to compare.
- delta: number
  The maximum allowed difference between corresponding components.
Returns boolean
True if the vectors are almost equal; otherwise, false.
- Defined in index.d.ts:728
almostEqual(x: Vector3, delta: number): boolean
Checks if the current vector is almost equal to another Vector3 within a given tolerance (delta).
Parameters
- x: Vector3
  The Vector3 to compare.
- delta: number
  The maximum allowed difference between corresponding components.
Returns boolean
True if the vectors are almost equal; otherwise, false.
- Defined in index.d.ts:736
almostEqual(x: Direction, delta: number): boolean
Checks if the current vector is almost equal to a Direction within a given tolerance (delta).
Parameters
- x: Direction
  The Direction to compare.
- delta: number
  The maximum allowed difference between corresponding components.
Returns boolean
True if the vectors are almost equal; otherwise, false.
- Defined in index.d.ts:744
almostEqual(x: number[], delta: number): boolean
Checks if the current vector is almost equal to a vector represented by an array of numbers, within a given tolerance (delta).
Parameters
- x: number[]
  The array of numbers representing the vector.
- delta: number
  The maximum allowed difference between corresponding components.
Returns boolean
True if the vectors are almost equal; otherwise, false.
- Defined in index.d.ts:753

angleBetween

angleBetween(x: number, y: number, z: number): number
Computes the angle (in radians) between the current vector and a vector specified by three numbers.
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
Returns number
The angle in radians between the two vectors.
- Defined in index.d.ts:435
angleBetween(x: Vec3): number
Computes the angle (in radians) between the current vector and another Vec3.
Parameters
- x: Vec3
  The Vec3 to compute the angle with.
Returns number
The angle in radians between the two vectors.
- Defined in index.d.ts:442
angleBetween(x: Vector3): number
Computes the angle (in radians) between the current vector and another Vector3.
Parameters
- x: Vector3
  The Vector3 to compute the angle with.
Returns number
The angle in radians between the two vectors.
- Defined in index.d.ts:449
angleBetween(x: Direction): number
Computes the angle (in radians) between the current vector and a Direction.
Parameters
- x: Direction
  The Direction to compute the angle with.
Returns number
The angle in radians between the two vectors.
- Defined in index.d.ts:456
angleBetween(x: number[]): number
Computes the angle (in radians) between the current vector and a vector represented by an array of numbers.
Parameters
- x: number[]
  The array of numbers representing the other vector.
Returns number
The angle in radians between the two vectors.
- Defined in index.d.ts:463

ceil

ceil(): Vec3
Ceils the X, Y, and Z components of the vector.

Returns Vec3
A new vector with the ceiled components.
- Defined in index.d.ts:625

ceilX

ceilX(): Vec3
Ceils the X component of the vector.

Returns Vec3
A new vector with the ceiled X component.
- Defined in index.d.ts:630

ceilY

ceilY(): Vec3
Ceils the Y component of the vector.

Returns Vec3
A new vector with the ceiled Y component.
- Defined in index.d.ts:635

ceilZ

ceilZ(): Vec3
Ceils the Z component of the vector.

Returns Vec3
A new vector with the ceiled Z component.
- Defined in index.d.ts:640

copy

copy(): Vec3
Creates a copy of the current vector.

Returns Vec3
A new vector with the same values as the current vector.
- Defined in index.d.ts:35

cross

cross(x: number, y: number, z: number): Vec3
Computes the cross product of the current vector with three numbers.

A cross product is a vector that is perpendicular to both vectors.
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
Returns Vec3
A new vector representing the cross product.
- Defined in index.d.ts:256
cross(x: Vec3): Vec3
Computes the cross product of the current vector with another Vec3.

A cross product is a vector that is perpendicular to both vectors.
Parameters
- x: Vec3
  The Vec3 to be crossed.
Returns Vec3
A new vector representing the cross product.
- Defined in index.d.ts:265
cross(x: Vector3): Vec3
Computes the cross product of the current vector with another Vector3.

A cross product is a vector that is perpendicular to both vectors.
Parameters
- x: Vector3
  The Vector3 to be crossed.
Returns Vec3
A new vector representing the cross product.
- Defined in index.d.ts:274
cross(x: Direction): Vec3
Computes the cross product of the current vector with a Direction.

A cross product is a vector that is perpendicular to both vectors.
Parameters
- x: Direction
  The Direction to be crossed.
Returns Vec3
A new vector representing the cross product.
- Defined in index.d.ts:283
cross(x: number[]): Vec3
Computes the cross product of the current vector with an array of numbers.

A cross product is a vector that is perpendicular to both vectors.
Parameters
- x: number[]
  The array of numbers representing a vector.
Returns Vec3
A new vector representing the cross product.
- Defined in index.d.ts:292

distance

distance(x: number, y: number, z: number): number
Computes the distance between the current vector and a vector represented by three numbers.
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
Returns number
The distance between the two vectors.
- Defined in index.d.ts:301
distance(x: Vec3): number
Computes the distance between the current vector and another Vec3.
Parameters
- x: Vec3
  The Vec3 to measure the distance to.
Returns number
The distance between the two vectors.
- Defined in index.d.ts:308
distance(x: Vector3): number
Computes the distance between the current vector and another Vector3.
Parameters
- x: Vector3
  The Vector3 to measure the distance to.
Returns number
The distance between the two vectors.
- Defined in index.d.ts:315
distance(x: Direction): number
Computes the distance between the current vector and a Direction.
Parameters
- x: Direction
  The Direction to measure the distance to.
Returns number
The distance between the two vectors.
- Defined in index.d.ts:322
distance(x: number[]): number
Computes the distance between the current vector and a vector represented by an array of numbers.
Parameters
- x: number[]
  The array of numbers representing the other vector.
Returns number
The distance between the two vectors.
- Defined in index.d.ts:329

distanceSquared

distanceSquared(x: number, y: number, z: number): number
Computes the squared distance between the current vector and a vector represented by three numbers. This is faster than computing the actual distance and can be useful for comparison purposes.
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
Returns number
The squared distance between the two vectors.
- Defined in index.d.ts:339
distanceSquared(x: Vec3): number
Computes the squared distance between the current vector and another Vec3. This is faster than computing the actual distance and can be useful for comparison purposes.
Parameters
- x: Vec3
  The Vec3 to measure the squared distance to.
Returns number
The squared distance between the two vectors.
- Defined in index.d.ts:347
distanceSquared(x: Vector3): number
Computes the squared distance between the current vector and another Vector3. This is faster than computing the actual distance and can be useful for comparison purposes.
Parameters
- x: Vector3
  The Vector3 to measure the squared distance to.
Returns number
The squared distance between the two vectors.
- Defined in index.d.ts:355
distanceSquared(x: Direction): number
Computes the squared distance between the current vector and a Direction. This is faster than computing the actual distance and can be useful for comparison purposes.
Parameters
- x: Direction
  The Direction to measure the squared distance to.
Returns number
The squared distance between the two vectors.
- Defined in index.d.ts:363
distanceSquared(x: number[]): number
Computes the squared distance between the current vector and a vector represented by an array of numbers. This is faster than computing the actual distance and can be useful for comparison purposes.
Parameters
- x: number[]
  The array of numbers representing the other vector.
Returns number
The squared distance between the two vectors.
- Defined in index.d.ts:371

distanceToLineSegment

distanceToLineSegment(start: Vector3, end: Vector3): 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.
- Defined in index.d.ts:600

divide

divide(x: number, y: number, z: number): Vec3
Divides the current vector by three numbers.
Parameters
- x: number
  The divisor for the x component.
- y: number
  The divisor for the y component.
- z: number
  The divisor for the z component.
Returns Vec3
The updated vector after division.
- Defined in index.d.ts:190
divide(x: Vec3): Vec3
Divides the current vector by another Vec3.
Parameters
- x: Vec3
  The Vec3 divisor.
Returns Vec3
The updated vector after division.
- Defined in index.d.ts:197
divide(x: Vector3): Vec3
Divides the current vector by another Vector3.
Parameters
- x: Vector3
  The Vector3 divisor.
Returns Vec3
The updated vector after division.
- Defined in index.d.ts:204
divide(x: Direction): Vec3
Divides the current vector by a Direction.
Parameters
- x: Direction
  The Direction divisor.
Returns Vec3
The updated vector after division.
- Defined in index.d.ts:211
divide(x: number[]): Vec3
Divides the current vector by an array of numbers.
Parameters
- x: number[]
  The array divisor.
Returns Vec3
The updated vector after division.
- Defined in index.d.ts:218
divide(x: number): Vec3
Divides the current vector by a scalar.
Parameters
- x: number
  The scalar divisor.
Returns Vec3
The updated vector after division.
- Defined in index.d.ts:225

dot

dot(x: number, y: number, z: number): number
Computes the dot product of the current vector with a vector specified by three numbers.
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
Returns number
The dot product of the two vectors.
- Defined in index.d.ts:398
dot(x: Vec3): number
Computes the dot product of the current vector with another Vec3.
Parameters
- x: Vec3
  The Vec3 to compute the dot product with.
Returns number
The dot product of the two vectors.
- Defined in index.d.ts:405
dot(x: Vector3): number
Computes the dot product of the current vector with another Vector3.
Parameters
- x: Vector3
  The Vector3 to compute the dot product with.
Returns number
The dot product of the two vectors.
- Defined in index.d.ts:412
dot(x: Direction): number
Computes the dot product of the current vector with a Direction.
Parameters
- x: Direction
  The Direction to compute the dot product with.
Returns number
The dot product of the two vectors.
- Defined in index.d.ts:419
dot(x: number[]): number
Computes the dot product of the current vector with a vector represented by an array of numbers.
Parameters
- x: number[]
  The array of numbers representing the other vector.
Returns number
The dot product of the two vectors.
- Defined in index.d.ts:426

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.
- Defined in index.d.ts:670

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.
- Defined in index.d.ts:685

equals

equals(x: number, y: number, z: number): boolean
Checks if the current vector is exactly equal to another vector defined by three numbers.
Parameters
- x: number
  The x component of the other vector.
- y: number
  The y component of the other vector.
- z: number
  The z component of the other vector.
Returns boolean
True if the vectors are exactly equal; otherwise, false.
- Defined in index.d.ts:762
equals(x: Vec3): boolean
Checks if the current vector is exactly equal to another Vec3.
Parameters
- x: Vec3
  The Vec3 to compare.
Returns boolean
True if the vectors are exactly equal; otherwise, false.
- Defined in index.d.ts:769
equals(x: Vector3): boolean
Checks if the current vector is exactly equal to another Vector3.
Parameters
- x: Vector3
  The Vector3 to compare.
Returns boolean
True if the vectors are exactly equal; otherwise, false.
- Defined in index.d.ts:776
equals(x: Direction): boolean
Checks if the current vector is exactly equal to a Direction.
Parameters
- x: Direction
  The Direction to compare.
Returns boolean
True if the vectors are exactly equal; otherwise, false.
- Defined in index.d.ts:783
equals(x: number[]): boolean
Checks if the current vector is exactly equal to a vector represented by an array of numbers.
Parameters
- x: number[]
  The array of numbers representing the vector.
Returns boolean
True if the vectors are exactly equal; otherwise, false.
- Defined in index.d.ts:790

floor

floor(): Vec3
Floors the X, Y, and Z components of the vector.

Returns Vec3
A new vector with the floored components.
- Defined in index.d.ts:605

floorX

floorX(): Vec3
Floors the X component of the vector.

Returns Vec3
A new vector with the floored X component.
- Defined in index.d.ts:610

floorY

floorY(): Vec3
Floors the Y component of the vector.

Returns Vec3
A new vector with the floored Y component.
- Defined in index.d.ts:615

floorZ

floorZ(): Vec3
Floors the Z component of the vector.

Returns Vec3
A new vector with the floored Z component.
- Defined in index.d.ts:620

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.
- Defined in index.d.ts:695

length

length(): number
Computes the length (magnitude) of the vector.

Returns number
The length of the vector.
- Defined in index.d.ts:238

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.
- Defined in index.d.ts:245

lerp

lerp(v: Vector3, t: number): 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.
- Defined in index.d.ts:380

multiply

multiply(x: number, y: number, z: number): Vec3
Multiplies the current vector by three numbers.
Parameters
- x: number
  The multiplier for the x component.
- y: number
  The multiplier for the y component.
- z: number
  The multiplier for the z component.
Returns Vec3
The updated vector after multiplication.
- Defined in index.d.ts:139
multiply(x: Vec3): Vec3
Multiplies the current vector by another Vec3.
Parameters
- x: Vec3
  The Vec3 multiplier.
Returns Vec3
The updated vector after multiplication.
- Defined in index.d.ts:146
multiply(x: Vector3): Vec3
Multiplies the current vector by another Vector3.
Parameters
- x: Vector3
  The Vector3 multiplier.
Returns Vec3
The updated vector after multiplication.
- Defined in index.d.ts:153
multiply(x: Direction): Vec3
Multiplies the current vector by a Direction.
Parameters
- x: Direction
  The Direction multiplier.
Returns Vec3
The updated vector after multiplication.
- Defined in index.d.ts:160
multiply(x: number[]): Vec3
Multiplies the current vector by an array of numbers.
Parameters
- x: number[]
  The array multiplier.
Returns Vec3
The updated vector after multiplication.
- Defined in index.d.ts:167
multiply(x: number): Vec3
Multiplies the current vector by a scalar.
Parameters
- x: number
  The scalar multiplier.
Returns Vec3
The updated vector after multiplication.
- Defined in index.d.ts:174

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.
- Defined in index.d.ts:232

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.
- Defined in index.d.ts:675

projectOnto

projectOnto(x: number, y: number, z: number): Vec3
Computes the projection of the current vector onto a vector specified by three numbers. This method finds how much of the current vector lies in the direction of the given vector.
Parameters
- x: number
  The x component of the vector to project onto.
- y: number
  The y component of the vector to project onto.
- z: number
  The z component of the vector to project onto.
Returns Vec3
A new vector representing the projection of the current vector.
- Defined in index.d.ts:473
projectOnto(x: Vec3): Vec3
Computes the projection of the current vector onto another Vec3. This method finds how much of the current vector lies in the direction of the given vector.
Parameters
- x: Vec3
  The Vec3 to project onto.
Returns Vec3
A new vector representing the projection of the current vector.
- Defined in index.d.ts:481
projectOnto(x: Vector3): Vec3
Computes the projection of the current vector onto another Vector3. This method finds how much of the current vector lies in the direction of the given vector.
Parameters
- x: Vector3
  The Vector3 to project onto.
Returns Vec3
A new vector representing the projection of the current vector.
- Defined in index.d.ts:489
projectOnto(x: Direction): Vec3
Computes the projection of the current vector onto a Direction. This method finds how much of the current vector lies in the direction of the given vector.
Parameters
- x: Direction
  The Direction to project onto.
Returns Vec3
A new vector representing the projection of the current vector.
- Defined in index.d.ts:497
projectOnto(x: number[]): Vec3
Computes the projection of the current vector onto a vector represented by an array of numbers. This method finds how much of the current vector lies in the direction of the given vector.
Parameters
- x: number[]
  The array of numbers representing the vector to project onto.
Returns Vec3
A new vector representing the projection of the current vector.
- Defined in index.d.ts:505

reflect

reflect(x: number, y: number, z: number): Vec3
Computes the reflection of the current vector against a normal vector specified by three numbers. Useful for simulating light reflections or bouncing objects.
Parameters
- x: number
  The x component of the normal vector.
- y: number
  The y component of the normal vector.
- z: number
  The z component of the normal vector.
Returns Vec3
A new vector representing the reflection of the current vector.
- Defined in index.d.ts:515
reflect(x: Vec3): Vec3
Computes the reflection of the current vector against another Vec3 normal vector. Useful for simulating light reflections or bouncing objects.
Parameters
- x: Vec3
  The Vec3 representing the normal vector.
Returns Vec3
A new vector representing the reflection of the current vector.
- Defined in index.d.ts:523
reflect(x: Vector3): Vec3
Computes the reflection of the current vector against another Vector3 normal vector. Useful for simulating light reflections or bouncing objects.
Parameters
- x: Vector3
  The Vector3 representing the normal vector.
Returns Vec3
A new vector representing the reflection of the current vector.
- Defined in index.d.ts:531
reflect(x: Direction): Vec3
Computes the reflection of the current vector against a Direction normal vector. Useful for simulating light reflections or bouncing objects.
Parameters
- x: Direction
  The Direction representing the normal vector.
Returns Vec3
A new vector representing the reflection of the current vector.
- Defined in index.d.ts:539
reflect(x: number[]): Vec3
Computes the reflection of the current vector against a normal vector represented by an array of numbers. Useful for simulating light reflections or bouncing objects.
Parameters
- x: number[]
  The array of numbers representing the normal vector.
Returns Vec3
A new vector representing the reflection of the current vector.
- Defined in index.d.ts:547

rotate

rotate(axis: Vector3, angle: number): 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.
- Defined in index.d.ts:555

round

round(): Vec3
Rounds the X, Y, and Z components of the vector.

Returns Vec3
A new vector with the rounded components.
- Defined in index.d.ts:645

roundX

roundX(): Vec3
Rounds the X component of the vector.

Returns Vec3
A new vector with the rounded X component.
- Defined in index.d.ts:650

roundY

roundY(): Vec3
Rounds the Y component of the vector.

Returns Vec3
A new vector with the rounded Y component.
- Defined in index.d.ts:655

roundZ

roundZ(): Vec3
Rounds the Z component of the vector.

Returns Vec3
A new vector with the rounded Z component.
- Defined in index.d.ts:660

scale

scale(scalar: number): Vec3
Scales the current vector by a scalar.
Parameters
- scalar: number
  The scalar to scale the vector by.
Returns Vec3
The updated vector after scaling.
- Defined in index.d.ts:181

setX

setX(value: number): 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.
- Defined in index.d.ts:571
setX(value: (x: number) => number): Vec3
Sets the X component of the vector.
Parameters
- value: (x: number) => number
  The new X value.
Returns Vec3
The updated vector with the new X value.
- Defined in index.d.ts:572

setY

setY(value: number): 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.
- Defined in index.d.ts:579
setY(value: (y: number) => number): Vec3
Sets the Y component of the vector.
Parameters
- value: (y: number) => number
  The new Y value.
Returns Vec3
The updated vector with the new Y value.
- Defined in index.d.ts:580

setZ

setZ(value: number): 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.
- Defined in index.d.ts:587
setZ(value: (z: number) => number): Vec3
Sets the Z component of the vector.
Parameters
- value: (z: number) => number
  The new Z value.
Returns Vec3
The updated vector with the new Z value.
- Defined in index.d.ts:588

slerp

slerp(v: Vector3, t: number): 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.
- Defined in index.d.ts:389

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.
- Defined in index.d.ts:680

subtract

subtract(x: number, y: number, z: number): Vec3
Subtracts three numbers from the current vector.
Parameters
- x: number
  The x component to be subtracted.
- y: number
  The y component to be subtracted.
- z: number
  The z component to be subtracted.
Returns Vec3
The updated vector after subtraction.
- Defined in index.d.ts:102
subtract(x: Vec3): Vec3
Subtracts another Vec3 from the current vector.
Parameters
- x: Vec3
  The Vec3 to be subtracted.
Returns Vec3
The updated vector after subtraction.
- Defined in index.d.ts:109
subtract(x: Vector3): Vec3
Subtracts another Vector3 from the current vector.
Parameters
- x: Vector3
  The Vector3 to be subtracted.
Returns Vec3
The updated vector after subtraction.
- Defined in index.d.ts:116
subtract(x: Direction): Vec3
Subtracts a Direction from the current vector.
Parameters
- x: Direction
  The Direction to be subtracted.
Returns Vec3
The updated vector after subtraction.
- Defined in index.d.ts:123
subtract(x: number[]): Vec3
Subtracts an array of numbers from the current vector.
Parameters
- x: number[]
  The array of numbers to be subtracted.
Returns Vec3
The updated vector after subtraction.
- Defined in index.d.ts:130

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.
- Defined in index.d.ts:700

toBlockLocation

toBlockLocation(): Vec3
Returns a new vector with the X, Y, and Z components rounded to the nearest block location.

Returns Vec3
- Defined in index.d.ts:709

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
- Defined in index.d.ts:705

toString

toString(format?: "long" | "short", separator?: string): string
Converts the vector to a string representation.
Parameters
- Optionalformat: "long" | "short"
  The format of the string representation. Defaults to "long".
- Optionalseparator: string
  The separator to use between components. Defaults to ", ".
Returns string
The string representation of the vector.

Remarks
The "long" format is "Vec3(x, y, z)". The "short" format is "x, y, z".
- Defined in index.d.ts:801

toYawPitch

toYawPitch(): Vector2
Converts the normal vector to yaw and pitch values.

Returns Vector2
A Vector2 containing the yaw and pitch values.
- Defined in index.d.ts:56

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.
- Defined in index.d.ts:665

update

update(
    x: undefined | ((x: number) => number),
    y: undefined | ((y: number) => number),
    z: undefined | ((z: number) => number),
): Vec3
Updates the X, Y, and Z components of the vector.
Parameters
- x: undefined | ((x: number) => number)
  The function to use to update the X value.
- y: undefined | ((y: number) => number)
  The function to use to update the Y value.
- z: undefined | ((z: number) => number)
  The function to use to update the Z value.
Returns Vec3
The updated vector with the new values.
- Defined in index.d.ts:564

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.
- Defined in index.d.ts:690

`Static`from

from(x: number, y: number, z: number): Vec3
Creates a new vector from the given values.
Parameters
- x: number
- y: number
- z: number
Returns Vec3
- Defined in index.d.ts:24
from(x: Vec3): Vec3
Creates a new vector from the given values.
Parameters
- x: Vec3
Returns Vec3
- Defined in index.d.ts:25
from(x: Vector3): Vec3
Creates a new vector from the given values.
Parameters
- x: Vector3
Returns Vec3
- Defined in index.d.ts:26
from(x: Direction): Vec3
Creates a new vector from the given values.
Parameters
- x: Direction
Returns Vec3
- Defined in index.d.ts:27
from(x: number[]): Vec3
Creates a new vector from the given values.
Parameters
- x: number[]
Returns Vec3
- Defined in index.d.ts:28

`Static`fromYawPitch

fromYawPitch(rotation: Vector2): Vec3
Creates a new direction vector from yaw and pitch values.
Parameters
- rotation: Vector2
  The yaw and pitch values in degrees.
Returns Vec3
A new vector representing the direction.
- Defined in index.d.ts:42
fromYawPitch(yaw: number, pitch: number): 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.
- Defined in index.d.ts:50

Class Vec3

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vec3

Parameters

Returns Vec3

Parameters

Returns Vec3

Parameters

Returns Vec3

Parameters

Returns Vec3

Properties

Readonlyx

Remarks

Readonlyy

Remarks

Readonlyz

Remarks

Static ReadonlyDown

Static ReadonlyEast

Static ReadonlyNorth

Static ReadonlySouth

Static ReadonlyUp

Static ReadonlyWest

Static ReadonlyZero

Methods

add

Parameters

Returns Vec3

Parameters

Returns Vec3

Parameters

Returns Vec3

Parameters

Returns Vec3

Parameters

Returns Vec3

almostEqual

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

angleBetween

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

ceil

Returns Vec3

ceilX

Returns Vec3

ceilY

Returns Vec3

ceilZ

Returns Vec3

copy

Returns Vec3

cross

Parameters

Returns Vec3

Parameters

`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