Skip to main content
Version: 5.7.0

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.
  • SysAddMember - Adds the given member to the given lobby instance.
  • SysAddMemberWithPingData - Adds the given member to the given lobby instance.
  • SysCreateLobby - Creates an instance of a lobby. Will return the newly created lobby id in the event of a successful creation.
  • SysCreateLobbyWithPingData - Creates an instance of a lobby. Will return the newly created lobby id in the event of a successful creation.
  • SysGetLobbyData - Gets data for the given lobby instance <lobbyId>.
  • SysRemoveMember - Evicts the specified user from the specified lobby.
  • SysUpdateSettings - Updates the settings for the given lobby instance.
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.

Last updated on by Jason Liang