Class MultiplayServerOptions

Allows configuring the server options of a Game Server Hosting server.

Inheritance
object
MultiplayServerOptions
Inherited Members
Namespace: Unity.Services.Multiplayer
Assembly: Unity.Services.Multiplayer.Server.dll
Syntax
[Obsolete("The Multiplay service will cease to operate on March 31st 2026 - For alternative hosting providers, please update to com.unity.services.multiplayer 2.1")]
public class MultiplayServerOptions
Remarks

The Multiplay service will cease to operate on March 31st 2026 - For alternative hosting providers, please update to com.unity.services.multiplayer 2.1

Constructors

MultiplayServerOptions(string, string, string, string, bool)

Creates a new instance of MultiplayServerOptions that can be used to configure a Game Server Hosting server.

Declaration
public MultiplayServerOptions(string serverName, string gameType, string buildId, string map, bool autoReady = true)
Parameters
Type Name Description
string serverName

The name of the server.
string gameType

The type of game running on the allocated server.
string buildId

The id of the build running on the allocated server.
string map

The map of the game running on the allocated server.
bool autoReady

When using Server Readiness check, if this is true, the server will be automatically set to ready once the server is started.

Properties

AutoReady

When using Server Readiness check, if AutoReady is true, the server will be automatically set to ready once the server is started.

Declaration
public bool AutoReady { get; set; }
Property Value
Type Description
bool

BuildId

The Id of the build running on the allocated server.

Declaration
public string BuildId { get; set; }
Property Value
Type Description
string

GameType

The type of game running on the allocated server.

Declaration
public string GameType { get; set; }
Property Value
Type Description
string

Map

The map of the game running on the allocated server.

Declaration
public string Map { get; set; }
Property Value
Type Description
string

ServerName

The name of the server.

Declaration
public string ServerName { get; set; }
Property Value
Type Description
string