Interface IMultiplaySessionManager#

Provides methods to manage a Game Server Hosting server.

Namespace: Unity.Services.Multiplayer#

Syntax#

public interface IMultiplaySessionManager

Properties#

Allocation#

The server allocation information.

Declaration#

ServerAllocation Allocation { get; }

Property Value#

ConnectionPort#

The connection port for the session. Null when the server is not allocated.

Declaration#

ushort? ConnectionPort { get; }

Property Value#

IpAddress#

The connection IP for the session. Null when the server is not allocated.

Declaration#

string IpAddress { get; }

Property Value#

IsReadyForPlayers#

Whether the server is ready to accept players.

Declaration#

bool IsReadyForPlayers { get; }

Property Value#

See Also#

QueryPort#

The Server Query Protocol Port. Null when the server is not allocated.

Declaration#

ushort? QueryPort { get; }

Property Value#

ServerId#

The server ID. Null when the server is not allocated.

Declaration#

long? ServerId { get; }

Property Value#

ServerLogDirectory#

The directory on the server Multiplay will write logs to. Null when the server is not allocated.

Declaration#

string ServerLogDirectory { get; }

Property Value#

Session#

The Session being hosted by this server.

Declaration#

IServerSession Session { get; }

Property Value#

State#

Current state of the Multiplay session handler.

Declaration#

MultiplaySessionManagerState State { get; }

Property Value#

Methods#

GetAllocationPayloadFromJsonAsAsync<TPayload>()#

Gets the payload allocation, in JSON, and deserializes it as the given object.

Declaration#

Task<TPayload> GetAllocationPayloadFromJsonAsAsync<TPayload>()

Returns#

Type Parameters#

GetAllocationPayloadFromPlainTextAsync()#

Gets the payload allocation as plain text.

Declaration#

Task<string> GetAllocationPayloadFromPlainTextAsync()

Returns#

SetPlayerReadinessAsync(Boolean)#

Set the server as ready to receive players.

Declaration#

Task SetPlayerReadinessAsync(bool isReady)

Parameters#

Returns#