Class Console

Server console.

Hierarchy (View Summary)

EntityLike
- Console

Implements

Service

Index

Constructors

Properties

headYaw pitch runtimeId server uuid x y yaw z

Accessors

Lifecycle

Constructors

constructor

new Console(server: Server, runtimeId?: bigint): Console
Parameters
- server: Server
- runtimeId: bigint = ...
Returns Console
Overrides EntityLike.constructor
- Defined in packages/prismarine/src/Console.ts:28

Properties

headYaw

headYaw: number

pitch

pitch: number

`Protected` `Readonly`runtimeId

runtimeId: bigint

`Protected` `Readonly`server

server: Server

`Protected` `Readonly`uuid

uuid: string

`Protected`x

x: number = 0

The X coordinate.

`Protected`y

y: number

The Y coordinate.

yaw

yaw: number

`Protected`z

z: number = 0

The Z coordinate.

Accessors

`Static`ZERO

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

Returns Vector3
Inherited from EntityLike.ZERO
- Defined in packages/math/src/Vector3.ts:10

Methods

equals

equals(vector: Console): boolean
Compare an instance of Vector3 with another.
Parameters
- vector: Console
  The Vector3 to compare to.
Returns boolean
true if they're equal otherwise false.
Inherited from EntityLike.equals
- Defined in packages/math/src/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.
Inherited from EntityLike.floor
- Defined in packages/math/src/Vector3.ts:69

getFormattedUsername

getFormattedUsername(): string
Returns string
- Defined in packages/prismarine/src/Console.ts:135

getName

getName(): string
Returns string
- Defined in packages/prismarine/src/Console.ts:131

getNearestEntity

getNearestEntity(entities?: Entity[]): Entity[]
Returns the nearest entity from the current entity.
Parameters
- Optionalentities: Entity[] = ...
  The entities to compare the distance between.
Returns Entity[]
The nearest entity.
Todo
Customizable radius
Example
```
const nearestEntity = entity.getNearestEntity();
console.log('Nearest entity:', nearestEntity);
```
Inherited from EntityLike.getNearestEntity
- Defined in packages/prismarine/src/entity/Entity.ts:106

getPosition

getPosition(): Vector3
Get the entity's position.

Returns Vector3
The entity's position.
Example
```
const position = entity.getPosition();
```
Overrides EntityLike.getPosition
- Defined in packages/prismarine/src/Console.ts:165

getRuntimeId

getRuntimeId(): bigint
Get the entity's runtime id.

Returns bigint
The entity's runtime id.
Inherited from EntityLike.getRuntimeId
- Defined in packages/prismarine/src/entity/Entity.ts:71

getServer

getServer(): Server
Get the server instance.

Returns Server
The server instance.
Inherited from EntityLike.getServer
- Defined in packages/prismarine/src/entity/Entity.ts:79

getType

getType(): string
Returns string
- Defined in packages/prismarine/src/Console.ts:169

getWorld

getWorld(): World
Get the world of the position.

Returns World
The world of the position.
Overrides EntityLike.getWorld
- Defined in packages/prismarine/src/Console.ts:143

getX

getX(): number
Get the x coordinate.

Returns number
The x coordinate's value.
Overrides EntityLike.getX
- Defined in packages/prismarine/src/Console.ts:155

getY

getY(): number
Get the y coordinate.

Returns number
The y coordinate's value.
Overrides EntityLike.getY
- Defined in packages/prismarine/src/Console.ts:158

getZ

getZ(): number
Get the z coordinate.

Returns number
The z coordinate's value.
Overrides EntityLike.getZ
- Defined in packages/prismarine/src/Console.ts:161

isConsole

isConsole(): boolean
Returns boolean
- Defined in packages/prismarine/src/Console.ts:173

isOp

isOp(): boolean
Returns boolean
- Defined in packages/prismarine/src/Console.ts:151

isPlayer

isPlayer(): boolean
Returns boolean
- Defined in packages/prismarine/src/Console.ts:147

sendMessage

sendMessage(message: string): Promise<void>
Parameters
- message: string
Returns Promise<void>
- Defined in packages/prismarine/src/Console.ts:139

setWorld

setWorld(world: World): void
Set the world of the position.
Parameters
- world: World
  The world to set.
Returns void
Inherited from EntityLike.setWorld
- Defined in packages/prismarine/src/world/Position.ts:57

setX

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

setY

setY(y: number): void
Set the Y coordinate.
Parameters
- y: number
  The Y coordinate.
Returns void
Example
```
entity.setY(10);
```
Inherited from EntityLike.setY
- Defined in packages/math/src/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 EntityLike.setZ
- Defined in packages/math/src/Vector2.ts:59

toString

toString(): string
Returns string
Inherited from EntityLike.toString
- Defined in packages/prismarine/src/world/Position.ts:26

trunc

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

Returns Vector3
A new Vector3 with truncated axis.
Inherited from EntityLike.trunc
- Defined in packages/math/src/Vector3.ts:77

write

write(line: string): void
Parameters
- line: string
Returns void
- Defined in packages/prismarine/src/Console.ts:120

`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.
Inherited from EntityLike.fromObject
- Defined in packages/math/src/Vector3.ts:41

`Static`fromVector3

fromVector3(vector: Vector3, world: World): Position
Creates a Position from a Vector3 and a World.
Parameters
- vector: Vector3
  The vector to create the position from.
- world: World
  The world of the position.
Returns Position
The new position.
Inherited from EntityLike.fromVector3
- Defined in packages/prismarine/src/world/Position.ts:36

Lifecycle

disable

disable(): Promise<void>
On disable hook.

Returns Promise<void>
Implementation of Service.disable
- Defined in packages/prismarine/src/Console.ts:99

enable

enable(): Promise<void>
On enable hook.

Returns Promise<void>
Implementation of Service.enable
- Defined in packages/prismarine/src/Console.ts:41