v1.2.1
Latest
2020.3+

Class CreateLobbyOptions

Optional parameter class for Lobby creation requests.

Inheritance
CreateLobbyOptions
Namespace: Unity.Services.Lobbies
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
TypeDescription
Dictionary<String, DataObject>

IsLocked

Declaration
public bool? IsLocked { get; set; }
Property Value
TypeDescription
Nullable<Boolean>

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
TypeDescription
Nullable<Boolean>

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
TypeDescription
String

Player

Information about a specific player creating the lobby.

Declaration
public Player Player { get; set; }
Property Value
TypeDescription
Player