Class Lobby
Data about an individual lobby.
Inherited Members
Namespace: Unity.Services.Lobbies.Models
Assembly: solution.dll
Syntax
[Preserve]
public class Lobby
Constructors
Name | Description |
---|---|
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. |
Properties
Name | Description |
---|---|
AvailableSlots | The number of remaining open slots for players before the lobby becomes full. |
Created | When the lobby was created. The timestamp is in UTC and conforms to ISO 8601. |
Data | Properties of the lobby set by the host. |
EnvironmentId | The ID of the environment this lobby exists in. |
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. |
HostId | The ID of the player that is the lobby host. |
Id | Parameter id of Lobby |
IsLocked | Whether or not the lobby is locked. If true, new players will not be able to join. |
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 |
LastUpdated | When the lobby was last updated. The timestamp is in UTC and conforms to ISO 8601. |
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. |
MaxPlayers | The maximum number of players that can be members of the lobby. |
Name | The name of the lobby. Typically this is shown in game UI to represent the lobby. |
Players | The members of the lobby. |
Upid | The Unity project ID of the game. |
Version | The current version of the lobby. Incremented when any non-private lobby data changes. |