VRChat 非公式日本語ドキュメント

プレイヤー参加ゾーン

Player Join Zones World Preview

このサンプルは、プレイヤーの位置に基づいてプレイヤーを集める方法や、基本的なロビー機能の実装方法を示しています。ユーザーがゲームに参加し、プレイして結果を確認した後、新しいゲームを開始するといった一連の流れを構築できます。この機能は、インスタンス内の特定のプレイヤーのみで遊ぶゲームなど、参加型のエクスペリエンスを作成する際に役立ちます。また、ランダムに選ばれたプレイヤーを巨大化させる方法や、プレハブのロジックを拡張して別のモードを追加する方法も紹介しています。

実際に試してみたい場合は、Player Join Zones Example World にアクセスしてください。

サンプルの使用方法

これらのサンプルは1人のプレイヤーでも動作しますが、2人以上でテストするとより効果的です。 まずは player-join-zones シーンをUnity Editorで開いて試すか、上記のリンクからVRChatクライアントでサンプルワールドにアクセスしてください。 このサンプルにはTextMeshProが必要です。プロジェクトにTextMeshProが含まれていない場合は、ウィンドウが表示され「Import TMP Essentials」を求められます。この指示に従ってインポートし、完了後にシーンを再度開いてください。

Player Join Zone:

  1. まず、キャンバスの下部にあるボタンが「Players Needed」と表示され、操作できない状態になっていることを確認してください。
  2. 床のハイライト表示されたエリア内に入ると、目の前のボードに自分の displayName が表示されるのを確認できます。
  3. エリアに出入りすることで、自分の名前が表示されたり消えたりします。
  4. 「Start Game」ボタンを押してプレイヤーリストを確定させます。ボタンを押すと、プレイヤーの出入りによってリストが変更されることはなくなります。
  5. 「Reset」と表示されたボタンを押すとプレイヤーリストが消去され、新しいリストを作成できるようになります。

Boss Picker:

  1. 床のハイライト表示されたエリア内に入ると、目の前のボードの「Possible Bosses:」というラベルの下に自分の displayName が表示されるのを確認できます。
  2. エリアに出入りすることで、自分の名前が表示されたり消えたりします。
  3. 「Start Game」ボタンを押すと、プレイヤーがランダムに1人選ばれて巨大化し、「Boss」となります。ラベルが「Possible Bosses:」から「Boss:」に変わることに注目してください。
  4. 「Reset」と表示されたボタンを押すと、ボスが元のサイズに戻り、プレイヤーリストが消去されて新しいリストを作成できるようになります。

サンプルのインポート

以下の手順に従って、このサンプルを Unity プロジェクトに追加します。

  1. Unity エディターのメニューの「VRChat SDK > 🏠 Example Central」から Example Central ウィンドウ を開きます。
  2. リストの中からこのプレハブを探すか、タイトル（このページのタイトルと同じ）で検索します。
  3. 「Import」ボタンを押して、Unitypackage をプロジェクトにインポートします。

技術的詳細解説

このセクションでは、ベースプログラムとその2つの拡張機能である JoinZoneWithDisplay および BossPicker について解説します。

PlayerJoinZone プログラムは、特定のゾーン内のプレイヤーを管理するためのベースクラスです。このプログラムは以下の処理を担います。

インタラクションの例:

  1. ゾーンがモードを MODE_JOIN に設定し、このプログラムを持つGameObjectのオーナーに ResetPlayers() を実行させます。
    1. ResetPlayers() が、オーナー上に新しい Players DataListを作成します。
  2. プレイヤー「Dingbat」がゾーンのコライダーに入り、インスタンス内の全員に対して OnPlayerTriggerStay イベントをトリガーします。
    1. オーナーはDingbatがリストに既に存在するかを確認し、それ以外のプレイヤーはトリガーを無視します。リストにDingbatが見つからないため、オーナーはDingbatを追加します。
    2. Dingbatがゾーン内に留まっている間はこのイベントがトリガーされ続けますが、既にDataListに存在するため、それ以上の処理は行われません。
  3. プレイヤー「SquirrelFam」がゾーンのコライダーに入り、上記と同じアクションがトリガーされます。これにより、Players DataListには2人のプレイヤーが入った状態になります。
  4. Dingbatが別のゲームをプレイすることにし、インスタンスから退出します。
  5. ゾーンはDingbatに対する OnPlayerLeft イベントを受け取り、Players DataListからDingbatを削除します。これでSquirrelFamのみが残ります。
  6. SquirrelFamがゾーンから出ると OnPlayerTriggerExit イベントがトリガーされ、オーナーはこれに応答してDataListからSquirrelFamを削除します。これでDataListには誰もいない状態になります。

クラスの拡張

上記のインタラクション例では Players リストが作成・更新されましたが、インスタンス内のユーザーには何の表示も行われませんでした。これは、ベースクラスには多くのシナリオで有用なロジックが含まれていますが、単体では完結していないためです。機能をどのように追加できるかを示すため、このベースクラスの2つの拡張機能を用意しています。

JoinZoneWithDisplay

この拡張機能は、いくつかのUIフィールドとボタンをコアロジックに接続し、実用可能な状態にします。ベースクラスにはUI項目への参照が含まれていません。これは、プロジェクト内で再利用や拡張をしやすくするためです。

このクラスには以下のUIオブジェクトが含まれます。

このクラスは新しい文字列 PlayerNamesString を追加します。これは、現在の全プレイヤー名をコンマで区切ったテキスト行です。これはオーナー上で構築され、全プレイヤーに同期され、FieldChangeCallbackを使用して _playerNamesField を更新します。また、MODE_WAIT という新しいモードを追加します。これはUIボタンを3秒間凍結し、「ゲーム」がすぐに終了してしまうのを防ぎます。この期間は _waitDuration のインスペクターフィールドで設定可能です。

PlayerJoinZone プログラムのインタラクション例を再確認すると、JoinZoneWithDisplay プログラムを使用した場合、以下のように動作が異なります。

  1. Players Datalist を作成した後、OnPlayersChanged() メソッドが呼び出されます。このメソッドは基底クラスでは空ですが、拡張クラスでは基底クラスの GetPlayersAsStringList() メソッドを実行することで、同期文字列 PlayerNamesString を設定します。
    1. インスタンス内の全プレイヤーがこの更新された文字列を受け取り、その値を使って各々の _playerNamesField 内のテキストを設定します。
    2. 各プレイヤーは SetupButtonFromPlayers() も呼び出します。これにより、ゾーン内に誰もいない場合は _toggleButton のテキストが「Players Needed」に変更されます。
  2. Owner が Dingbat を Players Datalist に追加すると、OnPlayersChanged() メソッドが再度トリガーされます。これにより上記と同じ変更が伝播され、同期された PlayerNamesString の値が更新されるほか、必要に応じてテキストフィールドやボタンラベルの更新も行われます。

Owner が Players リストに対して行うすべての変更の直後には、データを更新してインスタンス内の他の全員に表示させるために OnPlayersChanged() が呼び出されます。

この例には、以下のようにモードを切り替えるためのボタンも用意されています。

  1. 任意のプレイヤーがボタンを押すと、そのボタンは UdonBehavior.SendCustomEvent(_ToggleMode) にリンクされています。押したプレイヤーが Owner でない場合、イベント ToggleModeRPC() が Owner に送信されます。Owner である場合は、自身で ToggleModeRPC() を呼び出します。いずれの場合もそのメソッドが実行され、スイッチが次の Mode へと切り替わります。
  2. Mode は FieldChangeCallback を持つ同期変数であるため、その値はインスタンス内の全員で更新され、各プレイヤーのローカルで OnModeChanged() 関数が実行されます。
  3. このメソッドは基底クラスではほぼ空（外部リスナーへの伝播ロジックのみを含む）ですが、この例では、現在のモードが MODE_CHOSEN である場合に _toggleButton のラベルを「Reset」に設定します。

このクラスによって設定されるすべてのテキストは、簡単に更新できるようクラス上部の数箇所にある文字列変数で定義されています。

BossPicker

この拡張機能は JoinZoneWithDisplay と同様のフィールドをいくつか持ち、選択されたグループから1人のプレイヤーを選んでスケールを適用するロジックを追加しています。これは、1人のキャラクターを他のキャラクターより大きくする必要があるゲームを作成する際に役立ちます。また、スコアを確認するための MODE_GAMEOVER というモードも追加されています。

これには同期フィールド PlayerNamesString が含まれており、リストを作成してインスタンス内の全プレイヤーに同期し、テキストフィールドを更新するために同じロジックを使用します。

Mode が MODE_CHOSEN に変更されると、Owner は Datalist からランダムに1人のプレイヤーを選択し、その PlayerId を _bossPlayerId として保存します。これは FieldChangeCallback を持ち、_OnBossChanged() をトリガーする新しい同期フィールドです。

OnBossChanged() 内では、各プレイヤーが自分が Boss かどうかを確認します。Boss であれば、AvatarEyeHeight を最大サイズ（現在は5ユニット）に設定します。それ以外のすべてのプレイヤーは、Inspector で調整可能な _maxPlayerHeight よりも大きい場合にのみ身長が変更されます。

ToggleModeRPC() メソッドは、新しいモードを処理するためにこのクラスでオーバーライドされています。現在、MODE_CHOSEN は、5秒後（または Inspector で gameDuration に設定した値）に自動的に MODE_END へ移行するタイマーを開始します。また、このメソッドは MODE_CHOSEN 状態の間、ボタンを無効にしてゲームが早期に終了しないようにします。最後に、UI ボタンが押されたときに MODE_END から MODE_JOIN へ移行するロジックが含まれています。

OnModeChanged() では、モードが MODE_JOIN に戻ったとき（通常はゲーム終了後、新しいラウンドが開始される際）、各プレイヤーは元の身長にリセットされます。

Udon Graph および既存プログラムとの統合

これらのプログラムにはそれぞれ targets フィールドがあり、これは UdonBehaviour の配列になっています。Udonプログラムを作成・修正して、常に最新の状態に保たれる特別な変数をいくつか含めることができます。それらは以下の通りです。

「Graph Listener」キャンバスはこれを示しており、両方のプログラムからの最新のイベントや更新情報を表示に反映させます。このUdon Graphプログラムでは、単純にこれら3つのパブリック変数を実装し、OnVariableChanged ノードを使用してそれらの変更に反応させ、結果をテキストフィールドに書き込んでいます。

最終更新: