Class PacketHandler.DisconnectReason
Captures either a server-originated message or a client-originated disconnect type.
public sealed class PacketHandler.DisconnectReason
- Inheritance
-
PacketHandler.DisconnectReason
- Inherited Members
Properties
ClientDisconnectType
Gets the client disconnect type. Returns null if the disconnect was initiated by the server.
public DisconnectType? ClientDisconnectType { get; }
Property Value
- DisconnectType?
ServerDisconnectReason
Gets the server disconnect reason as plain text. Returns null if the disconnect was initiated by the client.
public string? ServerDisconnectReason { get; }
Property Value
ServerDisconnectReasonFormatted
Gets the formatted server disconnect reason. Returns null if the disconnect was initiated by the client.
public FormattedMessage? ServerDisconnectReasonFormatted { get; }
Property Value
- FormattedMessage
Methods
SetClientDisconnectType(DisconnectType)
Records a client-originated type and clears any server-originated reason.
public void SetClientDisconnectType(DisconnectType clientDisconnectType)
Parameters
clientDisconnectTypeDisconnectTypeThe broad client disconnect type.
SetServerDisconnectReason(FormattedMessage?)
Records a server-originated reason and clears any client-originated type.
public void SetServerDisconnectReason(FormattedMessage? serverDisconnectReason)
Parameters
serverDisconnectReasonFormattedMessageThe formatted server reason, or null.
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
- string
A string that represents the current object.