Client

Source: client.ts:111

High-level client.

Type Parameters

• IsReady extends boolean = boolean

Constructors

new Client< IsReady extends boolean = boolean, >( options: ClientOption, ): Client<IsReady>

Parameters

• options (ClientOption)

Returns

Client<IsReady>

Properties

emit: (event: K, args: ClientEvents[K] extends any[] ? any[any] : never) => void

on: (event: K, func: ClientEvents[K] extends any[] ? (args: any[any]) => void : never) => void

once: (event: K, func: ClientEvents[K] extends any[] ? (args: any[any]) => void : never) => void

Methods

at

Get the block state at position

Parameters

• x (number)
• y (number)
• z (number)

Returns

• BlockState | null

Get the block state at position

Parameters

• position (BaseVec3)

Returns

• BlockState | null

chat(message: string): void

Send a message

Parameters

• message (string)

Returns

• void

connect(): Promise<void>

Create a connection to the server

Returns

• Promise<void>

disconnect(reason: string, raw?: TextComponent): void

Destroy the connection

Parameters

• reason (string, default: "\"Disconnect\"")
• raw (TextComponent, optional)

Returns

• void

hold(inout: Input): void

Press and hold a key

Parameters

• inout (Input)

Returns

• void

lookAt(yaw: number, pitch: number): void

Rotate your face

Parameters

• yaw (number) — In degree
• pitch (number) — In degree

Returns

• void

release(input: Input): void

Release a key

Parameters

• input (Input)

Returns

• void

stopMoving(): void

Release all key

Returns

• void