Constructor Lobby

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

[Preserve]
public Lobby(string id = null, string lobbyCode = null, string upid = null, string environmentId = null, string name = null, int maxPlayers = 0, int availableSlots = 0, bool isPrivate = false, bool isLocked = false, List<Player> players = null, Dictionary<string, DataObject> data = null, string hostId = null, DateTime created = default, DateTime lastUpdated = default, int version = 0, bool hasPassword = false)

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 lobbyCode with other users who can use it to join this lobby.
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.