通常、プロジェクト固有のユーティリティ スクリプトが AutomationTool BuildCommand
クラスとして実装されます。カスタム タスクをプロジェクト用に自動化するには、BuildGraph が役立ちます。BuildGraph はタスクをいくつでも拡張し、各自の特定のニーズに合わせた方法でビルド自動化タスクをカスタマイズすることができます。次のセクションでは、BuildGraph を使用してカスタム タスクを作成する方法を説明します。カスタム タスク作成を開始する際に最適な定義済みタスクの一覧も示します。
カスタム タスク
新しいカスタム タスクを作成するには、CustomTask
クラスから派生したクラスを実装し、それに TaskElement
属性を適用します。TaskElement
コンストラクタには、2 つの引数があります。それが表される XML エレメントの名前と、そのパラメータが含まれるクラスの型です (ロード時に超すトラクタへ渡されます)。
XML ファイルからパラメータのクラス フィールドを読み出す場合は、タスクに TaskParameter
属性をアタッチします。TaskParameter
属性をアタッチすると、引数に適用されるべき追加のバリデーションを含めて、パラメータが必須であるか任意であるかを示します。
定義済みタスク
タスク作成の開始点として、テンプレートに多様な定義済みタスクがあります。単純な定義済みタスクを求めている場合は、LogTask
から始めることをお勧めします。BuildGraph の最新情報を知りたい場合は、このページをブックマークしてください。以下の定義済みタスクの一覧が定期的に更新されます。
BuildCookRun はパワフルなコマンドで、一般的にパッケージング作業で使用されます。詳細については「ビルド操作」を参照してください。
AgeStore
一連のファイルからシンボルを取り除くタスク。このタスクの名前は Microsoft デバッガー ツール SDK に付属する AGESTORE ユーティリティにちなんでいますが、実際には個別に実装されたものです。主な違いは削除するファイルを決定するときに、最終アクセス時刻ではなく最終変更時刻を使用することです。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Platform | UnrealTargetPlatform | 必須 | シンボルをエージングするターゲット プラットフォーム。 |
StoreDir | String | 必須 | シンボル サーバー ディレクトリ。 |
Days | Integer | 必須 | 必要なシンボルを保持する日数。 |
BuildDir | String | オプション | ビルド ディレクトリのルート。既存のビルド バージョンの名前がついたディレクトリを確認します。 |
Filter | String | オプション | シンボルを削除する前に、ディレクトリのファイル名と一致する部分文字列。これにより複数のビルドが同じシンボル サーバーを共有する場合に、「age store」タスクが他のビルドからシンボルを削除することを回避できます。このフィルタ値の特定の用途は、プラットフォーム ツールチェーンで定義したシンボル サーバーの構造によって決まります。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Aws
AWS CLI をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Arguments | String | オプション | 新しく作成されたプロセスの引数。 |
Environment | String | オプション | 環境変数。 |
EnvironmentFile | String | オプション | 環境の読み取り元のファイル。 |
LogOutput | Boolean | オプション | ログに出力を書き込みます。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Aws-AssumeRole
AWS ロールを引き受けます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Arn | String | 必須 | 引き受けるロール。 |
Session | String | 必須 | このセッションの名前。 |
Duration | Integer | オプション | トークンの継続時間 (秒単位)。 |
Environment | String | オプション | 環境変数。 |
EnvironmentFile | String | オプション | 環境変数の読み取り元のファイル。 |
OutputFile | String | 必須 | 新しい環境の出力ファイル。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Aws-EcsDeploy
新しい AWS ECS タスクの定義を作成して ECS サービスを更新し、タスク定義のこの新しいリビジョンを使用します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
TaskDefinitionFile | String | 必須 | 使用するタスク定義ファイル。 |
DockerImage | String | 必須 | 新しいタスク定義内に設定する Docker イメージ (この値によって %%DOCKER_PATTERN%% が置き換えられる)。 |
Version | String | オプション | 新しいタスク定義内に設定するアプリ バージョン (この値によって %%VERSION%% が置き換えられる)。 |
Cluster | String | 必須 | 実行する AWS ECS クラスタを表すクラスタ ARN。 |
Service | String | 必須 | 更新対象およびデプロイ先となるサービス名。 |
Environment | String | オプション | 環境変数。 |
EnvironmentFile | String | オプション | 環境の読み取り元のファイル。 |
LogOutput | Boolean | オプション | ログに出力を書き込みます。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Command
AutomationTool の子プロセスを呼び出して、指定されたコマンドを実行します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Name | String | 必須 | 実行するコマンド名。 |
Arguments | String | オプション | コマンドに渡す引数。 |
MergeTelemetryWithPrefix | String | オプション | null 以外の場合、コマンドからのテレメトリを、指定したプレフィックスを持つこの UAT インスタンスのテレメトリとマージするように指示します。空の文字列 (null ではない) の可能性があります。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Commandlet
エディタをスポーンしてコマンドレットを実行します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Name | String | 必須 | 実行するコマンドレット名。 |
Project | FileSpec | オプション | エディタで実行するプロジェクト。 |
Arguments | String | オプション | コマンドレットに渡す引数。 |
EditorExe | FileReference | オプション | 使用するエディタの実行可能ファイル。デフォルトは、現在のプラットフォーム用の開発 UnrealEditor の実行可能ファイルです。 |
ErrorLevel | Integer | オプション | エラーとして扱われる最小の終了コード。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Compile
Unreal Build Tool でターゲットをコンパイルします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Target | String | オプション | コンパイルするターゲット。 |
Configuration | UnrealTargetConfiguration | 必須 | コンパイルするコンフィギュレーション。 |
Platform | UnrealTargetPlatform | 必須 | コンパイルするプラットフォーム。 |
Project | FileSpec | オプション | コンパイルするプロジェクト。 |
Arguments | String | オプション | Unreal Build Tool の追加の引数。 |
AllowXGE | Boolean | オプション | コンパイルに XGE の使用を許可するかどうか。 |
AllowParallelExecutor | Boolean | オプション | このコンパイルに並列エグゼキューターの使用を許可するかどうか。 |
AllowAllCores | Boolean | オプション | AllowXGE が無効な場合に UBT が使用可能なすべてのコアの使用を許可するかどうか。 |
Clean | Boolean | オプション | このターゲットにクリーンを許可するかどうか。指定しない場合でも、コマンドラインで -Clean 引数を渡すとターゲットがクリーンされます。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Cook
特定のプラットフォーム用に、選択したマップをクックします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Project | String | 必須 | クックするプロジェクト ファイル。 |
Platform | String | 必須 | ターゲットにするクック プラットフォーム (例:Windows)。 |
Maps | String | オプション | 「+」文字で区切られた、クックするマップのリスト。 |
Versioned | Boolean | オプション | クッカーに渡す追加の引数。 |
Arguments | String | オプション | クッカーに渡す追加の引数。 |
EditorExe | String | オプション | クックのために実行するエディタの実行可能ファイルへのパス (オプション)。 |
TagOutput | Boolean | オプション | クックの出力をタグ付けするかどうか。クックが大量のファイルを生成するため、それらのファイルが依存ノードで必要ない場合は、タグ付けするために時間を費やすと悪影響を及ぼす可能性があります。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Copy
あるディレクトリから別のディレクトリにファイルをコピーします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | オプション | 入力ファイルのリストに適用するオプションのフィルタ。 |
From | FileSpec | 必須 | コピー元のパターン (例:Engine/*.txt )。 |
To | FileSpec | 必須 | コピー先のディレクトリ。 |
Overwrite | Boolean | オプション | 既存のファイルを上書きするかどうか。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
ErrorIfNotFound | Boolean | オプション | コピーするファイルがなかった場合にエラーをスローするかどうか。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
CsCompile
C# のプロジェクト ファイルとその依存関係をコンパイルします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Project | String | 必須 | コンパイルする C# プロジェクト ファイル。セミコロンを使用して複数のプロジェクト ファイルを指定できます。 |
Configuration | String | オプション | コンパイルするコンフィギュレーション。 |
Platform | String | オプション | コンパイルするプラットフォーム。 |
Target | String | オプション | ビルドするターゲット。 |
Properties | String | オプション | コマンドのプロパティ |
Arguments | String | オプション | コンパイラに渡す追加オプション。 |
EnumerateOnly | Boolean | オプション | ビルド プロダクトを列挙するだけです。実際にはプロジェクトをコンパイルしません。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
TagReferences | TagList | オプション | プロジェクトが含む非プライベート参照に適用するタグ。(たとえば、出力ディレクトリにコピーしない外部にあるもの)。 |
UseSystemCompiler | Boolean | オプション | バンドルされている UE SDK ではなくシステム ツールチェーンを使用するかどうか。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Delete (削除)
一連のファイルを削除します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | オプション | セミコロンで区切ったファイル仕様のリスト (例:*.cpp;Engine/.../*.bat )、またはタグ セットの名前。 |
Directories | String | オプション | ディレクトリ名のリスト。 |
DeleteEmptyDirectories | Boolean | オプション | ファイルを削除した後に、空のディレクトリを削除するかどうか。デフォルトは true です。 |
Verbose | Boolean | オプション | 詳細なログを使用するかどうか。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
DeployTool
Horde を介してツール更新をデプロイします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
ID | String | 必須 | ツールの識別子。 |
Settings (設定) | String | 必須 | デプロイに使用する設定ファイル。サーバー名とアクセス トークンを含む JSON ファイルにする必要があります。 |
Version | String | 必須 | 新しいツールのバージョン番号。 |
Duration | Integer | オプション | ツールを展開するまでの期間 (分単位)。 |
Paused (一時停止) | Boolean | オプション | デプロイメントを一時停止として作成するかどうか。 |
File | String | オプション | アップロードするファイルを含む Zip ファイル。 |
Directory | String | オプション | ツールをアップロードするディレクトリ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Docker
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Arguments | String | 必須 | Docker のコマンド ライン引数。 |
Environment | String | オプション | 設定する環境変数。 |
EnvironmentFile | String | オプション | 環境変数の読み取り元のファイル。 |
WorkingDir | String | オプション | コマンドを実行するためのベース ディレクトリ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Docker-Build
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
BaseDir | String | 必須 | ビルドのベース ディレクトリ。 |
Files | String | 必須 | イメージをビルドする前にステージングされるファイル。 |
DockerFile | String | オプション | Dockerfile へのパス。指定されていない場合、basedir のルートが使用されます。 |
DockerIgnoreFile | String | オプション | .dockerignore へのパス。指定されている場合は、basedir にコピーされます。 |
UseBuildKit | Boolean | オプション | Docker で BuildKit を使用します。 |
ProgressOutput | String | オプション | 進捗の出力のタイプ (--progress )。 |
Tag | String | オプション | イメージのタグ。 |
Arguments | String | オプション | オプションの引数。 |
OverlayDirs | String | オプション | ステージングされた入力ファイルにオーバーレイする追加のディレクトリのリスト。認証情報のステージングなどを許可します。 |
Environment | String | オプション | 設定する環境変数。 |
EnvironmentFile | String | オプション | 環境変数の読み取り元のファイル。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Docker-Compose-Down
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
File | String | 必須 | docker-compose ファイルへのパス。 |
Arguments | String | オプション | コマンドの引数。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Docker-Compose-Up
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
File | String | 必須 | docker-compose ファイルへのパス。 |
Arguments | String | オプション | コマンドの引数。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Docker-Push
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Repository | String | 必須 | リポジトリ。 |
Image | String | 必須 | プッシュするソース イメージ。 |
TargetImage | String | オプション | ターゲット イメージの名前。 |
Environment | String | オプション | 追加の環境変数。 |
EnvironmentFile | String | オプション | 環境の読み取り元のファイル。 |
AwsEcr | Boolean | オプション | AWS ECR にログインするかどうか。 |
RepositoryAuthFile | String | オプション | プッシュするリポジトリの認証用 json ファイルへのパス。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
DotNet
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Arguments | String | オプション | Docker のコマンド ライン引数。 |
BaseDir | String | オプション | コマンドを実行するためのベース ディレクトリ。 |
Environment | String | オプション | 設定する環境変数。 |
EnvironmentFile | String | オプション | 環境変数の読み取り元のファイル。 |
ErrorLevel | Integer | オプション | エラーとして扱われる最小の終了コード。 |
DotNetPath | FileReference | オプション | dotnet 実行可能ファイルへのオーバーライド パス。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
FindModifiedFiles
C# のプロジェクト ファイルとその依存関係をコンパイルします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Path | FileSpec | オプション | セミコロンで区切ったファイル仕様のリスト (デフォルトは ... です)。 |
Change | Integer | オプション | コンパイルするコンフィギュレーション。 |
MinChange | Integer | オプション | コンパイルするコンフィギュレーション。 |
MaxChange | Integer | オプション | コンパイルするコンフィギュレーション。 |
Output | FileReference | オプション | 書き込み先のファイル。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Git
Git をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Arguments | String | オプション | Git のコマンド ライン引数。 |
BaseDir | String | オプション | コマンドを実行するためのベース ディレクトリ。 |
ErrorLevel | Integer | オプション | エラーとして扱われる最小の終了コード。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Git-Clone
Git リポジトリのクローンをローカル パスに作成します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Dir | String | 必須 | リポジトリのディレクトリ。 |
Remote | String | オプション | 追加するリモート。 |
Branch | String | 必須 | リモートでチェック アウトするブランチ。 |
ConfigFile | String | オプション | repo のコンフィギュレーション ファイル。これは、フェッチするリモートのセットアップや認証情報の提供に利用できます。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Helm
Helm をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Chart | String | 必須 | Helm のコマンド ライン引数。 |
Deployment | String | 必須 | リリースの名前。 |
Namespace | String | オプション | Kubernetes 名前空間。 |
KubeContext | String | オプション | kubectl のコンテキスト。 |
KubeConfig | String | オプション | 使用する kubectl コンフィグ ファイル。 |
Values | String | オプション | チャートを実行するために設定する値。 |
ValuesFile | String | オプション | チャートを実行するために設定する値。 |
Environment | String | オプション | 設定する環境変数。 |
EnvironmentFile | String | オプション | 環境変数のパース元のファイル。 |
Arguments | String | オプション | 追加の引数。 |
WorkingDir | String | オプション | コマンドを実行するためのベース ディレクトリ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Horde-CreateReport
Horde レポート ファイルを作成します。このタスクを実行しているジョブとともに、このレポートがダッシュボードに表示されます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Name | String | 必須 | レポートの名前。 |
Scope | String | 必須 | レポートを表示するかどうか。 |
Placement | String | 必須 | レポートを表示するかどうか。 |
Text | String | 必須 | テキストが表示されるように設定します。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Kubectl
Kubectl をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Arguments | String | 必須 | コマンド ライン引数。 |
BaseDir | String | オプション | コマンドを実行するためのベース ディレクトリ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Log
メッセージ (およびその他オプションの診断情報) を出力ログに出力します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Message | String | オプション | 出力するメッセージ。 |
Files | FileSpec | オプション | 指定した場合、設定したメッセージの後に指定したファイルのリストを出力します。 |
IncludeContents | Boolean | オプション | 指定した場合、設定したファイルのコンテンツを出力します。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
ModifyConfig
コンフィグ ファイルを変更します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
File | FileSpec | 必須 | コンフィグ ファイルのパス。 |
Section | String | 必須 | 変更するセクション名。 |
Key | String | 必須 | 設定するプロパティ名。 |
Value | String | 必須 | 設定するプロパティ値。 |
Tag | TagList | オプション | 抽出したファイルに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
ModifyJsonValue
キー パスに指定された値を設定することで JSON ファイルを変更します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | 必須 | 変更される JSON ファイルのパス。 |
KeyPath | String | 必須 | 各ファイルで検索する JSON キーのパス。 |
NewValue | Integer | 必須 | 適用する新しい値。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Move
あるディレクトリから別のディレクトリにファイルを移動します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | オプション | 入力ファイルのリストに適用するオプションのフィルタ。 |
From | FileSpec | 必須 | コピー元のパターン (例:Engine/*.txt )。 |
To | FileSpec | 必須 | コピー先のディレクトリ。 |
Overwrite | Boolean | オプション | ファイルが上書きされるかどうか (オプション)。デフォルトは false です。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
ErrorIfNotFound | Boolean | オプション | コピーするファイルがなかった場合にエラーをスローするかどうか。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
MsBuild
MsBuild を実行します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Project | String | 必須 | コンパイルする C# プロジェクト ファイル。セミコロンを使用して複数のプロジェクト ファイルを指定できます。 |
Configuration | String | オプション | コンパイルするコンフィギュレーション。 |
Platform | String | オプション | コンパイルするプラットフォーム。 |
Arguments | String | オプション | コンパイラに渡す追加オプション。 |
Verbosity | String | オプション | MSBuild 出力の詳細。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
NuGet-LicenseCheck
Docker をスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
BaseDir | String | 必須 | コマンドを実行するためのベース ディレクトリ。 |
IgnorePackages | String | オプション | バージョン チェックで無視するパッケージを指定するセミコロン区切りのリストを設定します。name@version 構文を使用して、任意のバージョン番号を指定することができます。 |
LicenseDir | DirectoryReference | オプション | 許可されているライセンスを含むディレクトリ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
OnExit
外部の実行可能ファイルをスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Command | String | 必須 | スポーンする実行可能ファイル。 |
Lease | Boolean | オプション | リースの終了時に実行するかどうか。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
PakFile
指定した一連のファイルから PAK ファイルを作成します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | 必須 | PAK ファイルに追加するファイルのリスト、ワイルドカード、タグ セット。「;」文字で区切ります。 |
Output | FileReference | 必須 | 出力する PAK ファイル。 |
ResponseFile | FileReference | オプション | 個別に指定する代わりの、PAK ファイルに追加するファイルのリストを含む応答ファイルのパス。 |
RebaseDir | DirectoryList | オプション | 関連するファイルをリベースするディレクトリ。指定した場合、リストしたディレクトリ配下の、最も短いパスを各ファイルに対して使用します。 |
Order | FileReference | オプション | ファイルの順序を示すスクリプト。 |
Sign | FileReference | オプション | この PAK ファイルの暗号化キー。 |
Compress | Boolean | オプション | ファイルを圧縮するかどうか。 |
Arguments | String | オプション | UnrealPak に渡す追加の引数。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
QueryTargets
UBT を実行し、特定のプロジェクトのターゲットをすべてクエリします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
ProjectFile | FileReference | オプション | クエリするプロジェクト ファイルへのパス。 |
OutputFile | FileReference | オプション | ターゲットに関する情報を受け取る出力ファイルへのパス。 |
IncludeAllTargets | Boolean | オプション | デフォルトが「Default*.ini 」ファイルの「BuildSettings 」セクションで指定されている場合にも、すべてのターゲットを書き出します。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
RandomData
指定された出力ディレクトリに、ランダムなデータを含むファイルを作成します。一時ストレージ システム用のテスト データを生成するために使用されます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Size (サイズ) | Integer | オプション | 各ファイルのサイズ。 |
Count (回数) | Integer | オプション | 書き込むファイルの数。 |
Different | Boolean | オプション | 出力ファイルごとに異なるデータを生成するかどうか。 |
OutputDir | String | オプション | 出力ディレクトリ。 |
Tag | String | オプション | 入力ファイルのリストに適用するオプションのフィルタ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
名前を変更
ファイル、またはファイルのグループの名前を変更します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | 必須 | 1 つもしくは複数の、名前を変更するファイル。 |
From | String | オプション | 現在のファイル名、もしくは一致するパターン (例:*.txt )。パス区切り文字は使用できません。 |
To | String | 必須 | 1 つもしくは複数のファイルの、新しい名前。パス区切り文字は使用できません。 |
Tag | TagList | オプション | 名前を変更したファイルに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
SanitizeReceipt
*.target
ファイルから読み取ることにより、ビルド プロダクトやランタイム依存関係をタグ付けするタスク。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | 必須 | セミコロンで区切った、ワイルドカードとタグ名を含む、一連のレシート ファイル (*.target )。 |
EngineDir | DirectoryReference | オプション | レシート ファイルの $(EngineDir) プロパティを展開するために使用する Engine フォルダのパス。現在のワークスペースの Engine ディレクトリがデフォルトです。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
SetVersion
指定したバージョン情報でローカル バージョン ファイル (Engine/Source/Runtime/Launch/Resources/Version.h
、Engine/Build/Build.version
、および Engine/Source/Programs/Shared/Metadata.cs
) を更新します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Change | Integer | 必須 | バージョン ファイルに設定するチェンジリスト。 |
CompatibleChange | Integer | オプション | バージョン ファイルに設定するエンジン互換のチェンジリスト。 |
Branch | String | 必須 | Branch 文字列。 |
Build (ビルド) | String | オプション | ビルド バージョン文字列。 |
BuildURL | String | オプション | 実行中の継続的な統合ジョブの URL。 |
Licensee | Boolean | オプション | IS_LICENSEE_VERSION フラグを true に設定するかどうか。 |
Promoted | Boolean | オプション | ENGINE_IS_PROMOTED_BUILD フラグを true に設定するかどうか。 |
SkipWrite | Boolean | オプション | 設定した場合、ファイルに書き込みが行われず、ただ更新されるバージョン ファイルを返します。ローカル ビルドに便利です。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Sign
インストール済みの証明書で一連の実行可能ファイルに署名します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | 必須 | セミコロンで区切ったファイル仕様のリスト (例:*.cpp;Engine/.../*.bat )、またはタグ セットの名前。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Spawn
外部の実行可能ファイルをスポーンして完了を待ちます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Exe | String | 必須 | スポーンする実行可能ファイル。 |
Arguments | String | オプション | 新しく作成されたプロセスの引数。 |
WorkingDir | String | オプション | 新規タスクをスポーンするための作業ディレクトリ。 |
Environment | String | オプション | 設定する環境変数。 |
EnvironmentFile | String | オプション | 環境の読み取り元のファイル。 |
LogOutput | Boolean | オプション | ログに出力を書き込みます。 |
ErrorLevel | Integer | オプション | エラーとして扱われる最小の終了コード。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Stage
ビルド レシートにリストされているファイルを出力ディレクトリにステージします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Project | FileReference | オプション | このターゲットが属するプロジェクト。 |
Target | String | 必須 | ステージするターゲットの名前。 |
Platform | UnrealTargetPlatform | 必須 | ステージするプラットフォーム。 |
Configuration | UnrealTargetConfiguration | 必須 | ステージするコンフィギュレーション。 |
Architecture | String | オプション | ステージするアーキテクチャ。 |
ToDir | DirectoryReference | 必須 | レシート ファイルをステージする先のディレクトリ。 |
Overwrite | Boolean | オプション | 既存のファイルを上書きするかどうか。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Strip
一連のファイルからデバッグ情報を取り除きます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Platform | UnrealTargetPlatform | 必須 | バイナリを除去するプラットフォーム ツールチェーン。 |
BaseDir | DirectoryReference | オプション | ファイルを検索するディレクトリ。 |
Files | FileSpec | 必須 | セミコロンで区切ったファイル仕様のリスト (例:Engine/.../*.pdb )、またはタグ セットの名前。 |
OutputDir | DirectoryReference | オプション | 除去されたファイルの出力ディレクトリ。デフォルトは入力パスで、入力ファイルを上書きします。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Submit
新しいチェンジリストを作成して、一連のファイルを Perforce ストリームに送信します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Description | String | 必須 | 送信するチェンジリストの説明。 |
Files | FileSpec | 必須 | 送信するファイル。 |
FileType | String | オプション | 送信するファイルの Perforce ファイル タイプ (例: binary+FS32)。 |
Workspace | String | オプション | ワークスペース名。指定した場合、与えられたストリームとルート ディレクトリを使用して新しいワークスペースを作成し、ファイルを送信します。指定しない場合は現在のワークスペースを使用します。 |
Stream | String | オプション | ワークスペースのストリーム。デフォルトは現在のストリームです。Workspace 属性も指定していない場合は無視されます。 |
Branch | String | オプション | ワークスペースのブランチ (レガシーの P4 デポのパス)。Stream と組み合わせて使用できない場合があります。 |
RootDir | DirectoryReference | オプション | ストリームのルート ディレクトリ。指定しない場合、デフォルトは現在のルート ディレクトリです。 |
RevertUnchanged | Boolean | オプション | 送信を試みる前に未変更のファイルを元に戻すかどうか。 |
Force | Boolean | オプション | 問題解決が必要な場合でも強制的に送信します (常に現在のバージョンを受け入れます)。 |
P4Verbose | Boolean | オプション | 詳細な P4 出力 (スピュー) を許可します。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
SymStore
一連のファイルからシンボルを取り除くタスク。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Platform | UnrealTargetPlatform | 必須 | シンボル ファイルの処理に必要なプラットフォーム ツールチェーン。 |
Files | String | 必須 | 出力ファイルのリスト。このリストから PDB を抽出します。 |
StoreDir | String | 必須 | 圧縮したシンボルの出力ディレクトリ。 |
Product | String | 必須 | シンボル ストア レコードのプロダクト名。 |
Branch | String | オプション | すべてのデポ ソース ファイルのベースとなるブランチの名前。IndexSources が true の場合に使用されます (一部のプラットフォームでのみ使用されます)。 |
Change | Integer | オプション | すべてのデポ ソース ファイルが同期されているチェンジリスト。IndexSources が true の場合に使用されます (一部のプラットフォームでのみ使用されます)。 |
BuildVersion | String | オプション | これらのシンボルに関連付けられた BuildVersion。このバージョンをビルド共有のディレクトリ名と照合することで、AgeStore のクリーンアップに使用します。 |
IndexSources | Boolean | オプション | アップロードされたシンボルにソース コード インデックスを含めるかどうか。有効にすると、タスクによってソース サーバーで必要なデータが生成されます (一部のプラットフォームおよびソース コントロール サーバーのみがサポートされます)。ビルドのデバッグ時またはダンプの解析時に、ソース サーバーによってデバッガは自動的に一致するソース コードを取得できるようになります。 |
SourceFiles | String | オプション | インデックス付けされるデポ ソース ファイルをフィルタするためのセミコロン区切りの Perforce フィルタ リストです (例:Engine/....cpp;Engine/....h )。これは、事前に定義されているタグの名前の場合もあります。たとえば、IndexSources が true の場合は #SourceFiles が使用されます (一部のプラットフォームでのみ使用されます)。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Tag
指定した一連のファイルにタグを適用します。ファイルのリストは、「'Files'」パラメータで指定したタグとファイル仕様を列挙すると見つかります。このリストから、「'Filter'」パラメータに一致しないファイルと、「'Except'」パラメータと一致するファイルがすべて削除されます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
BaseDir | DirectoryReference | オプション | ベース ディレクトリを設定して、相対パスとパターンを解決します。設定した場合、絶対パターン (例:/Engine/Build/... ) がこのパスに相対的であると見なされます。設定しない場合は、本当に絶対パスとして見なされます。 |
Files | FileSpec | オプション | セミコロンで区切ったワイルドカードとタグ名を含む、作業する一連のファイル。設定した場合は BaseDir に関連して解決され、設定しない場合はブランチ ルート ディレクトリに対して解決されます。 |
FileLists | FileSpec | オプション | 追加ファイルを追加する一連のテキスト ファイル。各ファイル リストは、1 行につき 1 つのファイルが必要です。 |
Filter | FileSpec | オプション | タグ名やワイルドカードを含む、ファイルのリストをフィルタ処理するパターン。設定した場合、ベース ディレクトリに適用するパターンを含むことができます。指定しない場合、デフォルトはすべてのファイルです。 |
Except | FileSpec | オプション | 一致リストから除外する一連のパターン。ベース ディレクトリに適用するパターンのタグ名を含むことができます。 |
With | TagList | 必須 | 適用するタグの名前。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
TagReceipt
「*.target」ファイルから読み取ることにより、ビルド プロダクトやランタイム依存関係をタグ付けするタスク。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Files | FileSpec | 必須 | セミコロンで区切った、ワイルドカードとタグ名を含む、一連のレシート ファイル (*.target )。 |
EngineDir | DirectoryReference | オプション | レシート ファイルの $(EngineDir) プロパティを展開するために使用する Engine フォルダのパス。現在のワークスペースの Engine ディレクトリがデフォルトです。 |
ProjectDir | DirectoryReference | オプション | レシート ファイルの $(ProjectDir) プロパティを展開するために使用するプロジェクト フォルダのパス。デフォルトは現在のワークスペースの「Engine」ディレクトリです -- 非推奨。 |
BuildProducts | Boolean | オプション | レシートにリストされているビルド プロダクトにタグ付けするかどうか。 |
BuildProductType | String | オプション | タグを付けるビルド プロダクトのタイプ (有効な値については、TargetReceipt.cs — UnrealBuildTool.BuildProductType を参照)。 |
RuntimeDependencies | Boolean | オプション | レシートにリストされているランタイム依存関係にタグ付けするかどうか。 |
StagedFileType | String | オプション | タグを付けるランタイム依存関係のタイプ (有効な値については、TargetReceipt.cs — UnrealBuildTool.StagedFileType を参照)。 |
With | TagList | 必須 | 適用するタグの名前。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Unzip
ZIP アーカイブからファイルを抽出します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
ZipFile | FileSpec | 必須 | 解凍する ZIP ファイルへのパス。 |
ToDir | DirectoryReference | 必須 | 抽出したファイルの出力ディレクトリ。 |
UseLegacyUnzip | Boolean | オプション | レガシー unzip コードを使用するかどうか。 |
OverwriteFiles | Boolean | オプション | 解凍時にファイルを上書きするかどうか。 |
Tag | TagList | オプション | 抽出したファイルに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Upload
今後の取得のために、ファイル セットを Jupiter にアップロードします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
FromDir | DirectoryReference | 必須 | 圧縮ファイルを読み取るディレクトリ。 |
Files | FileSpec | オプション | セミコロンで区切ったファイル仕様のリスト (例:*.cpp;Engine/.../*.bat )、またはタグ セットの名前。相対パスを FromDir から取得します。 |
JupiterNamespace | String | 必須 | ビルドをアップロードするために使用される Jupiter 名前空間。ビルドにアクセス権を持つユーザーを制御するために使用します。 |
JupiterKey | String | 必須 | ビルドを再度ダウンロードするために使用する、ビルドのキー。このアップロードにおいて、これはグローバルに一意でなければなりません。 |
ArchiveType | String | 必須 | ファイルの取得元のアーカイブのタイプ。メタデータに追加されます。 |
ProjectName | String | 必須 | このファイル セットが関連付けられるプロジェクトの名前。メタデータに追加されます。 |
Branch | String | 必須 | これらのファイルの生成元であるソース コントロール ブランチ。メタデータに追加されます。 |
Changelist | String | 必須 | これらのファイルの生成元であるソース コントロール リビジョン。メタデータに追加されます。 |
JupiterUrl | String | 必須 | アップロード先の Jupiter インスタンスの URL を指定します。 |
AdditionalMetadata | String | オプション | セミコロン区切りのリストで、「=」によって区切られたキー値のマッピング。メタデータに追加されます。たとえば、Foo=bar;spam=eggs です。 |
LimitMemoryUsage | Boolean | オプション | 有効にすると、ファイルの内容はメモリ内に維持されずメモリ使用率が低下しますが、ファイルの内容を複数回読み取る必要があるため、I/O が増加します (ハッシング時やアップロード時など)。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Wait
定義した秒数の間待機します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Seconds | Integer | 必須 | 待機する秒数。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
WriteJsonValue
キー パスに指定された値を設定することで json ファイルを変更します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
File | FileSpec | 必須 | 変更される JSON ファイル。 |
Key | String | 必須 | 各ファイルに設定する JSON 要素。この文字列の構文は JsonPath 表記の制限されたサブセットで、オブジェクトのプロパティと配列インデックスをサポートします。省略されているか範囲外にある配列インデックスは、新しい要素を配列に追加します (たとえば、$.foo.bar[] は要素を foo オブジェクトの bar 配列に追加します)。 |
Value | String | 必須 | 設定する新しい値。任意の値の JSON 値 (文字列、配列、オブジェクト、数値、ブール値、または null) にします。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
WriteTextFile
ファイルにテキストを書き込みます。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
File | FileReference | 必須 | 書き込み先のファイルのパス。 |
Append | Boolean | オプション | 省略可能。上書きではなく追加するかどうかを指定。 |
Text | String | オプション | ファイルに書き込むテキスト。 |
Files | FileSpec | オプション | 指定した場合、設定したメッセージの後に指定したファイルのリストを出力します。 |
Tag | TagList | オプション | このタスクのビルド プロダクトに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
ZenExportSnapshot
スナップショットを Zen から指定した宛先にエクスポートします。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
Project | FileReference | オプション | スナップショットのエクスポート元となるプロジェクト。 |
Platform | String | オプション | スナップショットをエクスポートするターゲットのプラットフォーム。 |
SnapshotDescriptorFile | FileReference | オプション | エクスポートされたスナップショットに関する情報を含めて作成するファイル。 |
DestinationStorageType | String | 必須 | スナップショットをエクスポートする宛先のタイプ (クラウドなど)。 |
DestinationCloudHost | String | オプション | クラウドの宛先にエクスポートするときに使用するホスト名。 |
DestinationCloudNamespace | String | オプション | クラウドの宛先にエクスポートするときに使用する名前空間。 |
DestinationCloudIdentifier | String | オプション | クラウドの宛先にエクスポートするときに使用する識別子。 |
DestinationCloudBucket | String | オプション | クラウドの宛先にエクスポートするときに使用するカスタム バケット名。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |
Zip
ファイルを ZIP アーカイブに圧縮します。
属性 | 型 | 必須 | 説明 |
---|---|---|---|
FromDir | DirectoryReference | 必須 | 圧縮ファイルを読み取るディレクトリ。 |
Files | FileSpec | オプション | セミコロンで区切ったファイル仕様のリスト (例:*.cpp;Engine/.../*.bat )、またはタグ セットの名前。相対パスを FromDir から取得します。 |
ExecutableFiles | FileSpec | オプション | 実行ビット セットを設定する必要があるファイルのリスト。 |
ZipFile | FileReference | 必須 | 作成する ZIP ファイル。 |
Tag | TagList | オプション | 作成した ZIP ファイルに適用するタグ。 |
If | 条件式 | オプション | このタスクを実行するかどうか。この条件式が false と評価された場合は無視します。 |