Skip to main content

RequestMatchmakerPlayer

Attempts to create a new matchmaker player for the current identity.

If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Responses

RequestMatchmakerPlayer 200 response