Public Member Functions | |
| LobbyService (IBeamableRequester requester, IUserContext userContext) | |
| Promise< LobbyQueryResponse > | FindLobbies () |
| Find lobbies for the player to join. More... | |
| Promise< Lobby > | CreateLobby (string name, LobbyRestriction restriction, SimGameTypeRef gameTypeRef=null, string description=null, List< Tag > playerTags=null, int? maxPlayers=null, int? passcodeLength=null, List< string > statsToInclude=null) |
| Create a new Lobby with the current player as the host. More... | |
| Promise< Lobby > | JoinLobby (string lobbyId, List< Tag > playerTags=null) |
| Join a Lobby given its id. More... | |
| Promise< Lobby > | JoinLobbyByPasscode (string passcode, List< Tag > playerTags=null) |
| Join a Lobby given its passcode. More... | |
| Promise< Lobby > | GetLobby (string lobbyId) |
| Fetch the current status of a Lobby. More... | |
| Promise | LeaveLobby (string lobbyId) |
| Notify the given lobby that the player intends to leave. More... | |
| Promise< Lobby > | AddPlayerTags (string lobbyId, List< Tag > tags, string playerId=null, bool replace=false) |
| Add a list of Tag to the given player in the given lobby. More... | |
| Promise< Lobby > | RemovePlayerTags (string lobbyId, List< string > tags, string playerId=null) |
| Remove a list of tags from the given player in the given Lobby. More... | |
| Promise | KickPlayer (string lobbyId, string playerId) |
| Send a request to the given Lobby to remove the player with the given playerId. If the requesting player doesn't have the capability to boot players, this will throw an exception. More... | |
Member Function Documentation
◆ AddPlayerTags()
|
inline |
Add a list of Tag to the given player in the given lobby.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ CreateLobby()
|
inline |
Create a new Lobby with the current player as the host.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ FindLobbies()
|
inline |
Find lobbies for the player to join.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ GetLobby()
Fetch the current status of a Lobby.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ JoinLobby()
|
inline |
Join a Lobby given its id.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ JoinLobbyByPasscode()
|
inline |
Join a Lobby given its passcode.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ KickPlayer()
|
inline |
Send a request to the given Lobby to remove the player with the given playerId. If the requesting player doesn't have the capability to boot players, this will throw an exception.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ LeaveLobby()
|
inline |
Notify the given lobby that the player intends to leave.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
◆ RemovePlayerTags()
|
inline |
Remove a list of tags from the given player in the given Lobby.
Implements Beamable.Experimental.Api.Lobbies.ILobbyApi.
The documentation for this class was generated from the following file:
- com.beamable/Common/Runtime/Api/Lobbies/LobbyService.cs
