レプリケート関数 のセットアップ方法と様々な形式の使用方法を紹介します。
レプリケート関数は、主に Multicast、Run on Server、Run on owning Client に分類されます。Multicast 関数は、実行され、その後自動でクライアント側に順送りされると、サーバー上で呼び出されます。Server 関数はクライアントによって呼び出され、サーバー上でのみ実行されます。Client 関数はサーバーで呼び出され、所有しているクライアント上でのみ実行されます。
Multicast
この例では、スターター コンテンツ を有効にして Blueprint Third Person テンプレート を使用します。
Multicast レプリケート関数を設定する方法を説明します。
-
[Play] ボタンの横にある下向きの矢印をクリックし、 Number of Players を 4 に設定します。
[Advanced Settings] オプションで、マルチプレイヤー用に生成されたウィンドウのサイズを変更することができます。
-
コンテンツ ブラウザ の Content/ThirdPersonBP/Blueprints で ThirdPersonCharacter ブループリントを開きます。
-
グラフを 右クリック し、 Space Bar Key Event を追加し、 Spawn Actor from Class ノードに接続します。
-
右クリック して Get Actor Transform ノードを追加し、Class を Blueprint_Effect_Fire に設定して以下のように接続します。
これを押すと、プレイヤー キャラクターの位置で炎のエフェクトがスポーンされます。
-
コンパイル および 保存 をしたら、ブループリントを終了し、 [Play] ボタンをクリックしてエディタで再生します。
-
ゲーム内で [Server] というウィンドウを探して、ジャンプするために スペース バー を押します。
スポーンされたエフェクトが見えるのはこのサーバー ウィンドウのみで、その他のプレイヤーからは見えません。
他のプレイヤーでジャンプを試みる場合、他のプレイヤーは炎のエフェクトをローカルにのみスポーンし、それ以外のプレイヤーはエフェクトがスポーンされたことに気づきません。 さらに、炎のエフェクトはキャラクターにはアタッチされていないので、 スペース バー を押した時のみキャラクター位置でのみスポーンされます。
Shift + F1 でマウス コントロールが可能になり、マルチプレイヤー テスティング中にゲームウィンドウ間をジャンプできます。
-
ThirdPersonCharacter ブループリントで、Space Bar ノードの Pressed を 右クリック して切断します。
-
右クリック して Custom Event を見つけて追加し、 MulticastSpawn Event を呼び出します。
-
カスタム イベントをクリックし、 [Details] パネルの [Replicates] のドロップダウン メニューを Multicast に設定し、以下のように接続します。
クリックしてフルサイズで表示
最後のいくつかのステップは上のような結果になり、カスタム イベントを Multicast Replication を使用するように設定しました。
-
Space Bar Key Event を引き出して、コール関数 MulticastSpawn を探して追加します。
作成したカスタム イベントが見つからない場合は、 [Compile] ボタンをクリックして再度検索してください。
-
コンパイル および 保存 をしたら、ブループリントを終了し、 [Play] ボタンをクリックしてエディタで再生します。
-
ゲーム内で [Server] というウィンドウを探して、ジャンプするために スペース バー を押します。
今回は、スペース バーを押すとサーバーのプレイヤーがジャンプし、サーバーだけでなくすべてのクライアント上で炎のエフェクトがスポーンされる様子が確認できます。クライアントがエフェクトをスポーンしたことをサーバーに伝えていないので、他のプレイヤーでジャンプを試しても、エフェクトはまだローカルでしかスポーンされません。その設定方法を、次のセクション『 Run on Server 』で説明します。
Run On Server
このセクションでも、引き続き Multicast Replication からのサンプルを使用します。
Run on Server レプリケート関数の設定は、以下の手順でおこないます。
-
コンテンツ ブラウザ の Content/ThirdPersonBP/Blueprints で ThirdPersonCharacter ブループリントを開きます。
-
MulticastSpawn Custom Event を選択し、Replicates ドロップダウン オプションを Run on Server に変更します。
クリックしてフルサイズで表示
整合を取るために Graph Node の名前を Run On Server に変更します。
-
コンパイル および 保存 をしたら、ブループリントを終了し、 [Play] ボタンをクリックしてエディタで再生します。
-
ゲーム内で [Server] 以外のゲーム ウィンドウを探し、ジャンプさせるために スペース バー を押します。
炎のエフェクトはどのプレイヤーがジャンプしてもサーバー上でのみスポーンされます。サーバー上のプレイヤー以外には見えません。このスクリプトは命令通りにサーバー上でのみ実行されているので、エフェクト自体がレプリケートされて、サーバーだけでなくすべてのクライアントに渡されるようにしてください。
-
「Content/StarterContent/Blueprints」 フォルダ内で、Blueprint_Effect_Fire ブループリントを開きます。
-
メイン ツールバーで Class Defaults を選択し [Details] パネルで [Replicates] チェックボックスにチェックを入れます。
-
コンパイル および 保存 をしたら、ブループリントを終了し、 [Play] ボタンをクリックしてエディタで再生します。
-
ゲーム内で [Server] 以外のゲーム ウィンドウを探し、ジャンプさせるために スペース バー を押します。
すべてのクライアント上でも見えるようにアクタをレプリケートする設定にしたので、サーバー側のスクリプトを部分的に実行するようにサーバーに実際にメッセージを送りました。
Run On Owning Client
このセクションでも、引き続き Multicast Replication からのサンプルを使用します。
このセクションでは、サーバー イベントが発行されると、ある特定のクライアントだけを更新する変数を作成してみます。
Run on owning Client レプリケート関数の設定は、以下のステップで行います。
-
「Content/ThirdPersonBP/Blueprints 」フォルダで ThirdPersonCharacter ブループリントを開きます。
-
[MyBlueprint] ウィンドウで、新規に変数を作成し、 「Inventory」 という名前を付けて [Compile] をクリックします。
-
変数の [Details] パネルで String 、Editable 、Replicated に設定し、 Default Value に 「Empty」と入力します。
この変数を Replicated に設定しておけば、接続先のマシンにネットワーク経由で確実にレプリケートされます。これを使って、マルチプレイヤー ゲームでキャラクターがトリガー ボリュームへ入った時にアイテムを拾い、トリガー ボリュームを去る時にアイテムを取り除くシミュレーションを行ってみます。
-
Print String ノードに接続されている P Key Event を追加し、 Control を押しながら Inventory 変数へドラッグして、以下のように接続します。
-
コンパイル し 保存 してから、ThirdPersonCharacter ブループリントを閉じます。
-
[Place Actors] パネルの [Basic] タブにある Box Trigger をレベル内にドラッグします。
プレイヤー キャラクターがトリガー領域に入ると、作成した変数を更新しますが、トリガー ボックスに入ったクライアントのみが該当します。
-
Box Trigger の [Details] パネルで、 Rendering の [Actor Hidden In Game] オプションのチェックを外します。
これにより、エディタで再生する場合にレベルでボックスが見えるようになり、テストしやすくなります。
-
[Box Trigger] をクリックして選択し、メイン ツールバーから [Level Blueprint] を開きます。
-
グラフを 右クリック して、 Begin Overlap を検索して、 Add On Actor Begin Overlap Event を選択します。
-
前のステップを繰り返します。しかし、今回は Add On Actor End Overlap を検索して追加します。
-
それぞれのノードを Switch Has Authority ノードに接続します。
Switch Has Authority ノードは、実行中のスクリプトがどこから実行されているのかを確認し、そのスクリプトの実行元がネットワーク経由の Authority (権限のある) マシン(通常はサーバー) または Remote (リモート) マシン (クライアント) のどちらなのかによって、2 つに分岐します。
サーバー側のみで発生させたいものに対しては、大抵、 Authority を使います (通常はゲームプレイにとって重要なものが該当します。例えば、プレイヤーのヘルス値の調整、報酬や略奪品の分配などがあります。不正行為ができないように、クライアントがこの種の変更をいつするかを決定できないようにします)。
この例では、テキスト変数を更新してみます。これは、プレイヤーのヘルス値を含む変数や収集アイテムの変数が考えられます。
-
グラフ内を 右クリック して、 Add Item という名前の Custom Event を追加します。
-
Replicates オプションを Run on owning Client に設定し、 Actor に設定されている Character という名前の入力を追加します。
作成後、ノード上にエラーの警告が出た場合は、 [Compile] ボタンをクリックしてエラーを取り除きます。
-
「Remove Item」 という名前の Custom Event を Add Item Event と同じ設定でもう 1 つ作成します。
-
Add Item ノードと Remove Item ノードを以下のように 2 つの Overlap Event に接続します。
トリガーがオーバーラップした時に、サーバー上でオーバーラップが発生すると、サーバー側の Add Item Event を実行し、それを所有するクライアント (トリガーをオーバーラップするキャラクター) へレプリケートすると宣言しています。「それ」とは、 Add Item の発行時に呼び出され、サーバー側でのみ実行されるがクライアントへレプリケートされるスクリプトを指します。キャラクターがトリガー ボックスを出ると、再度サーバー側が判断し、サーバーで Remove Item Event を実行して、それを所有するクライアントへレプリケートします。
-
Add Item Event から Print String (テキストは Item Added に設定) を追加して、 Character と Cast To ThirdPersonCharacter を引き出します。
-
As Third Person Character ピンを引き出して、テキストが Has the Item に設定されている Set Inventory ノードを検索して追加します。
クリックしてフルサイズで表示
ここでは、サーバー側で実行されクライアント側へレプリケートされ、画面に「item added」とプリントした後で、所有するクライアントの Inventory テキスト変数を [Has the item] に設定するイベントを作成しています。
-
Add Item Event に続く 3 つのノードをコピーして、 Remove Item Event に接続します。
-
Print String を Item Removed に、Inventory テキスト変数を Empty に変更します。
クリックしてフルサイズで表示
これで、キャラクターがトリガーを出ると、テキスト変数がサーバー上で更新されて、所有するクライアントへレプリケートされます。
-
コンパイル し 保存 してから、Level ブループリント を閉じてエディタでプレイします。
この動画では、ゲームの起動時に、 P を押してテキスト変数を画面に印字すると、それが各キャラクターに対して「empty」と表示されます。ただし、キャラクターの 1 つがトリガーボックスへ入ると、[item added] というテキストが表示されます。このキャラクターが P を押すと、テキストが [has the item] に変わります。残りのキャラクターの表示は [empty] のままです。キャラクターがボックスを出ると、[item removed] が表示されますが、再度 P を押すとテキストは [empty] に戻ります。
以上が、サーバー側でイベントを実行し、それらを個々のクライアントにレプリケートする方法の説明です。