Documentation

Multiplayer Services SDK

Multiplayer Services SDK

Find and join a session

Implement ways for joining multiplayer sessions by entering a join code, browsing available sessions, or reconnecting after a disconnection.
Read time 3 minutesLast updated a day ago

A player can join a previously created session in the following ways:

Join code

await MultiplayerService.Instance.JoinSessionByCodeAsync(joinCode);
A unique and human-friendly join code is generated when a host starts a session. A host can then share this join code with other players to invite them to play the same session. The codes use a combination of letters and numbers and are designed to be short and easy to type or spell out loud.

Browse multiplayer sessions

You can generate a list of sessions in your game for users to browse and join. Users may want to filter this list based on different parameters to help them find a session that best matches what they're looking for.
You can use a session query to list sessions.
await MultiplayerService.Instance.QuerySessionsAsync(queryOptions);
Query results include all non-full, public sessions a player can join. Players can select a session from a list displaying only public properties of the session (such as its name), and join directly by session ID.
Refer to JoinSessionByIdAsync. Refer to QuerySessionOptions for available options.
Note
You can use queries to discover a session as long as its IsPrivate property is set to false. A session's ID is not the same as its join code.

Access rules

The session's access rules settings affect how players can join it. For more information, refer to Access rules.

Reconnect to a session

If a player is disconnected from a session but remains a member of it, they can reconnect to the same session. Implement the following flow in your game to handle the cases when a player disconnects.

Save the session type for reconnection

To reconnect to the session under the same
Type
, you must save the session's
Type
. If you set a
Type
when you created or joined the session, you must save the mapping between the session ID and the session type yourself, for example in
PlayerPrefs
or Cloud Save. The Multiplayer Services SDK doesn't save this information, and the service doesn't return it. Save the mapping as soon as the player creates or joins the session, so it's available if the game crashes.
For more information about session types, refer to Session identifiers.

Reconnect

Note
Reconnection is designed specifically for cases when a user hasn't yet been removed from the session by either the host or the service. If the player has already been removed, then they need to join the session again.
To reconnect a user, do the following:
  1. Fetch all the sessions the current user is part of using GetJoinedSessionIdsAsync:
    await MultiplayerService.Instance.GetJoinedSessionIdsAsync();
    Use the mapping you saved to find the session type for each session ID.
  2. To reconnect to the chosen session, call ReconnectAsync:
    await sessionManager.ReconnectAsync(sessionId);
You can add a custom network handler implementation to your reconnect request by specifying a
ReconnectSessionOptions
that uses your own network handler implementation:
await sessionManager.ReconnectAsync(sessionId,new ReconnectSessionOptions().WithNetworkHandler(customNetworkHandler));

Additional resources