bancho.js

Classes

Classes

BanchoBotStatsReturn
BanchoChannel
BanchoChannelMember
BanchoChannelMemberMode
BanchoClient
Banchojs
BanchoLobby
BanchoLobbyPlayer
BanchoLobbyPlayerScore
BanchoMessage
BanchoMod
BanchoMods
BanchoMultiplayerChannel
BanchoUser
BanchoWhoisReturn
ChannelMessage
OutgoingBanchoMessage
PrivateMessage

Events

JOIN

Emitted when someone joins this channel

Type: BanchoChannelMember
Source:

message

Emitted when a message is received in a BanchoChannel

Type: ChannelMessage
Source:

PART

Emitted when someone leaves this channel

Type: BanchoChannelMember
Source:

CM

Fired when a channel message is received, or sent from us (check for the self property).

Type: ChannelMessage
Source:

connected

Connected to Bancho!

Source:

disconnected

Disconnected from Bancho!

Type: Error
Source:

error

An error has occured on the socket.

Type: Error
Source:

JOIN

Fired when a user has joined a channel

Type: BanchoChannelMember
Source:

nochannel

Fired when a no channel error is received from Bancho.

Type: BanchoChannel
Source:

nouser

Fired when a no user error is received from Bancho.

Type: BanchoUser
Source:

PART

Fired when a user has left a channel

Type: BanchoChannelMember
Source:

PM

Fired when a PM is received, or sent from us (check for the self property).

Type: PrivateMessage
Source:

QUIT

Fired when a user has disconnected from Bancho (with no other client opened)

Type: BanchoUser
Source:

rejectedMessage

Fired when Bancho sends us back a PM that couldn't be sent.
As far as we know, only happens when a PM is rejected because the recipient blocks messages from non-friends.

Type: PrivateMessage
Source:

state

ConnectState has updated! Emits with an error if any.

Type: Error
Source:

allPlayersReady

Source:

beatmap

Fired when the beatmap property is updated from the API

Type: nodesu.Beatmap
Source:

beatmapId

Fired when the beatmapId is updated

Type: number
Source:

beatmapNotFound

Emitted when a selected map is not found on the osu! API.

Type: number
Source:

freemod

Fired when the lobby's freemod property is updated

Type: boolean
Source:

gamemode

Fired when the gamemode of the lobby is updated

Type: nodesu.Mode
Source:

host

Type: BanchoLobbyPlayer
Source:

hostCleared

Source:

invalidBeatmapId

Source:

matchAborted

Source:

matchFinished

Sorted scores array

Type: Array.<BanchoLobbyPlayerScore>
Source:

matchSettings

Type: object
Properties:
Name Type Description
size number
teamMode number

See BanchoLobbyTeamModes
winCondition number

See BanchoLobbyWinConditions
Source:

matchStarted

Source:

mods

Fired when the lobby's mods are updated

Type: Array.<BanchoMod>
Source:

name

Fired when the name of the lobby is updated

Type: string
Source:

passwordChanged

Source:

passwordRemoved

Source:

playerChangedTeam

Type: object
Properties:
Name Type Description
player BanchoLobbyPlayer
team string

See BanchoLobbyTeams
Source:

playerFinished

Type: BanchoLobbyPlayerScore
Source:

playerJoined

Type: object
Properties:
Name Type Description
player BanchoLobbyPlayer
slot number

Starting from 0
team string

Blue or Red
Source:

playerLeft

Type: BanchoLobbyPlayer
Source:

playerMoved

Type: object
Properties:
Name Type Description
player BanchoLobbyPlayer
slot number

Starting from 0
Source:

playing

Fired when the lobby starts or stops playing

Type: Symbol
Source:
See:
  • {BanchoLobbyState}

refereeAdded

Type: string
Source:

refereeRemoved

Type: string
Source:

size

Fired when the size of the lobby is updated

Type: number
Source:

slots

Fired when the slots of the lobby are updated

Type: Array.<BanchoLobbyPlayer>
Source:

slotsLocked

Source:

slotsUnlocked

Source:

startTimerAborted

Emitted when a start timer is aborted

Source:

startTimerStarted

Emitted when a start timer is started

Source:

startTimerTick

Emitted when a start timer ticks

Type: object
Properties:
Name Type Description
seconds number
Source:

teamMode

Fired when the team mode is updated

Type: number
Source:
See:

timerAborted

Emitted when a timer is aborted

Source:

timerEnded

Emitted when a timer ends

Source:

timerTick

Emitted when a timer ticks

Type: object
Properties:
Name Type Description
seconds number
Source:

userNotFound

Source:

userNotFoundUsername

Type: string
Source:

winCondition

Fired when the win condition is updated

Type: number
Source:
See:

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:

message

Emitted when a message is received from a BanchoUser

Type: PrivateMessage
Source: