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.

Implements

Constructors

Properties

x: number

X component of this vector.

y: number

Y component of this vector.

z: number

Z component of this vector.

Methods

  • add

    Adds the vector v to this, returning itself.

    Parameters

    Returns this

  • Assigns the values of the passed in vector to this vector. Returns itself.

    Parameters

    Returns this

  • clamp

    Clamps the components of a vector to limits to produce a new vector

    Parameters

    Returns this

  • cross

    Computes the cross product of this and the passed in vector, returning itself.

    Parameters

    Returns this

  • distance

    Calculate the distance between two vectors

    Parameters

    Returns number

  • dot

    Computes the dot product of this and the passed in vector.

    Parameters

    Returns number

  • equals

    Check the equality of two vectors

    Parameters

    Returns boolean

  • floor

    Floor the components of a vector to produce a new vector

    Returns this

  • lerp

    Constructs a new vector using linear interpolation on each component from two vectors.

    Parameters

    Returns this

  • magnitude

    The magnitude of the vector

    Returns number

  • normalize

    Normalizes this vector, returning itself.

    Returns this

  • scale

    Scales this by the passed in value, returning itself.

    Parameters

    • val: number

    Returns this

  • slerp

    Constructs a new vector using spherical linear interpolation on each component from two vectors.

    Parameters

    Returns this

  • subtract

    Subtracts the vector v from this, returning itself.

    Parameters

    Returns this

  • toString

    Create a string representation of a vector

    Parameters

    • Optionaloptions: { decimals?: number; delimiter?: string }

    Returns string