[UE4] コンソールウィンドウを開くコマンド

1. 概要

ログを出力するためのウィンドウ (以下図の矢印) を表示するコマンドを紹介します。
使い方はコマンドの入力バー、コンソールを出してコンソールコマンドを入力するだけ¹です。
下の図の矢印のウィンドウを出したり出さなかったりします。

2. コマンド

ShowLog
・ログ出力ウィンドウを表示することができトグル方式でON/OFFを切り替えることができる
・起動引数に"-log"を付けて起動²せずともログ出力を確認することができる
・ウィンドウの動的な表示の切替が可能で、ログの出力を都度リセットすることができる
・Shippingでは利用不可、Debug/Development/Testで利用可能
・PIE、Standaloneで利用可能
・コンソール/モバイル実機では利用不可、PCで利用可能

3. 実装

実装はUEngineの以下の箇所で定義されています。HandleShowLogCommandの中でShow()を実行しています。

UnrealEngine.cpp

bool UEngine::Exec( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )
{
    // ...
    else if( FParse::Command(&Cmd,TEXT("SHOWLOG")) )
    {
        return HandleShowLogCommand( Cmd, Ar );
    }
}

bool UEngine::HandleShowLogCommand( const TCHAR* Cmd, FOutputDevice& Ar )
{
    // Toggle display of console log window.
    if (GLogConsole)
    {
        GLogConsole->Show( !GLogConsole->IsShown() );
    }
    return 1;
}

4. まとめ

Windowsでの開発において、StandaloneやPackageでの確認の際に役に立ちます。
これらをうまく活用してデバッグを効率的に行いましょう。

---

1. コンソールの出し方：コンソールコマンドの入力は"~"キー(日本語キーボードは"@"キー)を押してコンソールを表示してコマンドを入力する。たまにどちらか混同する。 ↩

2. -log：ログ出力ウィンドウを表示するための起動引数。Visual Studioを使わないBlueprint Onlyのプロジェクトや、Network関連のデバッグなど、ログで確認した方が良いケースなどでは捗る。 ↩