Class Vector

Utilities operating on Vector3 objects.

This is a mixture of the Vector3Builder and Vector3Utils classes.

Hierarchy (View Summary)

Vector3Builder
- Vector

Implements

Vector3Utils

Index

Constructors

constructor

Properties

Methods

add assign clamp cross distance dot equals floor lerp magnitude multiply normalize rotateX rotateY rotateZ scale slerp subtract toString

Constructors

constructor

new Vector(vecStr: string, delim?: string, arg2?: undefined): Globals.Vector
Parameters
- vecStr: string
- Optionaldelim: string
- Optionalarg2: undefined
Returns Globals.Vector
Inherited from Vector3Builder.constructor
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/math.js/lib/types/math-public.d.ts:206
new Vector(vec: Vector3, arg?: undefined, arg2?: undefined): Globals.Vector
Parameters
- vec: Vector3
- Optionalarg: undefined
- Optionalarg2: undefined
Returns Globals.Vector
Inherited from Vector3Builder.constructor
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/math.js/lib/types/math-public.d.ts:207
new Vector(x: number, y: number, z: number): Globals.Vector
Parameters
- x: number
- y: number
- z: number
Returns Globals.Vector
Inherited from Vector3Builder.constructor
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/math.js/lib/types/math-public.d.ts:208

Properties

back

back: { x: 0; y: 0; z: -1 } & Vector3 = ...

back

A unit vector representing the world BACK direction (0,0,-1)

down

down: { x: 0; y: -1; z: 0 } & Vector3 = ...

down

A unit vector representing the world DOWN direction (0,-1,0)

east

east: { x: 1; y: 0; z: 0 } & Vector3 = ...

east

A unit vector representing the world EAST direction (1,0,0) (same as RIGHT)

forward

forward: { x: 0; y: 0; z: 1 } & Vector3 = ...

forward

A unit vector representing the world FORWARD direction (0,0,1)

left

left: { x: -1; y: 0; z: 0 } & Vector3 = ...

left

A unit vector representing the world LEFT direction (-1,0,0)

north

north: { x: 0; y: 0; z: 1 } & Vector3 = ...

north

A unit vector representing the world NORTH direction (0,0,1) (same as FORWARD)

one

one: { x: 1; y: 1; z: 1 } & Vector3 = ...

one

A unit vector representing the value of 1 in all directions (1,1,1)

right

right: { x: 1; y: 0; z: 0 } & Vector3 = ...

right

A unit vector representing the world RIGHT direction (1,0,0)

south

south: { x: 0; y: 0; z: -1 } & Vector3 = ...

south

A unit vector representing the world SOUTH direction (0,0,-1) (same as BACK)

up

up: { x: 0; y: 1; z: 0 } & Vector3 = ...

A unit vector representing the world UP direction (0,1,0)

west

west: { x: -1; y: 0; z: 0 } & Vector3 = ...

west

A unit vector representing the world WEST direction (-1,0,0) (same as LEFT)

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.

zero

zero: { x: 0; y: 0; z: 0 } & Vector3 = ...

zero

A unit vector representing the value of 0 in all directions (0,0,0)

`Static`add

add: (v1: Vector3, v2: Partial<Vector3>) => Vector3 = Vector3Utils.add

add

Add two vectors to produce a new vector

`Static`back

back: { x: 0; y: 0; z: -1 } & Vector3 = ...

back

A unit vector representing the world BACK direction (0,0,-1)

`Static`clamp

clamp: (
v: Vector3,
limits?: { max?: Partial<Vector3>; min?: Partial<Vector3> },
) => Vector3 = Vector3Utils.clamp

clamp

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

`Static`cross

cross: (a: Vector3, b: Vector3) => Vector3 = Vector3Utils.cross

cross

Calculate the cross product of two vectors. Returns a new vector.

`Static`distance

distance: (a: Vector3, b: Vector3) => number = Vector3Utils.distance

distance

Calculate the distance between two vectors

`Static`dot

dot: (a: Vector3, b: Vector3) => number = Vector3Utils.dot

dot

Calculate the dot product of two vectors

`Static`down

down: { x: 0; y: -1; z: 0 } & Vector3 = ...

down

A unit vector representing the world DOWN direction (0,-1,0)

`Static`east

east: { x: 1; y: 0; z: 0 } & Vector3 = ...

east

A unit vector representing the world EAST direction (1,0,0) (same as RIGHT)

`Static`equals

equals: (v1: Vector3, v2: Vector3) => boolean = Vector3Utils.equals

equals

Check the equality of two vectors

`Static`floor

floor: (v: Vector3) => Vector3 = Vector3Utils.floor

floor

Floor the components of a vector to produce a new vector

`Static`forward

forward: { x: 0; y: 0; z: 1 } & Vector3 = ...

forward

A unit vector representing the world FORWARD direction (0,0,1)

`Static`left

left: { x: -1; y: 0; z: 0 } & Vector3 = ...

left

A unit vector representing the world LEFT direction (-1,0,0)

`Static`lerp

lerp: (a: Vector3, b: Vector3, t: number) => Vector3 = Vector3Utils.lerp

lerp

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

`Static`magnitude

magnitude: (v: Vector3) => number = Vector3Utils.magnitude

magnitude

The magnitude of a vector

`Static`multiply

multiply: (a: Vector3, b: Vector3) => Vector3 = Vector3Utils.multiply

multiply

Element-wise multiplication of two vectors together. Not to be confused with Vector3Utils.dot product or Vector3Utils.cross product

`Static`normalize

normalize: (v: Vector3) => Vector3 = Vector3Utils.normalize

normalize

Takes a vector 3 and normalizes it to a unit vector

`Static`north

north: { x: 0; y: 0; z: 1 } & Vector3 = ...

north

A unit vector representing the world NORTH direction (0,0,1) (same as FORWARD)

`Static`one

one: { x: 1; y: 1; z: 1 } & Vector3 = ...

one

A unit vector representing the value of 1 in all directions (1,1,1)

`Static`right

right: { x: 1; y: 0; z: 0 } & Vector3 = ...

right

A unit vector representing the world RIGHT direction (1,0,0)

`Static`rotateX

rotateX: (v: Vector3, a: number) => Vector3 = Vector3Utils.rotateX

rotateX

Rotates the vector around the x axis counterclockwise (left hand rule)

Type declaration

- (v: Vector3, a: number): Vector3
- Parameters
  - v: Vector3
  - a: number
    Angle in radians
  Returns Vector3

`Static`rotateY

rotateY: (v: Vector3, a: number) => Vector3 = Vector3Utils.rotateY

rotateY

Rotates the vector around the y axis counterclockwise (left hand rule)

Type declaration

- (v: Vector3, a: number): Vector3
- Parameters
  - v: Vector3
  - a: number
    Angle in radians
  Returns Vector3

`Static`rotateZ

rotateZ: (v: Vector3, a: number) => Vector3 = Vector3Utils.rotateZ

rotateZ

Rotates the vector around the z axis counterclockwise (left hand rule)

Type declaration

- (v: Vector3, a: number): Vector3
- Parameters
  - v: Vector3
  - a: number
    Angle in radians
  Returns Vector3

`Static`scale

scale: (v1: Vector3, scale: number) => Vector3 = Vector3Utils.scale

scale

Multiple all entries in a vector by a single scalar value producing a new vector

`Static`slerp

slerp: (a: Vector3, b: Vector3, t: number) => Vector3 = Vector3Utils.slerp

slerp

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

`Static`south

south: { x: 0; y: 0; z: -1 } & Vector3 = ...

south

A unit vector representing the world SOUTH direction (0,0,-1) (same as BACK)

`Static`subtract

subtract: (v1: Vector3, v2: Partial<Vector3>) => Vector3 = Vector3Utils.subtract

subtract

Subtract two vectors to produce a new vector (v1-v2)

`Static`toString

toString: (
v: Vector3,
options?: { decimals?: number; delimiter?: string },
) => string = Vector3Utils.toString

toString

Create a string representation of a vector3

Type declaration

- (v: Vector3, options?: { decimals?: number; delimiter?: string }): string
- toString
  
  Create a string representation of a vector3
  Parameters
  - v: Vector3
  - Optionaloptions: { decimals?: number; delimiter?: string }
  Returns string

`Static`up

up: { x: 0; y: 1; z: 0 } & Vector3 = ...

A unit vector representing the world UP direction (0,1,0)

`Static`west

west: { x: -1; y: 0; z: 0 } & Vector3 = ...

west

A unit vector representing the world WEST direction (-1,0,0) (same as LEFT)

`Static`zero

zero: { x: 0; y: 0; z: 0 } & Vector3 = ...

zero

A unit vector representing the value of 0 in all directions (0,0,0)

Methods

toString

toString(options?: { decimals?: number; delimiter?: string }): string
toString

Create a string representation of a vector
Parameters
- Optionaloptions: { decimals?: number; delimiter?: string }
Returns string
Inherited from Vector3Builder.toString
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/math.js/lib/types/math-public.d.ts:277

Class Vector

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Globals.Vector

Parameters

Returns Globals.Vector

Parameters

Returns Globals.Vector

Properties

back

down

east

forward

left

north

one

right

south

up

west

x

Remarks

y

Remarks

z

Remarks

zero

Staticadd

Staticback

Staticclamp

Staticcross

Staticdistance

Staticdot

Staticdown

Staticeast

Staticequals

Staticfloor

Staticforward

Staticleft

Staticlerp

Staticmagnitude

Staticmultiply

Staticnormalize

Staticnorth

Staticone

Staticright

StaticrotateX

Type declaration

Parameters

Returns Vector3

StaticrotateY

Type declaration

Parameters

Returns Vector3

StaticrotateZ

Type declaration

Parameters

Returns Vector3

Staticscale

Staticslerp

Staticsouth

Staticsubtract

StatictoString

Type declaration

Parameters

Returns string

Staticup

Staticwest

Staticzero

Methods

add

Parameters

Returns this

`Static`add

`Static`back

`Static`clamp

`Static`cross

`Static`distance

`Static`dot

`Static`down

`Static`east

`Static`equals

`Static`floor

`Static`forward

`Static`left

`Static`lerp

`Static`magnitude

`Static`multiply

`Static`normalize

`Static`north

`Static`one

`Static`right

`Static`rotateX

`Static`rotateY

`Static`rotateZ

`Static`scale

`Static`slerp

`Static`south

`Static`subtract

`Static`toString

`Static`up

`Static`west

`Static`zero