Class Channel

The channel for send and listen the Minecraft packet.

🏭 Constructors

constructor

Channel(): Channel

Return Type

• Channel

Defined in: packages/client/channel.ts:47

🏷️ Properties

state

state: keyof States = 'handshake'

Defined in: packages/client/channel.ts:21

🔑 Accessors

ready

Defined in: packages/client/channel.ts:71

🔧 Methods

disconnect

disconnect(): Promise<void>

Return Type

• Promise<void>

Defined in: packages/client/channel.ts:124

findCoderById

findCoderById(packetId: number, side: Side): Coder<any>

Parameters

• packetId: number
• side: Side

Return Type

• Coder<any>

Defined in: packages/client/channel.ts:75

getPacketId

getPacketId(packetInst: any, side: Side): number

Parameters

• packetInst: any
• side: Side

Return Type

• number

Defined in: packages/client/channel.ts:80

listen

listen(option: NetConnectOpts & { keepalive?: number | boolean }): Promise<void>

Open the connection and start to listen the port.

Parameters

• option: NetConnectOpts & { keepalive?: number | boolean }

Return Type

• Promise<void>

Defined in: packages/client/channel.ts:104

on

on(channel: string, listener: (event: T) => void): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

• channel: string
• listener: (event: T) => void The callback function

Return Type

• this

Inherited from: EventEmitter.on

Defined in: packages/client/channel.ts:172

once

once(channel: string, listener: (event: T) => void): this

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

• channel: string
• listener: (event: T) => void The callback function

Return Type

• this

Inherited from: EventEmitter.once

Defined in: packages/client/channel.ts:173

oncePacket

oncePacket(packet: (args: any[]) => T, listener: (event: T) => void): this

Parameters

• packet: (args: any[]) => T
• listener: (event: T) => void

Return Type

• this

Defined in: packages/client/channel.ts:166

onPacket

onPacket(packet: (args: any[]) => T, listener: (event: T) => void): this

Listen for sepcific packet by its class name.

Parameters

• packet: (args: any[]) => T
• listener: (event: T) => void

Return Type

• this

Defined in: packages/client/channel.ts:162

registerPacket

registerPacket(entry: PacketRegistryEntry): void

Parameters

• entry: PacketRegistryEntry

Return Type

• void

Defined in: packages/client/channel.ts:94

registerPacketType

registerPacketType(clazz: (args: any) => any): void

Parameters

• clazz: (args: any) => any

Return Type

• void

Defined in: packages/client/channel.ts:86

send

send(message: T, skeleton: Partial<T>): Promise<void>

Sent a packet to server.

Parameters

• message: T
• skeleton: Partial<T>

Return Type

• Promise<void>

Defined in: packages/client/channel.ts:144