K.Y.さん、しんちょくどーですか?

仕事や趣味で知ったこと、つまずいたことを書いています

【UE5】ListView のラップ(Wrap)指定時のフォーカス移動をきちんとループさせる

この記事は Unreal Engine (UE) Advent Calendar 2025 シリーズ 4 の 23 日目の記事です。


ListView の UI ナビゲーションで「ラップ(Wrap)」を指定すると、リストの端でフォーカスが反対側にループする...と思っていたのですが、試してみると期待したようには動きませんでした。

実際には、上下(または左右)移動で端に到達した際、フォーカスが先頭/末尾に戻らず、そのまま移動が止まっているように見えます。

この記事では、こうした ListView のラップ指定時の挙動について、改善方法を紹介します。

確認環境

  • UE5.7.1
  • C++ プロジェクト

改善前/改善後(動画)

ラップ指定時の挙動について、改善前後の様子は以下の動画のとおりです。
(リスト内の項目がフォーカスを受けると、緑色に変わるようにしています。)

youtu.be

改善方法(C++ 必須)

UI ナビゲーションでラップが指定されている場合でも、ListView では端を越えるナビゲーションが先頭/末尾へループする挙動にはなっていませんでした。

そのため、ListView を継承し OnNavigation(Slate 側)で、リスト端に到達した際のフォーカス移動を反対側の項目へ差し替える処理を実装します。

Slate 側の挙動を拡張するため、今回の方法では C++ が必須となります。

Slate / SlateCore の有効化

Slate のナビゲーション処理を拡張するため、Slate UI を使用できるように設定しておきます。
[プロジェクト名].Build.cs にある以下の行を有効化します。
(行自体がコメントアウトされているので、コメントを外します)

// Uncomment if you are using Slate UI
PrivateDependencyModuleNames.AddRange(new string[] { "Slate", "SlateCore" });

ListView を継承したクラスの作成

次に、ListView を継承したクラスを作成し、ナビゲーション処理を拡張します。

以下は、ラップが指定されている方向の入力に対して、リスト端に到達した場合に反対側の項目へフォーカスを移動する実装例です。

#pragma once

#include "CoreMinimal.h"
#include "Components/ListView.h"
#include "MyListView.generated.h"

template <typename ItemType>
class SMyListView : public SListView<ItemType>
{
public:
  virtual FNavigationReply OnNavigation(const FGeometry& MyGeometry, const FNavigationEvent& InNavigationEvent) override
  {
    if (this->HasValidItemsSource() && this->bHandleDirectionalNavigation && (this->bHandleGamepadEvents || InNavigationEvent.GetNavigationGenesis() != ENavigationGenesis::Controller))
    {
      const TArrayView<const ItemType> ItemsSourceRef = this->GetItems();
      const int32 NumItems = ItemsSourceRef.Num();
      if (0 < NumItems)
      {
        // ナビゲーションで「ラップ」が指定された方向の入力のみ処理
        const EUINavigation NavigationType = InNavigationEvent.GetNavigationType();
        const TSharedPtr<FNavigationMetaData> NavigationMetaData = this->GetMetaData<FNavigationMetaData>();
      if (NavigationMetaData.IsValid() && NavigationMetaData->GetBoundaryRule(NavigationType) == EUINavigationRule::Wrap)
        {
          const int32 CurSelectionIndex = ItemsSourceRef.Find(TListTypeTraits<ItemType>::NullableItemTypeConvertToItemType(this->SelectorItem));
          if (CurSelectionIndex != INDEX_NONE)
          {
            const int32 NumItemsPerLine = this->GetNumItemsPerLine();
            int32 AttemptSelectIndex = CurSelectionIndex;

            // リストの方向(垂直/水平)に応じた入力方向にナビゲーション
            if ((this->Orientation == Orient_Vertical && NavigationType == EUINavigation::Up) ||
              (this->Orientation == Orient_Horizontal && NavigationType == EUINavigation::Left))
            {
              AttemptSelectIndex = CurSelectionIndex - NumItemsPerLine;
            }
            else if ((this->Orientation == Orient_Vertical && NavigationType == EUINavigation::Down) ||
                (this->Orientation == Orient_Horizontal && NavigationType == EUINavigation::Right))
            {
              AttemptSelectIndex = CurSelectionIndex + NumItemsPerLine;
            }

            if (!ItemsSourceRef.IsValidIndex(AttemptSelectIndex) && this->bIsGamepadScrollingEnabled)
            {
              // ナビゲーション先がリストの端を越えたなら逆側に移動
              AttemptSelectIndex = (AttemptSelectIndex + NumItems) % NumItems;

              this->NavigationSelect(ItemsSourceRef[AttemptSelectIndex], InNavigationEvent);
              return FNavigationReply::Explicit(nullptr);
            }
          }
        }
      }
    }

    return SListView<ItemType>::OnNavigation(MyGeometry, InNavigationEvent);
  }
};

UCLASS()
class UMyListView : public UListView
{
GENERATED_BODY()

protected:
  virtual TSharedRef<STableViewBase> RebuildListWidget() override
  {
    return ConstructListView<SMyListView>();
  }
};

UMG で使用する

ビルドしてエディターを起動すると、UMG のパレットに "MyListView"(自前で作成した ListView)が表示されます。

通常の ListView の代わりに、こちらを使用するだけで OK です。

余談 - ScrollBox について

ScrollBox でも、UI ナビゲーションでラップを指定した際に、期待したようなループ挙動にはなっていませんでした。

この挙動の改善については、CommonHierarchicalScrollBox を使用するのがお手軽なのでおすすめです。

SCommonHierarchicalScrollBox::OnNavigation を見ると、ループ処理が拡張されているのがわかります。
今回の MyListView の実装も、この処理を参考にしています。

あとがき

Widget BP のみで解決できないかも試してみましたが、うまくいかず断念しました...

ナビゲーションをカスタムに変更し、今回紹介した C++ コードと似たような処理を BP 側で組むことでループ自体は実現できましたが、ループ直後のフォーカスイベントが発火しない問題が発生しました。

BP オンリーでうまく解決できる方法があれば、ぜひ教えてください。


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)

【UE5】CommonButtonBase を無効化する 3 つの方法とそれぞれの違い

CommonButtonBase を親クラスにしたボタンには、無効化(クリックなどの操作を制限)する方法がいくつか用意されています。

それぞれの無効状態によって、見た目や呼び出されるイベントが異なるため、違いをまとめました。

確認環境

Unreal Engine 5.5.4

ボタン無効化の種類

CommonButtonBase には、以下の 3 種類の無効化方法が用意されています。

完全無効化

ボタンをフォーカス対象から外し、完全に操作できない状態にします。
ボタンの「無効化」といえば通常この状態を指すと思いますが、本記事では他の無効化方法と区別するため「完全無効化」と呼んでいます。

SetIsEnabled ノードで有効/無効を切り替えます。

 

インタラクション無効化

ボタンへのホバーやクリックは無効化されますが、フォーカスは可能(キーボードの矢印キーやゲームパッドの十字キーによるフォーカス移動が可能)な状態になります。

SetIsInteractionEnabled ノードでインタラクション有効/無効を切り替えます。

ロック

ボタンへのフォーカスやホバーは可能なまま、クリック操作だけを制限します。
ロック中は、通常のクリックイベント OnClicked の代わりに OnLockClicked が呼び出されます。

SetIsLocked ノードでロック/ロック解除を切り替えます。

無効化の種類による違いまとめ

無効化の種類によって見た目や挙動にも違いがあるため、整理してまとめました。

ボタンスタイル(見た目)の違い

状態 見た目の挙動
完全無効化
SetIsEnabled
ボタンスタイルの「無効 > Disabled」が反映されます。
インタラクション無効化
SetIsInteractionEnabled
自動で半透明になります。
半透明にしたくない場合は、ボタンの詳細設定にある ApplyAlphaOnDisable をオフにしてください。
ロック
SetIsLocked
通常時と同じボタンスタイルが反映されます。
(ロック専用のスタイルは用意されていません。)

サウンドの違い

状態 サウンド
完全無効化
SetIsEnabled
サウンドなし
インタラクション無効化
SetIsInteractionEnabled
サウンドなし
ロック
SetIsLocked

ロック専用のサウンドが設定可能です。

ボタンスタイルの以下の項目から設定できます。

  • LockedPressedSound: ロック中にボタンを押したときに鳴るサウンド
  • LockedHoveredSound: ロック中にボタンにホバーしたときに鳴るサウンド

呼び出されるイベントの違い

無効化の種類によって、呼び出されるイベントにも違いがあります。
以下の表にまとめました。

○:イベントが呼び出される  ×:イベントが呼び出されない

イベント名 完全無効化SetIsEnabled インタラクション無効化
SetIsInteractionEnabled
ロック
SetIsLocked
OnClicked × × ×
OnDoubleClicked × × ×
OnPressed × × ○
OnReleased × × ○
OnHovered × × ○
OnUnhovered × × ○
OnFocused × ○ ○
OnUnfocused × ○ ○
OnLockedChanged × × ○
OnLockClicked × × ○
OnLockDoubleClicked × × ○
OnEnabled ○ × ×
OnDisabled ○ × ×
OnSelected
※Selectable 設定をオンにしておく必要あり
× × ○
OnDeselected
※Selectable 設定をオンにしておく必要あり
× × ○
OnInputActionTriggered
※TriggeringInputAction を設定しておく必要あり
× × ○

あとがき

CommonButtonBase は標準のボタンより細かく操作の制限をかけられるのが良いですね。
制限のかけ方にも微妙な違いがあるので、状況に応じてうまく使い分けていきたいです。


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)

【UE5】ボタンなどの Widget を無効化したときに自動で半透明になるのを止める方法

ボタンなどの Widget 全般は SetIsEnabled ノードを使用することで、有効/無効を切り替えることができるようになっています。

無効状態に設定された Widget は、自動的に半透明になるのですが、この記事ではその自動で半透明になる効果を無効化する方法について紹介しています。

半透明を止める方法

以下のコンソールコマンドを実行すると、 Widget が無効状態になったときの半透明化を無効にできます。
Slate.ApplyDisabledEffectOnWidgets false

コンソールコマンド実行時の参考動画を載せておきます。

www.youtube.com

また、ウィジェットリフレクタの「フラッグ > 透明率が無効なエフェクト」からでもオン/オフを切り替えられます。

起動時からこの設定を反映しておきたい場合は、 DefaultEngine.ini に以下を追記すれば OK です。

[ConsoleVariables]
Slate.ApplyDisabledEffectOnWidgets=false

注意点

設定は全体に反映される

この設定は、ゲーム中にビューポートに追加されたすべての Widget に一括で反映されるため、特定の Widget だけに反映することはできません。

利用可能なバージョンは UE5.2 以降

Slate.ApplyDisabledEffectOnWidgets は UE5.2 から追加された機能なので、それ以前のバージョンでは利用できません。

RetainerBox の子要素には反映されない

以下の投稿を見て知りましたが、 RetainerBox の子要素にはこの設定が反映されません。(UE5.5.4 でも同様の挙動を確認しました。)
仕様なのか不具合なのかはわかりませんが、 RetainerBox を使う際は注意しましょう。

forums.unrealengine.com

あとがき

ボタンを無効化したときの見た目を変えようとしていたのですが、無効状態の半透明がボタンの子要素にまで反映されてしまい、困っていました。
ですが、 Slate.ApplyDisabledEffectOnWidgets を使うことで解決できてよかったです。


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)

【UE5】UE5.5.0 の新機能で気になったものをピックアップして紹介( Blueprints, UI 周りのみ)

UE5.5.0 で追加された新機能の中から、気になったものをピックアップして紹介します。

紹介するのは Blueprints と UI 関連の機能のみになります。
今回紹介する機能以外にも新機能はたくさんあるので、ぜひ公式のリリースノートをご覧ください。

dev.epicgames.com

Blueprints 関連の新機能

関数パラメータに変更不可設定 (Const) を追加

関数のリファレンス渡しのパラメータに Const 設定が追加されました。
この設定により、パラメータを変更不可(書き込み不可)にできます。

...と言いつつ、現状は Const をオンにしてもパラメータの変更が可能で、コンパイルエラーや警告も発生しませんでした。この点は注意が必要です。

UClass/TSubclassOf 型への UPARAM AllowedClasses メタデータ指定子を追加

UClass と TSubclassOf 型の引数に対して AllowedClasses メタデータを指定できるようになりました。
これにより、 BP 側で指定可能なクラスを制限できます。

UFUNCTION(BlueprintCallable)
void MyFunction(
    UPARAM(meta = (AllowedClasses = "/Script/Engine.Actor")) UClass* Class1,
  UPARAM(meta = (AllowedClasses = "/Script/Engine.Actor")) TSubclassOf<UObject> Class2
);

また、リリースノートでは ShowDisplayNames メタデータ指定子の追加も記載されていますが、その効果は未確認です。

Slate 関連の新機能

フォントアトラスビジュアライザで各グリフの情報を表示

フォントアトラスビジュアライザ(ウィジェットリフレクタのメニューバー > アトラス > フォントアトラスを表示)で、グリフにマウスオーバーするとフォントやサイズなどの情報がツールチップで表示されるようになりました。

UMG 関連の新機能

マウスカーソル位置を取得するマテリアル関数を追加

新しいマテリアル関数 MF_UI_CursorPosition を使うことで、マテリアル側でマウスカーソルの位置を取得できるようになりました。

ビューポートの左上(タイトルバーを含む部分)を (0, 0) とした位置を取得できます。

CommonVideoPlayer の関数を BP でも扱えるようになった

これまで C++ 専用だった CommonVideoPlayer の関数が BP で利用可能になりました。

使い方については以下の記事をご覧ください。

kumasan-debug.hatenablog.com

UI コンポーネントシステムの導入(実験段階)

UMG に実験的な機能として「 UI コンポーネントシステム」が導入されました。
このシステムでは、アクターにコンポーネントを付与するのと同様に、 Widget にコンポーネントを付与して機能を追加できます。

利用するには、コンソールコマンド "Widget.ExposeUIComponents true" を実行する必要があります。
コマンドを実行後、 UserWidget を開くと詳細タブに「新規コンポーネントを追加」ボタンが表示されます。

「新規コンポーネントを追加」から UUIComponent を継承したクラス( C++ 必須)を新規コンポーネントとして追加できます。
追加したのはいいものの削除する方法がわからない...

UE5.5.0 時点では基本的な機能のみ実装されています。
今後のアップデートでエンジン側からもコンポーネントが提供されていくそうです。

あとがき

細々とした機能の紹介でしたが、便利になっていて良いですね。

特に、まだ実験段階ですが UI コンポーネントシステムが気になりました。
どういった活用方法が生まれるのか楽しみです。


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)

【UE5】CommonUI の Widget の使い方 - CommonVisualAttachment

Common UI Plugin を有効にすると追加される Widget の使い方を紹介します。

こちらの記事では CommonVisualAttachment について紹介しています。
ほかの Widget については下記の記事をご覧ください。

kumasan-debug.hatenablog.com

確認環境

  • UE5.4
  • Common UI Plugin Beta Version 1.0

機能

UE 標準で用意されている SizeBox を拡張した Widget です。

この Widget の特徴は子に配置した Widget をずらして表示できるところです。

設定項目

ContentAnchor

子に配置した Widget の位置を指定した座標分だけ移動できます。

値を変更するとデザイナー画面上に即座に反映されるため、位置を確認しながら調整可能です。

使用感

実際に使った感覚としては、 CanvasPanel 内で子 Widget の位置調整を行うのに似ているので使いやすいです。
逆に言えば、すでに CanvasPanel を使っているのであればあまり出番はないかも?

ただし、 Overlay の子 Widget を Overlay の外側に配置したいといった場合に使えそうです。


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)

【UE5】UMG Widget Preview (実験段階)の機能紹介

...ということで UE5.5.0 Preview から追加された UMG Widget Preview をさわってみたので、その機能を紹介します。

UMG Widget Preview の機能について

名前の通り、 Widget をプレビューできる機能です。

ゲーム画面での UI の動作を、実際にボタンを押すなどのインタラクションも含めて確認できます。
PIE せずに動作確認できるのでかなり便利です。

ただし、 UE5.5.0 Preview では実験段階の機能なので使用時にはご注意ください。

Widget をプレビューする手順

早くプレビューを試してみたい!
ということで Widget をプレビューする手順を記載します。

  1. コンテンツブラウザで右クリックし、ユーザーインターフェイス > ウィジェットプレビュー を選択して新しいアセットを作成
  2. 作成したアセットを開き、詳細タブ > Widget Type にプレビューしたい Widget を指定
  3. 警告が表示された場合は「修正を適用」をクリック(警告の詳細は後述)
  4. ビューポートに指定した Widget が表示される

警告について

ウィジェットプレビューで対象の Widget を設定した際に、次のような警告が表示されることがあります。

参照先ウィジェットの 1 つまたは複数がサポートされていません([プレイヤーコンテキストなしで呼び出しの初期化可能] が無効になっている可能性がある)
【警告対象の Widget 】

これは警告対象の Widget に原因があります。
Widget のクラス設定 > Can Call Initialized Without Player Context がオフの場合に発生します。この設定をオンにすることで警告を回避できます。(警告内の「修正を適用」をクリックすると自動でオンにしてくれます。)

ちなみに、 Can Call Initialized Without Player Context の用途は以下のように説明されています。

つまり、 Widget を初期化するとき( OnInitialized イベント)に PlayerController を参照していないのであれば、設定をオンにして問題ありません。

UE から言わせると、「プレビューしている間は( Widget の所有者にあたる) PlayerController を生成しないから PlayerController を参照できませんよ~」ということだと思います。

画面構成

ウィジェットプレビューは以下のパネルで構成されています。

① ツールバー:保存ボタンやプレビューの状態をリセットするボタンがあります。

② ビューポート:プレビュー対象の Widget が表示されます。

③ 詳細タブ:プレビュー対象の Widget を設定したり、プロパティを変更できます。

④ メッセージログ:何かメッセージがあれば表示されます。

⑤ プレビューシーン設定:ビューポートで表示されている空間の環境を設定します。

詳細タブについてもっと詳しく

詳細タブの各項目について解説します。

Widget Type

プレビューしたい Widget を指定します。

ウィジェットプロパティ

プレビューしている Widget のプロパティを直接変更できます。
変更した内容はプレビュー中のみ適用されるので、 Widget 本体には影響がありません。
変更内容をすべてリセットしたい場合はツールバーの戻り矢印のアイコンを押せば一括でリセットできます。

Slot Widgets

Widget Type で指定した Widget に NamedSlot (もしくは似た機能を持つ Widget )が配置されていた場合、 NamedSlot の子にする Widget を指定できます。

NamedSlot を配置した Widget があったとして...

↓ Slot Widgets で子にしたい Widget を指定できる。

気になることを実験! Q&A

以下の内容はすべてプレビュー中の Widget の挙動になります。

Q1: Widget のイベントは反応する?

A1: 反応します。ボタンをクリックすれば OnClicked イベントが発生しますし、スライダーの値を変更すれば OnValueChanged イベントが発生します。

Q2: Widget が持つ変数の値を変更できる?

A2: 変更できます。

ウィジェットプレビューの詳細タブ  > ウィジェットプロパティからプレビュー中の変数の値を変更できます。ここにはプライベートの変数も表示されます。

Q3: Tick は走る?

A3: 走ります。

Q4: タイマーは使える?

A4: 使用できます。 SetTimerByEvent などを使えます。

Q5:  UMG アニメーションは再生できる?

A5: 再生できます。

Q6: PreConstruct イベントの IsDesignTime の値はどうなる?

A6: False になります。つまり、実際のゲーム実行中と同じ扱いです。

Q7: Widget を作成・表示できる?

A7: CreateWidget や ConstructObjectFromClass で作成可能です。

ただし、作成した Widget はビューポートに直接追加 (AddToViewport, AddToPlayerScreen) できません。
Widget に配置しているパネルなどの子に追加する形で表示できます。

Q8: Widget を削除できる?

A8: プレビュー中の Widget 自体は削除できませんが、内部の Widget は RemoveFromParent で削除できます。

Q9: ログを出力できる?

A9: PrintString や PrintText でログを出力できます。出力ログウィンドウをドッキングさせておくと便利です。

Q10: BP のブレークポイントは使える?

A10: ブレークポイントはおそらく反応しないようです。

あとがき

いよいよ PIE せずに Widget の動作確認ができる時がきました。
正式版がリリースされたら開発で使いこなして効率的に UI を作っていきたいですね。


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)

【UE5】Widget の編集画面を複数開いて、デザイナー画面とグラフ画面を並べて作業する方法

通常、 UE では同じ Widget に対して複数の編集画面を開くことができません。
しかし、自前で処理を用意することで、同じ Widget に対して複数の編集画面を同時に開くことが可能になります。

本記事では、エンジンの改造なしで複数の編集画面を開く実装例を紹介します。
この実装を利用することで、 Widget のデザイナー画面とグラフ画面を同時に表示して効率的に作業が行えます。

注意点

UE は基本的に同じアセットに対して 1 つの編集画面しか開けない設計です。

これから紹介する実装はこの設計を無視しているため、動作が安定しない場合やクラッシュする可能性があります。利用する際は自己責任でお願いします。

また、「同じような機能がすでにある」や「ここの処理は危険かもしれない」などのアドバイスがあればぜひ教えていただけると嬉しいです。

作業環境

  • UE5.4
  • C++ 必須

実装に必要なスキル

  • C++ のプロジェクトを作成できること
  • C++ の細かいことは分からなくても、ソースコードを編集できること

実装目標と手順

実装目標

目標は、 Widget のアセットアクション(アセットを右クリックすると表示されるメニュー)から新規の編集画面を開けるようにすることです。

以下の動画のような挙動を目指します。

youtu.be

実装手順

エディタモジュールの追加

これから用意する処理はエディタ上でのみ使用するため、エディタモジュールを作成し、そのあと処理を追加していきます。

以下の構成になるようにフォルダとファイルを追加してください。

Source
┗ MyProjectEd
    ┣ MyProjectEd.Build.cs
    ┣ MyProjectEd.cpp
    ┗ MyProjectEd.h

本記事ではモジュール名を "MyProjectEd" としています。
モジュール名を変更する場合は "MyProjectEd" の部分を適宜置き換えてください。

各ファイルを実装していきます。

using UnrealBuildTool;
public class MyProjectEd : ModuleRules {
public MyProjectEd(ReadOnlyTargetRules Target) : base(Target)
{
PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
PublicDependencyModuleNames.AddRange(new string[] {
"Core",
          "CoreUObject",
      });

PrivateDependencyModuleNames.AddRange(new string[] {
"UnrealEd",
          "SlateCore",
          "ToolMenus",
            "AssetTools",
            "UMGEditor",
            "ContentBrowser",
          "AssetDefinition",
      });
}
}
#pragma once

class FMyProjectEdModule : public IModuleInterface
{
public:
virtual void StartupModule() override;
    virtual void ShutdownModule() override;
};
#pragma once

#include "MyProjectEd.h"

#include "Modules/ModuleManager.h"

IMPLEMENT_MODULE(FMyProjectEdModule, MyProjectEd);

void FMyProjectEdModule::StartupModule()
{
}

void FMyProjectEdModule::ShutdownModule()
{
}
アセットアクションの追加

アセットアクションに項目を追加するため、 UAssetDefinitionDefault を継承したクラスを作成し、新規の編集画面を開く処理を実装します。

以下のファイルをエディタモジュールに追加してください。

Source
┗ MyProjectEd
    ┣ AssetDefinition_OpenNewWidgetEditor.cpp 【追加】
    ┣ AssetDefinition_OpenNewWidgetEditor.h 【追加】
    ┣ MyProjectEd.Build.cs
    ┣ MyProjectEd.cpp
    ┗ MyProjectEd.h

新しく追加したファイルを実装します。

#pragma once

#include "AssetDefinitionDefault.h"

#include "AssetDefinition_OpenNewWidgetEditor.generated.h"

UCLASS()
class UAssetDefinition_OpenNewWidgetEditor : public UAssetDefinitionDefault
{
    GENERATED_BODY()

public:
    virtual FText GetAssetDisplayName() const override;
    virtual FLinearColor GetAssetColor() const override;
    virtual TSoftClassPtr<UObject> GetAssetClass() const override;
};
#include "AssetDefinition_OpenNewWidgetEditor.h"

#include "AssetDefinition.h"
#include "AssetDefinitionRegistry.h"
#include "AssetRegistry/AssetData.h"
#include "AssetSelection.h"
#include "ContentBrowserMenuContexts.h"
#include "IAssetTools.h"
#include "ToolMenus.h"
#include "WidgetBlueprint.h"

#define LOCTEXT_NAMESPACE "AssetTypeActions"

FText UAssetDefinition_OpenNewWidgetEditor::GetAssetDisplayName() const
{
return LOCTEXT("AssetTypeActions_OpenNewWidgetEditor", "Open New Widget Editor");
}

FLinearColor UAssetDefinition_OpenNewWidgetEditor::GetAssetColor() const
{
return FLinearColor(FColor(44, 89, 180));
}

TSoftClassPtr<UObject> UAssetDefinition_OpenNewWidgetEditor::GetAssetClass() const
{
return UWidgetBlueprint::StaticClass();
}

namespace MenuExtension_OpenNewWidgetEditor
{
/**
* 指定のアセットの編集画面を開く
*/
void ExecuteOpenNewEditor(const FToolMenuContext& InContext, TArray<FAssetData> InAssets)
{
if (const UAssetDefinitionRegistry* AssetDefinitionRegistry = UAssetDefinitionRegistry::Get())
{
for (const FAssetData& Asset : InAssets)
{
if (const UAssetDefinition* AssetDefinition = AssetDefinitionRegistry->GetAssetDefinitionForAsset(Asset))
{
FAssetOpenArgs OpenArgs;
OpenArgs.OpenMethod = EAssetOpenMethod::Edit;
OpenArgs.Assets = { Asset };
AssetDefinition->OpenAssets(OpenArgs);
}
}
}
}

/**
* アセットアクションに項目を追加
*/
static FDelayedAutoRegisterHelper DelayedAutoRegister(EDelayedRegisterRunPhase::EndOfEngineInit, []
{
UToolMenus::RegisterStartupCallback(FSimpleMulticastDelegate::FDelegate::CreateLambda([]()
{
FToolMenuOwnerScoped OwnerScoped(UE_MODULE_NAME);
if (UToolMenu* Menu = UE::ContentBrowser::ExtendToolMenu_AssetContextMenu(UWidgetBlueprint::StaticClass()))
{
FToolMenuSection& Section = Menu->FindOrAddSection("GetAssetActions");
Section.AddDynamicEntry(NAME_None, FNewToolMenuSectionDelegate::CreateLambda([](FToolMenuSection& InSection)
{
if (IAssetTools::Get().IsAssetClassSupported(UWidgetBlueprint::StaticClass()))
{
if (const UContentBrowserAssetContextMenuContext* Context = UContentBrowserAssetContextMenuContext::FindContextWithAssets(InSection))
{
const TAttribute Label = LOCTEXT("OpenNewWidgetEditor_ActionMenuLabel", "Open New Editor");
const TAttribute ToolTip = LOCTEXT("OpenNewWidgetEditor_ActionMenuToolTip", "Opens a new editor. (You can open more than one editor.)");

FToolUIAction UIAction;
TArray<FAssetData> SelectedAssets(Context->SelectedAssets);
UIAction.ExecuteAction = FToolMenuExecuteAction::CreateStatic(&ExecuteOpenNewEditor, MoveTemp(SelectedAssets));
InSection.AddMenuEntry("OpenNewWidgetEditor_Run", Label, ToolTip, FSlateIcon(), UIAction);
}
}
}));
}
}));
});
}

#undef LOCTEXT_NAMESPACE
モジュールの読み込み設定

プロジェクト側が作成したエディタモジュールを読み込むようにします。

[プロジェクト名].uproject をテキストファイルとして開き、 "Modules" に以下を追加してください。

"Modules": [
{
...
},
{
"Name": "MyProjectEd",
      "Type": "Editor",
      "LoadingPhase": "PostEngineInit"
}
]

追加できたら、 [プロジェクト名].uproject を右クリックし "Generate Visual Studio project files" を実行してください。

エディタを起動し、 Widget のアセットアクションに "Open New Editor" が追加されていれば実装完了です。

動作確認

きちんと動作するか確認します。
以下の手順で、同じ Widget の編集画面を複数開けるか動作確認してください。

  1. コンテンツブラウザで Widget を右クリック
  2. Open New Editor を選択
  3. 編集画面が開く
  4. 以上の手順を繰り返し、編集画面が 2 つ開けば OK

参考資料


記事の内容について、誤字脱字、内容の誤り、感想などありましたら気軽にコメントしていただけると嬉しいです。(このブログでも SNS でも歓迎です。)