v1.0.0
Latest
2022.3+
Class CreateLobbyOptions
Optional parameter class for Lobby creation requests.
Inheritance
System.Object
CreateLobbyOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unity.Services.Lobbies
Syntax
public class CreateLobbyOptionsProperties
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 |
|---|---|
| System.Collections.Generic.Dictionary<System.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 |
|---|---|
| System.Nullable<System.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
| Type | Description |
|---|---|
| System.Nullable<System.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
| Type | Description |
|---|---|
| System.String |
Player
Information about a specific player creating the lobby.
Declaration
public Player Player { get; set; }Property Value
| Type | Description |
|---|---|
| Player |