Unreal Engine の CommonUI で拡張入力を使用する | Unreal Engine 5.7 ドキュメンテーション

CommonUI プラグイン は、Enhanced Input アクションを限定的にサポートします。

UE 5.2 の時点で、拡張入力のサポートは CommonUI の他の機能ほど十分にテストされていません。現時点では、この機能を使用するタイトルのシッピングは推奨していません。

1. 必要な設定

このページでは、CommonUI について次の設定ステップを実行済みであることを前提としています。

CommonUI プラグインと Enhanced Input プラグインの両方を有効にする。
ビューポートクラスを CommonGameViewportClient に設定する。
Accept や Back アクション用に InputData を設定する。

2. CommonUI の拡張入力を有効にする

CommonUI プラグインと Enhanced Input プラグインを有効にしたら、[Project Settings (プロジェクト設定)] を開いて [Game (ゲーム)] > [Common Input Settings (共通入力設定)] の順に移動し、[Enable Enhanced Input Support (拡張入力サポートを有効)] を true に設定します。これにより、2 つのプラグインが連携するためのサポートが有効になります。

Enable Enhanced Input in Project Settings

3. CommonUI 用の Enhanced Input アクションを設定する

Enhanced Input アクションは、継続中 のイベントや トリガー済み のイベントなどの特殊なバリアントを含む入力イベントを、どこへでもバインドすることができます。ただし、FaceButtonTop、Accept、Back などの UI アクションバインディングの大部分をグローバルにバインドすることは、予期しないタイミングでのユーザーの入力の結果として意図しないイベントが発生する可能性があるため、望ましくなく、無秩序となります。CommonUI では、この問題を 汎用的なアクション で解決します。汎用的なアクションは UI 要素にバインドされますが、CommonUI の拡張入力イベントをトリガーしません。

CommonUI 内に Enhanced Input アクションを設定するには、次の手順を実行します。

コンテンツブラウザで汎用的な 入力アクション を作成し、「IA_UI_GenericAccept」という名前を付けます。
入力アクションに PlayerMappableKeySettings を追加します。
PlayerMappableKeySettings の [Settings (設定)] で、ICommonMappingContextMetadataInterface を実装するオブジェクトに [Metadata (メタデータ)] フィールドを設定します。

CommonUI 以外のものに対して入力アクションメタデータが必要になる場合があります。そのため、柔軟性を保つ目的で ICommonMappingContextMetadataInterface を実装するクラスを使用することをお勧めします。
コンテンツブラウザで右クリックし、[Miscellaneous (その他)] > [Data Asset (データアセット)] をクリックしてデータアセットを作成します。
データアセットクラスとして ICommonMappingContextMetadataInterface を実装するメタデータクラスを選択します。「Metadata UI_IA_GenericMetadata」という名前を付けます。UCommonMappingContextMetadata をデフォルトとして使用するか、カスタム仕様のアセットクラスを使用することができます。
UI_IA_GenericMetadata を開き、設定を次のように編集します。
- Is Generic Input Action: True
- Per Action Enhanced Input Metadata: IA_UI_GenericAccept
- Nav Bar Priority: 10
CommonUI で入力アクションがブロードキャストされないようにするには、Is Generic Input Action にチェックを入れます。

このデータアセットは、CommonUI アクションデータを設定できるメタデータオブジェクトを提供します。すでに CommonUI に慣れている場合は、CommonUI のデータテーブルの Nav Bar Priority 設定を見たことがあるかもしれません。UCommonInputMetadata から継承することにより、追加のメタデータで入力アクションを拡張することもできます。

Per Action Enhanced Input Metadata を使用すると、アクションごとに 1 つのアセットを作成するのではなく、1 つのアセットで複数のアクション用のメタデータを処理することができます。
ステップ 5 ～ 6 を繰り返しますが、今回は Is Generic Input Action のチェックをオフにします。このメタデータの名前を「UI_IA_SpecificMetadata」にします。これにより、汎用的ではない任意の入力アクションで使用できるメタデータクラスになります。
入力アクションを開きます。メタデータを UI_IA_GenericMetadata に設定します。入力アクションに、CommonUI で機能するために必要な情報がすべて含まれるようになりました。
メタデータの Is Generic Input Action が有効になっていない入力アクションの場合、他の入力アクションのように入力をイベントにバインドすることができます。

4. CommonUI の入力マッピングコンテキスト (IMC) を作成する

CommonUI の入力マッピングコンテキスト (IMC) は、他の IMC と同様に動作します。入力マッピングコンテキストを作成するには、コンテンツブラウザを右クリックして、[Input (入力)] > [Input Mapping Context (入力マッピングコンテキスト)] の順にクリックします。次の図は、CommonUI で使用する IMC の例です。