Writer - Documentation

new Writer(input)

Source:

base/writer.js, line 8

Parameters:

Name	Type	Description
`input`	Buffer \| OsuBuffer \| undefined

Members

toBuffer

Source:

base/writer.js, line 177

Returns a buffer

Methods

AccountRestricted() → {Writer}

Source:

bancho/writer.js, line 589

Returns:

Type: Writer

Announce(data) → {Writer}

Source:

bancho/writer.js, line 160

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

BanInfo(data) → {Writer}

Source:

bancho/writer.js, line 503

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

BeatmapInfoReply() → {Writer}

Source:

bancho/writer.js, line 373

Returns:

Type: Writer

BeatmapInfoRequest() → {Writer}

Source:

client/writer.js, line 335

Returns:

Type: Writer

CantSpectate() → {Writer}

Source:

client/writer.js, line 106

Returns:

Type: Writer

ChannelAvailable(data) → {Writer}

Source:

bancho/writer.js, line 341

Parameters:

Name	Type	Description
`data`	Channel

Returns:

Type: Writer

ChannelAvailableAutojoin(data) → {Writer}

Source:

bancho/writer.js, line 363

Parameters:

Name	Type	Description
`data`	Channel

Returns:

Type: Writer

ChannelJoin(data) → {Writer}

Source:

client/writer.js, line 325

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

ChannelJoinSuccess(data) → {Writer}

Source:

bancho/writer.js, line 330

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

ChannelLeave(data) → {Writer}

Source:

client/writer.js, line 389

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

ChannelListingComplete() → {Writer}

Source:

bancho/writer.js, line 481

Returns:

Type: Writer

ChannelRevoked(data) → {Writer}

Source:

bancho/writer.js, line 352

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

CommandError() → {Writer}

Source:

bancho/writer.js, line 22

Returns:

Type: Writer

ErrorReport() → {Writer}

Source:

client/writer.js, line 96

Returns:

Type: Writer

Exit(data) → {Writer}

Source:

client/writer.js, line 34

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

FellowSpectatorJoined(data) → {Writer}

Source:

bancho/writer.js, line 225

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

FellowSpectatorLeft(data) → {Writer}

Source:

bancho/writer.js, line 236

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

FriendAdd(data) → {Writer}

Source:

client/writer.js, line 357

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

FriendRemove(data) → {Writer}

Source:

client/writer.js, line 368

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

FriendsList(data) → {Writer}

Source:

bancho/writer.js, line 395

Parameters:

Name	Type	Description
`data`	Array

Returns:

Type: Writer

GetAttention() → {Writer}

Source:

bancho/writer.js, line 149

Returns:

Type: Writer

HandleIrcChangeUsername(data) → {Writer}

Source:

bancho/writer.js, line 53

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

HandleIrcQuit() → {Writer}

Source:

bancho/writer.js, line 63

Returns:

Type: Writer

HandleOsuUpdate(data) → {Writer}

Source:

bancho/writer.js, line 74

Parameters:

Name	Type	Description
`data`	OsuUpdate

Returns:

Type: Writer

HandleUserQuit(data) → {Writer}

Source:

bancho/writer.js, line 85

Parameters:

Name	Type	Description
`data`	UserQuit

Returns:

Type: Writer

Invite(data) → {Writer}

Source:

bancho/writer.js, line 471

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

Invite(data) → {Writer}

Source:

client/writer.js, line 433

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

LobbyJoin() → {Writer}

Source:

client/writer.js, line 137

Returns:

Type: Writer

LobbyPart() → {Writer}

Source:

client/writer.js, line 127

Returns:

Type: Writer

LoginPermissions(data) → {Writer}

Source:

bancho/writer.js, line 384

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

LoginReply(data) → {Writer}

Source:

bancho/writer.js, line 12

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MarshalPacket(data, layout) → {Buffer}

Source:

base/writer.js, line 138

Marshal's a packet to a buffer from a layout

Parameters:

Name	Type	Default	Description
`data`	Object \| Number \| String \| Boolean \| Array \| Null	`null`
`layout`	Array \| Object

Returns:

Type: Buffer

MatchAbort() → {Writer}

Source:

client/writer.js, line 497

Returns:

Type: Writer

MatchAllPlayersLoaded() → {Writer}

Source:

bancho/writer.js, line 278

Returns:

Type: Writer

MatchChangeMods(data) → {Writer}

Source:

client/writer.js, line 254

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchChangePassword(data) → {Writer}

Source:

client/writer.js, line 444

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

MatchChangePassword(data) → {Writer}

Source:

bancho/writer.js, line 492

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

MatchChangeSettings(data) → {Writer}

Source:

client/writer.js, line 212

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

MatchChangeSlot(data) → {Writer}

Source:

client/writer.js, line 180

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchChangeTeam() → {Writer}

Source:

client/writer.js, line 378

Returns:

Type: Writer

MatchComplete() → {Writer}

Source:

bancho/writer.js, line 299

Returns:

Type: Writer

MatchComplete() → {Writer}

Source:

client/writer.js, line 243

Returns:

Type: Writer

MatchCreate(data) → {Writer}

Source:

client/writer.js, line 148

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

MatchDisband(data) → {Writer}

Source:

bancho/writer.js, line 193

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchFailed() → {Writer}

Source:

client/writer.js, line 294

Returns:

Type: Writer

MatchHasBeatmap() → {Writer}

Source:

client/writer.js, line 304

Returns:

Type: Writer

MatchJoin(data) → {Writer}

Source:

client/writer.js, line 159

Parameters:

Name	Type	Description
`data`	MatchJoin

Returns:

Type: Writer

MatchJoinFail() → {Writer}

Source:

bancho/writer.js, line 214

Returns:

Type: Writer

MatchJoinSuccess(data) → {Writer}

Source:

bancho/writer.js, line 204

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

MatchLoadComplete() → {Writer}

Source:

client/writer.js, line 264

Returns:

Type: Writer

MatchLock(data) → {Writer}

Source:

client/writer.js, line 201

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchNew(data) → {Writer}

Source:

bancho/writer.js, line 182

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

MatchNoBeatmap() → {Writer}

Source:

client/writer.js, line 274

Returns:

Type: Writer

MatchNotReady() → {Writer}

Source:

client/writer.js, line 284

Returns:

Type: Writer

MatchPart() → {Writer}

Source:

client/writer.js, line 169

Returns:

Type: Writer

MatchPlayerFailed(data) → {Writer}

Source:

bancho/writer.js, line 289

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchPlayerSkipped(data) → {Writer}

Source:

bancho/writer.js, line 438

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchReady() → {Writer}

Source:

client/writer.js, line 190

Returns:

Type: Writer

MatchScoreUpdate(data) → {Writer}

Source:

client/writer.js, line 233

Parameters:

Name	Type	Description
`data`	ScoreFrame

Returns:

Type: Writer

MatchScoreUpdate(data) → {Writer}

Source:

bancho/writer.js, line 258

Parameters:

Name	Type	Description
`data`	ScoreFrame

Returns:

Type: Writer

MatchSkip() → {Writer}

Source:

bancho/writer.js, line 309

Returns:

Type: Writer

MatchSkipRequest() → {Writer}

Source:

client/writer.js, line 314

Returns:

Type: Writer

MatchStart(data) → {Writer}

Source:

bancho/writer.js, line 247

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

MatchStart() → {Writer}

Source:

client/writer.js, line 222

Returns:

Type: Writer

MatchTransferHost(data) → {Writer}

Source:

client/writer.js, line 346

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

MatchTransferHost() → {Writer}

Source:

bancho/writer.js, line 268

Returns:

Type: Writer

MatchUpdate(data) → {Writer}

Source:

bancho/writer.js, line 171

Parameters:

Name	Type	Description
`data`	Match

Returns:

Type: Writer

Monitor() → {Writer}

Source:

bancho/writer.js, line 427

Returns:

Type: Writer

Ping() → {Writer}

Source:

bancho/writer.js, line 42

Returns:

Type: Writer

Pong() → {Writer}

Source:

client/writer.js, line 54

Returns:

Type: Writer

ProtocolNegotiation(data) → {Writer}

Source:

bancho/writer.js, line 406

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

ReceiveUpdates(data) → {Writer}

Source:

client/writer.js, line 400

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

RequestStatusUpdate() → {Writer}

Source:

client/writer.js, line 44

Returns:

Type: Writer

Restart(data) → {Writer}

Source:

bancho/writer.js, line 460

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

RTX(data) → {Writer}

Source:

bancho/writer.js, line 600

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

SendIrcMessage(data) → {Writer}

Source:

client/writer.js, line 23

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

SendIrcMessagePrivate(data) → {Writer}

Source:

client/writer.js, line 117

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

SendMessage(data) → {Writer}

Source:

bancho/writer.js, line 32

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

SendUserStatus(data) → {Writer}

Source:

client/writer.js, line 12

Parameters:

Name	Type	Description
`data`	UserStatus

Returns:

Type: Writer

SetIrcAwayMessage(data) → {Writer}

Source:

client/writer.js, line 411

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

SpecialJoinMatchChannel(data) → {Writer}

Source:

client/writer.js, line 508

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

SpecialLeaveMatchChannel(data) → {Writer}

Source:

client/writer.js, line 519

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

SpecialMatchInfoRequest(data) → {Writer}

Source:

client/writer.js, line 455

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

SpectateFrames(data) → {Writer}

Source:

bancho/writer.js, line 118

Parameters:

Name	Type	Description
`data`	ReplayFrame

Returns:

Type: Writer

SpectateFrames(data) → {Writer}

Source:

client/writer.js, line 86

Parameters:

Name	Type	Description
`data`	ReplayFrame

Returns:

Type: Writer

SpectatorCantSpectate(data) → {Writer}

Source:

bancho/writer.js, line 139

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

SpectatorJoined(data) → {Writer}

Source:

bancho/writer.js, line 96

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

SpectatorLeft(data) → {Writer}

Source:

bancho/writer.js, line 107

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

StartSpectating(data) → {Writer}

Source:

client/writer.js, line 65

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

StopSpectating() → {Writer}

Source:

client/writer.js, line 75

Returns:

Type: Writer

SwitchServer(data) → {Writer}

Source:

bancho/writer.js, line 579

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

SwitchTourneyServer(data) → {Writer}

Source:

bancho/writer.js, line 611

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

TargetIsSilenced(data) → {Writer}

Source:

bancho/writer.js, line 558

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

TitleUpdate(data) → {Writer}

Source:

bancho/writer.js, line 417

Parameters:

Name	Type	Description
`data`	String

Returns:

Type: Writer

Unauthorised() → {Writer}

Source:

bancho/writer.js, line 319

Returns:

Type: Writer

UserPMBlocked(data) → {Writer}

Source:

bancho/writer.js, line 547

Parameters:

Name	Type	Description
`data`	Message

Returns:

Type: Writer

UserPresence(data) → {Writer}

Source:

bancho/writer.js, line 449

Parameters:

Name	Type	Description
`data`	UserPresence

Returns:

Type: Writer

UserPresenceBundle(data) → {Writer}

Source:

bancho/writer.js, line 536

Parameters:

Name	Type	Description
`data`	Array

Returns:

Type: Writer

UserPresenceRequest(data) → {Writer}

Source:

client/writer.js, line 466

Parameters:

Name	Type	Description
`data`	Array

Returns:

Type: Writer

UserPresenceRequestAll() → {Writer}

Source:

client/writer.js, line 476

Returns:

Type: Writer

UserPresenceSingle(data) → {Writer}

Source:

bancho/writer.js, line 525

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

UserSilenced(data) → {Writer}

Source:

bancho/writer.js, line 514

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

UserStatsRequest(data) → {Writer}

Source:

client/writer.js, line 422

Parameters:

Name	Type	Description
`data`	Array

Returns:

Type: Writer

UserToggleBlockNonFriendPM(data) → {Writer}

Source:

client/writer.js, line 487

Parameters:

Name	Type	Description
`data`	Number

Returns:

Type: Writer

VersionUpdate() → {Writer}

Source:

bancho/writer.js, line 128

Returns:

Type: Writer

VersionUpdateForced() → {Writer}

Source:

bancho/writer.js, line 568

Returns:

Type: Writer

Write(o) → {Buffer}

Source:

base/writer.js, line 20

Writes a set of data to a buffer

Parameters:

Name Type Description

o

Object

Properties

Name	Type	Attributes
`type`	String
`data`	Object \| Array \| String \| Number \| Boolean \| Null
`nullable`	Boolean	<nullable>

Returns:

Type: Buffer

WritePacket(packet) → {Writer}

Source:

base/writer.js, line 164

Writes the packet to the buffer and returns self

Parameters:

Name	Type	Description
`packet`

Returns:

Type: Writer