Unreal Engine の Iris のコンポーネント | Unreal Engine 5.7 ドキュメンテーション

Iris レプリケーションシステム は Unreal Engine (UE) における Iris のメインインターフェースです。Iris は、レプリケートされたすべてのステートデータの完全なコピーを量子化された形式で保持することにより、ゲームプレイシステムとレプリケーションシステムとの間の依存関係を最小限に抑えます。Iris では負荷が大きい処理は 1 回のみ実行され、接続間の処理が共有されます。これによって、より多くの処理を同時に行うことができるようになります。同時作業を行うと、時間とリソースの節約になります。

このページでは次の項目について説明します。

レプリケーションブリッジとレプリケーションシステムにアクセスするための手順
Iris がオブジェクトをレプリケートする内部処理の概要

インターフェース

Iris レプリケーションシステムインターフェースを使用すると、レプリケーションシステム自体の管理や、コントロールへの機能の提供を行うことができます。

接続
グループ
優先順位付け
フィルタリング
リモートプロシージャコール

すべての Iris インターフェース機能は、レプリケーションブリッジで作成されたネット参照ハンドル (FNetRefHandle) で動作します。ネット参照ハンドル は、Iris レプリケーションブリッジで作成された識別子です。ネット参照ハンドルは、ネットワークオブジェクトを、作成時に指定された関連するゲームプレイインスタンス (UObject、UActorComponent、または AActor) に一意にマップするキーです。

Iris の説明に使用する用語の詳細については、「Iris 用語集」ドキュメントページを参照してください。

レプリケーションブリッジ

Iris レプリケーションブリッジは、アクタなど、ゲームプレイインスタンスオブジェクトで動作するすべての機能を実行します。レプリケーションブリッジは、ゲームコードと内部 Iris レプリケーションシステム間に存在します。ブリッジは Iris のすべての処理の中央チャンネルで、Iris レプリケーションシステムとゲームプレイコード間のステートデータの通信を行います。

送信マシンで、レプリケーションブリッジはネットワークオブジェクトの存続期間とレプリケーションシステムで必要なプロトコルを管理します。レプリケーションブリッジを使用して、レプリケートされたオブジェクトのネット参照ハンドルを取得できます。次に、ネット参照ハンドルをレプリケーションシステムで使用して、オブジェクト用にレプリケーション設定をカスタマイズします。

受信マシンで、レプリケーションブリッジは、アクタのインスタンス化と存続期間の管理を行います。

具体的に、レプリケーションブリッジは以下のことを行います。

BeginReplication と EndReplication で、レプリケートされたオブジェクトのレプリケーションを開始および終了する。
レプリケーションプロトコルとレプリケーションインスタンスプロトコルの作成を制御する。
オブジェクトのインスタンス化に必要なデータをシリアル化およびシリアル化解除する。
レプリケーションシステムのゲーム側でオブジェクトをインスタンス化する。
ゲームプレイインスタンスとネット参照ハンドル間のマッピングを処理する。

レプリケーションブリッジの関連ヘッダファイルには、以下のものが含まれています。

..\Engine\Source\Runtime\Engine\Public\Net\Iris\ReplicationSystem\ActorReplicationBridge.h
..\Engine\Source\Runtime\Experimental\Iris\Core\Public\Iris\ReplicationSystem\ObjectReplicationBridge.h

レプリケーションを制御する

オブジェクトをレプリケートするために、Iris では最初にオブジェクトのネットワーク表現を作成します。レプリケーションブリッジは、BeginReplication のネットオブジェクトとネット参照ハンドルの作成を管理します。

レプリケーションを開始する

BeginReplication の実行時に、Iris は、オブジェクトに関連付けられたレプリケートされたデータのすべての側面を記述するレプリケーションプロトコルを設定します。このレプリケーションプロトコルは、同じタイプのすべてのインスタンスで共有されます。オブジェクトのインスタンスごとに、レプリケーションシステムでは、インスタンス固有のデータを含むレプリケーションインスタンスプロトコルを作成します。インスタンス固有のデータには、レプリケートする必要があるデータを配置する場所とこの特定のインスタンスに受信したデータをプッシュする場所が含まれています。

レプリケーションブリッジにアクセスする

Iris がレプリケートされたオブジェクトのネット参照ハンドルを作成すると、レプリケーションシステム API を使用して、オブジェクトがレプリケートする方法を制御できます。レプリケートされたオブジェクトのネット参照ハンドルを取得するには、以下の手順に従います。

必要な Iris ファイルを含めます。
```
         #if UE_WITH_IRIS
         #include "Net/Iris/ReplicationSystem/ReplicationSystemUtil.h"
         #include "Net/Iris/ReplicationSystem/ActorReplicationBridge.h"
         #endif UE_WITH_IRIS
```
#if UE_WITH_IRIS #include "Net/Iris/ReplicationSystem/ReplicationSystemUtil.h" #include "Net/Iris/ReplicationSystem/ActorReplicationBridge.h" #endif UE_WITH_IRIS
アクタのレプリケーションブリッジへの参照を取得します。
```
         // ネット参照ハンドルを取得するアクタ
         AActor* RepActorPtr;
		
         UActorReplicationBridge* ReplicationBridge = UE::Net::FReplicationSystemUtil::GetActorReplicationBridge(RepActorPtr);
```
// ネット参照ハンドルを取得するアクタ AActor* RepActorPtr; UActorReplicationBridge* ReplicationBridge = UE::Net::FReplicationSystemUtil::GetActorReplicationBridge(RepActorPtr);
レプリケートされたアクタのネット参照ハンドルを取得します。
```
         UE::Net::FNetRefHandle RepActorNetRefHandle = ReplicationBridge->GetReplicatedRefHandle(RepActorPr);
		
         // これで、レプリケーション システムを取得して API 操作を実行できるようになりました。
```
UE::Net::FNetRefHandle RepActorNetRefHandle = ReplicationBridge->GetReplicatedRefHandle(RepActorPr); // これで、レプリケーションシステムを取得して API 操作を実行できるようになりました。

レプリケーションを終了する

EndReplication の実行時に、レプリケーションシステムは、ゲームプレイオブジェクト用に作成したすべてのネットワーキングリソースをクリーンアップし、オブジェクトのレプリケーションを停止します。

ステートトラッキング

Iris では、実行する処理が存在する場合にゲームがレプリケーションシステムに通知すると、最適に実行します。Iris では、レプリケーションシステムが変更をポーリングすることを想定していません。レプリケーションシステムでは、レプリケートされたプロパティが変更されるときは常に通知されることを想定しています。この変更システムを効率的に実行するために、Iris のレプリケートされたすべての変数がレプリケーションステートに含まれています。レプリケーションステート は、ネットワーク上でレプリケートまたは送信される必要のあるデータを含む構造体です。

レプリケーションステートには、メンバーのダーティネスをトラッキングするビットフィールドのために割り当てられた領域があります。メンバーのステートが変更された場合、メンバーは ダーティ ですが、変更はまだダウンストリームシステムに伝達されていません。レプリケーションステートには、更新する必要があるダーティなステートデータがオブジェクトに含まれていることをレプリケーションシステムに通知するのに使用する埋め込みの識別子も含まれています。

レプリケーションシステム

レプリケーションシステムは、Iris でレプリケートされたオブジェクトと対話するための主要な API です。レプリケーションブリッジを介して対話するオブジェクトのネット参照ハンドルを取得すると、オブジェクトのレプリケーション動作をカスタマイズできます。カスタマイズには、オブジェクトのレプリケート先の接続のフィルタリングやオブジェクトのレプリケーション優先順位の更新が含まれています。

レプリケーションシステムにアクセスする

レプリケートされたオブジェクトに使用するレプリケーションシステムにアクセスするには、以下の手順に従います。

必要な Iris ファイルを含めます。
```
         #if UE_WITH_IRIS
         #include "Net/Iris/ReplicationSystem/ReplicationSystemUtil.h"
         #endif UE_WITH_IRIS
```
#if UE_WITH_IRIS #include "Net/Iris/ReplicationSystem/ReplicationSystemUtil.h" #endif UE_WITH_IRIS
ゲームプレイコードで、レプリケートされたオブジェクトのレプリケーションシステムを取得します。
```
         // ネット参照ハンドルを取得するアクタ
         AActor* RepActorPtr;
		
         UReplicationSystem* ReplicationSystem = UE::Net::FReplicationSystemUtil::GetReplicationSystem(RepActorPtr);
```
// ネット参照ハンドルを取得するアクタ AActor* RepActorPtr; UReplicationSystem* ReplicationSystem = UE::Net::FReplicationSystemUtil::GetReplicationSystem(RepActorPtr);

レプリケーションシステムの関連ヘッダファイルには、以下のものが含まれています。

..\Engine\Source\Runtime\Engine\Public\Net\Iris\ReplicationSystem\ReplicationSystemUtil.h
..\Engine\Source\Runtime\Experimental\Iris\Core\Public\Iris\ReplicationSystem\ReplicationSystem.h

レプリケートされたオブジェクトのレプリケーションをカスタマイズする方法の例については、フィルタリングと優先順位付けのドキュメントを参照してください。

レプリケーションシステムのプロセスフロー

このセクションでは、Iris の内部処理のプロセスフローおよび Iris のさまざまなコンポーネントの仕組みについて説明します。

プロセスフローは、1 台の送信マシンと 1 台以上の受信マシンから構成されています。送信マシンには、送信側がマルチプレイヤーセッションで他の接続済みマシンに伝達する必要のある、レプリケートされたオブジェクトの新しい情報が含まれています。送信マシンのレプリケーションプロセスは、プリセンド更新とセンド更新の 2 つのステップから構成されます。古い情報が含まれている接続済みマシンは、送信マシンのステートと一致するレプリケートされたオブジェクトに関する情報を更新する必要がある受信マシンです。

ネットシリアライザとデータストリームは、送信マシンと受信マシン間のデータ通信の処理時に使用されます。ネットシリアライザは、ネットワークを介して効率的に転送できるようにデータをトランスフォームします。データストリームは、特別なデリバリ保証を含め、データの送信方法を定義します。

送信マシン

プリセンド更新

レプリケーションシステムの送信側のプリセンド更新は、多くの共有作業が実行される場所です。これは、システムがゲームプレイコードのデータにアクセスする唯一の時間でもあります。この更新は、次の手順で構成されています。

レガシーモードで実行している場合、レプリケートされたオブジェクトをステート変更のためにポーリングします。
すべてのダーティなステートデータをコピーおよび量子化します。
レプリケートされたオブジェクトのダーティネスステータスをリセットします。
ネットオブジェクトのフィルタリングステータスを更新します。
ネットオブジェクトの優先順位付けを更新します。

センド更新

パケットデータを入力した場合、目的はレプリケーションシステム内に含まれていないデータに触れないことです。これによって、キャッシュフレンドリーな方法でタスクを同時に実行することが容易になります。センド更新プロセスはすべての接続に対して、以下のように続行します。

すべてのデータストリームをティックして、パケットの作成とデータ入力を行います。
- レプリケーションデータストリーム：
  1. ダーティステートのオブジェクトを、オブジェクトの優先順位とスケジュールの優先順位に基づいて送信するようにスケジュール設定します。
  2. 優先順位と依存関係に基づいて並び替えます。
  3. ステートデータをシリアル化します。

受信マシン

パケットを受信する側は、すべての接続に対して、以下のように受信パケットを処理します。

最初にデリバリ通知を更新します。
データストリームは、各パケットに含まれているデータを処理します。
- レプリケーションデータストリーム：
  - ステートデータの読み取り： ステートデータはパケット全体が読み取られた後、ディスパッチされます。レプリケーションシステムがこれらに依存してレプリケーションプロトコルを構築するため、新しいオブジェクトは即座にインスタンス化されます。
  - ステートデータのディスパッチ： レプリケーションシステムは新しいデータをゲームにプッシュして、ゲームプレイオブジェクトを更新します。

詳細情報

アクタのレプリケーション動作の変更方法の例など、Iris レプリケーションシステムのコンポーネントの詳細については、このセクションの他のドキュメントページを参照してください。