JoinRejectedMsg

public struct JoinRejectedMsg

Gateway -> client: the join was refused; Reason is fit to show the player. The gateway disconnects after sending it.

Fields

Reason

public string Reason;

Retry

public bool Retry;

Whether the client should retry automatically, such as when this gateway is draining. Reaching another gateway requires a configured load balancer or another routing mechanism. When false, inspect Code and Reason before reconnecting.

Code

public JoinRejectReason Code;

The typed refusal reason. Defaults to JoinRejectReason.None when omitted.

Saturation

public float Saturation;

How saturated the target was, for JoinRejectReason.AtCapacity: 1 = the whole of the dominant component's budget (CapacityInfo.Saturation). Sent as an f16; 0 when unknown.

SupportedMinVersion

public ushort SupportedMinVersion;

The gateway's inclusive supported protocol range, supplied on every refusal. Both limits are 18. Zero means the corresponding field was omitted.

SupportedMaxVersion

public ushort SupportedMaxVersion;

The gateway's inclusive supported protocol range, supplied on every refusal. Both limits are 18. Zero means the corresponding field was omitted.

ServerContentVersion

public uint ServerContentVersion;

The gateway's configured game content version, supplied on every refusal. Zero means content version checks are disabled or the field was omitted.

Methods

Write

public void Write(NetworkWriter w);

Read

public static JoinRejectedMsg Read(NetworkReader r);