Class Vector3

3D Vector.

Hierarchy (View Summary)

Vector2
- Vector3
  - CommandArgumentPosition
  - Position

Index

Constructors

Properties

x y z

Accessors

Methods

equals floor getX getY getZ setX setY setZ toString trunc fromObject

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3
Create a new Vector3 instance.
Parameters
- x: number
  The X coordinate.
- y: number
  The Y coordinate.
- z: number
  The Z coordinate.
Returns Vector3
Example
```
const vector = new Vector3(10, 20, 30);
```
Overrides Vector2.constructor
- Defined in Vector3.ts:24

Properties

`Protected`x

x: number = 0

The X coordinate.

`Protected`y

y: number

The Y coordinate.

`Protected`z

z: number = 0

The Z coordinate.

Accessors

`Static`ZERO

get ZERO(): Vector3
Returns a Vector3 with 0 on all axis.

Returns Vector3
Overrides Vector2.ZERO
- Defined in Vector3.ts:10

Methods

equals

equals(vector: Vector3): boolean
Compare an instance of Vector3 with another.
Parameters
- vector: Vector3
  The Vector3 to compare to.
Returns boolean
true if they're equal otherwise false.
Overrides Vector2.equals
- Defined in Vector3.ts:86

floor

floor(): Vector3
Returns a new Vector3 with each component rounded down to the nearest integer.

Returns Vector3
A new Vector3 with rounded down components.
Overrides Vector2.floor
- Defined in Vector3.ts:69

getX

getX(): number
Get the x coordinate.

Returns number
The x coordinate's value.
Inherited from Vector2.getX
- Defined in Vector2.ts:67

getY

getY(): number
Get the y coordinate.

Returns number
The y coordinate's value.
- Defined in Vector3.ts:61

getZ

getZ(): number
Get the z coordinate.

Returns number
The z coordinate's value.
Inherited from Vector2.getZ
- Defined in Vector2.ts:75

setX

setX(x: number): void
Set the X coordinate.
Parameters
- x: number
  The X coordinate.
Returns void
Example
```
await entity.setX(10);
```
Inherited from Vector2.setX
- Defined in Vector2.ts:47

setY

setY(y: number): void
Set the Y coordinate.
Parameters
- y: number
  The Y coordinate.
Returns void
Example
```
entity.setY(10);
```
- Defined in Vector3.ts:53

setZ

setZ(z: number): void
Set the Z coordinate.
Parameters
- z: number
  The Z coordinate.
Returns void
Example
```
await entity.setZ(10);
```
Inherited from Vector2.setZ
- Defined in Vector2.ts:59

toString

toString(): string
Returns string
Overrides Vector2.toString
- Defined in Vector3.ts:32

trunc

trunc(): Vector3
Returns a new Vector3 with each component truncated to the nearest integer.

Returns Vector3
A new Vector3 with truncated axis.
Overrides Vector2.trunc
- Defined in Vector3.ts:77

`Static`fromObject

fromObject(obj: { x: number; y: number; z: number }): Vector3
Creates a new Vector3 instance from an object with x, y, and z properties.
Parameters
- obj: { x: number; y: number; z: number }
  The object containing x, y, and z properties.
Returns Vector3
A new Vector3 instance.
Overrides Vector2.fromObject
- Defined in Vector3.ts:41