Documentation

Lobby

Properties

Optional Available Slots

  • availableSlots: number

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

memberof

Lobby

Optional Created

  • created: string

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

memberof

Lobby

Optional Data

  • data: {}

Properties of the lobby set by the host.

memberof

Lobby

Type declaration

Optional Environment Id

  • environmentId: string

The ID of the environment this lobby exists in.

memberof

Lobby

Optional Host Id

  • hostId: string

The ID of the player that is the lobby host.

memberof

Lobby

Optional Id

  • id: string
memberof

Lobby

Optional Is Locked

  • isLocked: boolean

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

memberof

Lobby

Optional Is Private

  • isPrivate: boolean

Whether or not the lobby is private. Private lobbies do not appear in query results.

memberof

Lobby

Optional Last Updated

  • lastUpdated: string

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

memberof

Lobby

Optional Lobby Code

  • lobbyCode: string

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.

memberof

Lobby

Optional Max Players

  • maxPlayers: number

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

memberof

Lobby

Optional Name

  • name: string

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

memberof

Lobby

Optional Players

The members of the lobby.

memberof

Lobby

Optional Upid

  • upid: string

The Unity project ID of the game.

memberof

Lobby