UDN
Search public documentation:

CommandletListJP
English Translation
中国翻译
한국어
Interested in the Unreal Engine?
Visit the Unreal Technology site.

Looking for jobs and company info?
Check out the Epic games site.

Questions about support via UDN?
Contact the UDN Staff

コマンドレット一覧

ドキュメントの概要: Unreal Engine 3 で使われる全コマンドレットの一覧。

ドキュメントの変更ログ: 作成完了。経時的に更新。

概要

コマンドレットは、 Unreal Engine 環境で動作するコマンドラインプログラムです。この内容には大きな変更がしばしば加わるので、情報を得るため、またはユニットテストメカニズムとして、見直しをかけるのが常です。

これらは、基本的には、初期化済みのエンジンを持つ小さなアプレット群であり、出力は主に Windows のコンソールのみに限定されます。

エンジンは、自動的にコマンドラインで渡したコマンドがコマンドレットかどうかの判別を試みます。そして、それがコマンドレットであれば、対応するコードを実行します。

このドキュメントは、 Unreal Engine 3 によって利用されるコマンドレットに対する説明と構文の一覧を掲載しています。

コマンドレット一覧

ヘルプ

help commandlet(ヘルプコマンドレット) は、どのコマンドレットが実行可能か、その目的、どのコマンドレットでパラメータを使用するかを見極めるために利用されます。どのコマンドレットが利用可能かを知るためには、以下を実行してください :

構文 

gamename.exe help <list | commandletname | webhelp commandletname>

パラメータ

  • list - 利用可能なすべてのコマンドレットの一覧です
  • commandlet name - 指定したコマンドレットのヘルプ情報を表示します
  • webhelp - 指定したコマンドレットの説明をしているウェブページの URL でブラウザを起動します

fixupredirects

Fixupredirects は、すべてのパッケージ中、または、オプションで指定したパッケージ中のすべての リダイレクタ? を修正します。 自己参照のリダイレクタは削除されます。もし、パッケージの指定がなければ、ゲームで必要なすべてのパッケージのリダイレクタがテストされます。

  • パッケージを保存しようとする前には、 (UnrealEd? 内の SCC と同様の方式を使用して) ソースコントロールからチェックアウトしようとします。
  • ですが、パッケージは、マニュアルでチェックインする必要があります。
  • 必要なパッケージ (リダイレクタを持つパッケージ及びそれらをポイントするパッケージ) のみを保存します。
  • リダイレクタをポイントするパッケージがチェックアウトできなかった場合は、リダイレクタはクリーンアップされません。
  • 一つのパッケージ名とすることが可能です、その結果、パッケージ内のリダイレクタのみを修正することになります (すなわち、特定のリダイレクタをポイントするパッケージと他のすべてのパッケージです) 。このようにすると、最上層でインポートし、リダイレクタがポイントしているオブジェクトを削除することができるため、リダイレクタをクリーンアップしたいときに有用です。
  • パッケージを開くときに失敗した場合は、継続するか中止するかを求める警告が表示されます。もし継続した場合は、開けなかったパッケージにリダイレクタに対する参照が含まれている可能性があるため、いくつかのオブジェクト参照が不明な可能性がありますが、コマンドレットはそれが無いものとみなします。なぜならば、パッケージがオープンできないため、その存在を確認する方法が無いからです。もし、その時点で中止を選択したら、その他のパッケージが保存されます。 (もちらん、パッケージを開く時点でクラッシュした場合は、明らかに処理はアボートしており、すべてのパッケージは、手付かずのままです。)
  • -nowarn オプションが指定できます、この場合は、パッケージが開けなければ単に終了します。(これは、スクリプト等のためですが、ファイルを開けなければ中止することは所在が不明なときには安全な方法です) 。

構文 

game.exe fixupredirects <package.ext>

パラメータ

  • package.ext - リダイレクタのテストを行うパッケージ名。 (オプション)

batchexport

BatchExport commandlet (BatchExport? コマンドレット)は、 Unreal パッケージファイルから様々な外部のファイルタイプにリソースをエクスポートするために利用されます。

構文 

gamename.exe gamename.exe BatchExport <package.ext> <classname> <export_ext> [dest_path_name]

パラメータ

  • package.ext - リソースをエクスポートするパッケージの名前。パス名はオプションです。
  • classname - "Class", "Texture" 等のような、エクスポートするオブジェクトのクラス。
  • export_ext - 出力ファイルのファイルタイプ。 リソースをエクスポートするためにどの処理をするかを決定します。
  • dest_path_name - 出力ファイルを保存するパス。ディレクトリが存在しなければ生成します。

make

make コマンドレットは、ゲームの最新で無いパッケージがあれば、 Unrealscript ソース (.uc ファイル) をコンパイルして、 Unreal パッケージ (.u ファイル) を生成します。

構文 

gamename.exe make <-スイッチ>

パラメータ

  • ==full- たとえ、旧バージョンで無くてもすべてのパッケージの再コンパイルを強制実行します。
nodelete - 旧バージョンで無い依存パッケージを削除しません。デフォルトでは、 EditPackages? リスト内で旧バージョンのパッケージの後に任意のパッケージのリビルドを起動します。
  • nodelete - 期限切れでない依存パッケージを削除しません。デフォルトでは、EditPackages リストにある期限切れパッケージの日付以降に発生したパッケージをリビルドします。”
  • debug - - コンパイル済みのバイナリ内にデバッグ情報を含めます。 UnrealScript? デバッガを使用するために必要です。
  • auto - 問い合わせ無しに、更新が必要な自動的に生成されたヘッダを自動的にチェックアウトします。自動生成したヘッダファイルのエクスポートに関係したスクリプトコンパイラによって生成されたすべての問い合わせを抑止します。
  • unattended - 自動的に "Yes" と返答することで、ビルド中に生成されたすべての問い合わせを抑止します。
  • silent - unattended と似ていますが、すべてのビルド出力 (ログ、その他) も抑止します。
  • silentbuild - コンソール出力ウィンドウに表示されるすべてのスクリプトコンパイラのステータスメッセージを抑止します。
  • noconform - (個々のゲームで異なる可能性がある) 自動適合ディレクトリ内に同じ名前で存在するパッケージの場合には、スクリプトパッケージは、通常は自動的に適合されます。 (ConformCommandlet? を参照してください)
  • WarningsAsErrors - すべてのスクリプトコンパイルの警告をエラーとして取り扱い、ビルドを失敗させます。
  • intermediate - スクリプトプリプロセッサ : すべての unrealscript ファイルの後処理済みバージョンを、プリプロセッサの ProcessedFileDirectory? 値によって指定されたプリプロセッサの中間ディレクトリに出力します。 UnrealScript? マクロのデバッグに有効です。
  • nopreprocess - スクリプトプリプロセッサ : 任意の UnrealScript? マクロについて、プリプロセッサで処理しないようにします。これは、一般的に完全にスクリプトのコンパイルを失敗させるために、デバッグのみで有効です。

stripsource

stripsource コマンドレットは、 Unreal パッケージ (.u ファイル) のロードをすべてのクラスに対して繰り返し、 ScriptText? を一つの場所に設定してから、パッケージを保存するために SavePackage?() を呼び出します。

問題は、 Core.u 、 Engine.u 、 Editor.u その他のような、コマンドレット実行中の実行ファイルによって使用中であり、上書きすることのできないパッケージです。そのため、それらのパッケージの保存は失敗します。

この問題を解決するために推奨する方法は、ScriptText (および CppText?) を取り除くパッケージのクッキングです。 データのクックを行わない場合は、 ResetLoaders?() の呼び出しで、オープンしているパッケージの問題を解決するかもしれません。

構文 

gamename.exe stripsource <package.u, ...>

パラメータ

conform

conform コマンドレットは、同じ GUID を割り当てることにより、パッケージのネットワーク互換性を確保します。これは、パッケージが変更されるたびに行われなければいけません。

構文 

gamename.exe conform to_package from_package

パラメータ

pkginfo

pkginfo コマンドレットは、一つ以上のパッケージ内に含まれるリソースについての情報を表示します。

構文 

gamename.exe pkginfo <package.ext> <-switch>

パラメータ

  • package.ext - リソース情報を表示するためのパッケージの名前です。
  • names - 指定されたパッケージに対する名前テーブルに対する情報を表示します。
  • imports - 指定されたパッケージ (ImportTable?) に含まれるオブジェクトによって参照される外部リソースを表示します。
  • exports - 指定されたパッケージ (ExportTable?) に含まれるリソースを表示します。
  • simple - -exports フラグと組み合わせて利用された時にだけ関係があります。それぞれのエクスポートに対してすべての情報では無く、名前とサイズのみを表示します。
  • depends - インポートまたはエクスポートの依存関係を表示します。すなわちオブジェクト参照および再帰的に参照している参照です。
  • all - パッケージに内に格納されたすべてのデータを表示します – 本質的には、コマンドラインで三つのすべてのタイプ (-imports -exports -names) を指定することと同じです。
  • chunks - パッケージ内の圧縮チャンクの情報を表示します。
  • paths - 参照されているすべての外部リソース (インポートなど) へのフル パス名を表示します。
  • hideoffsets - パッケージに含まれている UObjects の最初への直列化されたオフセット (エクスポートなど) を表示しません。
  • platform=<ps3,xenon> - パッケージがクックされるプラットフォームを指定するのに使用されます。

wranglecontent

wranglecontent コマンドレットはパッケージ内のどの資産が任意のレベルファイルから使用されないかを識別するために使用されます。

構文 

gamename.exe wranglecontent <-Switch>

パラメータ

  • reportunreferenced - 未使用のコンテンツをダンプ出力します。
  • ==restore - 分析ステップ後からピックアップします。コマンドレットの実行でメモリ不足の時や、一つのモードで実行したけれども、今は、他のモードで実行したい時などに便利です。
  • ==nosave* - 単に分析を行い、レポートをダンプ出力することが可能ですが、実際に保存はできません。
  • nosaveunreferenced - デフォルトでは、コマンドレットは参照されていないコンテンツを内部ポインタを損なわないためにオブジェクトの名前を変えた NFS_ packages として NFSContent ディレクトリ (非出荷) に保存します。このオプションは、このステップをスキップします (再度コンテンツを利用しないことがわかっている場合は有用です) 。.
  • reportunreferenced - 参照されていないコンテンツのリストの .csv ファイルをダンプ出力します。
  • removeeditoronly - 未使用のコンテンツを削除している間に、結果のパッケージをより小さくするためにエディタ専用のデータも取り除きますが、フルコンテンツ生成におおいては、それほど利用価値があるわけではありません。

analyzereferencedcontent

analyzereferencedcontent コマンドレットは、パッケージ内で使用されているデータを識別するのに使用されます。

構文 

gamename.exe analyzereferencedcontent <-switch>

パラメータ

  • mapsonly - レベル パッケージのみを使用します。
  • excludescript - スクリプト パッケージを除外します。
  • excludenonnativescript - 非 Native スクリプトを除外します。
  • loadsublevels - サブ レベルを読み込みます。永続性マップのみをパスすることができます。
  • ignorestaticmesh - StaticMesh? を含めません。
  • ignoresmc - StaticMeshComponent? を含めません。
  • ignorestaticmeshactor - StaticMeshActor? を含めません。
  • ignoretexture - Texture を含めません。
  • ignorematerial - Material を含めません。
  • ignoreparticle - ParticleComponent? と ParticleSystem? を含めません。
  • ignoreanim - AnimSets?/AnimSequences を含めません。
  • ignorelevel - Levels を含めません。
  • ignoresoundcue - SoundCue? を含めません。
  • ignorebrush - Brush を含めません。
  • ignoreshadowmap - ShadowMap? を含めません。

rebuildmap

rebuildmap コマンドレットは、ライティングも含めたマップをリビルドするために利用されます。

* 注記 *: コマンドレットは完全なデバッグはできませんので、 (すべての新規マテリアルおよび UV と共に BSP をランダムにリマップするように) しばしば、期待しない結果と成ることがあります。

このコマンドレットは、しばしばエディタを実行している際のメモリ欠如 (OOM) を回避するために使用されます。リビルドをいくつかの段階に分けることが最善です。

  1. まずは a BSP をビルドする。 b 保存する。 c 再起動する。
  2. それから a パスをビルドする。 b 保存する。 c 再起動する。
  3. 最後に a ライティングをビルドする。 b 保存する。

クイック ボタンを使用するのではなく、Tools (ツール) のドロップダウンを使用すると、それ以外で利用可能でないようなオプションの完全なホストを得ることができます。

また、何が問題なのかデバッグできるようになるまで、後ろで何も実行していない状態の完全な再起動状態から始めることが最善です。内部では、最新のビデオ ドライバを (適切に) アンインストールして、再インストールするまで、マップで非常に大きな OOM 問題を抱えていました。

構文 

gamename.exe rebuildmap <levelname>

パラメータ

levelname - リビルドするレベル (マップ) の名前

resavepackages

resavepackages コマンドレットは、ゲームのパッケージをオープンして保存します。

構文 

gamename.exe resavepackages

パラメータ

exportloc

exportloc コマンドレットは、 UnrealScript? パッケージ内のローカライズ文字列をローカライズテキストファイルにエクスポートします。

構文 

gamename.exe exportloc

パラメータ

mergepackages

mergepackages コマンドレットは、他のパッケージにパッケージの内容を設定します。

構文 

gamename.exe mergepackages <package> <targetpackage>

パラメータ

diffpackages

diffpackages コマンドレットは、特定の 2 つのパッケージですべてのプロパティ差異を表示します。

構文 

gamename.exe diffpackages <package> <package>

パラメータ

cookpackages

cookpackages コマンドレットは、コンソールが読み取れるようなフォーマットに、パッケージ データをプロセスして変換します。

通常、Unreal Frontend とともにクッカを実行しますが、クッキングを自動化させたいならば、コマンドライン インターフェースを使用してください。

構文 

gamename.exe CookPackages [map1 [map2] ... ] -platform=<Platform> [options]

パラメータ

  • platform=PLATFORM - クックするためのプラットフォームを設定します。PLATFORM は pc、ps3、xbox360、xenon のどれかを使用できます。
  • full - すべての既存のパッケージを強制的に再保存します。このオプションが指定されると、CookedYYY フォルダのコンテンツは最初に削除されます。
  • recookseekfree - すべてのシークフリー パッケージを強制的に再保存します (コマンドラインのスタートアップ、スタンドアロン シークフリー、マップ、または .ini)。デフォルト依存性チェックが動作しない (特にスタンドアロン シークフリー パッケージです。なぜならば、マップとは違って非シークフリー パッケージが変更される際、すべてのスタンドアロン シークフリー パッケージはリクックされないからです。) 場合に便利です。
  • cookallmaps - ゲーム内のすべてのマップをクックします。
  • mapsonly - マップのみをクックし、他に何もクックしようとしません。
  • inisonly - .ini とローカリゼーション ファイルのみを (Coalesced.ini や Coalesced.int などのファイルに) クックします。
  • sha - スタートアップ、合体ファイルに SHA ハッシュを生成して、Hashes.sha に出力します。
  • skipsavingmaps - マップをクックしますが、保存はしません。マップに使用されている LOC データをクックするのに便利です。
  • skipnotrequiredpackages - LOC クックをスピードアップするために、クック プロセスに必要とされないパッケージの読み込みと保存をスキップします。
  • languageforcooking=LANG - ローカライズ化クックの言語を LANG に設定します。int (English) にデフォルトします。

showtaggedprops

showtaggedprops コマンドレットは、クラス デフォルトやアーキタイプから派生した値やランタイム時に設定された値などに対して、オブジェクトのパッケージ ファイルに実際にどの値が保存されたかを識別する手助けをします (というのは、オブジェクトの値を見るのに唯一のもう 1 つの選択肢は、デバッガで実行するか、=OBJ DUMP ObjectName?= コンソール コマンドをランタイム時に使用することだからです)。問題が読み込みにあるのか、保存にあるのかが簡単に分かるので、直列化に関する何かをトラックする際には、このコマンドレットを使用します。

構文 

gamename.exe showtaggedprops <PackageName[.ext]> <ClassPackage.ClassName> [PropertyA[,PropertyB...]]

パラメータ

listpackagesreferencing

listpackagesreferencing コマンドレットは、任意のパッケージで欠けているリソースを探すのに有用です。

構文 

gamename.exe listpackagesreferencing <package.missingresource>

パラメータ

setmaterialusage

setmaterialusage コマンドレットは、任意のパッケージのマテリアル使用量を識別します。

構文 

gamename.exe setmaterialusage <package>

パラメータ

dumpshaders

dumpshaders コマンドレットは、シェーダ、すべてのインクルード、プリプロセスされたバージョン、結果となった asm、バッチ ファイルをダンプし、素早いイテレーションのために、コマンドライン シェーダ コンパイラ (.fxc) を使用してリコンパイルします。

グローバル シェーダが提供されていると、マッチするタイプのみが操作されます。マテリアルが提供されていると、そのマテリアルによってコンパイルされたすべてのシェーダはダンプされます。

より詳細な情報は、 シェーダ ホーム ページを参照してください。

構文 

gamename.exe DumpShaders platform=<platform> [globalshader=<shadertype>] [material=<materialname>]

パラメータ

CheckpointGameAssetDatabase

このコマンドレットのドキュメントは、コンテンツ ブラウザ データベース ページを参照してください。

CheckLightMapUVs

静的メッシュをスキャンし、ライトマップ テクスチャ座標セットの問題をチェックします。以下の問題を検知します。

  • 欠けているライトマップ テクスチャ座標セット
  • 0.0 - 1.0 範囲外のライトマップ テクスチャ座標
  • お互いに重複するライトマップ テクスチャ座標

問題が見つかると、詳細の警告メッセージが繰り返されます。

また、エディタがジャーナル サーバーに接続するように設定されていると、アーティストが簡単に見つけられるように、コマンドレットは自動的にアセットをコレクションに追加します。以下の 2 つのコレクションが作成されます。

  • 欠けている LightMap UVs: ライトマップ テクスチャ座標セットが欠けているアセットを含みます。
  • 不正な LightMap UVs: 0.0 - 1.0 範囲外、または重複した UV を持つライトマップ テクスチャ座標を持つアセットを含みます。

コマンドレットを実行するたびに、これらのコレクションは破壊されリビルドされます。

デフォルトで、すべてのゲーム パッケージは、(マップ パッケージ) を含む静的メッシュに関するスキャンをします。もう 1 つの選択肢として、コマンドラインでパッケージのセットを指定してスキャンできます。

構文 

gamename.exe CheckLightMapUVs [package1] [package2] ...

パラメータ

ありません。

FindUniqueSpecularTextureMaterials

Content ブラウザで、UNIQUE なスペキュラーテクスチャを持つすべての環境マテリアルのコレクションを生成します。環境マテリアルの判定は、WORLD LODGroup に設定されたディフューズチェーンにテクスチャが含まれているかどうかにより決まります。

構文 

gamename.exe FindUniqueSpecularTextureMaterials <-ALLMATERIALS>

パラメータ

-ALLMATERIALS 環境マテリアルだけでなく、すべてのマテリアルについてスペキュラーテクスチャが存在するかどうかを調べます。

FindDarkDiffuseTextures

ディフューズプロパティチェーンに 'dark' (暗い) テクスチャが含まれているすべてのマテリアルの Content ブラウザコレクションを生成します。

構文 

gamename.exe FindDarkDiffuseTextures <MINBRIGHT=###> <-ALLOWBLACK> <-GRAYSCALE> <UPDATE=##>

パラメータ

MINBRIGHT=###

'not dark' (暗くない) ことを意味する明るさパーセント値を、浮動少数点数により指定します。 この値は GammaSpace の [0.0 .. 100.0] までの範囲にあることを前提としています。 デフォルト値を editor.ini ファイルでも指定することもできます ([DarkTextures],MinimalBrightness)。

-ALLOWBLACK

TRUE の場合、明るさの計算に真っ黒のテクセルも含まれます。 デフォルト値は FALSE で、ini ファイルでも指定できます ([DarkTextures],bIgnoreBlack) (false == allow)。

-GRAYSCALE

TRUE の場合、明るさの計算では次の式を用いて各ピクセルをグレースケールに変換します。 GS = R * 0.30 + G * 0.58 + B * 0.11 FALSE の場合、明るさの計算式は Max(R, Max(G,B)) です。 デフォルト値は editor.ini ファイルでも指定できます ([DarkTextures],bUseGraySCale)。

UPDATE=##

## 個のパッケージが処理されるたびに、コレクションが更新されることを示す整数。

コマンドレットの作成方法

コマンドレットの作成方法 ページをご覧ください。