Class MultiplayServerOptions
Allows configuring the server options of a Game Server Hosting server.
Inheritance
Inherited Members
Namespace: Unity.Services.Multiplayer
Syntax
public class MultiplayServerOptionsConstructors
MultiplayServerOptions(String, String, String, String, Boolean)
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 |
|---|---|---|
| System.String | serverName | The name of the server. |
| System.String | gameType | The type of game running on the allocated server. |
| System.String | buildId | The id of the build running on the allocated server. |
| System.String | map | The map of the game running on the allocated server. |
| System.Boolean | 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 |
|---|---|
| System.Boolean |
BuildId
The Id of the build running on the allocated server.
Declaration
public string BuildId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
GameType
The type of game running on the allocated server.
Declaration
public string GameType { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Map
The map of the game running on the allocated server.
Declaration
public string Map { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ServerName
The name of the server.
Declaration
public string ServerName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |