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()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Multiplayer

Assembly: Unity.Services.Multiplayer.dll

Syntax

public class SessionOptions : BaseSessionOptions

Constructors

SessionOptions()

Creates an instance of 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

See Also

IsLocked

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

Remarks

Private sessions are not visible in queries and cannot be joined with quick-join. They can still be joined by ID or by Code.

See Also

IsPrivate

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

See Also

MaxPlayers

Name

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

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

See Also

Name

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

Remarks

A string between 8 and 64 characters. The password must be provided when joining the session. It is not readable from sessions.

See Also

Password

Password

SessionProperties

Additional user-defined session properties (e.g. 'map').

Declaration

public Dictionary<string, SessionProperty> SessionProperties { get; set; }

Property Value

Type	Description
Dictionary<string, SessionProperty>

Remarks

Only used if a session needs to be created. Up to 20 properties may be set per session, including those used internally by this package. The host can modify the properties through IHostSession.

See Also

Properties

Extension Methods

SessionOptionsExtensions.WithDirectNetwork<T>(T, string, string, int)

SessionOptionsExtensions.WithNetworkHandler<T>(T, INetworkHandler)

SessionOptionsExtensions.WithRelayNetwork<T>(T, string)