Skip to main content

DisconnectEvent

DisconnectEvent

Holds information about a disconnect event. All disconnect events inherit from this class. Child classes can contain more specific information about the event.

Properties

roomName

string roomName { get; }

The name of the room where the event originated.

quickmatchRoom

bool quickmatchRoom { get; }

Whether the room was a Quickmatch room.

quickmatchRoomGroupName

string quickmatchRoomGroupName { get; }

The Quickmatch room group name, if applicable.

quickmatchRoomCode

string quickmatchRoomCode { get; }

The Quickmatch room code, if applicable.

quickmatchRoomCapacity

int? quickmatchRoomCapacity { get; }

The Quickmatch room capacity, if applicable.

connectOptions

ConnectOptions connectOptions { get; }

The connection options used to connect to the room.

didConnectToRoom

bool didConnectToRoom { get; }

Whether the room was successfully connected prior to being disconnected.

message

string message { get; }

A user-friendly description of the disconnect. It can be displayed to players in a GUI for example.

Methods

ToString

string ToString()

A detailed description of the disconnect. This can be included in the logs.