Class Vector2Builder

Vector2 wrapper class which can be used as a Vector2 for APIs on @minecraft/server which require a Vector2.

Implements

Vector2

Index

Constructors

Properties

x y

Methods

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

Constructors

constructor

new Vector2Builder(vecStr: string, delim?: string): Vector2Builder
Parameters
- vecStr: string
- Optionaldelim: string
Returns Vector2Builder
new Vector2Builder(vec: Vector2, arg?: never): Vector2Builder
Parameters
- vec: Vector2
- Optionalarg: never
Returns Vector2Builder
new Vector2Builder(x: number, y: number): Vector2Builder
Parameters
- x: number
- y: number
Returns Vector2Builder

Properties

x

x: number

Remarks

X component of the two-dimensional vector.

y

y: number

Remarks

Y component of the two-dimensional vector.

Methods

add

add(v: Partial<Vector2>): this
add

Adds the vector v to this, returning itself.
Parameters
- v: Partial<Vector2>
Returns this

assign

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

clamp

clamp(limits: { max?: Partial<Vector2>; min?: Partial<Vector2> }): this
clamp

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

distance

distance(vec: Vector2): number
distance

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

dot

dot(vec: Vector2): number
dot

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

equals

equals(v: Vector2): boolean
equals

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

floor

floor(): this
floor

Floor the components of a vector to produce a new vector

Returns this

lerp

lerp(vec: Vector2, t: number): this
lerp

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

magnitude

magnitude(): number
magnitude

The magnitude of the vector

Returns number

multiply

multiply(vec: Vector2): this
multiply

Element-wise multiplication of two vectors together. Not to be confused with Vector2Builder.dot product
Parameters
- vec: Vector2
Returns this

normalize

normalize(): this
normalize

Normalizes this vector, returning itself.

Returns this

scale

scale(val: number): this
scale

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

slerp

slerp(vec: Vector2, t: number): this
slerp

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

subtract

subtract(v: Partial<Vector2>): this
subtract

Subtracts the vector v from this, returning itself.
Parameters
- v: Partial<Vector2>
Returns this

toString

toString(options?: { decimals?: number; delimiter?: string }): string
Returns a string representation of an object.
Parameters
- Optionaloptions: { decimals?: number; delimiter?: string }
Returns string