[UE5]Shotコマンドのプチ解説

スクリーンショットを取るときに使用できるShotコマンド。
実は引数を付けることで処理を調整できることをご存じでしたか？
ということでShotコマンドで使える引数のプチ解説となります。

Shotコマンドについての基本的な内容は公式のリファレンスをご覧ください。
https://dev.epicgames.com/documentation/ja-jp/unreal-engine/taking-screenshots-in-unreal-engine

まず最初にご紹介する引数は、

• -showui

通常、Shotコマンドでスクリーンショットを撮影するとWidgetを使ったUIなどは出力画像に表示されません。
ですが、こちらの引数を付けてShotコマンドを呼び出すことでUIを出力画像に含めることができます。
挙動としては、エディタでショートカットキーの「F9」を押したときと同様の物となります。
このため、エディタ画面等も出力画像に含まれてしまいますので、そこはご注意ください。
これを避ける場合は例えばパッケージのフルスクリーンモードでコマンドを実行するなどの工夫が必要となります。

例1.引数のない通常の Shotコマンド

例2.Shot -showui（PIEモード）

例3.Shot -showui（SerectViewportモード）

次にご紹介する引数は、

• -filename=

Shotコマンドで出力される画像は自動的に　ScreenShot00000.png　といった形で、ScreenShot + 5桁連番 のファイル名で出力されます。
この引数を使えば、 ScreenShot 部分の文字列を任意のものに置き換えたファイル名での出力が可能になります。

例.Shot -filename=”Test”
　 出力ファイル名＝ Test00000.png

また、ファイルパスでの指定もできるので、任意のパスを指定することで好きなディレクトリに出力することも可能です。
例.Shot -filename=”C:\MyScreenShot\TestShot”
　 出力結果　C:\MyScreenShot\TestShot00000.png

この時、存在しないフォルダを指定している場合は新規にフォルダを生成してからその中に出力が行われます。

注意点として、相対パスで指定しようとした場合、エディタではインストールしたエンジンのUnrealEngine.exeがある階層をルートディレクトリとした場所となるのでご注意ください。
パッケージでの場合は作成したパッケージexeのある階層がルートディレクトリとなります。

最後にご紹介する引数が、

• -nosuffix

こちらは出力ファイル名に自動追加される5桁連番を付けないようにすることが出来ます。

例.Shot -nosuffix
　 出力ファイル名　ScreenShot.png

この引数を有効にしている場合、同名の画像が既に出力されていると上書きする動作となるのでご注意ください。

解説は以上ですが、これらの引数は組み合わせて使う事も可能です。
スクリーンショットを取るだけなら他の機能もありますが、Shot コマンドも引数を利用すればより便利に使うことが出来ます。
特に良く使われる HighResShot では難しいUI付きのスクリーンショットを、 Shot -showui コマンドで出力できるので、使い分けの参考になれば幸いです。