Class Vertex<T>

Vector that also has edges & some extra data. This should be used with graph data structures.

Type Parameters

Hierarchy

default
- Vertex

Index

Constructors

constructor

new Vertex<T>(x: number, y: number, data: T): Vertex<T>
Type Parameters
- T
Parameters
- x: number
- y: number
- data: T
Returns Vertex<T>
Overrides default.constructor
- Defined in src/game/utilities/collection/graph/Vertex.ts:23

Properties

`Readonly` data

data: T

`Readonly` edges

edges: default<Vertex<T>>[] = []

`Static` `Readonly` DIRECTIONS

DIRECTIONS: Readonly<Record<Direction, default>> = ...

Accessors

x

get x(): number
Returns number
Inherited from Vector2.x
- Defined in src/game/utilities/math/Vector2.ts:345
set x(value: number): void
Parameters
- value: number
Returns void
Inherited from Vector2.x
- Defined in src/game/utilities/math/Vector2.ts:348

xy

get xy(): [number, number]
Returns [number, number]
Inherited from Vector2.xy
- Defined in src/game/utilities/math/Vector2.ts:359
set xy(values: [number, number]): void
Parameters
- values: [number, number]
Returns void
Inherited from Vector2.xy
- Defined in src/game/utilities/math/Vector2.ts:365

y

get y(): number
Returns number
Inherited from Vector2.y
- Defined in src/game/utilities/math/Vector2.ts:352
set y(value: number): void
Parameters
- value: number
Returns void
Inherited from Vector2.y
- Defined in src/game/utilities/math/Vector2.ts:355

`Static` INFINITY

get INFINITY(): default
Returns default
Inherited from Vector2.INFINITY
- Defined in src/game/utilities/math/Vector2.ts:34

`Static` INFINITY_NEGATIVE

get INFINITY_NEGATIVE(): default
Returns default
Inherited from Vector2.INFINITY_NEGATIVE
- Defined in src/game/utilities/math/Vector2.ts:31

`Static` ONE

get ONE(): default
Returns default
Inherited from Vector2.ONE
- Defined in src/game/utilities/math/Vector2.ts:27

`Static` ZERO

get ZERO(): default
Returns default
Inherited from Vector2.ZERO
- Defined in src/game/utilities/math/Vector2.ts:24

Methods

add

add(vector: IVector3 | IVector2): Vertex<T>
Parameters
- vector: IVector3 | IVector2
Returns Vertex<T>
Inherited from default.add
- Defined in src/game/utilities/math/Vector2.ts:438
add(amount: number): Vertex<T>
Parameters
- amount: number
Returns Vertex<T>
Inherited from default.add
- Defined in src/game/utilities/math/Vector2.ts:439
add(x: number, y: number): Vertex<T>
Parameters
- x: number
- y: number
Returns Vertex<T>
Inherited from default.add
- Defined in src/game/utilities/math/Vector2.ts:440

at

at(index: number): number
Parameters
- index: number
Returns number
Inherited from default.at
- Defined in src/game/utilities/math/Vector2.ts:392

ceil

ceil(dest?: Vertex<T>): Vertex<T>
Parameters
- dest: Vertex<T> = ...
Returns Vertex<T>
Inherited from default.ceil
- Defined in src/game/utilities/math/Vector2.ts:485

clamp

clamp(a: IVector2, b: IVector2): Vertex<T>
Parameters
- a: IVector2
- b: IVector2
Returns Vertex<T>
Inherited from default.clamp
- Defined in src/game/utilities/math/Vector2.ts:557

copy

copy(): default
Returns default
Inherited from default.copy
- Defined in src/game/utilities/math/Vector2.ts:401
copy<D>(dest: D): D
Type Parameters
- D extends IVector2
Parameters
- dest: D
Returns D
Inherited from default.copy
- Defined in src/game/utilities/math/Vector2.ts:402

deserializeObject

deserializeObject(serializer: ISerializer, dataType: Types): boolean
Parameters
- serializer: ISerializer
- dataType: Types
Returns boolean
Inherited from default.deserializeObject
- Defined in src/game/utilities/math/Vector2.ts:596

divide

divide(vector: IVector3 | IVector2): Vertex<T>
Parameters
- vector: IVector3 | IVector2
Returns Vertex<T>
Inherited from default.divide
- Defined in src/game/utilities/math/Vector2.ts:468
divide(amount: number): Vertex<T>
Parameters
- amount: number
Returns Vertex<T>
Inherited from default.divide
- Defined in src/game/utilities/math/Vector2.ts:469
divide(x: number, y: number): Vertex<T>
Parameters
- x: number
- y: number
Returns Vertex<T>
Inherited from default.divide
- Defined in src/game/utilities/math/Vector2.ts:470

equals

equals(vector?: IVector2): boolean
Parameters
- Optional vector: IVector2
Returns boolean
Inherited from default.equals
- Defined in src/game/utilities/math/Vector2.ts:423

floor

floor(dest?: Vertex<T>): Vertex<T>
Parameters
- dest: Vertex<T> = ...
Returns Vertex<T>
Inherited from default.floor
- Defined in src/game/utilities/math/Vector2.ts:478

length

length(): number
Returns number
Inherited from default.length
- Defined in src/game/utilities/math/Vector2.ts:427

lerp

lerp(vector: IVector2, amount: number): Vertex<T>
Parameters
- vector: IVector2
- amount: number
Returns Vertex<T>
Inherited from default.lerp
- Defined in src/game/utilities/math/Vector2.ts:499

map

map(mapper: ((v2: default) => default)): default
Parameters
- mapper: ((v2: default) => default)
  - - (v2: default): default
    - Parameters
      
      v2: default
      
      Returns default
Returns default
Inherited from default.map
- Defined in src/game/utilities/math/Vector2.ts:410

midpoint

midpoint(vec: IVector2): IVector2
Parameters
- vec: IVector2
Returns IVector2
Inherited from default.midpoint
- Defined in src/game/utilities/math/Vector2.ts:572

mod

mod(n: number): Vertex<T>
Parameters
- n: number
Returns Vertex<T>
Inherited from default.mod
- Defined in src/game/utilities/math/Vector2.ts:506

multiply

multiply(vector: IVector3 | IVector2): Vertex<T>
Parameters
- vector: IVector3 | IVector2
Returns Vertex<T>
Inherited from default.multiply
- Defined in src/game/utilities/math/Vector2.ts:458
multiply(amount: number): Vertex<T>
Parameters
- amount: number
Returns Vertex<T>
Inherited from default.multiply
- Defined in src/game/utilities/math/Vector2.ts:459
multiply(x: number, y: number): Vertex<T>
Parameters
- x: number
- y: number
Returns Vertex<T>
Inherited from default.multiply
- Defined in src/game/utilities/math/Vector2.ts:460

negate

negate(): default
Returns default
Inherited from default.negate
- Defined in src/game/utilities/math/Vector2.ts:414
negate<D>(dest: D): D
Type Parameters
- D extends IVector2
Parameters
- dest: D
Returns D
Inherited from default.negate
- Defined in src/game/utilities/math/Vector2.ts:415

normalize

normalize(): Vertex<T>
Returns Vertex<T>
Inherited from default.normalize
- Defined in src/game/utilities/math/Vector2.ts:522
normalize<D>(dest: D): D
Type Parameters
- D extends IVector2
Parameters
- dest: D
Returns D
Inherited from default.normalize
- Defined in src/game/utilities/math/Vector2.ts:523

offset

offset(direction: Direction): Vertex<T>
Parameters
- direction: Direction
Returns Vertex<T>
Inherited from default.offset
- Defined in src/game/utilities/math/Vector2.ts:564

raw

raw(): IVector2
Returns IVector2
Inherited from default.raw
- Defined in src/game/utilities/math/Vector2.ts:550

reset

reset(): void
Returns void
Inherited from default.reset
- Defined in src/game/utilities/math/Vector2.ts:396

round

round(dest?: Vertex<T>): Vertex<T>
Parameters
- dest: Vertex<T> = ...
Returns Vertex<T>
Inherited from default.round
- Defined in src/game/utilities/math/Vector2.ts:492

scale

scale(value: number): Vertex<T>
Parameters
- value: number
Returns Vertex<T>
Inherited from default.scale
- Defined in src/game/utilities/math/Vector2.ts:513
scale<D>(value: number, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- value: number
- dest: D
Returns D
Inherited from default.scale
- Defined in src/game/utilities/math/Vector2.ts:514

serializeObject

serializeObject(serializer: ISerializer): undefined
Parameters
- serializer: ISerializer
Returns undefined
Inherited from default.serializeObject
- Defined in src/game/utilities/math/Vector2.ts:586

squaredLength

squaredLength(): number
Returns number
Inherited from default.squaredLength
- Defined in src/game/utilities/math/Vector2.ts:431

subtract

subtract(vector: IVector3 | IVector2): Vertex<T>
Parameters
- vector: IVector3 | IVector2
Returns Vertex<T>
Inherited from default.subtract
- Defined in src/game/utilities/math/Vector2.ts:448
subtract(amount: number): Vertex<T>
Parameters
- amount: number
Returns Vertex<T>
Inherited from default.subtract
- Defined in src/game/utilities/math/Vector2.ts:449
subtract(x: number, y: number): Vertex<T>
Parameters
- x: number
- y: number
Returns Vertex<T>
Inherited from default.subtract
- Defined in src/game/utilities/math/Vector2.ts:450

toRadians

toRadians(): number
Returns number
Inherited from default.toRadians
- Defined in src/game/utilities/math/Vector2.ts:546

toString

toString(): string
Returns string
Overrides default.toString
- Defined in src/game/utilities/collection/graph/Vertex.ts:27

`Static` angle

angle(directionInRadians: number, distance?: number): default
Parameters
- directionInRadians: number
- distance: number = 1
Returns default
Inherited from default.angle
- Defined in src/game/utilities/math/Vector2.ts:95

`Static` chebyshevDistance

chebyshevDistance(vec1: IVector2, vec2: IVector2): number
The greater of the distances from points A and B on each axis.

This distance formula covers a square pattern on a grid.
Parameters
- vec1: IVector2
- vec2: IVector2
Returns number
Inherited from default.chebyshevDistance
- Defined in src/game/utilities/math/Vector2.ts:241

`Static` cross

cross(vector: IVector2, vector2: IVector2): default
Parameters
- vector: IVector2
- vector2: IVector2
Returns default
Inherited from default.cross
- Defined in src/game/utilities/math/Vector2.ts:190
cross<D>(vector: IVector2, vector2: IVector2, dest: D): D
Type Parameters
- D extends IVector3
Parameters
- vector: IVector2
- vector2: IVector2
- dest: D
Returns D
Inherited from default.cross
- Defined in src/game/utilities/math/Vector2.ts:191

`Static` difference

difference(vector: IVector2, vector2: IVector2): default
Parameters
- vector: IVector2
- vector2: IVector2
Returns default
Inherited from default.difference
- Defined in src/game/utilities/math/Vector2.ts:293
difference<D>(vector: IVector2, vector2: IVector2, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- vector: IVector2
- vector2: IVector2
- dest: D
Returns D
Inherited from default.difference
- Defined in src/game/utilities/math/Vector2.ts:294

`Static` direction

direction(vector: IVector2, vector2: IVector2): default
Parameters
- vector: IVector2
- vector2: IVector2
Returns default
Inherited from default.direction
- Defined in src/game/utilities/math/Vector2.ts:249
direction<D>(vector: IVector2, vector2: IVector2, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- vector: IVector2
- vector2: IVector2
- dest: D
Returns D
Inherited from default.direction
- Defined in src/game/utilities/math/Vector2.ts:250

`Static` distance

distance(vector: IVector2, vector2: IVector2): number
The measure of a straight line between points A and B.

This distance formula covers a circular pattern on a grid.
Parameters
- vector: IVector2
- vector2: IVector2
Returns number
Inherited from default.distance
- Defined in src/game/utilities/math/Vector2.ts:213

`Static` dot

dot(vector: IVector2, vector2: IVector2): number
Parameters
- vector: IVector2
- vector2: IVector2
Returns number
Inherited from default.dot
- Defined in src/game/utilities/math/Vector2.ts:200

`Static` equals

equals(vec1: IVector2, vec2: IVector2): boolean
Parameters
- vec1: IVector2
- vec2: IVector2
Returns boolean
Inherited from default.equals
- Defined in src/game/utilities/math/Vector2.ts:245

`Static` forRange

forRange(center: IVector2, range: number, consumer: ConsumerVectorRange): void
Parameters
- center: IVector2
- range: number
- consumer: ConsumerVectorRange
Returns void
Inherited from default.forRange
- Defined in src/game/utilities/math/Vector2.ts:99
forRange(center: IVector2, range: number, includeCenter: boolean, consumer: ConsumerVectorRange): void
Parameters
- center: IVector2
- range: number
- includeCenter: boolean
- consumer: ConsumerVectorRange
Returns void
Inherited from default.forRange
- Defined in src/game/utilities/math/Vector2.ts:100
forRange(center: IVector2, range: number, min: IVector2, max: IVector2, consumer: ConsumerVectorRange): void
Parameters
- center: IVector2
- range: number
- min: IVector2
- max: IVector2
- consumer: ConsumerVectorRange
Returns void
Inherited from default.forRange
- Defined in src/game/utilities/math/Vector2.ts:101
forRange(center: IVector2, range: number, min: IVector2, max: IVector2, includeCenter: boolean, consumer: ConsumerVectorRange): void
Parameters
- center: IVector2
- range: number
- min: IVector2
- max: IVector2
- includeCenter: boolean
- consumer: ConsumerVectorRange
Returns void
Inherited from default.forRange
- Defined in src/game/utilities/math/Vector2.ts:102

`Static` fromClient

fromClient(clientXClientY: {
clientX?: number;
clientY?: number;
}): default
Parameters
- clientXClientY: {
  clientX?: number;
  clientY?: number;
  }
  - Optional clientX?: number
  - Optional clientY?: number
Returns default
Inherited from default.fromClient
- Defined in src/game/utilities/math/Vector2.ts:84
fromClient(clientXClientY?: {
clientX?: number;
clientY?: number;
}): undefined | default
Parameters
- Optional clientXClientY: {
  clientX?: number;
  clientY?: number;
  }
  - Optional clientX?: number
  - Optional clientY?: number
Returns undefined | default
Inherited from default.fromClient
- Defined in src/game/utilities/math/Vector2.ts:85

`Static` fromSize

fromSize(size: {
height: number;
width: number;
}): default
Parameters
- size: {
  height: number;
  width: number;
  }
  - height: number
  - width: number
Returns default
Inherited from default.fromSize
- Defined in src/game/utilities/math/Vector2.ts:72
fromSize(size?: {
height: number;
width: number;
}): undefined | default
Parameters
- Optional size: {
  height: number;
  width: number;
  }
  - height: number
  - width: number
Returns undefined | default
Inherited from default.fromSize
- Defined in src/game/utilities/math/Vector2.ts:73

`Static` fromTopLeft

fromTopLeft(topLeft: {
left: number;
top: number;
}): default
Parameters
- topLeft: {
  left: number;
  top: number;
  }
  - left: number
  - top: number
Returns default
Inherited from default.fromTopLeft
- Defined in src/game/utilities/math/Vector2.ts:78
fromTopLeft(topLeft?: {
left: number;
top: number;
}): undefined | default
Parameters
- Optional topLeft: {
  left: number;
  top: number;
  }
  - left: number
  - top: number
Returns undefined | default
Inherited from default.fromTopLeft
- Defined in src/game/utilities/math/Vector2.ts:79

`Static` inRange

inRange(center: IVector2, range: number, includeCenter?: boolean): Generator<IVector2, any, unknown>
Parameters
- center: IVector2
- range: number
- includeCenter: boolean = false
Returns Generator<IVector2, any, unknown>
Inherited from default.inRange
- Defined in src/game/utilities/math/Vector2.ts:91

`Static` is

is(thing: unknown): thing is IVector2
Parameters
- thing: unknown
Returns thing is IVector2
Inherited from default.is
- Defined in src/game/utilities/math/Vector2.ts:332

`Static` isDistanceWithin

isDistanceWithin(vector: IVector2, vector2: IVector2, distance: number): boolean
Parameters
- vector: IVector2
- vector2: IVector2
- distance: number
Returns boolean
Inherited from default.isDistanceWithin
- Defined in src/game/utilities/math/Vector2.ts:204

`Static` manhattanDistance

manhattanDistance(vec1: IVector2, vec2: IVector2): number
The number of adjacent grid cell movements needed to get from A to B.

This distance formula covers a diamond pattern on a grid.
Parameters
- vec1: IVector2
- vec2: IVector2
Returns number
Inherited from default.manhattanDistance
- Defined in src/game/utilities/math/Vector2.ts:232

`Static` mix

mix(vector: IVector2, vector2: IVector2, time: number): default
Parameters
- vector: IVector2
- vector2: IVector2
- time: number
Returns default
Inherited from default.mix
- Defined in src/game/utilities/math/Vector2.ts:272
mix<D>(vector: IVector2, vector2: IVector2, time: number, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- vector: IVector2
- vector2: IVector2
- time: number
- dest: D
Returns D
Inherited from default.mix
- Defined in src/game/utilities/math/Vector2.ts:273

`Static` product

product(vector: IVector2, vector2: IVector2): default
Parameters
- vector: IVector2
- vector2: IVector2
Returns default
Inherited from default.product
- Defined in src/game/utilities/math/Vector2.ts:302
product<D>(vector: IVector2, vector2: IVector2, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- vector: IVector2
- vector2: IVector2
- dest: D
Returns D
Inherited from default.product
- Defined in src/game/utilities/math/Vector2.ts:303

`Static` quotient

quotient(vector: IVector2, vector2: IVector2): default
Parameters
- vector: IVector2
- vector2: IVector2
Returns default
Inherited from default.quotient
- Defined in src/game/utilities/math/Vector2.ts:311
quotient<D>(vector: IVector2, vector2: IVector2, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- vector: IVector2
- vector2: IVector2
- dest: D
Returns D
Inherited from default.quotient
- Defined in src/game/utilities/math/Vector2.ts:312

`Static` range

range(a: IVector2, b: IVector2): Generator<number[], void, unknown>
Parameters
- a: IVector2
- b: IVector2
Returns Generator<number[], void, unknown>
Inherited from default.range
- Defined in src/game/utilities/math/Vector2.ts:320

`Static` rawCopy

rawCopy(v2: IVector2): IVector2
Parameters
- v2: IVector2
Returns IVector2
Inherited from default.rawCopy
- Defined in src/game/utilities/math/Vector2.ts:339

`Static` raycast

raycast(center: IVector2, range: number, angle: IVector2): IVector2[]
Parameters
- center: IVector2
- range: number
- angle: IVector2
Returns IVector2[]
Inherited from default.raycast
- Defined in src/game/utilities/math/Vector2.ts:119

`Static` raycastArc

raycastArc(center: IVector2, radius: number, angleStart: number | IVector2, angleEnd: number | IVector2): IVector2[]
Parameters
- center: IVector2
- radius: number
- angleStart: number | IVector2
- angleEnd: number | IVector2
Returns IVector2[]
Inherited from default.raycastArc
- Defined in src/game/utilities/math/Vector2.ts:147

`Static` squaredDistance

squaredDistance(vector: IVector2, vector2: IVector2): number
The euclidean distance (Vector2.distance), but without a sqrt operation afterwards, usually used for performance.
Parameters
- vector: IVector2
- vector2: IVector2
Returns number
Inherited from default.squaredDistance
- Defined in src/game/utilities/math/Vector2.ts:220

`Static` sum

sum(vector: IVector2, vector2: IVector2): default
Parameters
- vector: IVector2
- vector2: IVector2
Returns default
Inherited from default.sum
- Defined in src/game/utilities/math/Vector2.ts:284
sum<D>(vector: IVector2, vector2: IVector2, dest: D): D
Type Parameters
- D extends IVector2
Parameters
- vector: IVector2
- vector2: IVector2
- dest: D
Returns D
Inherited from default.sum
- Defined in src/game/utilities/math/Vector2.ts:285

`Static` xy

xy(vector: IVector2): [x: number, y: number]
Parameters
- vector: IVector2
Returns [x: number, y: number]
Inherited from default.xy
- Defined in src/game/utilities/math/Vector2.ts:68

Class Vertex<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

x: number

y: number

data: T

Returns Vertex<T>

Properties

Readonly data

Readonly edges

Static Readonly DIRECTIONS

Accessors

x

Returns number

Parameters

value: number

Returns void

xy

Returns [number, number]

Parameters

values: [number, number]

Returns void

y

Returns number

Parameters

value: number

Returns void

Static INFINITY

Returns default

Static INFINITY_NEGATIVE

Returns default

Static ONE

Returns default

Static ZERO

Returns default

Methods

add

Parameters

vector: IVector3 | IVector2

Returns Vertex<T>

Parameters

amount: number

Returns Vertex<T>

Parameters

x: number

y: number

Returns Vertex<T>

at

Parameters

index: number

Returns number

ceil

Parameters

dest: Vertex<T> = ...

Returns Vertex<T>

clamp

Parameters

a: IVector2

b: IVector2

Returns Vertex<T>

copy

Returns default

Type Parameters

D extends IVector2

Parameters

dest: D

Returns D

deserializeObject

Parameters

`Readonly` data

`Readonly` edges

`Static` `Readonly` DIRECTIONS

`Static` INFINITY

`Static` INFINITY_NEGATIVE

`Static` ONE

`Static` ZERO

`Optional` vector: IVector2