@temporary-escape/mod-sdk / Vector4i

Class: Vector4i

Defined in: math/vector4i.ts:7

Constructors

Constructor

new Vector4i(
   x?: number, 
   y?: number, 
   z?: number, 
   w?: number
): Vector4i;

Defined in: math/vector4i.ts:13

Parameters

Parameter	Type	Default value
x	number	0
y	number	x
z	number	x
w	number	x

Returns

Vector4i

Properties

Property	Type	Defined in
w	number	math/vector4i.ts:11
x	number	math/vector4i.ts:8
y	number	math/vector4i.ts:9
z	number	math/vector4i.ts:10

Methods

get()

get(i: number): number;

Defined in: math/vector4i.ts:42

Get an axis from the vector.

Parameters

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

Returns

number

---

set()

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

Defined in: math/vector4i.ts:51

Set an axis value to the vector.

Parameters

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

Returns

void

---

toString()

toString(): string;

Defined in: math/vector4i.ts:20

Returns

string

---

xy()

xy(): Vector2i;

Defined in: math/vector4i.ts:27

Returns a vector containing the x and y components of this vector.

Returns

Vector2i

---

xyz()

xyz(): Vector3i;

Defined in: math/vector4i.ts:34

Returns a vector containing the x, y and z components of this vector.

Returns

Vector3i

---

abs()

static abs(x: Vector4i): Vector4i;

Defined in: math/vector4i.ts:145

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

Parameters

Parameter	Type
x	Vector4i

Returns

Vector4i

---

add()

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

Defined in: math/vector4i.ts:89

Returns addition of two vectors.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

Vector4i

---

cmpEqual()

static cmpEqual(a: Vector4i, b: Vector4i): Vector4b;

Defined in: math/vector4i.ts:131

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

Vector4b

---

cmpNotEqual()

static cmpNotEqual(a: Vector4i, b: Vector4i): Vector4b;

Defined in: math/vector4i.ts:138

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

Vector4b

---

div()

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

Defined in: math/vector4i.ts:110

Returns division of two vectors.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

Vector4i

---

eq()

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

Defined in: math/vector4i.ts:117

Returns true if two vectors are equal.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

boolean

---

fromFloat()

static fromFloat(v: Vector4f): Vector4i;

Defined in: math/vector4i.ts:75

Convert a Vector4f to a Vector4i, losing precision.

Parameters

Parameter	Type
v	Vector4f

Returns

Vector4i

---

max()

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

Defined in: math/vector4i.ts:176

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

Parameters

Parameter	Type
x	Vector4i
y	Vector4i

Returns

Vector4i

---

min()

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

Defined in: math/vector4i.ts:169

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

Parameters

Parameter	Type
x	Vector4i
y	Vector4i

Returns

Vector4i

---

mul()

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

Defined in: math/vector4i.ts:103

Returns multiplication of two vectors.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

Vector4i

---

ne()

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

Defined in: math/vector4i.ts:124

Returns true if two vectors are not equal.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

boolean

---

sign()

static sign(a: Vector4i): Vector4i;

Defined in: math/vector4i.ts:157

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

Parameters

Parameter	Type
a	Vector4i

Returns

Vector4i

---

sub()

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

Defined in: math/vector4i.ts:96

Returns subtraction of two vectors.

Parameters

Parameter	Type
a	Vector4i
b	Vector4i

Returns

Vector4i

---

unm()

static unm(a: Vector4i): Vector4i;

Defined in: math/vector4i.ts:82

Returns the negation of the vector.

Parameters

Parameter	Type
a	Vector4i

Returns

Vector4i