Reader - Documentation

new Reader(input)

Source:

base/reader.js, line 9

Parameters:

Name	Type	Description
`input`	Buffer \| OsuBuffer

Members

toBuffer

Source:

base/reader.js, line 168

Returns a buffer

Methods

AccountRestricted() → {Packet}

Source:

bancho/reader.js, line 589

Returns:

Type: Packet

Announce(raw) → {Packet}

Source:

bancho/reader.js, line 160

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

BanInfo(raw) → {Packet}

Source:

bancho/reader.js, line 503

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

BeatmapInfoReply() → {Packet}

Source:

bancho/reader.js, line 373

Returns:

Type: Packet

BeatmapInfoRequest() → {Packet}

Source:

client/reader.js, line 335

Returns:

Type: Packet

CantSpectate() → {Packet}

Source:

client/reader.js, line 106

Returns:

Type: Packet

ChannelAvailable(raw) → {Packet}

Source:

bancho/reader.js, line 341

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

ChannelAvailableAutojoin(raw) → {Packet}

Source:

bancho/reader.js, line 363

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

ChannelJoin(raw) → {Packet}

Source:

client/reader.js, line 325

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

ChannelJoinSuccess(raw) → {Packet}

Source:

bancho/reader.js, line 330

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

ChannelLeave(raw) → {Packet}

Source:

client/reader.js, line 389

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

ChannelListingComplete() → {Packet}

Source:

bancho/reader.js, line 481

Returns:

Type: Packet

ChannelRevoked(raw) → {Packet}

Source:

bancho/reader.js, line 352

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

CommandError() → {Packet}

Source:

bancho/reader.js, line 22

Returns:

Type: Packet

ErrorReport() → {Packet}

Source:

client/reader.js, line 96

Returns:

Type: Packet

Exit(raw) → {Packet}

Source:

client/reader.js, line 34

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

FellowSpectatorJoined(raw) → {Packet}

Source:

bancho/reader.js, line 225

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

FellowSpectatorLeft(raw) → {Packet}

Source:

bancho/reader.js, line 236

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

FriendAdd(raw) → {Packet}

Source:

client/reader.js, line 357

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

FriendRemove(raw) → {Packet}

Source:

client/reader.js, line 368

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

FriendsList(raw) → {Packet}

Source:

bancho/reader.js, line 395

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

GetAttention() → {Packet}

Source:

bancho/reader.js, line 149

Returns:

Type: Packet

HandleIrcChangeUsername(raw) → {Packet}

Source:

bancho/reader.js, line 54

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

HandleIrcQuit() → {Packet}

Source:

bancho/reader.js, line 64

Returns:

Type: Packet

HandleOsuUpdate(raw) → {Packet}

Source:

bancho/reader.js, line 74

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

HandleUserQuit(raw) → {Packet}

Source:

bancho/reader.js, line 85

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

Invite(raw) → {Packet}

Source:

client/reader.js, line 433

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

Invite(raw) → {Packet}

Source:

bancho/reader.js, line 471

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

LobbyJoin() → {Packet}

Source:

client/reader.js, line 137

Returns:

Type: Packet

LobbyPart() → {Packet}

Source:

client/reader.js, line 127

Returns:

Type: Packet

LoginPermissions(raw) → {Packet}

Source:

bancho/reader.js, line 384

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

LoginReply(raw) → {Packet}

Source:

bancho/reader.js, line 12

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchAbort() → {Packet}

Source:

client/reader.js, line 497

Returns:

Type: Packet

MatchAllPlayersLoaded() → {Packet}

Source:

bancho/reader.js, line 278

Returns:

Type: Packet

MatchChangeMods(raw) → {Packet}

Source:

client/reader.js, line 254

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchChangePassword(raw) → {Packet}

Source:

client/reader.js, line 444

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchChangePassword(raw) → {Packet}

Source:

bancho/reader.js, line 492

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchChangeSettings(raw) → {Packet}

Source:

client/reader.js, line 212

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchChangeSlot(raw) → {Packet}

Source:

client/reader.js, line 180

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchChangeTeam() → {Packet}

Source:

client/reader.js, line 378

Returns:

Type: Packet

MatchComplete() → {Packet}

Source:

client/reader.js, line 243

Returns:

Type: Packet

MatchComplete() → {Packet}

Source:

bancho/reader.js, line 299

Returns:

Type: Packet

MatchCreate(raw) → {Packet}

Source:

client/reader.js, line 148

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchDisband(raw) → {Packet}

Source:

bancho/reader.js, line 193

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchFailed() → {Packet}

Source:

client/reader.js, line 294

Returns:

Type: Packet

MatchHasBeatmap() → {Packet}

Source:

client/reader.js, line 304

Returns:

Type: Packet

MatchJoin(raw) → {Packet}

Source:

client/reader.js, line 159

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchJoinFail() → {Packet}

Source:

bancho/reader.js, line 214

Returns:

Type: Packet

MatchJoinSuccess(raw) → {Packet}

Source:

bancho/reader.js, line 204

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchLoadComplete() → {Packet}

Source:

client/reader.js, line 264

Returns:

Type: Packet

MatchLock(raw) → {Packet}

Source:

client/reader.js, line 201

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchNew(raw) → {Packet}

Source:

bancho/reader.js, line 182

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchNoBeatmap() → {Packet}

Source:

client/reader.js, line 274

Returns:

Type: Packet

MatchNotReady() → {Packet}

Source:

client/reader.js, line 284

Returns:

Type: Packet

MatchPart() → {Packet}

Source:

client/reader.js, line 169

Returns:

Type: Packet

MatchPlayerFailed(raw) → {Packet}

Source:

bancho/reader.js, line 289

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchPlayerSkipped(raw) → {Packet}

Source:

bancho/reader.js, line 438

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchReady() → {Packet}

Source:

client/reader.js, line 190

Returns:

Type: Packet

MatchScoreUpdate(raw) → {Packet}

Source:

bancho/reader.js, line 258

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchScoreUpdate(raw) → {Packet}

Source:

client/reader.js, line 233

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchSkip() → {Packet}

Source:

bancho/reader.js, line 309

Returns:

Type: Packet

MatchSkipRequest() → {Packet}

Source:

client/reader.js, line 314

Returns:

Type: Packet

MatchStart(raw) → {Packet}

Source:

bancho/reader.js, line 247

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchStart() → {Packet}

Source:

client/reader.js, line 222

Returns:

Type: Packet

MatchTransferHost(raw) → {Packet}

Source:

client/reader.js, line 346

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

MatchTransferHost() → {Packet}

Source:

bancho/reader.js, line 268

Returns:

Type: Packet

MatchUpdate(raw) → {Packet}

Source:

bancho/reader.js, line 171

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

Monitor() → {Packet}

Source:

bancho/reader.js, line 427

Returns:

Type: Packet

Parse() → {Array}

Source:

base/reader.js, line 138

Attempts to parse the whole buffer and returns an array of packets

Returns:

Type: Array

Ping() → {Packet}

Source:

bancho/reader.js, line 43

Returns:

Type: Packet

Pong() → {Packet}

Source:

client/reader.js, line 54

Returns:

Type: Packet

ProtocolNegotiation(raw) → {Packet}

Source:

bancho/reader.js, line 406

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

Read(buff, layout) → {Object|Array}

Source:

base/reader.js, line 20

Reads a set of data from a buffer

Parameters:

Name	Type	Description
`buff`	OsuBuffer
`layout`	Object

Returns:

Type: Object | Array

ReceiveUpdates(raw) → {Packet}

Source:

client/reader.js, line 400

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

RequestStatusUpdate() → {Packet}

Source:

client/reader.js, line 44

Returns:

Type: Packet

Restart(raw) → {Packet}

Source:

bancho/reader.js, line 460

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

RTX(raw) → {Packet}

Source:

bancho/reader.js, line 600

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SendIrcMessage(raw) → {Packet}

Source:

client/reader.js, line 23

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SendIrcMessagePrivate(raw) → {Packet}

Source:

client/reader.js, line 117

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SendMessage(raw) → {Packet}

Source:

bancho/reader.js, line 33

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SendUserStatus(raw) → {Packet}

Source:

client/reader.js, line 12

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SetIrcAwayMessage(raw) → {Packet}

Source:

client/reader.js, line 411

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpecialJoinMatchChannel(raw) → {Packet}

Source:

client/reader.js, line 508

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpecialLeaveMatchChannel(raw) → {Packet}

Source:

client/reader.js, line 519

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpecialMatchInfoRequest(raw) → {Packet}

Source:

client/reader.js, line 455

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpectateFrames(raw) → {Packet}

Source:

client/reader.js, line 86

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpectateFrames(raw) → {Packet}

Source:

bancho/reader.js, line 118

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpectatorCantSpectate(raw) → {Packet}

Source:

bancho/reader.js, line 139

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpectatorJoined(raw) → {Packet}

Source:

bancho/reader.js, line 96

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SpectatorLeft(raw) → {Packet}

Source:

bancho/reader.js, line 107

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

StartSpectating(raw) → {Packet}

Source:

client/reader.js, line 65

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

StopSpectating() → {Packet}

Source:

client/reader.js, line 75

Returns:

Type: Packet

SwitchServer(raw) → {Packet}

Source:

bancho/reader.js, line 579

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

SwitchTourneyServer(raw) → {Packet}

Source:

bancho/reader.js, line 611

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

TargetIsSilenced(raw) → {Packet}

Source:

bancho/reader.js, line 558

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

TitleUpdate(raw) → {Packet}

Source:

bancho/reader.js, line 417

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

Unauthorised() → {Packet}

Source:

bancho/reader.js, line 319

Returns:

Type: Packet

UnmarshalPacket(raw, layout) → {Object|Null}

Source:

base/reader.js, line 115

Unmarshal's the buffer from the layout

Parameters:

Name	Type	Default	Description
`raw`	OsuBuffer \| Buffer
`layout`	Array \| Object \| Null	`null`

Returns:

Type: Object | Null

UserPMBlocked(raw) → {Packet}

Source:

bancho/reader.js, line 547

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserPresence(raw) → {Packet}

Source:

bancho/reader.js, line 449

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserPresenceBundle(raw) → {Packet}

Source:

bancho/reader.js, line 536

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserPresenceRequest(raw) → {Packet}

Source:

client/reader.js, line 466

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserPresenceRequestAll() → {Packet}

Source:

client/reader.js, line 476

Returns:

Type: Packet

UserPresenceSingle(raw) → {Packet}

Source:

bancho/reader.js, line 525

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserSilenced(raw) → {Packet}

Source:

bancho/reader.js, line 514

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserStatsRequest(raw) → {Packet}

Source:

client/reader.js, line 422

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

UserToggleBlockNonFriendPM(raw) → {Packet}

Source:

client/reader.js, line 487

Parameters:

Name	Type	Description
`raw`	OsuBuffer

Returns:

Type: Packet

VersionUpdate() → {Packet}

Source:

bancho/reader.js, line 128

Returns:

Type: Packet

VersionUpdateForced() → {Packet}

Source:

bancho/reader.js, line 568

Returns:

Type: Packet