ロビーイベント
Subscribe to real-time lobby events to receive updates when lobby or player state changes occur.
読み終わるまでの所要時間 4 分最終更新 2ヶ月前
注
重要: ロビーイベントは、バージョン 1.0.0 以降でのみ使用できます。
SubscribeToLobbyEventsAsyncLobbyChangedApplyToLobbyModels.Lobby更新の受信
ロビーのリアルタイム更新をサブスクライブするには、以下を呼び出す必要があります。Lobbies.Instance.SubscribeToLobbyEventsAsync(lobbyId, callbacks);
- コールバックオブジェクトは、リアルタイム変更を消費するためのコールバックを提供します。
- コールバックパラメーターは のインスタンスを受け入れます。これを作成してサブスクライブする必要があります。
LobbyEventsCallbacks
注
ノート: プレイヤーがロビーのイベントを受信できるのは、そのロビー内にいる場合だけです。
m_Lobby = await Lobbies.Instance.CreateLobbyAsync(lobbyName, maxPlayers, options);var callbacks = new LobbyEventCallbacks();callbacks.LobbyChanged += OnLobbyChanged;callbacks.KickedFromLobby += OnKickedFromLobby;callbacks.LobbyEventConnectionStateChanged += OnLobbyEventConnectionStateChanged;try { m_LobbyEvents = await Lobbies.Instance.SubscribeToLobbyEventsAsync(m_Lobby.Id, callbacks);}catch (LobbyServiceException ex){ switch (ex.Reason) { case LobbyExceptionReason.AlreadySubscribedToLobby: Debug.LogWarning($"Already subscribed to lobby[{m_Lobby.Id}]. We did not need to try and subscribe again. Exception Message: {ex.Message}"); break; case LobbyExceptionReason.SubscriptionToLobbyLostWhileBusy: Debug.LogError($"Subscription to lobby events was lost while it was busy trying to subscribe. Exception Message: {ex.Message}"); throw; case LobbyExceptionReason.LobbyEventServiceConnectionError: Debug.LogError($"Failed to connect to lobby events. Exception Message: {ex.Message}"); throw; default: throw; }}
注
ノート: 前のコードサンプルでは、、、 がイベントを処理します。
OnLobbyChangedOnKickedFromLobbyOnLobbyEventConnectionStateChangedOnLobbyChangedprivate void OnLobbyChanged(ILobbyChanges changes){ if (changes.LobbyDeleted) { // Handle lobby being deleted // Calling changes.ApplyToLobby will log a warning and do nothing } else { changes.ApplyToLobby(m_Lobby); } // Refresh the UI in some way}
KickedFromLobby
Lobby Events サービスは、KickedFromLobbyLobbyEventConnectionStateChangedunsubscribedOnKickedFromLobby以下のコードサンプルは、private void OnKickedFromLobby(){ // These events will never trigger again, so let’s remove it. this.m_LobbyEvents = null; // Refresh the UI in some way}
OnLobbyEventConnectionStateChangedprivate void OnLobbyEventConnectionStateChanged(LobbyEventConnectionState state){ switch (state) { case LobbyEventConnectionState.Unsubscribed: /* Update the UI if necessary, as the subscription has been stopped. */ break; case LobbyEventConnectionState.Subscribing: /* Update the UI if necessary, while waiting to be subscribed. */ break; case LobbyEventConnectionState.Subscribed: /* Update the UI if necessary, to show subscription is working. */ break; case LobbyEventConnectionState.Unsynced: /* Update the UI to show connection problems. Lobby will attempt to reconnect automatically. */ break; case LobbyEventConnectionState.Error: /* Update the UI to show the connection has errored. Lobby will not attempt to reconnect as something has gone wrong. */ }}
ロビーへの変更の適用
LobbyEventCallbacks.LobbyChangedApplyToLobbyprivate void OnLobbyChanged(ILobbyChanges changes){ changes.ApplyToLobby(m_Lobby); // Refresh the UI in some way}
changes.ApplyToLobbyApplyToLobbyILobbyChangesChangedLobbyValueprivate void OnLobbyChanged(ILobbyChanges changes){ changes.ApplyToLobby(m_Lobby); if (changes.Name.Changed) { // Do something specific due to this change } // Refresh the UI in some way}
Lobby バージョン
Lobby バージョンは、最後にロビーが観測された後、新規にフェッチされたロビーが変更されたかどうかを確認するのに役立ちます。すべてのロビーがVersionGetLobbyvar lobby = await Lobbies.Instance.GetLobbyAsync("lobbyId");var version = lobby.Version;// check if a newer version of the lobby is available:var newLobby = await Lobbies.Instance.GetLobbyAsync("lobbyId", version);if (newLobby != null){ // New lobby version received version = lobby.Version; // observe changed values in newLobby:}
トラブルシューティング
提供されたすべてのイベントを処理していることを確認してください。特にOnLobbyEventConnectionStateChangedOnKickedFromLobbyOnLobbyEventConnectionStateChanged
Lobby Events の接続ステータスは、イベントを受信するかどうかを示します。 以下は接続ステータスです。 Unsubscribed (サブスクライブ解除済み)- を使用してサブスクライブ解除することを選択しました
ILobbyEvents.UnsubscribeAsync - 今後はロビーイベントを受信しません。
- Lobby Events は接続を試行しています。
- ロビーイベントは受信しません。
- Lobby Events は正常に接続します。
- ロビーイベントを受信します。
- 接続に一時的な問題があります。
- Lobby Events は再接続を自動的に試みます。
- ロビーイベントは受信しません。
エラー
- 接続に回復不能な問題があります。
- これは、インターネットの停止など、より大きな問題を示している可能性があります。解決には手動での介入が必要で、もう一度サブスクライブする必要がある場合があります。
- ロビーイベントは受信しません。
API
インターフェース
ILobbyServiceSDK
メソッド / 設定名 | 戻り値の型 | 説明 |
|---|---|---|
| SubscribeToLobbyEventsAsync | Task<ILobbyEvents> | ロビーイベントをサブスクライブし、そのサブスクリプションを制御するオブジェクトを返します。 |
ILobbyEvents
メソッド / 設定名 | 戻り値の型 | 説明 |
|---|---|---|
| Callbacks | LobbyEventCallbacks | |
| SubscribeAsync | Task | イベントをサブスクライブします。これは、最初に |
| UnsubscribeAsync | Task | ロビーイベントをサブスクライブ解除して、変更の受信を停止します。 |
ILobbyChanges
メソッド / 設定名 | 戻り値の型 | 説明 |
|---|---|---|
| LobbyDeleted | bool | ロビーが削除されたかどうかを示すブーリアン値。ロビーが削除された場合は true で、まだ使用可能な場合は false です。 |
| Name | ChangedLobbyValue<string> | ロビーの名前に対する変更 (変更された場合)。 |
| IsPrivate | ChangedLobbyValue<bool> | ロビーが Private かどうかに関する変更 (変更された場合)。 |
| IsLocked | ChangedLobbyValue<bool> | ロビーがロックされているかどうかに関する変更 (変更された場合)。 |
| AvailableSlots | ChangedLobbyValue<int> | ロビー内の使用可能スロットに対する変更 (変更された場合)。 |
| MaxPlayers | ChangedLobbyValue<int> | ロビー内の最大プレイヤー数に対する変更 (変更された場合)。 |
| Data | ChangedOrRemovedLobbyValue<Dictionary<string, ChangedOrRemovedLobbyValue<DataObject>>> | ロビーのデータに対する変更 (変更された場合)。 |
| PlayerLeft | ChangedLobbyValue<List<int>> | 退出したプレイヤーのリスト (いる場合)。 |
| PlayerJoined | ChangedLobbyValue<List<LobbyPlayerJoined>> | 参加したプレイヤーのリスト (いる場合)。 |
| PlayerData | ChangedLobbyValue<Dictionary<int, LobbyPlayerUpdated>> | プレイヤーのデータに対する変更 (変更された場合)。 |
| HostId | ChangedLobbyValue<string> | ロビーのホスト ID に対する変更 (変更された場合)。 |
| Version | int | ロビーの最新バージョン。 |
| LastUpdated | ChangedLobbyValue<DateTime> | ロビーの変更が行われた時刻。 |
| ApplyToLobby | void | ロビーおよび変更アプリケーターを取得して、特定のロビーをインプレースで更新します。 |
クラス、構造体、enum
LobbyEventCallbacks
イベント名 | 引数タイプ | 説明 |
|---|---|---|
| LobbyChanged | ILobbyChanges | ロビーがサーバー上で変更された場合、Lobby サービスは発生した変更のセットとともにこのイベントを起動します。 |
| KickedFromLobby | サーバー上のロビーに対するサブスクリプションが強制的に解除されたとき。 | |
| LobbyEventConnectionStateChanged | LobbyEventConnectionState | サブスクリプション接続の状態が変わったとき。 |
ChangedLobbyValue<T>
設定名 | 戻り値の型 | 説明 |
|---|---|---|
| Value | T | 変更によって提供された新しい値。 |
| Changed | bool | 変更が発生した場合は true で、変更がなかった場合は false。 |
LobbyValueChangeType<T>
enum 値の名前 | enum 値 | 説明 |
|---|---|---|
| Unchanged | 0 | 値は変更されませんでした。 |
| Changed | 1 | 値は変更されました。 |
| Removed | 2 | 値は削除されました。 |
ChangedOrRemovedLobbyValue<T>
設定名 | 戻り値の型 | 説明 |
|---|---|---|
| Value | T | 変更によって提供された新しい値。 |
| Changed | bool | 変更が発生した場合は true で、変更がなかった場合は false。 |
| ChangeType | LobbyValueChangeType | これが変更と削除のどちらであるか。 |
エラーコード
以下のエラーコードが追加されました。LobbyExceptionReason の enum 値 | エラーコード | 説明 |
|---|---|---|
| AlreadySubscribedToLobby | 16601 | このロビーはすでにサブスクライブしており、再度サブスクライブを試行しました |
| SubscriptionToLobbyLostWhileBusy | 16602 | サブスクライブやサブスクライブ解除など、接続を使用した操作中に接続が失われたか切断されました |
| LobbyEventServiceConnectionError | 16603 | Lobby サービスへの接続試行中に問題が発生しました。有効なロビー ID が送信されたことを確認してください |