Class: MockVector2D

Mock of the X-Ray engine 2D vector2 class for jest/node.

Pure-JS implementation of the subset of vector2 behaviour used by shared utilities, so code that calls new vector2() can run under jest when vector2 is bound to this mock.

Implements

• vector2

Constructors

Constructor

new MockVector2D(): MockVector2D;

Returns

MockVector2D

Methods

add()

add(first: number | vector2, second?: vector2): MockVector2D;

Parameters

Parameter	Type
first	number | vector2
second?	vector2

Returns

MockVector2D

---

distance_to()

distance_to(): number;

Returns

number

---

distance_to_sqr()

distance_to_sqr(): number;

Returns

number

---

dotproduct()

dotproduct(target: vector2): number;

Parameters

Parameter	Type
target	vector2

Returns

number

---

mul()

mul(by: number | vector2): MockVector2D;

Parameters

Parameter	Type
by	number | vector2

Returns

MockVector2D

---

normalize()

normalize(): MockVector2D;

Returns

MockVector2D

---

set()

Call Signature

set(x: number, y: number): MockVector2D;

Set components.

Parameters

Parameter	Type	Description
x	number	X component.
y	number	Y component.

Returns

MockVector2D

This vector.

Implementation of

vector2.set

Call Signature

set(x: vector2): MockVector2D;

Copy another vector.

Parameters

Parameter	Type
x	vector2

Returns

MockVector2D

This vector.

Implementation of

vector2.set

---

sub()

sub(first: vector2, second?: vector2): MockVector2D;

Parameters

Parameter	Type
first	vector2
second?	vector2

Returns

MockVector2D

---

create()

static create(x?: number, y?: number): MockVector2D;

Parameters

Parameter	Type	Default value
x	number	0
y	number	0

Returns

MockVector2D

---

mock()

static mock(x?: number, y?: number): vector2;

Parameters

Parameter	Type	Default value
x	number	0
y	number	0

Returns

vector2

Properties

x

x: number = 0;

X component.

Implementation of

vector2.x

---

y

y: number = 0;

Y component.

Implementation of

vector2.y

---

DEFAULT_DISTANCE

static DEFAULT_DISTANCE: number = 20;