Class SessionOptions

Options to configure a session when either joining or creating. Some options will only be used if a session needs to be created. Options can be customized to provide additional feature configuration.

Inheritance
object
BaseSessionOptions
SessionOptions
Inherited Members
BaseSessionOptions.Type
BaseSessionOptions.PlayerProperties
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
Namespace: Unity.Services.Multiplayer
Assembly: Unity.Services.Multiplayer.dll
Syntax
public class SessionOptions : BaseSessionOptions

Constructors

SessionOptions()

Declaration
public SessionOptions()

Properties

IsLocked

Determines if a session will be locked if a session is created. A locked session does not allow any more players to join. True if the session is locked, false otherwise. Only used if a session needs to be created.

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

IsPrivate

Determines if a session will be private if a session is created. Only used if a session needs to be created.

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

MaxPlayers

The max number of players (including host) allowed in the session if a session is created. Required to be over 0 if a session needs to be created.

Declaration
public int MaxPlayers { get; set; }
Property Value
Type Description
int

Name

Determines the name of the session if a session is created.

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

Password

Determines the password required to access a session if a session is created. The session password. Null for none. Only used if a session needs to be created.

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

SessionProperties

The session custom data (e.g. map) used if a session is created. Only used if a session needs to be created.

Declaration
public Dictionary<string, SessionProperty> SessionProperties { get; set; }
Property Value
Type Description
Dictionary<string, SessionProperty>

Extension Methods