Class Lobby#

Data about an individual lobby.

Namespace: Unity.Services.Lobbies.Models#

Syntax#

[Preserve]
public class Lobby

Constructors#

Lobby(String, String, String, String, String, Int32, Int32, Boolean, Boolean, List<Player>, Dictionary<String, DataObject>, String, DateTime, DateTime, Int32, Boolean)#

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), DateTime lastUpdated = default(DateTime), int version = 0, bool hasPassword = false)

Parameters#

Properties#

AvailableSlots#

The number of remaining open slots for players before the lobby becomes full.

Declaration#

[Preserve]
public int AvailableSlots { get; }

Property Value#

Created#

When the lobby was created. The timestamp is in UTC and conforms to ISO 8601.

Declaration#

[Preserve]
public DateTime Created { get; }

Property Value#

Data#

Properties of the lobby set by the host.

Declaration#

[Preserve]
public Dictionary<string, DataObject> Data { get; }

Property Value#

EnvironmentId#

The ID of the environment this lobby exists in.

Declaration#

[Preserve]
public string EnvironmentId { get; }

Property Value#

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#

[Preserve]
public bool HasPassword { get; }

Property Value#

HostId#

The ID of the player that is the lobby host.

Declaration#

[Preserve]
public string HostId { get; }

Property Value#

Id#

Parameter id of Lobby

Declaration#

[Preserve]
public string Id { get; }

Property Value#

IsLocked#

Whether or not the lobby is locked. If true, new players will not be able to join.

Declaration#

[Preserve]
public bool IsLocked { get; }

Property Value#

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#

[Preserve]
public bool IsPrivate { get; }

Property Value#

LastUpdated#

When the lobby was last updated. The timestamp is in UTC and conforms to ISO 8601.

Declaration#

[Preserve]
public DateTime LastUpdated { get; }

Property Value#

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#

[Preserve]
public string LobbyCode { get; }

Property Value#

MaxPlayers#

The maximum number of players that can be members of the lobby.

Declaration#

[Preserve]
public int MaxPlayers { get; }

Property Value#

Name#

The name of the lobby. Typically this is shown in game UI to represent the lobby.

Declaration#

[Preserve]
public string Name { get; }

Property Value#

Players#

The members of the lobby.

Declaration#

[Preserve]
public List<Player> Players { get; }

Property Value#

Upid#

The Unity project ID of the game.

Declaration#

[Preserve]
public string Upid { get; }

Property Value#

Version#

The current version of the lobby. Incremented when any non-private lobby data changes.

Declaration#

[Preserve]
public int Version { get; set; }

Property Value#