@temporary-escape/mod-sdk / Vector3b

Class: Vector3b

Defined in: math/vector3b.ts:4

Constructors

Constructor

new Vector3b(
   x?: boolean, 
   y?: boolean, 
   z?: boolean
): Vector3b;

Defined in: math/vector3b.ts:9

Parameters

Parameter	Type	Default value
x	boolean	false
y	boolean	x
z	boolean	x

Returns

Vector3b

Properties

Property	Type	Defined in
x	boolean	math/vector3b.ts:5
y	boolean	math/vector3b.ts:6
z	boolean	math/vector3b.ts:7

Methods

get()

get(i: number): boolean;

Defined in: math/vector3b.ts:30

Get an axis from the vector.

Parameters

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

Returns

boolean

---

set()

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

Defined in: math/vector3b.ts:39

Set an axis value to the vector.

Parameters

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

Returns

void

---

toString()

toString(): string;

Defined in: math/vector3b.ts:15

Returns

string

---

xy()

xy(): Vector2b;

Defined in: math/vector3b.ts:22

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

Returns

Vector2b

---

add()

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

Defined in: math/vector3b.ts:59

Returns addition of two vectors.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

Vector3b

---

all()

static all(a: Vector3b): boolean;

Defined in: math/vector3b.ts:122

Returns true if all components of x are true.

Parameters

Parameter	Type
a	Vector3b

Returns

boolean

---

any()

static any(a: Vector3b): boolean;

Defined in: math/vector3b.ts:115

Returns true if any component of x is true.

Parameters

Parameter	Type
a	Vector3b

Returns

boolean

---

cmpEqual()

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

Defined in: math/vector3b.ts:101

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

Vector3b

---

cmpNotEqual()

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

Defined in: math/vector3b.ts:108

Component-wise comparison of two vectors.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

Vector3b

---

div()

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

Defined in: math/vector3b.ts:80

Returns division of two vectors.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

Vector3b

---

eq()

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

Defined in: math/vector3b.ts:87

Returns true if two vectors are equal.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

boolean

---

mul()

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

Defined in: math/vector3b.ts:73

Returns multiplication of two vectors.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

Vector3b

---

ne()

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

Defined in: math/vector3b.ts:94

Returns true if two vectors are not equal.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

boolean

---

sub()

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

Defined in: math/vector3b.ts:66

Returns subtraction of two vectors.

Parameters

Parameter	Type
a	Vector3b
b	Vector3b

Returns

Vector3b

---

unm()

static unm(a: Vector3b): Vector3b;

Defined in: math/vector3b.ts:52

Returns the negation of the vector.

Parameters

Parameter	Type
a	Vector3b

Returns

Vector3b