|
Nuke.Unreal
Build Unreal apps in Style.
|
Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=UE4 Example2: RunUAT BenchmarkBuild -allcompile -project=UE4+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=UE4+QAGame+EngineTest -platform=WIn64+PS4+XboxOne+Switch -iterations=3 Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=Unreal Example2: RunUAT BenchmarkBuild -allcompile -project=Unreal+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=Unreal+QAGame+EngineTest -platform=Win64+PS4+XboxOne+Switch -iterations=3 Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=Unreal Example2: RunUAT BenchmarkBuild -allcompile -project=Unreal+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=Unreal+QAGame+EngineTest -platform=WIn64+PS4+XboxOne+Switch -iterations=3. More...
Public Member Functions | |
| virtual BenchmarkBuildConfig | Preview (params object[] values) |
| List everything that will run but don't do it. | |
| virtual BenchmarkBuildConfig | Project (params object[] values) |
| Do tests on the specified projec(s)t. E.g. -project=UE4+FortniteGame+QAGame Do tests on the specified projec(s)t. E.g. -project=UE+FortniteGame+QAGame Do tests on the specified project(s). E.g. -project=Unreal+FortniteGame+QAGame. | |
| virtual BenchmarkBuildConfig | All (params object[] values) |
| Run all the things (except noddc) Shorthand for -editor -client -AllCompile -AllEditor -AllCook -AllDDC. | |
| virtual BenchmarkBuildConfig | Allcompile (params object[] values) |
| Run all the compile things Shorthand for -compile -singlecompile -nopcompile. | |
| virtual BenchmarkBuildConfig | Editor (params object[] values) |
| Build an editor for compile tests Time building the editor. | |
| virtual BenchmarkBuildConfig | Client (params object[] values) |
| Build a client for comple tests (see -platform) Build a client for compile tests (see -platform) Time building the for the specified platform(s) | |
| virtual BenchmarkBuildConfig | Platform (params object[] values) |
| Specify the platform(s) to use for client compilation/cooking, if empty the local platform be used if -client or -cook is specified. | |
| virtual BenchmarkBuildConfig | Xge (params object[] values) |
| Do a compile with XGE / FASTBuild Do a pass with XGE / FASTBuild (default) | |
| virtual BenchmarkBuildConfig | Noxge (params object[] values) |
| Do a compile without XGE / FASTBuild Do a pass without XGE / FASTBuild. | |
| virtual BenchmarkBuildConfig | Singlecompile (params object[] values) |
| Do a single-file compile. | |
| virtual BenchmarkBuildConfig | Nopcompile (params object[] values) |
| Do a nothing-needs-compiled compile. | |
| virtual BenchmarkBuildConfig | Cores (params object[] values) |
| Do noxge builds with these processor counts (default is Environment.ProcessorCount) | |
| virtual BenchmarkBuildConfig | Cook (params object[] values) |
| Do a cook for the specified platform Extra args to use when cooking. -Cook1Args="-foo" -Cook2Args="-bar" will run two cooks with each argument set. Use -CookArgs for a single cook Time cooking the project for the specified platform(s). Specify maps with -editor-cook=map1+map2. | |
| virtual BenchmarkBuildConfig | Pie (params object[] values) |
| Launch the editor (only valid when -project is specified Extra args to use when running the editor. -PIE1Args="-foo" -PIE2Args="-bar" will run three PIE tests with each argument set. Use -PIEArgs for a single PIE. | |
| virtual BenchmarkBuildConfig | Map (params object[] values) |
| Map to PIE with (only valid when using a single project. | |
| virtual BenchmarkBuildConfig | Warmddc (params object[] values) |
| Cook / PIE with a warm DDC. | |
| virtual BenchmarkBuildConfig | Hotddc (params object[] values) |
| Cook / PIE with a hot local DDC (an untimed pre-run is performed) | |
| virtual BenchmarkBuildConfig | Coldddc (params object[] values) |
| Cook / PIE with a cold local DDC (a temporary folder is used) | |
| virtual BenchmarkBuildConfig | Noshaderddc (params object[] values) |
| Cook / PIE with no shaders in the DDC. | |
| virtual BenchmarkBuildConfig | Iterations (params object[] values) |
| How many times to perform each test) | |
| virtual BenchmarkBuildConfig | Wait (params object[] values) |
| How many seconds to wait between each test) | |
| virtual BenchmarkBuildConfig | Filename (params object[] values) |
| Name/path of file to write CSV results to. If empty the local machine name will be used. | |
| virtual BenchmarkBuildConfig | Noclean (params object[] values) |
| Don't build from clean. (Mostly just to speed things up when testing) | |
| virtual BenchmarkBuildConfig | CookArgs (params object[] values) |
| Extra args to use when cooking. -CookArgs1="-foo" -CookArgs2="-bar" will run two cooks with each argument set Extra args to use when cooking. -CookArgs="-foo" -Cook2Args="-bar" will run two cook passes with -foo and -bar. | |
| virtual BenchmarkBuildConfig | PIEArgs (params object[] values) |
| Extra args to use when running the editor. -PIEArgs1="-foo" -PIEArgs2="-bar" will run two PIE tests with each argument set Extra args to use for PIE. -PIEArgs="-foo" -PIE2Args="-bar" will run two PIE passes with -foo and -bar. | |
| virtual BenchmarkBuildConfig | Ue4 (params object[] values) |
| virtual BenchmarkBuildConfig | Fastbuild (params object[] values) |
| virtual BenchmarkBuildConfig | Nofastbuild (params object[] values) |
| virtual BenchmarkBuildConfig | Projects (params object[] values) |
| virtual BenchmarkBuildConfig | Platforms (params object[] values) |
| virtual BenchmarkBuildConfig | Maps (params object[] values) |
| Map to PIE with (only valid when using a single project. | |
| virtual BenchmarkBuildConfig | Unreal (params object[] values) |
| virtual BenchmarkBuildConfig | Compile (params object[] values) |
| Time compiling the target. | |
| virtual BenchmarkBuildConfig | Editorstartup (params object[] values) |
| Time launching the editor. Specify maps with -editor-startup=map1+map2. | |
| virtual BenchmarkBuildConfig | Editorpie (params object[] values) |
| Time pie'ing for a project (only valid when -project is specified). Specify maps with -editor-pie=map1+map2. | |
| virtual BenchmarkBuildConfig | Editorgame (params object[] values) |
| Time launching the editor as -game (only valid when -project is specified). Specify maps with -editor-game=map1+map2. | |
| virtual BenchmarkBuildConfig | AllEditor (params object[] values) |
| Shorthand for -editor-startup -editor-pie -editor-game. | |
| virtual BenchmarkBuildConfig | Editormaps (params object[] values) |
| Map to Launch/PIE with (only valid when using a single project. Same as setting editor-pie=m1+m2, editor-startup=m1+m2 individually. | |
| virtual BenchmarkBuildConfig | Cookiterative (params object[] values) |
| Time an iterative cook for the specified platform(s) (will run a cook first if -cook is not specified). Specify maps with -editor-cook-iterative=map1+map2. | |
| virtual BenchmarkBuildConfig | AllCook (params object[] values) |
| Shorthand for -cook -cook-iterative. | |
| virtual BenchmarkBuildConfig | Coldddcnoshared (params object[] values) |
| Cook / PIE with a cold local DDC and no shared ddc. | |
| virtual BenchmarkBuildConfig | AllDDC (params object[] values) |
| Shorthand for -coldddc -coldddc-noshared -noshaderddc -hotddc. | |
| virtual BenchmarkBuildConfig | Editorxge (params object[] values) |
| Do a pass with XGE for editor DDC (default) | |
| virtual BenchmarkBuildConfig | Noeditorxge (params object[] values) |
| Do a pass without XGE for editor DDC. | |
| virtual BenchmarkBuildConfig | UBTArgs (params object[] values) |
| Extra args to use when compiling. -UBTArgs="-foo" -UBT2Args="-bar" will run two compile passes with -foo and -bar. | |
| virtual BenchmarkBuildConfig | LaunchArgs (params object[] values) |
| Extra args to use for launching. -LaunchArgs="-foo" -Launch2Args="-bar" will run two launch passes with -foo and -bar. | |
| virtual BenchmarkBuildConfig | Csv (params object[] values) |
| Name/path of file to write CSV results to. If empty the local machine name will be used. | |
| virtual BenchmarkBuildConfig | Nopostclean (params object[] values) |
| Don't clean artifacts after a task when building a lot of platforms/projects. | |
| virtual BenchmarkBuildConfig | AllClient (params object[] values) |
| virtual BenchmarkBuildConfig | Launch (params object[] values) |
| virtual BenchmarkBuildConfig | UBT (params object[] values) |
Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig | |
| virtual void | AppendArgument (UnrealToolArgument arg) |
| virtual void | AppendArgument (string arg, UnrealToolArgumentMeta? meta=null) |
| virtual void | AppendSubtool (ToolConfig subtool) |
| virtual string | Gather (EngineVersion ueVersion) |
| Gether the arguments and subtools and render a command line output. | |
Properties | |
| override string | Name [get] |
| override string | CliName [get] |
| override UnrealCompatibility | Compatibility [get] |
| override ToolConfig[] | Configs [get] |
Properties inherited from Nuke.Unreal.Tools.ToolConfig | |
| string | Name [get] |
| The C# friendly name of the tool which will be used inside configurators. | |
| string | CliName [get] |
| The name which will be rendered onto command line. | |
| UnrealCompatibility | Compatibility [get] |
| Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored. | |
| virtual ToolConfig[] | Configs [get] |
Private Attributes | |
| ToolConfig[] | _configs = null |
Additional Inherited Members | |
Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig | |
| List< UnrealToolArgument > | UsingArguments = [] |
| readonly Dictionary< string, ToolConfig > | UsingSubtools = [] |
Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=UE4 Example2: RunUAT BenchmarkBuild -allcompile -project=UE4+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=UE4+QAGame+EngineTest -platform=WIn64+PS4+XboxOne+Switch -iterations=3 Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=Unreal Example2: RunUAT BenchmarkBuild -allcompile -project=Unreal+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=Unreal+QAGame+EngineTest -platform=Win64+PS4+XboxOne+Switch -iterations=3 Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=Unreal Example2: RunUAT BenchmarkBuild -allcompile -project=Unreal+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=Unreal+QAGame+EngineTest -platform=WIn64+PS4+XboxOne+Switch -iterations=3.
Definition at line 25638 of file UatConfigGenerated.cs.
|
virtual |
Run all the things (except noddc) Shorthand for -editor -client -AllCompile -AllEditor -AllCook -AllDDC.
Definition at line 25686 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26571 of file UatConfigGenerated.cs.
|
virtual |
Run all the compile things Shorthand for -compile -singlecompile -nopcompile.
Definition at line 25706 of file UatConfigGenerated.cs.
|
virtual |
Shorthand for -cook -cook-iterative.
Definition at line 26400 of file UatConfigGenerated.cs.
|
virtual |
Shorthand for -coldddc -coldddc-noshared -noshaderddc -hotddc.
Definition at line 26438 of file UatConfigGenerated.cs.
|
virtual |
Shorthand for -editor-startup -editor-pie -editor-game.
Definition at line 26343 of file UatConfigGenerated.cs.
|
virtual |
Build a client for comple tests (see -platform) Build a client for compile tests (see -platform) Time building the for the specified platform(s)
Definition at line 25747 of file UatConfigGenerated.cs.
|
virtual |
Cook / PIE with a cold local DDC (a temporary folder is used)
Definition at line 25980 of file UatConfigGenerated.cs.
|
virtual |
Cook / PIE with a cold local DDC and no shared ddc.
Definition at line 26419 of file UatConfigGenerated.cs.
|
virtual |
Time compiling the target.
Definition at line 26267 of file UatConfigGenerated.cs.
|
virtual |
Do a cook for the specified platform Extra args to use when cooking. -Cook1Args="-foo" -Cook2Args="-bar" will run two cooks with each argument set. Use -CookArgs for a single cook Time cooking the project for the specified platform(s). Specify maps with -editor-cook=map1+map2.
Definition at line 25884 of file UatConfigGenerated.cs.
|
virtual |
Extra args to use when cooking. -CookArgs1="-foo" -CookArgs2="-bar" will run two cooks with each argument set Extra args to use when cooking. -CookArgs="-foo" -Cook2Args="-bar" will run two cook passes with -foo and -bar.
Definition at line 26095 of file UatConfigGenerated.cs.
|
virtual |
Time an iterative cook for the specified platform(s) (will run a cook first if -cook is not specified). Specify maps with -editor-cook-iterative=map1+map2.
Definition at line 26381 of file UatConfigGenerated.cs.
|
virtual |
Do noxge builds with these processor counts (default is Environment.ProcessorCount)
Definition at line 25863 of file UatConfigGenerated.cs.
|
virtual |
Name/path of file to write CSV results to. If empty the local machine name will be used.
Definition at line 26533 of file UatConfigGenerated.cs.
|
virtual |
Build an editor for compile tests Time building the editor.
Definition at line 25726 of file UatConfigGenerated.cs.
|
virtual |
Time launching the editor as -game (only valid when -project is specified). Specify maps with -editor-game=map1+map2.
Definition at line 26324 of file UatConfigGenerated.cs.
|
virtual |
Map to Launch/PIE with (only valid when using a single project. Same as setting editor-pie=m1+m2, editor-startup=m1+m2 individually.
Definition at line 26362 of file UatConfigGenerated.cs.
|
virtual |
Time pie'ing for a project (only valid when -project is specified). Specify maps with -editor-pie=map1+map2.
Definition at line 26305 of file UatConfigGenerated.cs.
|
virtual |
Time launching the editor. Specify maps with -editor-startup=map1+map2.
Definition at line 26286 of file UatConfigGenerated.cs.
|
virtual |
Do a pass with XGE for editor DDC (default)
Definition at line 26457 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26153 of file UatConfigGenerated.cs.
|
virtual |
Name/path of file to write CSV results to. If empty the local machine name will be used.
Definition at line 26056 of file UatConfigGenerated.cs.
|
virtual |
Cook / PIE with a hot local DDC (an untimed pre-run is performed)
Definition at line 25961 of file UatConfigGenerated.cs.
|
virtual |
How many times to perform each test)
Definition at line 26018 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26590 of file UatConfigGenerated.cs.
|
virtual |
Extra args to use for launching. -LaunchArgs="-foo" -Launch2Args="-bar" will run two launch passes with -foo and -bar.
Definition at line 26514 of file UatConfigGenerated.cs.
|
virtual |
Map to PIE with (only valid when using a single project.
Definition at line 25923 of file UatConfigGenerated.cs.
|
virtual |
Map to PIE with (only valid when using a single project.
Definition at line 26229 of file UatConfigGenerated.cs.
|
virtual |
Don't build from clean. (Mostly just to speed things up when testing)
Definition at line 26075 of file UatConfigGenerated.cs.
|
virtual |
Do a pass without XGE for editor DDC.
Definition at line 26476 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26172 of file UatConfigGenerated.cs.
|
virtual |
Do a nothing-needs-compiled compile.
Definition at line 25844 of file UatConfigGenerated.cs.
|
virtual |
Don't clean artifacts after a task when building a lot of platforms/projects.
Definition at line 26552 of file UatConfigGenerated.cs.
|
virtual |
Cook / PIE with no shaders in the DDC.
Definition at line 25999 of file UatConfigGenerated.cs.
|
virtual |
Do a compile without XGE / FASTBuild Do a pass without XGE / FASTBuild.
Definition at line 25806 of file UatConfigGenerated.cs.
|
virtual |
Launch the editor (only valid when -project is specified Extra args to use when running the editor. -PIE1Args="-foo" -PIE2Args="-bar" will run three PIE tests with each argument set. Use -PIEArgs for a single PIE.
Definition at line 25904 of file UatConfigGenerated.cs.
|
virtual |
Extra args to use when running the editor. -PIEArgs1="-foo" -PIEArgs2="-bar" will run two PIE tests with each argument set Extra args to use for PIE. -PIEArgs="-foo" -PIE2Args="-bar" will run two PIE passes with -foo and -bar.
Definition at line 26115 of file UatConfigGenerated.cs.
|
virtual |
Specify the platform(s) to use for client compilation/cooking, if empty the local platform be used if -client or -cook is specified.
Definition at line 25766 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26210 of file UatConfigGenerated.cs.
|
virtual |
List everything that will run but don't do it.
Definition at line 25645 of file UatConfigGenerated.cs.
|
virtual |
Do tests on the specified projec(s)t. E.g. -project=UE4+FortniteGame+QAGame Do tests on the specified projec(s)t. E.g. -project=UE+FortniteGame+QAGame Do tests on the specified project(s). E.g. -project=Unreal+FortniteGame+QAGame.
Definition at line 25666 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26191 of file UatConfigGenerated.cs.
|
virtual |
Do a single-file compile.
Definition at line 25825 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26609 of file UatConfigGenerated.cs.
|
virtual |
Extra args to use when compiling. -UBTArgs="-foo" -UBT2Args="-bar" will run two compile passes with -foo and -bar.
Definition at line 26495 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26134 of file UatConfigGenerated.cs.
|
virtual |
Definition at line 26248 of file UatConfigGenerated.cs.
|
virtual |
How many seconds to wait between each test)
Definition at line 26037 of file UatConfigGenerated.cs.
|
virtual |
Cook / PIE with a warm DDC.
Definition at line 25942 of file UatConfigGenerated.cs.
|
virtual |
Do a compile with XGE / FASTBuild Do a pass with XGE / FASTBuild (default)
Definition at line 25786 of file UatConfigGenerated.cs.
|
private |
Definition at line 26627 of file UatConfigGenerated.cs.
|
get |
Definition at line 25641 of file UatConfigGenerated.cs.
|
get |
Definition at line 25642 of file UatConfigGenerated.cs.
|
getprotected |
Definition at line 26628 of file UatConfigGenerated.cs.
|
get |
Definition at line 25640 of file UatConfigGenerated.cs.