/// <summary>When the client lost connection during gameplay, this method attempts to reconnect and rejoin the room.</summary>
/// <remarks>
/// This method re-connects directly to the game server which was hosting the room PUN was in before.
/// If the room was shut down in the meantime, PUN will call OnJoinRoomFailed and return this client to the Master Server.
///
/// Check the return value, if this client will attempt a reconnect and rejoin (if the conditions are met).
/// If ReconnectAndRejoin returns false, you can still attempt a Reconnect and Rejoin.
///
/// Similar to PhotonNetwork.RejoinRoom, this requires you to use unique IDs per player (the UserID).
///
/// Rejoining room will not send any player properties. Instead client will receive up-to-date ones from server.
/// If you want to set new player properties, do it once rejoined.
/// </remarks>
/// <returns>False, if there is no known room or game server to return to. Then, this client does not attempt the ReconnectAndRejoin.</returns>
public static async UniTask ReconnectAndRejoinAsync(CancellationToken token)
{
var task = UniTask.WhenAny(
Pun2TaskCallback.OnJoinedRoomAsync().AsAsyncUnitUniTask(),
Pun2TaskCallback.OnJoinRoomFailedAsync());
var valid = PhotonNetwork.ReconnectAndRejoin();
if (!valid)
{
throw new InvalidRoomOperationException("It is not ready to join a room.");
}
var(winIndex, _, (returnCode, message)) = await task.WithCancellation(token);
if (winIndex == 0)
{
return;
}
throw new FailedToJoinRoomException(returnCode, message);
}
/// <summary>
/// Rejoins a room by roomName (using the userID internally to return). Will callback: OnJoinedRoom or OnJoinRoomFailed.
/// </summary>
/// <remarks>
/// After losing connection, you might be able to return to a room and continue playing,
/// if the client is reconnecting fast enough. Use Reconnect() and this method.
/// Cache the room name you're in and use RejoinRoom(roomname) to return to a game.
///
/// Note: To be able to Rejoin any room, you need to use UserIDs!
/// You also need to set RoomOptions.PlayerTtl.
///
/// <b>Important: Instantiate() and use of RPCs is not yet supported.</b>
/// The ownership rules of PhotonViews prevent a seamless return to a game, if you use PhotonViews.
/// Use Custom Properties and RaiseEvent with event caching instead.
///
/// Common use case: Press the Lock Button on a iOS device and you get disconnected immediately.
///
/// Rejoining room will not send any player properties. Instead client will receive up-to-date ones from server.
/// If you want to set new player properties, do it once rejoined.
public static async UniTask RejoinRoomAsync(string roomName, CancellationToken token = default)
{
var task = UniTask.WhenAny(
Pun2TaskCallback.OnJoinedRoomAsync().AsAsyncUnitUniTask(),
Pun2TaskCallback.OnJoinRoomFailedAsync());
var valid = PhotonNetwork.RejoinRoom(roomName);
if (!valid)
{
throw new InvalidRoomOperationException("It is not ready to join a room.");
}
var(winIndex, _, (returnCode, message)) = await task.AttachExternalCancellation(token);
if (winIndex == 0)
{
return;
}
throw new FailedToJoinRoomException(returnCode, message);
}
/// <summary>
/// Joins a specific room by name and creates it on demand. Will callback: OnJoinedRoom or OnJoinRoomFailed.
/// </summary>
/// <remarks>
/// Useful when players make up a room name to meet in:
/// All involved clients call the same method and whoever is first, also creates the room.
///
/// When successful, the client will enter the specified room.
/// The client which creates the room, will callback both OnCreatedRoom and OnJoinedRoom.
/// Clients that join an existing room will only callback OnJoinedRoom.
/// In all error cases, OnJoinRoomFailed gets called.
///
/// Joining a room will fail, if the room is full, closed or when the user
/// already is present in the room (checked by userId).
///
/// To return to a room, use OpRejoinRoom.
///
/// This method can only be called while the client is connected to a Master Server so you should
/// implement the callback OnConnectedToMaster.
/// Check the return value to make sure the operation will be called on the server.
/// Note: There will be no callbacks if this method returned false.
///
///
/// If you set room properties in roomOptions, they get ignored when the room is existing already.
/// This avoids changing the room properties by late joining players.
///
/// You can define an array of expectedUsers, to block player slots in the room for these users.
/// The corresponding feature in Photon is called "Slot Reservation" and can be found in the doc pages.
///
///
/// More about PUN matchmaking:
/// https://doc.photonengine.com/en-us/pun/v2/lobby-and-matchmaking/matchmaking-and-lobby
/// </remarks>
/// <param name="roomName">Name of the room to join. Must be non null.</param>
/// <param name="roomOptions">Options for the room, in case it does not exist yet. Else these values are ignored.</param>
/// <param name="typedLobby">Lobby you want a new room to be listed in. Ignored if the room was existing and got joined.</param>
/// <param name="expectedUsers">Optional list of users (by UserId) who are expected to join this game and who you want to block a slot for.</param>
/// <returns>True will be returned when you are the first user.</returns>>
public static async UniTask <bool> JoinOrCreateRoomAsync(
string roomName,
RoomOptions roomOptions,
TypedLobby typedLobby,
string[] expectedUsers = null,
CancellationToken token = default)
{
var createdRoomTask = Pun2TaskCallback.OnCreatedRoomAsync().GetAwaiter();
var task = UniTask.WhenAny(
Pun2TaskCallback.OnJoinedRoomAsync().AsAsyncUnitUniTask(),
Pun2TaskCallback.OnCreateRoomFailedAsync(),
Pun2TaskCallback.OnJoinRoomFailedAsync());
var valid = PhotonNetwork.JoinOrCreateRoom(roomName, roomOptions, typedLobby, expectedUsers);
if (!valid)
{
throw new InvalidRoomOperationException("It is not ready to join a room.");
}
var(winIndex,
_,
(createFailedCode, createFailedMessage),
(joinFailedCode, joinFailedMessage)) = await task.WithCancellation(token);
if (winIndex == 0)
{
return(createdRoomTask.IsCompleted);
}
if (winIndex == 1)
{
throw new FailedToCreateRoomException(createFailedCode, createFailedMessage);
}
else
{
throw new FailedToJoinRoomException(createFailedCode, createFailedMessage);
}
}
