UE5 で日本語のゲームを作っていて、こんな経験はありませんか。
- エディタのプレビューでは普通に日本語が出ていたのに、パッケージしたゲームで一部の字が □ や空白になった
- 翻訳を入れたら、韓国語や中国語だけ □ になった
- 日本語は出ているけれど、漢字の形がなんとなく日本のものと違う
調べてみると、原因はエンジンのフォントの選び方にありました。この記事では、エンジンのソース(UE 5.8)で確かめたことをまとめます。
結論
- エディタにしか無いフォントがある。Slate の標準フォントは、エディタで動いているときだけ日本語・中国語などの書体を足している
- 字が無いときに出る「代わりの字」(LastResort フォント)は、パッケージしたゲームには無い
- UMG の標準フォント(Roboto)は、日本語を中国語向けのフォントで出している。豆腐ではないが、字の形が違う
なので、「エディタで見て大丈夫だった」は、ゲームで大丈夫だという証拠になりません。
1. エディタでだけ足される日本語フォント
Slate の標準フォント(FCoreStyle::GetDefaultFont())は、FLegacySlateFontInfoCache::GetDefaultFont() で組み立てられています(Engine/Source/Runtime/SlateCore/Private/Fonts/LegacySlateFontInfoCache.cpp)。
中を見ると、Roboto と DroidSansFallback のほかに、こういう部分があります。
// Japanese (editor-only)
if (GIsEditor)
{
FCompositeSubFont& SubFont = ...;
SubFont.Cultures = TEXT("ja");
APPEND_RANGE(SubFont, CJKUnifiedIdeographs);
APPEND_RANGE(SubFont, Hiragana);
...
APPEND_EDITOR_FONT(SubFont.Typeface, "Regular", "GenEiGothicPro-Regular.otf", ...);
}
GIsEditor のときだけ、源暎ゴシック(Engine/Content/Editor/Slate/Fonts/)が日本語用の書体として足されます。中国語・韓国語などでも同じです。パッケージしたゲームでは GIsEditor が偽なので、この書体はありません。
2. 「代わりの字」はパッケージしたゲームには無い
フォントに字が無いと、Slate は LastResort フォント(Engine/Content/SlateDebug/Fonts/LastResort.ttf)で代わりに描こうとします。ただし、使えるかどうかはこう決まっています(LegacySlateFontInfoCache.cpp)。
bIsLastResortFontAvailable = !FPlatformProperties::RequiresCookedData() && FPaths::FileExists(LastResortFontPath);
クックしたデータを使うとき(=パッケージしたゲーム)は使えません。しかもこのフォントは、Unicode の「Last Resort」フォントで、字そのものではなく「この種類の字です」という記号を描くだけです。
つまり、
- エディタ:字が無いと、記号の入った四角が出る(気づける場合もある)
- パッケージしたゲーム:何も出ない、または □
になります。
よくある例:Rich Text Block に Text Style Set を設定していない
Rich Text Block は、Text Style Set(行の名前が「Default」のスタイル)か「Override Default Style」でフォントを決めます。どちらも無いとフォントが空になり、全部の字が LastResort 頼みになります。エディタでは何か出ていても、ゲームでは出ません。
3. UMG の標準フォントは、日本語を中国語の字形で出す
UMG の Text Block の初期フォント /Engine/EngineFonts/Roboto は、日本語の字を持っていません。代わりの書体(Fallback Typeface)の DroidSansFallback が描いています。DroidSansFallback は中国語(簡体字)向けの字形なので、「直」「骨」「角」などの形が日本のものと違います。
豆腐にはならないので見落としやすいですが、日本語のゲームとしては、日本語のフォント(Noto Sans JP など)を入れて使うのがおすすめです。
また、Roboto+DroidSansFallback には、次のような字はありません。
- 𠮷(つちよし)など、CJK 統合漢字 拡張B 以降の字
- 絵文字(😀 など)
実際に比べてみた
同じ文を 4 つのフォントで、パッケージ相当の条件(-game)で表示しました。
| フォント | 出なかった字 |
|---|---|
| UMG の標準(EngineFonts/Roboto) | 𠮷、絵文字 |
| Slate の標準(FCoreStyle) | 𠮷、絵文字(エディタの中で調べると「ある」と出る) |
| Roboto-Regular.ttf だけ | かな・漢字・ハングル・①♪★~㈱℃・絵文字 |
| DroidSansFallback.ttf だけ | Ü ï ö î õ・𠮷・絵文字 |
2 行目は、エディタの中で調べると「全部ある」と出るのに、ゲームでは □ になったフォントです。
字があるかをコードで調べる
Slate のフォントキャッシュを使うと、「このフォントでこの字が描けるか」を調べられます(エディタでもランタイムでも、Slate が動いていれば使えます)。
#include "Fonts/FontCache.h"
#include "Framework/Application/SlateApplication.h"
#include "Rendering/SlateRenderer.h"
// Font で C を描けるか(代わりの字=LastResort は数えない)
bool CanDraw(const FSlateFontInfo& Font, UTF32CHAR C)
{
FSlateFontCache& Cache = FSlateApplication::Get().GetRenderer()->GetFontCache().Get();
float Scale = 1.0f;
const FFontData& Data = Cache.GetFontDataForCodepoint(Font, C, Scale); // 合成フォントの中から書体を選ぶ
return Cache.CanLoadCodepoint(Data, C, EFontFallback::FF_NoFallback); // その書体に字があるか
}
FF_NoFallback を渡すのがポイントで、こうすると LastResort を数えません。
ただし エディタの中で動かすと、1 で書いたエディタ専用の書体まで選ばれるので、Slate の標準フォントについては「ある」と出てしまいます。正確に調べるには、FSlateFontInfo::GetCompositeFont() で合成フォントの中身(既定の書体・サブ書体・代わりの書体)を自分でたどり、Engine/Content/Editor/ の中のフォントを除いて判定する必要があります。
対策のまとめ
- 日本語のフォント(Noto Sans JP、源ノ角ゴシックなど)をインポートして、合成フォントに入れて使う
- Rich Text Block には、必ず Text Style Set(「Default」行)を設定する
- 翻訳する言語のフォントも用意する(韓国語・中国語は日本語フォントに無い字が多い)
- 外字や絵文字を使うなら、そのフォントを入れる
- 確認は「エディタで見る」ではなく、パッケージした状態か、エディタ専用フォントを除いた判定で行う
おまけ:まとめて点検するツールを作りました
プロジェクトの中の文字(ウィジェット・リッチテキスト・データテーブル・StringTable・ブループリントのノードの文字)を、上の方法でまとめて点検するエディタ用プラグインを作りました。
-
JpTextCheck(BOOTH・有料):豆腐(□になる字)・中国語の字形・翻訳されない文・未翻訳・古い訳・翻訳後のはみ出しを一覧にします。翻訳した言語ごとにも点検します
https://engineer-sasaki.booth.pm/items/9192082 -
JpTextKit(BOOTH・無料):UMG にルビ(ふりがな)と、日本語の改行ルール(禁則処理)を付けるプラグイン
https://engineer-sasaki.booth.pm/items/9188416
どちらも UE 5.6〜5.8 に対応しています。
参考にしたエンジンのソース(UE 5.8)
-
Engine/Source/Runtime/SlateCore/Private/Fonts/LegacySlateFontInfoCache.cpp(標準フォントの組み立て、LastResort の条件) -
Engine/Source/Runtime/SlateCore/Private/Fonts/FontCacheCompositeFont.cpp(合成フォントから書体を選ぶ処理) -
Engine/Source/Runtime/SlateCore/Private/Fonts/SlateFontRenderer.cpp(字があるかの判定) -
Engine/Source/Runtime/UMG/Private/Components/RichTextBlock.cpp(Rich Text Block の既定スタイル)
