@temporary-escape/mod-sdk / Vector3i

Class: Vector3i

Defined in: math/vector3i.ts:6

Constructors

Constructor

new Vector3i(
   x?: number, 
   y?: number, 
   z?: number
): Vector3i;

Defined in: math/vector3i.ts:11

Parameters

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

Returns

Vector3i

Properties

Property	Type	Defined in
x	number	math/vector3i.ts:7
y	number	math/vector3i.ts:8
z	number	math/vector3i.ts:9

Methods

get()

get(i: number): number;

Defined in: math/vector3i.ts:32

Get an axis from the vector.

Parameters

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

Returns

number

---

set()

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

Defined in: math/vector3i.ts:41

Set an axis value to the vector.

Parameters

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

Returns

void

---

toString()

toString(): string;

Defined in: math/vector3i.ts:17

Returns

string

---

xy()

xy(): Vector2i;

Defined in: math/vector3i.ts:24

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

Returns

Vector2i

---

abs()

static abs(x: Vector3i): Vector3i;

Defined in: math/vector3i.ts:133

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

Parameters

Parameter	Type
x	Vector3i

Returns

Vector3i

---

add()

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

Defined in: math/vector3i.ts:77

Returns addition of two vectors.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

Vector3i

---

cmpEqual()

static cmpEqual(a: Vector3i, b: Vector3i): Vector3b;

Defined in: math/vector3i.ts:119

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

Vector3b

---

cmpNotEqual()

static cmpNotEqual(a: Vector3i, b: Vector3i): Vector3b;

Defined in: math/vector3i.ts:126

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

Vector3b

---

div()

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

Defined in: math/vector3i.ts:98

Returns division of two vectors.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

Vector3i

---

eq()

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

Defined in: math/vector3i.ts:105

Returns true if two vectors are equal.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

boolean

---

fromFloat()

static fromFloat(v: Vector3f): Vector3i;

Defined in: math/vector3i.ts:63

Convert a Vector3f to a Vector3i, losing precision.

Parameters

Parameter	Type
v	Vector3f

Returns

Vector3i

---

max()

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

Defined in: math/vector3i.ts:154

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

Parameters

Parameter	Type
x	Vector3i
y	Vector3i

Returns

Vector3i

---

min()

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

Defined in: math/vector3i.ts:147

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

Parameters

Parameter	Type
x	Vector3i
y	Vector3i

Returns

Vector3i

---

mul()

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

Defined in: math/vector3i.ts:91

Returns multiplication of two vectors.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

Vector3i

---

ne()

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

Defined in: math/vector3i.ts:112

Returns true if two vectors are not equal.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

boolean

---

sign()

static sign(a: Vector3i): Vector3i;

Defined in: math/vector3i.ts:140

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

Parameters

Parameter	Type
a	Vector3i

Returns

Vector3i

---

sub()

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

Defined in: math/vector3i.ts:84

Returns subtraction of two vectors.

Parameters

Parameter	Type
a	Vector3i
b	Vector3i

Returns

Vector3i

---

unm()

static unm(a: Vector3i): Vector3i;

Defined in: math/vector3i.ts:70

Returns the negation of the vector.

Parameters

Parameter	Type
a	Vector3i

Returns

Vector3i