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

Constructors

constructor

Properties

x y z

Methods

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

Constructors

constructor

  • Parameters

    • vec: Vector3
    • Optional arg: undefined
    • Optional arg2: undefined

    Returns Vector3Builder

  • Parameters

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

    Returns Vector3Builder

Properties

x

x: number

y

y: number

z

z: number

Methods

add

  • add

    Adds the vector v to this, returning itself.

    Parameters

    • v: Vector3

    Returns Vector3Builder

assign

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

    Parameters

    • vec: Vector3

    Returns Vector3Builder

clamp

  • 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

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

    Parameters

    • vec: Vector3

    Returns Vector3Builder

dot

  • dot

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

    Parameters

    • vec: Vector3

    Returns number

equals

  • equals

    Check the equality of two vectors

    Parameters

    • v: Vector3

    Returns boolean

floor

magnitude

  • magnitude

    The magnitude of the vector

    Returns number

normalize

scale

  • scale

    Scales this by the passed in value, returning itself.

    Parameters

    • val: number

    Returns Vector3Builder

subtract

  • subtract

    Subtracts the vector v from this, returning itself.

    Parameters

    • v: Vector3

    Returns Vector3Builder

toString

  • toString

    Create a string representation of a vector

    Parameters

    • Optional options: {
          decimals?: number;
          delimiter?: string;
      }
      • Optional decimals?: number
      • Optional delimiter?: string

    Returns string

Settings

Member Visibility

Theme

On This Page