Class MutVec3

Implements

Vector3

Constructors

constructor

new MutVec3(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:8
new MutVec3(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:9
new MutVec3(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:10
new MutVec3(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:11
new MutVec3(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:12
new MutVec3(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:13

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(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:29
add(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:30
add(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:31
add(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:32
add(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:33
add(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:34

almostEqual

almostEqual(x: number, y: number, z: number, delta: number): boolean
Parameters
- x: number
- y: number
- z: number
- delta: number
Returns boolean
- Defined in index.d.ts:134
almostEqual(x: MutVec3, delta: number): boolean
Parameters
- x: MutVec3
- delta: number
Returns boolean
- Defined in index.d.ts:135
almostEqual(x: Vec3, delta: number): boolean
Parameters
- x: Vec3
- delta: number
Returns boolean
- Defined in index.d.ts:136
almostEqual(x: Vector3, delta: number): boolean
Parameters
- x: Vector3
- delta: number
Returns boolean
- Defined in index.d.ts:137
almostEqual(x: Direction, delta: number): boolean
Parameters
- x: Direction
- delta: number
Returns boolean
- Defined in index.d.ts:138
almostEqual(x: number[], delta: number): boolean
Parameters
- x: number[]
- delta: number
Returns boolean
- Defined in index.d.ts:139

angleBetween

angleBetween(x: number, y: number, z: number): number
Parameters
- x: number
- y: number
- z: number
Returns number
- Defined in index.d.ts:85
angleBetween(x: Vector3): number
Parameters
- x: Vector3
Returns number
- Defined in index.d.ts:86
angleBetween(x: Vec3): number
Parameters
- x: Vec3
Returns number
- Defined in index.d.ts:87
angleBetween(x: MutVec3): number
Parameters
- x: MutVec3
Returns number
- Defined in index.d.ts:88
angleBetween(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:89
angleBetween(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:90

ceil

ceil(): this
Returns this
- Defined in index.d.ts:115

ceilX

ceilX(): MutVec3
Returns MutVec3
- Defined in index.d.ts:116

ceilY

ceilY(): MutVec3
Returns MutVec3
- Defined in index.d.ts:117

ceilZ

ceilZ(): MutVec3
Returns MutVec3
- Defined in index.d.ts:118

copy

copy(): MutVec3
Returns MutVec3
- Defined in index.d.ts:21

cross

cross(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:59
cross(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:60
cross(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:61
cross(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:62
cross(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:63
cross(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:64

distance

distance(x: number, y: number, z: number): number
Parameters
- x: number
- y: number
- z: number
Returns number
- Defined in index.d.ts:65
distance(x: Vector3): number
Parameters
- x: Vector3
Returns number
- Defined in index.d.ts:66
distance(x: Vec3): number
Parameters
- x: Vec3
Returns number
- Defined in index.d.ts:67
distance(x: MutVec3): number
Parameters
- x: MutVec3
Returns number
- Defined in index.d.ts:68
distance(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:69
distance(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:70

distanceSquared

distanceSquared(x: number, y: number, z: number): number
Parameters
- x: number
- y: number
- z: number
Returns number
- Defined in index.d.ts:71
distanceSquared(x: Vector3): number
Parameters
- x: Vector3
Returns number
- Defined in index.d.ts:72
distanceSquared(x: Vec3): number
Parameters
- x: Vec3
Returns number
- Defined in index.d.ts:73
distanceSquared(x: MutVec3): number
Parameters
- x: MutVec3
Returns number
- Defined in index.d.ts:74
distanceSquared(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:75
distanceSquared(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:76

divide

divide(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:49
divide(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:50
divide(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:51
divide(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:52
divide(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:53
divide(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:54
divide(x: number): MutVec3
Parameters
- x: number
Returns MutVec3
- Defined in index.d.ts:55

dot

dot(x: number, y: number, z: number): number
Parameters
- x: number
- y: number
- z: number
Returns number
- Defined in index.d.ts:79
dot(x: Vector3): number
Parameters
- x: Vector3
Returns number
- Defined in index.d.ts:80
dot(x: Vec3): number
Parameters
- x: Vec3
Returns number
- Defined in index.d.ts:81
dot(x: MutVec3): number
Parameters
- x: MutVec3
Returns number
- Defined in index.d.ts:82
dot(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:83
dot(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:84

down

down(): MutVec3
Returns MutVec3
- Defined in index.d.ts:124

east

east(): MutVec3
Returns MutVec3
- Defined in index.d.ts:127

equals

equals(x: number, y: number, z: number): boolean
Parameters
- x: number
- y: number
- z: number
Returns boolean
- Defined in index.d.ts:140
equals(x: MutVec3): boolean
Parameters
- x: MutVec3
Returns boolean
- Defined in index.d.ts:141
equals(x: Vec3): boolean
Parameters
- x: Vec3
Returns boolean
- Defined in index.d.ts:142
equals(x: Vector3): boolean
Parameters
- x: Vector3
Returns boolean
- Defined in index.d.ts:143
equals(x: Direction): boolean
Parameters
- x: Direction
Returns boolean
- Defined in index.d.ts:144
equals(x: number[]): boolean
Parameters
- x: number[]
Returns boolean
- Defined in index.d.ts:145

floor

floor(): this
Returns this
- Defined in index.d.ts:111

floorX

floorX(): MutVec3
Returns MutVec3
- Defined in index.d.ts:112

floorY

floorY(): MutVec3
Returns MutVec3
- Defined in index.d.ts:113

floorZ

floorZ(): MutVec3
Returns MutVec3
- Defined in index.d.ts:114

isZero

isZero(): boolean
Returns boolean
- Defined in index.d.ts:129

length

length(): number
Returns number
- Defined in index.d.ts:57

lengthSquared

lengthSquared(): number
Returns number
- Defined in index.d.ts:58

lerp

lerp(v: Vector3, t: number): this
Parameters
- v: Vector3
- t: number
Returns this
- Defined in index.d.ts:77

multiply

multiply(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:41
multiply(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:42
multiply(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:43
multiply(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:44
multiply(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:45
multiply(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:46
multiply(x: number): MutVec3
Parameters
- x: number
Returns MutVec3
- Defined in index.d.ts:47

normalize

normalize(): this
Returns this
- Defined in index.d.ts:56

north

north(): MutVec3
Returns MutVec3
- Defined in index.d.ts:125

projectOnto

projectOnto(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:91
projectOnto(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:92
projectOnto(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:93
projectOnto(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:94
projectOnto(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:95
projectOnto(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:96

reflect

reflect(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:97
reflect(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:98
reflect(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:99
reflect(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:100
reflect(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:101
reflect(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:102

rotate

rotate(axis: Vector3, angle: number): this
Parameters
- axis: Vector3
- angle: number
Returns this
- Defined in index.d.ts:103

round

round(): this
Returns this
- Defined in index.d.ts:119

roundX

roundX(): MutVec3
Returns MutVec3
- Defined in index.d.ts:120

roundY

roundY(): MutVec3
Returns MutVec3
- Defined in index.d.ts:121

roundZ

roundZ(): MutVec3
Returns MutVec3
- Defined in index.d.ts:122

scale

scale(scalar: number): this
Parameters
- scalar: number
Returns this
- Defined in index.d.ts:48

setX

setX(value: number): MutVec3
Parameters
- value: number
Returns MutVec3
- Defined in index.d.ts:105
setX(value: (x: number) => number): MutVec3
Parameters
- value: (x: number) => number
Returns MutVec3
- Defined in index.d.ts:106

setY

setY(value: number): MutVec3
Parameters
- value: number
Returns MutVec3
- Defined in index.d.ts:107
setY(value: (y: number) => number): MutVec3
Parameters
- value: (y: number) => number
Returns MutVec3
- Defined in index.d.ts:108

setZ

setZ(value: number): MutVec3
Parameters
- value: number
Returns MutVec3
- Defined in index.d.ts:109
setZ(value: (z: number) => number): MutVec3
Parameters
- value: (z: number) => number
Returns MutVec3
- Defined in index.d.ts:110

slerp

slerp(v: Vector3, t: number): this
Parameters
- v: Vector3
- t: number
Returns this
- Defined in index.d.ts:78

south

south(): MutVec3
Returns MutVec3
- Defined in index.d.ts:126

subtract

subtract(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:35
subtract(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:36
subtract(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:37
subtract(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:38
subtract(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:39
subtract(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:40

toArray

toArray(): number[]
Returns number[]
- Defined in index.d.ts:130

toBlockLocation

toBlockLocation(): this
Returns this
- Defined in index.d.ts:133

toDirection

toDirection(): Direction
Returns Direction
- Defined in index.d.ts:131

toImmutable

toImmutable(): Vec3
Returns Vec3
- Defined in index.d.ts:22

toRotation

toRotation(): { x: number; y: number }
Returns { x: number; y: number }
- Defined in index.d.ts:25

toString

toString(format?: "long" | "short", separator?: string): string
Returns a string representation of an object.
Parameters
- Optionalformat: "long" | "short"
- Optionalseparator: string
Returns string
- Defined in index.d.ts:146

toStructureRotation

toStructureRotation(): StructureRotation
Returns StructureRotation
- Defined in index.d.ts:132

up

up(): MutVec3
Returns MutVec3
- Defined in index.d.ts:123

update

update(
    x: undefined | ((x: number) => number),
    y: undefined | ((y: number) => number),
    z: undefined | ((z: number) => number),
): this
Parameters
- x: undefined | ((x: number) => number)
- y: undefined | ((y: number) => number)
- z: undefined | ((z: number) => number)
Returns this
- Defined in index.d.ts:104

west

west(): MutVec3
Returns MutVec3
- Defined in index.d.ts:128

`Static`from

from(x: number, y: number, z: number): MutVec3
Parameters
- x: number
- y: number
- z: number
Returns MutVec3
- Defined in index.d.ts:14
from(x: MutVec3): MutVec3
Parameters
- x: MutVec3
Returns MutVec3
- Defined in index.d.ts:15
from(x: Vec3): MutVec3
Parameters
- x: Vec3
Returns MutVec3
- Defined in index.d.ts:16
from(x: Vector3): MutVec3
Parameters
- x: Vector3
Returns MutVec3
- Defined in index.d.ts:17
from(x: Direction): MutVec3
Parameters
- x: Direction
Returns MutVec3
- Defined in index.d.ts:18
from(x: number[]): MutVec3
Parameters
- x: number[]
Returns MutVec3
- Defined in index.d.ts:19

`Static`fromRotation

fromRotation(rotation: Vector2): MutVec3
Parameters
- rotation: Vector2
Returns MutVec3
- Defined in index.d.ts:23
fromRotation(yaw: number, pitch: number): MutVec3
Parameters
- yaw: number
- pitch: number
Returns MutVec3
- Defined in index.d.ts:24

`Static`fromString

fromString(str: string, format?: "long" | "short", separator?: string): MutVec3
Parameters
- str: string
- Optionalformat: "long" | "short"
- Optionalseparator: string
Returns MutVec3
- Defined in index.d.ts:147

Class MutVec3

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Properties

x

Remarks

y

Remarks

z

Remarks

Methods

add

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

Parameters

Returns MutVec3

almostEqual

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

angleBetween

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

ceil

Returns this

ceilX

Returns MutVec3

ceilY

Returns MutVec3

ceilZ

Returns MutVec3

copy

Returns MutVec3

cross

Parameters

Returns MutVec3