Class DisconnectPacket

Hierarchy (View Summary)

BaseRootPacket
- DisconnectPacket

Index

Constructors

Properties

message? messageTag messageType reason? showReason? messageTag messageType

Accessors

Methods

cancel clone serializeToWriter deserializeFromReader

Constructors

constructor

new DisconnectPacket(
    reason?: DisconnectReason,
    message?: string,
    showReason?: boolean,
): DisconnectPacket
Parameters
- Optionalreason: DisconnectReason
- Optionalmessage: string
- OptionalshowReason: boolean
Returns DisconnectPacket
Overrides BaseRootPacket.constructor
- Defined in packages/protocol/lib/packets/option/Disconnect.ts:14

Properties

`Optional` `Readonly`message

message?: string

messageTag

messageTag: Disconnect = ...

messageType

messageType: "option" = ...

`Optional` `Readonly`reason

reason?: DisconnectReason

`Optional` `Readonly`showReason

showReason?: boolean

`Static`messageTag

messageTag: Disconnect = ...

`Static`messageType

messageType: "option" = ...

Accessors

canceled

get canceled(): boolean
Returns boolean
Inherited from BaseRootPacket.canceled
- Defined in packages/protocol/lib/packets/BaseMessage.ts:17

Methods

cancel

cancel(): void
Returns void
Inherited from BaseRootPacket.cancel
- Defined in packages/protocol/lib/packets/BaseMessage.ts:41

clone

clone(): DisconnectPacket
Returns DisconnectPacket
Overrides BaseRootPacket.clone
- Defined in packages/protocol/lib/packets/option/Disconnect.ts:76

serializeToWriter

serializeToWriter(writer: HazelWriter): void
Parameters
- writer: HazelWriter
Returns void
Overrides BaseRootPacket.serializeToWriter
- Defined in packages/protocol/lib/packets/option/Disconnect.ts:53

`Static`deserializeFromReader

deserializeFromReader(reader: HazelReader): DisconnectPacket
Parameters
- reader: HazelReader
Returns DisconnectPacket
Overrides BaseRootPacket.deserializeFromReader
- Defined in packages/protocol/lib/packets/option/Disconnect.ts:26