Class Vector3Builder

Vector3 wrapper class which can be used as a Vector3 for APIs on @minecraft/server which require a Vector, but also contain additional helper methods. This is an alternative to using the core Vector 3 utility methods directly, for those who prefer a more object-oriented approach. This version of the class is mutable and changes state inline.

For an immutable version of the build, use ImmutableVector3Builder.

Hierarchy

Vector3Builder

Implements

Vector3

Index

Constructors

Properties

x y z

Methods

add assign clamp cross distance dot equals floor lerp magnitude normalize scale slerp subtract toString

Constructors

constructor

new Vector3Builder(vec, arg?, arg2?): Vector3Builder
Parameters
- vec: Vector3
- Optional arg: never
  Optional
- Optional arg2: never
  Optional
Returns Vector3Builder
new Vector3Builder(x, y, z): Vector3Builder
Parameters
- x: number
- y: number
- z: number
Returns Vector3Builder

Properties

x

x: number

Remarks

X component of this vector.

y

y: number

Remarks

Y component of this vector.

z

z: number

Remarks

Z component of this vector.

Methods

add

add(v): Vector3Builder
add

Adds the vector v to this, returning itself.
Parameters
- v: Vector3
Returns Vector3Builder

assign

assign(vec): Vector3Builder
Assigns the values of the passed in vector to this vector. Returns itself.
Parameters
- vec: Vector3
Returns Vector3Builder

clamp

clamp(limits): Vector3Builder
clamp

Clamps the components of a vector to limits to produce a new vector
Parameters
- limits: {
  max?: Partial<Vector3>;
  min?: Partial<Vector3>;
  }
  - Optional max?: Partial<Vector3>
  - Optional min?: Partial<Vector3>
Returns Vector3Builder

cross

cross(vec): Vector3Builder
cross

Computes the cross product of this and the passed in vector, returning itself.
Parameters
- vec: Vector3
Returns Vector3Builder

distance

distance(vec): number
distance

Calculate the distance between two vectors
Parameters
- vec: Vector3
Returns number

dot

dot(vec): number
dot

Computes the dot product of this and the passed in vector.
Parameters
- vec: Vector3
Returns number

equals

equals(v): boolean
equals

Check the equality of two vectors
Parameters
- v: Vector3
Returns boolean

floor

floor(): Vector3Builder
floor

Floor the components of a vector to produce a new vector

Returns Vector3Builder

lerp

lerp(vec, t): Vector3Builder
lerp

Constructs a new vector using linear interpolation on each component from two vectors.
Parameters
- vec: Vector3
- t: number
Returns Vector3Builder

magnitude

magnitude(): number
magnitude

The magnitude of the vector

Returns number

normalize

normalize(): Vector3Builder
normalize

Normalizes this vector, returning itself.

Returns Vector3Builder

scale

scale(val): Vector3Builder
scale

Scales this by the passed in value, returning itself.
Parameters
- val: number
Returns Vector3Builder

slerp

slerp(vec, t): Vector3Builder
slerp

Constructs a new vector using spherical linear interpolation on each component from two vectors.
Parameters
- vec: Vector3
- t: number
Returns Vector3Builder

subtract

subtract(v): Vector3Builder
subtract

Subtracts the vector v from this, returning itself.
Parameters
- v: Vector3
Returns Vector3Builder

toString

toString(options?): string
toString

Create a string representation of a vector
Parameters
- Optional options: {
  decimals?: number;
  delimiter?: string;
  }
  Optional
  - Optional decimals?: number
  - Optional delimiter?: string
Returns string