Lobby

For a full overview of the Lobby Service, see the Lobby Service Client API.

API Summary

LobbyService

• GetLobbyData - Gets data for the given lobby instance.
• GetLobbyInstances - Gets a map keyed by rating of the visible lobby instances matching the given type and rating range.
• GetLobbyInstancesWithPingData - Gets a map keyed by rating of the lobby instances matching the given type, rating range, and ping threshold.
• SysRoomReady - Indicates that a room is ready for use by the members of the given lobby.
• SysRoomCancelled - Indicates that the room allocation process has been cancelled for the given lobby.
• SysSendSignal - Send the given data to all members of the given lobby.
• SysDisbandLobby - Disbands the given lobby.
• SysRoomStopped - Indicates that the gameplay for the room associated with the given lobby has completed. The lobby can be returned to the 'setup' state.
• SysMemberLeft - Informs brainCloud that the specified user has left the specified lobby.
• SysGetLobbyMember - Retrieves lobby membership details for the specified user.

tip

All the client APIs that the names beigin with "Sys" are also available to S2S. For the usages of the S2S lobby APIs (if they are not listed at this section below), refer to brainCloud client lobby APIs.

📄️ GetLobbyData

Returns the data for the specified lobby, including member data.

📄️ GetVisibleLobbyInstances

Gets a map keyed by rating of the visible lobby instances matching the given type and rating range.

📄️ SysDisbandLobby

Disbands the given lobby. msg and details are optional values.

📄️ SysRoomCancelled

Tells the lobby system that creation of the room experience failed.

📄️ SysRoomReady

Tells the lobby system that a room server is ready to go.

📄️ SysSendSignal

Send the given data to all members of the given lobby.