[UE4] UE_LOGについてあれこれ

UE4C++を使用されている方は、ほとんどの方が UE_LOG というマクロを使用したことがあると思います。
これは、UE4C++の最も一般的なログ出力方法です。
今回は、この UE_LOG マクロについて、少しだけ掘り下げた使い方をご紹介します。

 

UE_LOGマクロの使い方

UE_LOG マクロの定義は下記のようになっています。

呼び出し時は、よく使う書き方であれば下記のようになるかと思います。

まずは、これらの引数の意味を見ていきます。

 

CategoryName

その名のとおり、カテゴリ名です。
UE_LOGで出力されるログは、多くのカテゴリに分かれています。
エンジン側で用意されているものの他、自分でカテゴリを定義することも出来ます。（後述）

 

Verbosity

Google翻訳で直訳すると「冗長」という意味だそうです。
これは、ログの詳細度のようなものです。
通常使用するのは、下記の７段階になっており、後のものほど詳細なログという扱いになります。

• Fatal　…　致命的なエラー。こちらはassertと同様の扱いになります。プログラムにブレークがかかります。
• Error　…　エラー。名前のとおりです。OutputLogウィンドウには赤色で表示されます。
• Warning　…　警告。これも名前のとおりです。OutputLogウィンドウには黄色で表示されます。
• Display / Log / Verbose / VeryVorbose　…　ログ。後のものほど詳細なログとして扱います。

 

Format, …

ログ出力する文字列です。一般的なフォーマット文字列が使用できます。（%d とか %s とか）

 

これらの引数のなかでも、特によく分からないのが、Verbosityの Display/Log/Verbose/VeryVerbose かと思います。

 

普段、もっともよく使うのは「Log」になりますが、特に考えずに「Log」を使用すると、普段のテストプレイや、そのログとは全く関係ない機能をテストする際などにログが埋まってしまい、邪魔になってしまいます。
パフォーマンスを検証する場合にも、大量のログ出力は決して軽い処理ではありません。

 

しかし、その機能をテストするためだけに、プログラムを再ビルドする手間をかけるのも面倒です。

 

そこで「Verbose」や「VeryVerbose」を使用します。

UE_LOG記述時に適切にVerbosityを設定しておくことで、特定の機能についてより深くログを取得したい場合だけログ出力するように出来ます。

どのVerbosityまでのログを出力するかは、logコマンドを使用することでランタイム中に変更することが出来ます。

 

logコマンド

どのVerbosityまでログ出力するかの変更は、コンソールコマンド「log」を使用します。
例えば下記のコマンドで「LogParticles」カテゴリのログ出力を「Verbose」に切り替えられます。

「LogParticles」カテゴリのVerbosityを「Verbose」に設定すると、全てのエフェクトの再生開始タイミングが出力されるようになります。

 

カテゴリの一覧と、各カテゴリの現在の設定を確認したい場合は、

で確認出来ます。

 

例えば下記のようなコードを実行した場合、

Verbosityを「Warning」「Log」「VeryVerbose」に切り替えた際に、それぞれ下記のようなログが出力されます。

 

普段、通常のプレイの邪魔にならない程度の情報は「Log」で、詳細な調査を行いたいとき用のログは「Verbose」、かなり本気のデバッグ時に細かく追跡するときは「VeryVerbose」といった使い方がよいのではないでしょうか。

 

ログのカテゴリを定義する

自分でログのカテゴリを定義するには、下記の２行を記述する必要があります。

「DECLARE_LOG_CATEGORY_EXTERN」は、共通のヘッダファイル等に記述するとよいでしょう。
「DEFINE_LOG_CATEGORY」は、cpp側に記述します。

 

「DECLARE_LOG_CATEGORY_EXTERN」の第二引数はそのカテゴリのデフォルトのVerbosity、
第三引数はコンパイル段階で有効化するVerbosityです。

例えば第三引数をVerboseにすると、ランタイムで設定を切り替えても、VeryVerboseのログは出力されなくなります。
これで、下記のような記述が可能になります。

 

ブループリントのPrintString

ブループリント上でよく使う「PrintString」は「LogBlueprintUserMessages」カテゴリに出力されます。
Verbosityは、「Print to Log」がONの時は「Log」、OFFのときは「Verbose」になっています。

 

実は、「Print to Log」をOFFにしても、「LogBlueprintUserMessages」カテゴリを「Verbose」に変更すれば、OutputLogウィンドウには出力されます。

 

ちなみに、スクリーンへの出力はUE_LOGとは別になります。興味があれば、KismetSystemLibrary.cpp 内のPrintString関数を見てみて下さい。

 

ログファイル

OutputLogウィンドウに出力されたログは、通常、プロジェクトの Saved/Logs フォルダにテキストファイルとして保存されています。
パッケージ済みゲームでも、Development以下のビルドであれば、同様にパッケージフォルダ内の Saved フォルダに保存されます。

 

チーム内の他メンバーの環境で発生した問題や、エディタを閉じてしまったりクラッシュしてしまった場合でも、適切にログ出力しておけば、ここから情報が得られる可能性があります。

 

以上、UE_LOGについてのご紹介でした。