Class ClientDisconnectEvent

Emitted when client disconnects from the server.

Hierarchy

ClientEvent
- ClientDisconnectEvent

Index

Properties

Methods

cancel

Constructors

constructor

Properties

Static eventName

eventName: string

Static eventNamee

eventNamee: "client.disconnect" = ...

canceled

canceled: boolean

client

client: SkeldjsClient

eventName

eventName: "client.disconnect" = ...

Optional message

message: string

The message for the reason, if the reason is custom.

reason

reason: DisconnectReason

The reason why the client disconnected.

Methods

cancel

cancel(): void

Inherited from ClientEvent.cancel
- Defined in events/lib/CancelableEvent.ts:12
Returns void

Constructors

constructor

new ClientDisconnectEvent(client: SkeldjsClient, reason?: DisconnectReason, message?: string): ClientDisconnectEvent

Overrides ClientEvent.constructor
- Defined in client/lib/events/Disconnect.ts:22
Parameters
- client: SkeldjsClient
- reason: DisconnectReason = ...
- Optional message: string
Returns ClientDisconnectEvent

Generated using TypeDoc