bancho.js

Class: BanchoMultiplayerChannel

BanchoMultiplayerChannel

Represents a multiplayer channel on Bancho.
It is a classic discussion channel, with commands related to the linked lobby on Bancho.

new BanchoMultiplayerChannel()

Properties:
Name Type Description
lobby BanchoLobby
Source:

Extends

Methods

<async> join()

Join the channel

Inherited From:
Overrides:
Source:
Returns:
Type
Promise.<null>

<async> leave()

Leave the channel

Inherited From:
Overrides:
Source:
Returns:
Type
Promise.<null>

<async> sendAction(message)

Sends an ACTION message to this channel

Parameters:
Name Type Description
message string
Inherited From:
Overrides:
Source:
Throws:

If we're offline

Type
Error
Returns:

Resolves when message is sent (rate-limiting)

Type
Promise.<null>

<async> sendMessage(message)

Sends a message to this channel

Elevated Bancho users are advised to heavily sanitize their inputs.

Parameters:
Name Type Description
message string
Inherited From:
Overrides:
Source:
Throws:

If we're offline

Type
Error
Returns:

Resolves when message is sent (rate-limiting)

Type
Promise.<null>

Events

JOIN

Emitted when someone joins this channel

Type: BanchoChannelMember
Inherited From:
Overrides:
Source:

message

Emitted when a message is received in a BanchoChannel

Type: ChannelMessage
Inherited From:
Overrides:
Source:

PART

Emitted when someone leaves this channel

Type: BanchoChannelMember
Inherited From:
Overrides:
Source: