Featured image of post [UE5] BP 関数の入出力ピンの名前を変更する方法 (UPARAM(DisplayName))
Unreal Engine C++ Blueprint

[UE5] BP 関数の入出力ピンの名前を変更する方法 (UPARAM(DisplayName))

Unreal Engine 5.1.1

結論

関数宣言内の引数および返却値の型の前に UPARAM(DisplayName = "《新しい名前》") と記述することで、Blueprint Node のピンの名前を変更することができます。

実例

例えば、ID と PIN コードで認証を行う関数を以下のように宣言したとします。

1
2
3
4
5

UFUNCTION(BlueprintCallable)
bool Authenticate(
    const FString& ID,
    int32 PINCode
);

すると、Blueprint ではこのように表示されます。

  • 入力ピンの ID って実はメールアドレスのことなんだけど、この名前だと伝わらないなあ
  • 入力ピンが PINCode って名前になっているけど、スペースで区切って PIN Code にしてほしかったなぁ
  • 出力ピンが Return Value って名前だと、どういうときに true が返るのかがわかりにくいなぁ

などと思うので、UPARAM(DisplayName) を引数および返却値の型の前に記述して、名前を変えることにします。

1
2
3
4
5

UFUNCTION(BlueprintCallable)
UPARAM(DisplayName = "Success") bool Authenticate(
    UPARAM(DisplayName = "ID (Mail Address)") const FString& ID,
    UPARAM(DisplayName = "PIN Code") int32 PINCode
);

ピンの名前が変わりました。

このように、UPARAM(DisplayName) を使うと、以下のことができます。

  • C++ では変数名に使えない括弧などの記号を使って、ピンの意味をよりわかりやすくできる
  • 返却値に名前を付けて、意味をわかりやすくできる
  • Unreal Engine が自動で行う表示名加工処理 (単語をスペースで区切るなど) の結果が気に入らない場合に修正できる

(๑•̀ㅂ•́)و✧＜おわり

参考