BLOGブログ

2020.07.23UE4/C++

[UE4] 名前をいい感じに表示してくれる仕組みについて

執筆バージョン: Unreal Engine 4.25

Blueprint Editor で変数・関数の Node を Event Graph 上に配置したときなどに、
それらの名前を人が読みやすいように整形して表示してくれる仕組みがあります。

今回は、この名前の整形処理についてざっくりとお話します。

どこで整形処理が行われるのか

名前の整形には、FName のメンバ関数である NameToDisplayString() が使われています。

第一引数に渡した文字列を整形した結果を返すというものです。

どのような整形が行われるのか

下記のような整形が行われます。

■ 単語の間にスペースを挿入する
……
名前がパスカルケースもしくはキャメルケースで書かれていることを想定した処理になっている
……
ただし、特定の単語 (一部の冠詞・前置詞など) はすべて小文字表記にする処理が入っている
……
この処理によって数字が不自然にスペースで区切られないように配慮されている
■ 先頭の文字を大文字にする
…… ただし、bool の名前について、先頭の文字が ‘b’ かつその次の文字が大文字の場合、先頭の ‘b’ を除外する
アンダースコアをスペースに置換する

なお、すべて小文字表記となる単語は下記の 15 語です (UE 4.25 時点)。
残念ながらコード内にベタ打ちで書かれているので、.ini を編集して追加・削除するようなことはできません。

In, As, To, Or, At, On, If, Be, By, The, For, And, With, When, From

また、先頭の ‘b’ が除外されるのは、それが bool の名前であるときに限定されています。
NameToDisplayString() は第 2 引数 bIsBool で「bool の名前かどうか」を取るようになっており、
これが false のときには先頭の ‘b’ を除外する処理は走りません。
試しに bool 型でない変数の先頭に ‘b’ を付けてみると、除外されずに残ることがわかります。

詳細な処理内容を知りたい方は、\Engine\Source\Runtime\Core\Private\UObject\UnrealNames.cpp 内の NameToDisplayString() の定義を読んでください。

整形が上手くいかない例

この整形処理ですが、大文字が連続した場合に単語がスペースで区切られないという問題があります。

エンジン側で用意されている関数の大部分は、UFUNCTION 内のメタデータ指定子 DisplayName
意図通りにスペースが挿入された名前を設定することでこの問題を回避しているのですが、
下のような一部の関数は対応できていません。

“GetIDFromData” の場合は、 C++ 定義であれば DisplayName に “Get ID from Data” を設定するか、
アンダースコアがスペースに置換されることを利用して “GetID_FromData” とするか、
“Id” 表記にするなどで対応することになります。

試しに処理内容を変更してみる

最後に、NameToDisplayString() に下記のようなコードを追加して、
上記の大文字連続時の問題の解決を試みることにします (後述しますが、不完全なコードです)。

この変更により、一部の Node については意図通りに表示されるようになりました。

ただし、この簡素過ぎるコードでは “IDs” が “I” と “Ds” で区切られてしまうようになるなど、別の問題が発生します。

何より、ちょっとした表示上の問題のためにエンジンの根幹部分にある FName のコードを修正するというのは割に合わないため、
修正を加えることは基本的に推奨できません。あくまで一例として参考にしてください。