Namespace Unity.Services.Lobbies
Classes
CreateLobbyOptions
Optional parameter class for Lobby creation requests.
JoinLobbyByCodeOptions
Optional parameter class for Lobby Join By Code requests
JoinLobbyByIdOptions
Optional parameter class for Lobby Join By ID requests
LobbyPlayerChanges
Contains information about a set of changes to a player.
LobbyService
Here is the first point and call for accessing the Lobby Package's features! Use the .Instance method to get a singleton of the ILobbyServiceSDK, and from there you can make various requests to the Lobby service API.
LobbyServiceException
Represents an exception that occurs when communicating with the Unity Lobby Service.
LobbyValue
Helper class for instantiating ChangedLobbyValue and ChangedOrRemovedLobbyValue!
QueryLobbiesOptions
Query parameters for Lobby service requests.
QuickJoinLobbyOptions
Optional parameters for Quick Joining a Lobby. Includes queryable fields for Lobby selection criterion.
UpdateLobbyOptions
Parameters to update on a given UpdateLobby request.
UpdatePlayerOptions
Paramters to update on a given UpdatePlayer request.
Structs
ChangedLobbyValue<T>
Contains whether or not a particular change has occurred, and if it has, the value of the change.
ChangedOrRemovedLobbyValue<T>
Contains whether or not a particular change or removal has occurred. If a change has occurred, also provides the value of the change.
LobbyPlayerJoined
Contains information about the player that joined.
Interfaces
ILobbyChanges
An interface providing a set of changes to apply to a lobby model.
ILobbyEvents
An interface for managing a lobby events subscription and the callbacks associated with it.
ILobbyService
Service for Lobbies. Provides user the ability to create, delete, update, and query Lobbies. Includes operations for interacting with given players in a Lobby context.
ILobbyServiceSDK
This interface is marked for deprecation. Please use ILobbyService instead.
ILobbyServiceSDKConfiguration
Interface used for editing the configuration of the lobby service SDK. Primary usage is for testing purposes.
Enums
LobbyEventConnectionState
An enum describing the current state of a Lobby Event subscription's connection status.
LobbyExceptionReason
Enumerates the known error causes when communicating with the Lobby Service. N.B. Error code range for this service: 16000-16999
LobbyValueChangeType
An enum providing the change type of a given change.