Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

> Setting Up Your Production Pipeline > Unreal Build Pipeline > AutomationTool > BuildGraph > BuildGraph Script Anatomy > BuildGraph Script Tasks

Light Theme

Dark Theme

BuildGraph Script Tasks

Learn how BuildGraph can help you create custom tasks.

Custom Tasks

To create a new custom task, implement a class derived from the CustomTask class and apply the TaskElement attribute to it. The TaskElement constructor takes two arguments: the name of the XML element that it is represented by and the type of class containing its parameters (which is passed to the constructor at load time).

If you want to read parameter class fields from an XML file, attach the TaskParameter attribute to the task. Attaching the TaskParameter attribute indicates if the parameter is required or optional, including additional validation that should be applied to the argument.

Predefined Tasks

If you would like to have a starting point for creating tasks, we provide a variety of predefined tasks as templates for you to work from. If you are looking for a simple predefined task to start from, we recommend using LogTask as a good starting point. If you want to keep up with our latest improvements to BuildGraph, bookmark this page. The following list of predefined tasks will be updated periodically.

BuildCookRun is a powerful and commonly used command for packaging tasks. For more information, read the overview that covers Build Operations.

AgeStore

Task that strips symbols from a set of files. This task is named after the AGESTORE utility that comes with the Microsoft debugger tools SDK, but is actually a separate implementation. The main difference is that it uses the last modified time rather than last access time to determine which files to delete.


Attribute	Type	Required?	Description
Platform	Unreal Target Platform	Required	The target platform to age symbols for.
StoreDir	String	Required	The symbol server directory.
Days	Integer	Required	Number of days worth of symbols to keep.
BuildDir	String	Optional	The root of the build directory to check for existing buildversion named directories.
Filter	String	Optional	A substring to match in directory file names before deleting symbols. This allows the "age store" task to avoid deleting symbols from other builds in the case where multiple builds share the same symbol server. Specific use of the filter value is determined by the symbol server structure defined by the platform toolchain.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Aws

Spawns AWS CLI and waits for it to complete.


Attribute	Type	Required?	Description
Arguments	String	Optional	Arguments for the newly created process.
Environment	String	Optional	Environment variables.
EnvironmentFile	String	Optional	File to read environment from.
LogOutput	Boolean	Optional	Write output to the log.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Aws-AssumeRole

Assumes an AWS role.


Attribute	Type	Required?	Description
Arn	String	Required	Role to assume.
Session	String	Required	Name of this session.
Duration	Integer	Optional	Duration of the token in seconds.
Environment	String	Optional	Environment variables.
EnvironmentFile	String	Optional	File to read environment variables from.
OutputFile	String	Required	Output file for the new environment.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Aws-EcsDeploy

Creates a new AWS ECS task definition and updates the ECS service to use this new revision of the task definition.


Attribute	Type	Required?	Description
TaskDefinitionFile	String	Required	Task definition file to use.
DockerImage	String	Required	Docker image to set in new task definition (will replace `DOCKER_PATTERN` with this value).
Version	String	Optional	App version to set in new task definition (will replace `VERSION` with this value).
Cluster	String	Required	Cluster ARN representing AWS ECS cluster to operate on.
Service	String	Required	Service name to update and deploy to.
Environment	String	Optional	Environment variables.
EnvironmentFile	String	Optional	File to read environment from.
LogOutput	Boolean	Optional	Write output to the log.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

CallMethod

Invokes a C# method.


Attribute	Type	Required?	Description
Class	String	Required	Name of the class to run a method in.
Method	String	Required	The method name to execute.
Arg1	String	Optional	Argument value.
Arg2	String	Optional	Argument value.
Arg3	String	Optional	Argument value.
Arg4	String	Optional	Argument value.
Arg5	String	Optional	Argument value.
Arg6	String	Optional	Argument value.
Arg7	String	Optional	Argument value.
Arg8	String	Optional	Argument value.
Arg9	String	Optional	Argument value.
Tags	String	Optional	List of tags for outputs.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Command

Invokes an AutomationTool child process to run the given command.


Attribute	Type	Required?	Description
Name	String	Required	The command name to execute.
Arguments	String	Optional	Arguments to be passed to the command.
MergeTelemetryWithPrefix	String	Optional	If non-null, instructs telemetry from the command to be merged into the telemetry for this UAT instance with the given prefix. May be an empty (non-null) string.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Commandlet

Spawns the editor to run a commandlet.


Attribute	Type	Required?	Description
Name	String	Required	The commandlet name to execute.
Project	File Spec	Optional	The project to run the editor with.
Arguments	String	Optional	Arguments to be passed to the commandlet.
EditorExe	File Reference	Optional	The editor executable to use. Defaults to the development UnrealEditor executable for the current platform.
ErrorLevel	Integer	Optional	The minimum exit code, which is treated as an error.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Compile

Compiles a target with UnrealBuildTool.


Attribute	Type	Required?	Description
Target	String	Optional	The target to compile.
Configuration	Unreal Target Configuration	Required	The configuration to compile.
Platform	Unreal Target Platform	Required	The platform to compile for.
Project	File Spec	Optional	The project to compile with.
Arguments	String	Optional	Additional arguments for UnrealBuildTool.
AllowXGE	Boolean	Optional	Whether to allow using XGE for compilation.
AllowParallelExecutor	Boolean	Optional	Whether to allow using the parallel executor for this compile.
Clean	Boolean	Optional	Whether to allow cleaning this target. If unspecified, targets are cleaned if the `-Clean` argument is passed on the command line.
Tag	Tag List	Optional	Tag to be applied to build products of this task.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Cook

Cook a selection of maps for a certain platform.


Attribute	Type	Required?	Description
Project	String	Required	Project file to be cooked.
Platform	String	Required	The cook platform to target (for example, Windows).
Maps	String	Optional	List of maps to be cooked, separated by '+' characters.
Versioned	Boolean	Optional	Additional arguments to be passed to the cooker.
Arguments	String	Optional	Additional arguments to be passed to the cooker.
EditorExe	String	Optional	Optional path to what editor executable to run for cooking.
Tag	Tag List	Optional	Tag to be applied to build products of this task.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

Copy

Copies files from one directory to another.


Attribute	Type	Required?	Description
Files	File Spec	Optional	Optional filter to be applied to the list of input files.
From	File Spec	Required	The pattern or patterns to copy from (for example, `Engine/*.txt`).
To	File Spec	Required	The directory to copy to.
Overwrite	Boolean	Optional	Whether or not to overwrite existing files.
Tag	Tag List	Optional	Tag to be applied to build products of this task.
ErrorIfNotFound	Boolean	Optional	Whether or not to throw an error if no files were found to copy.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.

CsCompile

Compiles C# project files and their dependencies.


Attribute	Type	Required?	Description
Project	String	Required	The C# project file to compile. Using semicolons, more than one project file can be specified.
Configuration	String	Optional	The configuration to compile.
Platform	String	Optional	The platform to compile.
Target	String	Optional	The target to build.
Properties	String	Optional	Properties for the command.
Arguments	String	Optional	Additional options to pass to the compiler.
EnumerateOnly	Boolean	Optional	Only enumerate build products ─ do not actually compile the projects.
Tag	Tag List	Optional	Tag to be applied to build products of this task.
TagReferences	Tag List	Optional	Tag to be applied to any non-private references the projects have (for example, those that are external and not copied into the output directory).
UseSystemCompiler	Boolean	Optional	Whether to use the system toolchain rather than the bundled UE SDK.
If	Condition	Optional	Whether to execute this task. It is ignored if this condition evaluates to false.