Photon Unity Networking 2  v2.1
English | 日本語 | 한국
Public Member Functions | List of all members
MonoBehaviourPunCallbacks Class Reference

このクラスは、.photonViewと、PUNが呼び出すことができるすべてのコールバック/イベントを提供します。使用したいイベント/メソッドをオーバーライドします。 More...

Inherits MonoBehaviourPun, IConnectionCallbacks, IMatchmakingCallbacks, IInRoomCallbacks, and ILobbyCallbacks.

Inherited by ConnectAndJoinRandom, CountdownTimer, PlayerNumbering, PunTeams, and PunTurnManager.

Public Member Functions

virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void OnConnected ()
 生の接続が確立されたことを知らせるために、クライアントがサーバーで操作を呼び出すことができる前に呼ばれます。 More...
 
virtual void OnLeftRoom ()
 ローカルユーザー/クライアントがルームを出たときに呼び出され、ゲームのロジックが内部状態をクリーンアップできるようにします。 More...
 
virtual void OnMasterClientSwitched (Player newMasterClient)
 現在のMasterClientが終了したときに新しいMasterClientに切り替えた後に呼び出されます。 More...
 
virtual void OnCreateRoomFailed (short returnCode, string message)
 サーバーがルームを作成できなかったとき(OpCreateRoomが失敗したとき)に呼び出されます。 More...
 
virtual void OnJoinRoomFailed (short returnCode, string message)
 前回のOpJoinRoom呼び出しがサーバーで失敗したときに呼び出されます。 More...
 
virtual void OnCreatedRoom ()
 このクライアントがルームを作成して入室すると呼び出されます。 OnJoinedRoom ()も呼び出されます。 More...
 
virtual void OnJoinedLobby ()
 マスターサーバーのロビーに入るときに呼び出されます。実際のルームリストの更新はOnRoomListUpdateを呼び出します。 More...
 
virtual void OnLeftLobby ()
 ロビーを出た後に呼び出されます。 More...
 
virtual void OnDisconnected (DisconnectCause cause)
 Photonサーバーから切断した後に呼び出されます。失敗、または意図的な可能性があります。 More...
 
virtual void OnRegionListReceived (RegionHandler regionHandler)
 ネームサーバーがあなたの役職のリージョンのリストを提供したときに呼び出されます。 More...
 
virtual void OnRoomListUpdate (List< RoomInfo > roomList)
 Master Serverのロビー(InLobby)にいる間に、ルームリストを更新するために呼び出されます。 More...
 
virtual void OnJoinedRoom ()
 このクライアントがルームを作成したか参加したかに関係なく、LoadBalancingClientがルームに入ったときに呼び出されます。 More...
 
virtual void OnPlayerEnteredRoom (Player newPlayer)
 リモートプレイヤーがルームに入ったときに呼び出されます。このプレイヤーはすでにプレイヤーリストに追加されています。 More...
 
virtual void OnPlayerLeftRoom (Player otherPlayer)
 リモートプレイヤーがルームを離れるか、非アクティブになったときに呼び出されます。 otherPlayer.IsInactiveを確認してください。 More...
 
virtual void OnJoinRandomFailed (short returnCode, string message)
 前回のOpJoinRandom呼び出しがサーバーで失敗したときに呼び出されます。 More...
 
virtual void OnConnectedToMaster ()
 クライアントがMaster Serverに接続されていて、マッチメイキングやその他のタスクを行う準備が整ったときに呼び出されます。 More...
 
virtual void OnRoomPropertiesUpdate (Hashtable propertiesThatChanged)
 ルームのカスタムプロパティが変更されたときに呼び出されます。propertiesThatChangedには、Room.SetCustomPropertiesで設定されたものがすべて含まれています。 More...
 
virtual void OnPlayerPropertiesUpdate (Player target, Hashtable changedProps)
 カスタムプレイヤープロパティが変更されたときに呼び出されます。 Playerと変更されたプロパティはobject[]として渡されます。 More...
 
virtual void OnFriendListUpdate (List< FriendInfo > friendList)
 サーバーがFindFriends要求に応答を送信したときに呼び出されます。 More...
 
virtual void OnCustomAuthenticationResponse (Dictionary< string, object > data)
 カスタム認証サービスが追加データで応答したときに呼び出されます。 More...
 
virtual void OnCustomAuthenticationFailed (string debugMessage)
 カスタム認証が失敗したときに呼び出されます。続いて切断されます! More...
 
virtual void OnWebRpcResponse (OperationResponse response)
 
virtual void OnLobbyStatisticsUpdate (List< TypedLobbyInfo > lobbyStatistics)
 マスターサーバーがロビー統計の更新を送信したときに呼び出されます。 More...
 

Additional Inherited Members

- Properties inherited from MonoBehaviourPun
PhotonView photonView [get]
 このGameObjectのPhotonViewへのキャッシュされた参照。 More...
 

Detailed Description

このクラスは、.photonViewと、PUNが呼び出すことができるすべてのコールバック/イベントを提供します。使用したいイベント/メソッドをオーバーライドします。

このクラスを拡張することで、オーバーライドとして個々のメソッドを実装できます。

「override」と入力し始めると、Visual StudioとMonoDevelopがメソッドのリストを提供します。 実装は "base.method()"を呼び出す必要はありません。

このクラスはすべてのコールバックインターフェイスを実装し、 Photon.Pun.MonoBehaviourPun.

Member Function Documentation

virtual void OnConnected ( )
virtual

生の接続が確立されたことを知らせるために、クライアントがサーバーで操作を呼び出すことができる前に呼ばれます。

接続 (低レベルトランスポート)が確立された後、クライアントは自動的に認証操作を送信します。 クライアントが他の操作を呼び出す前に応答を取得する必要があります。

ロジックは、OnRegionListReceivedまたはOnConnectedToMasterのいずれかを待つ必要があります。

このコールバックは、サーバーにアクセスできるかどうかを検出するのに役立ちます(技術的に)。 ほとんどの場合、OnDisconnected()を実装すれば十分です。

これは、マスターサーバーからゲームサーバーへの移行では呼び出されません。

Implements IConnectionCallbacks.

virtual void OnConnectedToMaster ( )
virtual

クライアントがMaster Serverに接続されていて、マッチメイキングやその他のタスクを行う準備が整ったときに呼び出されます。

LoadBalancingClient.OpJoinLobbyでロビーに入らない限り、利用可能なルームのリストは利用可能になりません。 ロビーにいなくても、ルームに参加してルームを作成できます。その場合はデフォルトのロビーが使用されます。

Implements IConnectionCallbacks.

Reimplemented in ConnectAndJoinRandom.

virtual void OnCreatedRoom ( )
virtual

このクライアントがルームを作成して入室すると呼び出されます。 OnJoinedRoom ()も呼び出されます。

このコールバックはルームを作成したクライアント上でのみ呼び出されます(OpCreateRoom参照)。

クライアントはいつでも閉じる(または接続を切断する)可能性があるため、 ルームの作成者がOnCreatedRoomを実行しない可能性があります。

特定のルームのプロパティや「開始信号」が必要な場合は、OnMasterClientSwitched ()を実装し、 新しいMasterClientごとにルームの状態を確認します。

Implements IMatchmakingCallbacks.

virtual void OnCreateRoomFailed ( short  returnCode,
string  message 
)
virtual

サーバーがルームを作成できなかったとき(OpCreateRoomが失敗したとき)に呼び出されます。

ルームの作成が失敗する最も一般的な原因は、タイトルが固定のルーム名に依存していて、そのルームがすでに存在している場合です。

Parameters
returnCodeサーバーからの操作ReturnCode。
messageエラーに関するデバッグメッセージ。

Implements IMatchmakingCallbacks.

virtual void OnCustomAuthenticationFailed ( string  debugMessage)
virtual

カスタム認証が失敗したときに呼び出されます。続いて切断されます!

カスタム認証は、ユーザー入力、不適切なトークン/秘密が原因で失敗する可能性があります。 認証が成功した場合、このメソッドは呼び出されません。 OnJoinedLobby ()またはOnConnectedToMaster ()を実装します(通常どおり)。

ゲームの開発中は、サーバー側の設定が間違っていることが原因で失敗することもあります。 そのような場合、debugMessageをログに記録することが非常に重要です。

アプリのカスタム認証サービスを(ダッシュボードに設定しない限り、 これは呼び出されません。

Parameters
debugMessage認証が失敗した理由を示すデバッグメッセージが含まれています。開発中に修正する必要があります。

Implements IConnectionCallbacks.

virtual void OnCustomAuthenticationResponse ( Dictionary< string, object >  data)
virtual

カスタム認証サービスが追加データで応答したときに呼び出されます。

カスタム認証サービスは、応答にいくつかのカスタムデータを含めることができます。 そのデータが存在する場合はこのコールバックでDictionaryとして利用可能になります。 データのキーは文字列である必要がありますが、値は文字列または数値(Jsonの場合)のいずれかです。 値の型が予想しているものであることを、確かめてください。数値は(現在)int64になります。

例: void OnCustomAuthenticationResponse(Dictionary<string, object> data) { ... }

https://doc.photonengine.com/en-us/realtime/current/reference/custom-authentication

Implements IConnectionCallbacks.

virtual void OnDisconnected ( DisconnectCause  cause)
virtual

Photonサーバーから切断した後に呼び出されます。失敗、または意図的な可能性があります。

この切断の理由は、DisconnectCauseとして示されています。

Implements IConnectionCallbacks.

Reimplemented in ConnectAndJoinRandom.

virtual void OnFriendListUpdate ( List< FriendInfo friendList)
virtual

サーバーがFindFriends要求に応答を送信したときに呼び出されます。

OpFindFriendsを呼び出した後、Master Serverはフレンドリストをキャッシュし、フレンドリストに更新情報を送信します。 友達には、リクエストされた各ユーザ/友達の名前、userId、オンライン状態、およびルーム(存在する場合)が含まれます。

UIで変更が強調表示される場合は、friendListを使用してUIを更新し、保存します。

Implements IMatchmakingCallbacks.

virtual void OnJoinedLobby ( )
virtual

マスターサーバーのロビーに入るときに呼び出されます。実際のルームリストの更新はOnRoomListUpdateを呼び出します。

ロビーにいる間、ルームリストは一定の間隔で自動的に更新されます(パブリッククラウドでは変更できません)。 ルームリストはOnRoomListUpdateを介して利用可能になります。

Implements ILobbyCallbacks.

Reimplemented in ConnectAndJoinRandom.

virtual void OnJoinedRoom ( )
virtual

このクライアントがルームを作成したか参加したかに関係なく、LoadBalancingClientがルームに入ったときに呼び出されます。

これが呼び出されると、Room.Playersの既存のプレイヤー、それらのカスタムプロパティ、およびRoom.CustomPropertiesにアクセスできます。

このコールバックでは、プレイヤーオブジェクトを作成できます。たとえばUnityでは、プレイヤーのプレハブをインスタンス化します。

対戦を「積極的に」開始する場合は、ユーザーに「準備完了」を知らせることができます(OpRaiseEventまたはカスタムプロパティを使用)。

Implements IMatchmakingCallbacks.

Reimplemented in PlayerNumbering, ConnectAndJoinRandom, and PunTeams.

virtual void OnJoinRandomFailed ( short  returnCode,
string  message 
)
virtual

前回のOpJoinRandom呼び出しがサーバーで失敗したときに呼び出されます。

最も一般的な原因は、ルームがいっぱいであるか存在しないことです(他の人が先に入室した場合やルームを閉じた場合)。

複数のロビーを使用する場合(OpJoinLobbyまたはTypedLobbyパラメータを介して)、他のロビーにはより多くの/適切なルームがあるかもしれません。

Parameters
returnCodeサーバーからの操作ReturnCode。
messageエラーに関するデバッグメッセージ。

Implements IMatchmakingCallbacks.

Reimplemented in ConnectAndJoinRandom.

virtual void OnJoinRoomFailed ( short  returnCode,
string  message 
)
virtual

前回のOpJoinRoom呼び出しがサーバーで失敗したときに呼び出されます。

最も一般的な原因は、ルームがいっぱいであるか存在しないことです(他の人が先に入った場合やルームを閉じた場合)。

Parameters
returnCodeサーバーからの操作ReturnCode。
messageエラーに関するデバッグメッセージ。

Implements IMatchmakingCallbacks.

virtual void OnLeftLobby ( )
virtual

ロビーを出た後に呼び出されます。

ロビーを出ると、[OpCreateRoom](@ ref OpCreateRoom)と[OpJoinRandomRoom](OpJoinRandomRoom) は自動的にデフォルトのロビーを参照します。

Implements ILobbyCallbacks.

virtual void OnLeftRoom ( )
virtual

ローカルユーザー/クライアントがルームを出たときに呼び出され、ゲームのロジックが内部状態をクリーンアップできるようにします。

ルームを出るとき、LoadBalancingClientはゲームサーバーを切断し、マスターサーバーに接続します。 これは複数の内部アクションをまとめたものです。

ロビーを使用して会議室に参加または作成する前に、コールバックOnConnectedToMasterを待ちます。

Implements IMatchmakingCallbacks.

Reimplemented in PlayerNumbering, and PunTeams.

virtual void OnLobbyStatisticsUpdate ( List< TypedLobbyInfo lobbyStatistics)
virtual

マスターサーバーがロビー統計の更新を送信したときに呼び出されます。

このコールバックには2つの前提条件があります: このクライアントが接続する前に、EnableLobbyStatisticsをtrueに設定する必要があります。 また、クライアントはマスターサーバーに接続する必要があり、マスターサーバーはロビーに関する情報を提供します。

Implements ILobbyCallbacks.

virtual void OnMasterClientSwitched ( Player  newMasterClient)
virtual

現在のMasterClientが終了したときに新しいMasterClientに切り替えた後に呼び出されます。

このクライアントがルームに入るとき、これは呼ばれません。 このメソッドが呼び出されたとき、前のMasterClientはまだプレイヤーリストにあります。

Implements IInRoomCallbacks.

virtual void OnPlayerEnteredRoom ( Player  newPlayer)
virtual

リモートプレイヤーがルームに入ったときに呼び出されます。このプレイヤーはすでにプレイヤーリストに追加されています。

ゲームが特定のプレイヤー数で開始される場合、このコールバックでRoom.playerCountを確認して 開始できるかどうかを判断するのに使用します。

Implements IInRoomCallbacks.

Reimplemented in PlayerNumbering, and PunTeams.

virtual void OnPlayerLeftRoom ( Player  otherPlayer)
virtual

リモートプレイヤーがルームを離れるか、非アクティブになったときに呼び出されます。 otherPlayer.IsInactiveを確認してください。

他のプレイヤーがルームを離れる時、またはサーバーが接続の切断を検出した時、 ゲームロジックに通知するためにこのコールバックが使用されます。

ルームの設定によっては、プレイヤーが非アクティブになることがあります。つまり、プレイヤーは戻ってきてルーム内に戻ることがあります。 そのような場合、プレイヤーはRoom.Players辞書に残ります。

プレイヤーが非アクティブでない場合は、コールバックが呼び出される前に、 Room.Players辞書から削除されます。

Implements IInRoomCallbacks.

Reimplemented in PlayerNumbering, and PunTeams.

virtual void OnPlayerPropertiesUpdate ( Player  target,
Hashtable  changedProps 
)
virtual

カスタムプレイヤープロパティが変更されたときに呼び出されます。 Playerと変更されたプロパティはobject[]として渡されます。

プロパティの変更はPlayer.SetCustomPropertiesによって行われる必要があります。これにより、このコールバックもローカルで行われます。

Parameters
targetPlayer変更されたPlayerが含まれています。
changedProps変更されたプロパティが含まれています。

Implements IInRoomCallbacks.

Reimplemented in PlayerNumbering, and PunTeams.

virtual void OnRegionListReceived ( RegionHandler  regionHandler)
virtual

ネームサーバーがあなたの役職のリージョンのリストを提供したときに呼び出されます。

提供された値を使用するには、RegionHandlerクラスの説明を確認してください。

Parameters
regionHandler現在使用されているRegionHandler。

Implements IConnectionCallbacks.

virtual void OnRoomListUpdate ( List< RoomInfo roomList)
virtual

Master Serverのロビー(InLobby)にいる間に、ルームリストを更新するために呼び出されます。

各アイテムはRoomInfoであり、カスタムプロパティを含むことができます(ただし、ルームを作成するときにそれらをロビーリストとして定義した場合)。 すべての種類のロビーがクライアントにルームのリストを提供するわけではありません。サイレントでサーバーサイドのマッチメイキング用のものもあります。

Implements ILobbyCallbacks.

virtual void OnRoomPropertiesUpdate ( Hashtable  propertiesThatChanged)
virtual

ルームのカスタムプロパティが変更されたときに呼び出されます。propertiesThatChangedには、Room.SetCustomPropertiesで設定されたものがすべて含まれています。

v1.25以降、このメソッドは1つのパラメータ、Hashtable propertiesThatChangedを持ちます。
プロパティの変更はRoom.SetCustomPropertiesによって行われる必要があります。これにより、このコールバックもローカルで発生します。

Parameters
propertiesThatChanged

Implements IInRoomCallbacks.

Reimplemented in PunTurnManager, and CountdownTimer.