Class Lobby
Data about an individual lobby.
Inheritance
Namespace: Unity.Services.Lobbies.Models
Assembly: solution.dll
Syntax
public class LobbyConstructors
Lobby(string, string, string, string, string, int, int, bool, bool, List<Player>, Dictionary<string, DataObject>, string, DateTime, DateTime, int, bool)
Data about an individual lobby.
Declaration
public Lobby(string id = null, string lobbyCode = null, string upid = null, string environmentId = null, string name = null, int maxPlayers = null, int availableSlots = null, bool isPrivate = null, bool isLocked = null, List<Player> players = null, Dictionary<string, DataObject> data = null, string hostId = null, DateTime created = null, DateTime lastUpdated = null, int version = null, bool hasPassword = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | id | id param |
| string | lobbyCode | A short code that can be used to join a lobby. This is only visible to lobby members. Typically this is displayed to the user so they can share it with other players out-of-game. Users with the code can join a lobby even when it is private. |
| string | upid | The Unity project ID of the game. |
| string | environmentId | The ID of the environment this lobby exists in. |
| string | name | The name of the lobby. Typically this is shown in game UI to represent the lobby. |
| int | maxPlayers | The maximum number of players that can be members of the lobby. |
| int | availableSlots | The number of remaining open slots for players before the lobby becomes full. |
| bool | isPrivate | Whether or not the lobby is private. Private lobbies do not appear in query results and cannot be fetched by non-members using the GetLobby API. If the lobby is not publicly visible, the creator can share the |
| bool | isLocked | Whether or not the lobby is locked. If true, new players will not be able to join. |
| List<Player> | players | The members of the lobby. |
| Dictionary<string, DataObject> | data | Properties of the lobby set by the host. |
| string | hostId | The ID of the player that is the lobby host. |
| DateTime | created | When the lobby was created. The timestamp is in UTC and conforms to ISO 8601. |
| DateTime | lastUpdated | When the lobby was last updated. The timestamp is in UTC and conforms to ISO 8601. |
| int | version | The current version of the lobby. Incremented when any non-private lobby data changes. |
| bool | hasPassword | Indicates whether or not a password is required to join the lobby. Players wishing to join must provide the matching password or will be rejected. |
Properties
AvailableSlots
The number of remaining open slots for players before the lobby becomes full.
Declaration
public int AvailableSlots { get; }Property Value
| Type | Description |
|---|---|
| int |
Created
When the lobby was created. The timestamp is in UTC and conforms to ISO 8601.
Declaration
public DateTime Created { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
Data
Properties of the lobby set by the host.
Declaration
public Dictionary<string, DataObject> Data { get; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, DataObject> |
EnvironmentId
The ID of the environment this lobby exists in.
Declaration
public string EnvironmentId { get; }Property Value
| Type | Description |
|---|---|
| string |
HasPassword
Indicates whether or not a password is required to join the lobby. Players wishing to join must provide the matching password or will be rejected.
Declaration
public bool HasPassword { get; }Property Value
| Type | Description |
|---|---|
| bool |
HostId
The ID of the player that is the lobby host.
Declaration
public string HostId { get; }Property Value
| Type | Description |
|---|---|
| string |
Id
Parameter id of Lobby
Declaration
public string Id { get; }Property Value
| Type | Description |
|---|---|
| string |
IsLocked
Whether or not the lobby is locked. If true, new players will not be able to join.
Declaration
public bool IsLocked { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsPrivate
Whether or not the lobby is private. Private lobbies do not appear in query results and cannot be fetched by non-members using the GetLobby API. If the lobby is not publicly visible, the creator can share the lobbyCode with other users who can use it to join this lobby.
Declaration
public bool IsPrivate { get; }Property Value
| Type | Description |
|---|---|
| bool |
LastUpdated
When the lobby was last updated. The timestamp is in UTC and conforms to ISO 8601.
Declaration
public DateTime LastUpdated { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
LobbyCode
A short code that can be used to join a lobby. This is only visible to lobby members. Typically this is displayed to the user so they can share it with other players out-of-game. Users with the code can join a lobby even when it is private.
Declaration
public string LobbyCode { get; }Property Value
| Type | Description |
|---|---|
| string |
MaxPlayers
The maximum number of players that can be members of the lobby.
Declaration
public int MaxPlayers { get; }Property Value
| Type | Description |
|---|---|
| int |
Name
The name of the lobby. Typically this is shown in game UI to represent the lobby.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Players
The members of the lobby.
Declaration
public List<Player> Players { get; }Property Value
| Type | Description |
|---|---|
| List<Player> |
Upid
The Unity project ID of the game.
Declaration
public string Upid { get; }Property Value
| Type | Description |
|---|---|
| string |
Version
The current version of the lobby. Incremented when any non-private lobby data changes.
Declaration
public int Version { get; set; }Property Value
| Type | Description |
|---|---|
| int |