@temporary-escape/mod-sdk / Vector2i

Class: Vector2i

Defined in: math/vector2i.ts:5

Constructors

Constructor

new Vector2i(x?: number, y?: number): Vector2i;

Defined in: math/vector2i.ts:9

Parameters

Parameter	Type	Default value
x	number	0
y	number	x

Returns

Vector2i

Properties

Property	Type	Defined in
x	number	math/vector2i.ts:6
y	number	math/vector2i.ts:7

Methods

get()

get(i: number): number;

Defined in: math/vector2i.ts:22

Get an axis from the vector.

Parameters

Parameter	Type	Description
i	number	Axis index in range [0, 1].

Returns

number

---

set()

set(i: number, v: number): void;

Defined in: math/vector2i.ts:31

Set an axis value to the vector.

Parameters

Parameter	Type	Description
i	number	Axis index in range [0, 1].
v	number	Axis value.

Returns

void

---

toString()

toString(): string;

Defined in: math/vector2i.ts:14

Returns

string

---

abs()

static abs(x: Vector2i): Vector2i;

Defined in: math/vector2i.ts:121

Returns x if x >= 0; otherwise, it returns -x.

Parameters

Parameter	Type
x	Vector2i

Returns

Vector2i

---

add()

static add(a: Vector2i, b: Vector2i): Vector2i;

Defined in: math/vector2i.ts:65

Returns addition of two vectors.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

Vector2i

---

cmpEqual()

static cmpEqual(a: Vector2i, b: Vector2i): Vector2b;

Defined in: math/vector2i.ts:107

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

Vector2b

---

cmpNotEqual()

static cmpNotEqual(a: Vector2i, b: Vector2i): Vector2b;

Defined in: math/vector2i.ts:114

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

Vector2b

---

div()

static div(a: Vector2i, b: Vector2i): Vector2i;

Defined in: math/vector2i.ts:86

Returns division of two vectors.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

Vector2i

---

eq()

static eq(a: Vector2i, b: Vector2i): boolean;

Defined in: math/vector2i.ts:93

Returns true if two vectors are equal.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

boolean

---

fromFloat()

static fromFloat(v: Vector2f): Vector2i;

Defined in: math/vector2i.ts:51

Convert a Vector2f to a Vector2i, losing precision.

Parameters

Parameter	Type
v	Vector2f

Returns

Vector2i

---

max()

static max(x: Vector2i, y: Vector2i): Vector2i;

Defined in: math/vector2i.ts:142

Returns y if x < y; otherwise, it returns x.

Parameters

Parameter	Type
x	Vector2i
y	Vector2i

Returns

Vector2i

---

min()

static min(x: Vector2i, y: Vector2i): Vector2i;

Defined in: math/vector2i.ts:135

Returns y if y < x; otherwise, it returns x.

Parameters

Parameter	Type
x	Vector2i
y	Vector2i

Returns

Vector2i

---

mul()

static mul(a: Vector2i, b: Vector2i): Vector2i;

Defined in: math/vector2i.ts:79

Returns multiplication of two vectors.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

Vector2i

---

ne()

static ne(a: Vector2i, b: Vector2i): boolean;

Defined in: math/vector2i.ts:100

Returns true if two vectors are not equal.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

boolean

---

sign()

static sign(a: Vector2i): Vector2i;

Defined in: math/vector2i.ts:128

Returns 1.0 if x > 0, 0.0 if x == 0, or -1.0 if x < 0.

Parameters

Parameter	Type
a	Vector2i

Returns

Vector2i

---

sub()

static sub(a: Vector2i, b: Vector2i): Vector2i;

Defined in: math/vector2i.ts:72

Returns subtraction of two vectors.

Parameters

Parameter	Type
a	Vector2i
b	Vector2i

Returns

Vector2i

---

unm()

static unm(a: Vector2i): Vector2i;

Defined in: math/vector2i.ts:58

Returns the negation of the vector.

Parameters

Parameter	Type
a	Vector2i

Returns

Vector2i