Class Vector3i

A 3D vector with floating point precision.

Hierarchy (View Summary)

Vector3f
- Vector3i

Index

Constructors

Properties

x y z

Methods

absolute add ceil clone cross distance distanceManhattan divide dot equals floor isZero length lengthSqrt lerp multiply normalize round set slerp subtract fromArray read write

Constructors

constructor

new Vector3i(x: number, y: number, z: number): Vector3i
Creates a new 3D vector.
Parameters
- x: number
  The x coordinate of the vector.
- y: number
  The y coordinate of the vector.
- z: number
  The z coordinate of the vector.
Returns Vector3i
Inherited from Vector3f.constructor
- Defined in packages/protocol/src/proto/types/vector3f.ts:34

Properties

x

x: number

The x coordinate of the vector.

y

y: number

The y coordinate of the vector.

z

z: number

The z coordinate of the vector.

Methods

absolute

absolute(): Vector3f
Computes the absolute value of each coordinate of the 3D vector.

Returns Vector3f
the absolute value of this 3D vector.
Inherited from Vector3f.absolute
- Defined in packages/protocol/src/proto/types/vector3f.ts:237

add

add(other: IPosition): Vector3f
Adds another 3D vector to this 3D vector.
Parameters
- other: IPosition
  The other 3D vector to add.
Returns Vector3f
The result of the addition.
Inherited from Vector3f.add
- Defined in packages/protocol/src/proto/types/vector3f.ts:92

ceil

ceil(): Vector3f
Ceils the coordinates of the 3D vector.

Returns Vector3f
The 3D vector with the coordinates ceiled.
Inherited from Vector3f.ceil
- Defined in packages/protocol/src/proto/types/vector3f.ts:67

clone

clone(): Vector3f
Clones this 3D vector into a new 3D vector.

Returns Vector3f
The cloned 3D vector.
Inherited from Vector3f.clone
- Defined in packages/protocol/src/proto/types/vector3f.ts:257

cross

cross(other: IPosition): Vector3f
Calculates the cross product between this 3D vector and another 3D vector.
Parameters
- other: IPosition
  The other 3D vector to calculate the cross product with.
Returns Vector3f
The result of the cross product.
Inherited from Vector3f.cross
- Defined in packages/protocol/src/proto/types/vector3f.ts:137

distance

distance(other: IPosition): number
Gets the distance between this 3D vector and another 3D vector.
Parameters
- other: IPosition
  The other 3D vector to get the distance to.
Returns number
The distance between the 3D vectors.
Inherited from Vector3f.distance
- Defined in packages/protocol/src/proto/types/vector3f.ts:214

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.
Inherited from Vector3f.distanceManhattan
- Defined in packages/protocol/src/proto/types/vector3f.ts:225

divide

divide(scalar: number): Vector3f
Divides this 3D vector with a scalar.
Parameters
- scalar: number
  The scalar to divide with.
Returns Vector3f
The result of the division.
Inherited from Vector3f.divide
- Defined in packages/protocol/src/proto/types/vector3f.ts:119

dot

dot(other: IPosition): number
Calculates the dot product between this 3D vector and another 3D vector.
Parameters
- other: IPosition
  The other 3D vector to calculate the dot product with.
Returns number
The result of the dot product.
Inherited from Vector3f.dot
- Defined in packages/protocol/src/proto/types/vector3f.ts:128

equals

equals(other: IPosition): boolean
Returns a string representation of this 3D vector.
Parameters
- other: IPosition
Returns boolean
The string representation of this 3D vector.
Inherited from Vector3f.equals
- Defined in packages/protocol/src/proto/types/vector3f.ts:205

floor

floor(): Vector3f
Floors the coordinates of the 3D vector.

Returns Vector3f
The 3D vector with the coordinates floored.
Inherited from Vector3f.floor
- Defined in packages/protocol/src/proto/types/vector3f.ts:79

isZero

isZero(): boolean
Checks if the 3D vector is zero.

Returns boolean
true if the 3D vector is zero, false otherwise.
Inherited from Vector3f.isZero
- Defined in packages/protocol/src/proto/types/vector3f.ts:245

length

length(): number
Calculates the length of this 3D vector.

Returns number
The length of the 3D vector.
Inherited from Vector3f.length
- Defined in packages/protocol/src/proto/types/vector3f.ts:149

lengthSqrt

lengthSqrt(): number
Calculates the square length of this 3D vector.

Returns number
the square length of the 3D vector.
Inherited from Vector3f.lengthSqrt
- Defined in packages/protocol/src/proto/types/vector3f.ts:157

lerp

lerp(other: IPosition, t: number): Vector3f
Linearly interpolates between this 3D vector and another 3D vector.
Parameters
- other: IPosition
  The other 3D vector to interpolate with.
- t: number
  The interpolation factor.
Returns Vector3f
The interpolated 3D vector.
Inherited from Vector3f.lerp
- Defined in packages/protocol/src/proto/types/vector3f.ts:176

multiply

multiply(scalar: number): Vector3f
Multiplies this 3D vector with a scalar.
Parameters
- scalar: number
  The scalar to multiply with.
Returns Vector3f
The result of the multiplication.
Inherited from Vector3f.multiply
- Defined in packages/protocol/src/proto/types/vector3f.ts:110

normalize

normalize(): Vector3f
Normalizes this 3D vector.

Returns Vector3f
The normalized 3D vector.
Inherited from Vector3f.normalize
- Defined in packages/protocol/src/proto/types/vector3f.ts:165

round

round(): Vector3f
Rounds the coordinates of the 3D vector to the nearest whole number.

Returns Vector3f
Inherited from Vector3f.round
- Defined in packages/protocol/src/proto/types/vector3f.ts:55

set

set(other: IPosition): void
Sets the coordinates of the 3D vector.
Parameters
- other: IPosition
  The other 3D vector to set the coordinates to.
Returns void
Inherited from Vector3f.set
- Defined in packages/protocol/src/proto/types/vector3f.ts:45

slerp

slerp(other: BlockPosition | Vector3f, t: number): Vector3f
Spherically interpolates between this 3D vector and another 3D vector.
Parameters
- other: BlockPosition | Vector3f
  The other 3D vector to interpolate with.
- t: number
  The interpolation factor.
Returns Vector3f
The interpolated 3D vector.
Inherited from Vector3f.slerp
- Defined in packages/protocol/src/proto/types/vector3f.ts:190

subtract

subtract(other: IPosition): Vector3f
Subtracts another 3D vector from this 3D vector.
Parameters
- other: IPosition
  The other 3D vector to subtract.
Returns Vector3f
The result of the subtraction.
Inherited from Vector3f.subtract
- Defined in packages/protocol/src/proto/types/vector3f.ts:101

`Static`fromArray

fromArray(array: number[] | [number, number, number]): Vector3f
Converts this array to a 3D vector.
Parameters
- array: number[] | [number, number, number]
Returns Vector3f
The 3D vector that was converted.
Inherited from Vector3f.fromArray
- Defined in packages/protocol/src/proto/types/vector3f.ts:265

`Static`read

read(stream: BinaryStream): Vector3i
Reads a 3D vector from the stream.
Parameters
- stream: BinaryStream
  The stream to read from.
Returns Vector3i
The 3D vector that was read.
Overrides Vector3f.read
- Defined in packages/protocol/src/proto/types/vector3i.ts:12

`Static`write

write(stream: BinaryStream, value: Vector3i): void
Writes a 3D vector to the stream.
Parameters
- stream: BinaryStream
  The stream to write to.
- value: Vector3i
  The 3D vector to write.
Returns void
Overrides Vector3f.write
- Defined in packages/protocol/src/proto/types/vector3i.ts:28