Class BlockPosition

constructor

• new BlockPosition(x: number, y: number, z: number): BlockPosition

  Parameters

  • x: number
  • y: number
  • z: number

  Returns BlockPosition

x

y

z

absolute

• absolute(): BlockPosition

  Computes the absolute value of each coordinate of the 3D vector.

  Returns BlockPosition

  Returnsthe

  absolute value of this 3D vector.

add

• add(other: IPosition): BlockPosition

  Adds another 3D position to this 3D position.

  Parameters

  • other: IPosition

    The other 3D position to add.

  Returns BlockPosition

  The result of the addition.

ceil

• ceil(): BlockPosition

  Ceils the coordinates of the 3D position.

  Returns BlockPosition

  The 3D position with the coordinates ceiled.

cross

• cross(other: IPosition): BlockPosition

  Calculates the cross product between this 3D position and another 3D position.

  Parameters

  • other: IPosition

    The other 3D position to calculate the cross product with.

  Returns BlockPosition

  The result of the cross product.

distance

• distance(other: IPosition): number

  Gets the distance between this 3D position and another 3D position.

  Parameters

  • other: IPosition

    The other 3D position to get the distance to.

  Returns number

  The distance between the 3D positions.

distanceManhattan

• distanceManhattan(other: IPosition): number

  Gets the Manhattan distance between this 3D vector and another 3D vector. The Manhattan distance is the sum of the absolute differences of their coordinates.

  Parameters

  • other: IPosition

    The other 3D vector to get the distance to.

  Returns number

  The Manhattan distance between the 3D vectors.

divide

• divide(scalar: number): BlockPosition

  Divides this 3D position with a scalar.

  Parameters

  • scalar: number

    The scalar to divide with.

  Returns BlockPosition

  The result of the division.

dot

• dot(other: IPosition): number

  Calculates the dot product between this 3D position and another 3D position.

  Parameters

  • other: IPosition

    The other 3D position to calculate the dot product with.

  Returns number

  The result of the dot product.

equals

• equals(other: IPosition): boolean

  Returns a string representation of this 3D position.

  Parameters

  • other: IPosition

  Returns boolean

  The string representation of this 3D position.

floor

• floor(): BlockPosition

  Floors the coordinates of the 3D position.

  Returns BlockPosition

  The 3D position with the coordinates floored.

length

• length(): number

  Calculates the length of this 3D position.

  Returns number

  The length of the 3D position.

lengthSqrt

• lengthSqrt(): number

  Calculates the square length of this 3D position.

  Returns number

  the square length of the 3D position.

lerp

• lerp(other: IPosition, t: number): BlockPosition

  Linearly interpolates between this 3D position and another 3D position.

  Parameters

  • other: IPosition

    The other 3D position to interpolate with.
  • t: number

    The interpolation factor.

  Returns BlockPosition

  The interpolated 3D position.

multiply

• multiply(scalar: number): BlockPosition

  Multiplies this 3D position with a scalar.

  Parameters

  • scalar: number

    The scalar to multiply with.

  Returns BlockPosition

  The result of the multiplication.

normalize

• normalize(): BlockPosition

  Normalizes this 3D position.

  Returns BlockPosition

  The normalized 3D position.

round

• round(): BlockPosition

  Rounds the coordinates of the 3D position to the nearest whole number.

  Returns BlockPosition

slerp

• slerp(other: BlockPosition | Vector3f, t: number): BlockPosition

  Spherically interpolates between this 3D position and another 3D position.

  Parameters

  • other: BlockPosition | Vector3f

    The other 3D position to interpolate with.
  • t: number

    The interpolation factor.

  Returns BlockPosition

  The interpolated 3D position.

subtract

• subtract(other: IPosition): BlockPosition

  Subtracts another 3D position from this 3D position.

  Parameters

  • other: IPosition

    The other 3D position to subtract.

  Returns BlockPosition

  The result of the subtraction.

Staticfrom

• from(position: IPosition): BlockPosition

  Gets the block position from a positional object.

  Parameters

  • position: IPosition

    The positional object.

  Returns BlockPosition

  The block position.

StaticfromVector3f

• fromVector3f(position: Vector3f): BlockPosition

  Converts a BlockPosition to a BlockPosition

  Parameters

  • position: Vector3f

    The BlockPosition to convert

  Returns BlockPosition

  The converted BlockPosition

Statichash

• hash(position: BlockPosition): bigint

  Convert the block position to a hash.

  Parameters

  • position: BlockPosition

  Returns bigint

  The hash of the block position.

Staticread

• read(stream: BinaryStream): BlockPosition

  Reads the data type from a binary stream.

  Parameters

  • stream: BinaryStream

  Returns BlockPosition

  The data type.

StatictoVector3f

• toVector3f(coordinates: BlockPosition): Vector3f

  Converts the BlockPosition to a BlockPosition

  Parameters

  • coordinates: BlockPosition

  Returns Vector3f

  The converted BlockPosition

Staticunhash

• unhash(hash: bigint): BlockPosition

  Convert the hash to block position.

  Parameters

  • hash: bigint

    The hash.

  Returns BlockPosition

  The block position.

Staticwrite

• write(stream: BinaryStream, value: BlockPosition): void

  Writes the data type to a binary stream.

  Parameters

  • stream: BinaryStream
  • value: BlockPosition

  Returns void