Class CreateLobbyOptions

Optional parameter class for Lobby creation requests.

Inheritance

object

CreateLobbyOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Lobbies

Assembly: Unity.Services.Multiplayer.dll

Syntax

public class CreateLobbyOptions

Properties

Data

Custom game-specific properties that apply to the lobby (e.g. mapName or gameType).

Declaration

public Dictionary<string, DataObject> Data { get; set; }

Property Value

Type	Description
Dictionary<string, DataObject>

IsLocked

Indicates whether or not the lobby is locked. If left as null, a default value will be used.

Declaration

public bool? IsLocked { get; set; }

Property Value

Type	Description
bool?

IsPrivate

Indicates whether or not the lobby is publicly visible and will show up in query results. If the lobby is not publicly visible, the creator can share the LobbyCode with other users who can use it to join this lobby. If left as null, a default value will be used.

Declaration

public bool? IsPrivate { get; set; }

Property Value

Type	Description
bool?

Password

If supplied, adds a password to this lobby; any player wishing to join needs to provide the matching password. Minimum password length is 8, maximum is 64

Declaration

public string Password { get; set; }

Property Value

Type	Description
string

Player

Information about a specific player creating the lobby.

Declaration

public Player Player { get; set; }

Property Value

Type	Description
Player