Class MutVec2

Implements

Vector2

Index

Constructors

constructor

new MutVec2(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:993
new MutVec2(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:994
new MutVec2(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:995
new MutVec2(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:996
new MutVec2(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:997
new MutVec2(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:998
new MutVec2(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:999

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(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1012
add(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1013
add(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1014
add(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1015
add(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1016
add(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1017
add(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1018

almostEqual

almostEqual(x: number, y: number, delta: number): boolean
Parameters
- x: number
- y: number
- delta: number
Returns boolean
- Defined in index.d.ts:1112
almostEqual(x: MutVec2, delta: number): boolean
Parameters
- x: MutVec2
- delta: number
Returns boolean
- Defined in index.d.ts:1113
almostEqual(x: Vec2, delta: number): boolean
Parameters
- x: Vec2
- delta: number
Returns boolean
- Defined in index.d.ts:1114
almostEqual(x: Vector2, delta: number): boolean
Parameters
- x: Vector2
- delta: number
Returns boolean
- Defined in index.d.ts:1115
almostEqual(x: VectorXZ, delta: number): boolean
Parameters
- x: VectorXZ
- delta: number
Returns boolean
- Defined in index.d.ts:1116
almostEqual(x: Direction, delta: number): boolean
Parameters
- x: Direction
- delta: number
Returns boolean
- Defined in index.d.ts:1117
almostEqual(x: number[], delta: number): boolean
Parameters
- x: number[]
- delta: number
Returns boolean
- Defined in index.d.ts:1118

angleBetween

angleBetween(x: number, y: number): number
Parameters
- x: number
- y: number
Returns number
- Defined in index.d.ts:1069
angleBetween(x: MutVec2): number
Parameters
- x: MutVec2
Returns number
- Defined in index.d.ts:1070
angleBetween(x: Vec2): number
Parameters
- x: Vec2
Returns number
- Defined in index.d.ts:1071
angleBetween(x: Vector2): number
Parameters
- x: Vector2
Returns number
- Defined in index.d.ts:1072
angleBetween(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:1073
angleBetween(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:1074

ceil

ceil(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1098

ceilX

ceilX(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1099

ceilY

ceilY(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1100

copy

copy(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1008

distance

distance(x: number, y: number): number
Parameters
- x: number
- y: number
Returns number
- Defined in index.d.ts:1046
distance(x: MutVec2): number
Parameters
- x: MutVec2
Returns number
- Defined in index.d.ts:1047
distance(x: Vec2): number
Parameters
- x: Vec2
Returns number
- Defined in index.d.ts:1048
distance(x: Vector2): number
Parameters
- x: Vector2
Returns number
- Defined in index.d.ts:1049
distance(x: VectorXZ): number
Parameters
- x: VectorXZ
Returns number
- Defined in index.d.ts:1050
distance(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:1051
distance(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:1052

distanceSquared

distanceSquared(x: number, y: number): number
Parameters
- x: number
- y: number
Returns number
- Defined in index.d.ts:1053
distanceSquared(x: MutVec2): number
Parameters
- x: MutVec2
Returns number
- Defined in index.d.ts:1054
distanceSquared(x: Vec2): number
Parameters
- x: Vec2
Returns number
- Defined in index.d.ts:1055
distanceSquared(x: Vector2): number
Parameters
- x: Vector2
Returns number
- Defined in index.d.ts:1056
distanceSquared(x: VectorXZ): number
Parameters
- x: VectorXZ
Returns number
- Defined in index.d.ts:1057
distanceSquared(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:1058
distanceSquared(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:1059

divide

divide(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1035
divide(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1036
divide(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1037
divide(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1038
divide(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1039
divide(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1040
divide(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1041
divide(x: number): MutVec2
Parameters
- x: number
Returns MutVec2
- Defined in index.d.ts:1042

dot

dot(x: number, y: number): number
Parameters
- x: number
- y: number
Returns number
- Defined in index.d.ts:1062
dot(x: MutVec2): number
Parameters
- x: MutVec2
Returns number
- Defined in index.d.ts:1063
dot(x: Vec2): number
Parameters
- x: Vec2
Returns number
- Defined in index.d.ts:1064
dot(x: Vector2): number
Parameters
- x: Vector2
Returns number
- Defined in index.d.ts:1065
dot(x: VectorXZ): number
Parameters
- x: VectorXZ
Returns number
- Defined in index.d.ts:1066
dot(x: Direction): number
Parameters
- x: Direction
Returns number
- Defined in index.d.ts:1067
dot(x: number[]): number
Parameters
- x: number[]
Returns number
- Defined in index.d.ts:1068

east

east(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1106

equals

equals(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
- Defined in index.d.ts:1119
equals(x: MutVec2): boolean
Parameters
- x: MutVec2
Returns boolean
- Defined in index.d.ts:1120
equals(x: Vec2): boolean
Parameters
- x: Vec2
Returns boolean
- Defined in index.d.ts:1121
equals(x: Vector2): boolean
Parameters
- x: Vector2
Returns boolean
- Defined in index.d.ts:1122
equals(x: VectorXZ): boolean
Parameters
- x: VectorXZ
Returns boolean
- Defined in index.d.ts:1123
equals(x: Direction): boolean
Parameters
- x: Direction
Returns boolean
- Defined in index.d.ts:1124
equals(x: number[]): boolean
Parameters
- x: number[]
Returns boolean
- Defined in index.d.ts:1125

floor

floor(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1095

floorX

floorX(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1096

floorY

floorY(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1097

isZero

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

length

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

lengthSquared

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

lerp

lerp(v: Vector2, t: number): MutVec2
Parameters
- v: Vector2
- t: number
Returns MutVec2
- Defined in index.d.ts:1060

multiply

multiply(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1026
multiply(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1027
multiply(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1028
multiply(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1029
multiply(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1030
multiply(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1031
multiply(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1032
multiply(x: number): MutVec2
Parameters
- x: number
Returns MutVec2
- Defined in index.d.ts:1033

normalize

normalize(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1043

north

north(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1104

projectOnto

projectOnto(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1075
projectOnto(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1076
projectOnto(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1077
projectOnto(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1078
projectOnto(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1079
projectOnto(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1080
projectOnto(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1081

reflect

reflect(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1082
reflect(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1083
reflect(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1084
reflect(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1085
reflect(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1086
reflect(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1087
reflect(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1088

round

round(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1101

roundX

roundX(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1102

roundY

roundY(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1103

scale

scale(scalar: number): MutVec2
Parameters
- scalar: number
Returns MutVec2
- Defined in index.d.ts:1034

setX

setX(value: number): MutVec2
Parameters
- value: number
Returns MutVec2
- Defined in index.d.ts:1090
setX(value: (x: number) => number): MutVec2
Parameters
- value: (x: number) => number
Returns MutVec2
- Defined in index.d.ts:1091

setY

setY(value: number): MutVec2
Parameters
- value: number
Returns MutVec2
- Defined in index.d.ts:1092
setY(value: (y: number) => number): MutVec2
Parameters
- value: (y: number) => number
Returns MutVec2
- Defined in index.d.ts:1093

slerp

slerp(v: Vector2, t: number): MutVec2
Parameters
- v: Vector2
- t: number
Returns MutVec2
- Defined in index.d.ts:1061

south

south(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1105

subtract

subtract(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1019
subtract(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1020
subtract(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1021
subtract(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1022
subtract(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1023
subtract(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1024
subtract(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1025

toArray

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

toBlockLocation

toBlockLocation(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1111

toDirection

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

toImmutable

toImmutable(): Vec2
Returns Vec2
- Defined in index.d.ts:1009

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:1126

toVec3

toVec3(z?: number): Vec3
Parameters
- Optionalz: number
Returns Vec3
- Defined in index.d.ts:1089

toYaw

toYaw(): number
Returns number
- Defined in index.d.ts:1011

update

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

west

west(): MutVec2
Returns MutVec2
- Defined in index.d.ts:1107

`Static`from

from(x: number, y: number): MutVec2
Parameters
- x: number
- y: number
Returns MutVec2
- Defined in index.d.ts:1000
from(x: MutVec2): MutVec2
Parameters
- x: MutVec2
Returns MutVec2
- Defined in index.d.ts:1001
from(x: Vec2): MutVec2
Parameters
- x: Vec2
Returns MutVec2
- Defined in index.d.ts:1002
from(x: Vector2): MutVec2
Parameters
- x: Vector2
Returns MutVec2
- Defined in index.d.ts:1003
from(x: VectorXZ): MutVec2
Parameters
- x: VectorXZ
Returns MutVec2
- Defined in index.d.ts:1004
from(x: Direction): MutVec2
Parameters
- x: Direction
Returns MutVec2
- Defined in index.d.ts:1005
from(x: number[]): MutVec2
Parameters
- x: number[]
Returns MutVec2
- Defined in index.d.ts:1006

`Static`fromYaw

fromYaw(yaw: number): MutVec2
Parameters
- yaw: number
Returns MutVec2
- Defined in index.d.ts:1010

Class MutVec2

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Properties

x

Remarks

y

Remarks

Methods

add

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

Parameters

Returns MutVec2

almostEqual

Parameters

Returns boolean

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 MutVec2

ceilX

Returns MutVec2

ceilY

Returns MutVec2

copy

Returns MutVec2

distance