author | title | description | ms.author | ms.topic | ms.service | ms.date |
---|---|---|---|---|---|---|
vicodex |
PlayFabMultiplayer.JoinLobby |
PlayFabMultiplayer.JoinLobby |
victorku |
reference |
playfab |
11/23/2021 |
Join a lobby as the local PlayFab entity.
public static Lobby JoinLobby(PFEntityKey newMember, string connectionString,
IDictionary<string, string> memberKeyValuePairs)
parameter | description |
---|---|
newMember | The local entity joining the lobby. |
connectionString | The connection string used by the entity to join the lobby. |
memberKeyValuePairs | The number of initial member properties for the joiner of the lobby. |
Output lobby object which can be used to queue operations for immediate execution of this operation.
This is an asynchronous operation. Upon successful completion, the title will be provided a OnLobbyMemberAdded
followed by a OnLobbyUpdated
and OnLobbyJoinCompleted
with the OnLobbyJoinCompleted.result
field set to Success
. Upon a failed completion, the title will be provided a OnLobbyJoinCompleted
with the result
field set to a failure.
Join a lobby as the local PlayFab entity.
public static Lobby JoinLobby(PlayFabAuthenticationContext newMember, string connectionString,
IDictionary<string, string> memberKeyValuePairs)
parameter | description |
---|---|
newMember | The local entity joining the lobby. |
connectionString | The connection string used by the entity to join the lobby. |
memberKeyValuePairs | The number of initial member properties for the joiner of the lobby. |
Output lobby object which can be used to queue operations for immediate execution of this operation.
This is an asynchronous operation. Upon successful completion, the title will be provided a OnLobbyMemberAdded
followed by a OnLobbyUpdated
and OnLobbyJoinCompleted
with the OnLobbyJoinCompleted.result
field set to Success
. Upon a failed completion, the title will be provided a OnLobbyJoinCompleted
with the result
field set to a failure.
- class Lobby
- class PFEntityKey
- class PlayFabMultiplayer
- namespace PlayFab.Multiplayer