|
Nuke.Unreal
Build Unreal apps in Style.
|
Configuration for Unreal Build Accelerator. More...
Public Member Functions | |
| virtual UnrealBuildAcceleratorConfigConfig | UBADisableRemote (bool? val=null) |
| When set to true, UBA will not use any remote help. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAForceRemote (bool? val=null) |
| When set to true, UBA will force all actions that can be built remotely to be built remotely. This will hang if there are no remote agents available. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAForcedRetry (bool? val=null) |
| When set to true, actions that fail locally with UBA will be retried without UBA. When set to true, all actions that fail locally with UBA will be retried without UBA. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAStrict (bool? val=null) |
| When set to true, all errors and warnings from UBA will be output at the appropriate severity level to the log (rather than being output as 'information' and attempting to continue regardless). | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAStoreRaw (bool? val=null) |
| If UBA should store cas compressed or raw. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBALinkRemote (bool? val=null) |
| If UBA should distribute linking to remote workers. This needs bandwidth but can be an optimization. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAStoreCapacityGb (double? val=null) |
| The amount of gigabytes UBA is allowed to use to store workset and cached data. It is a good idea to have this >10gb. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAMaxWorkers (double? val=null) |
| Max number of worker threads that can handle messages from remotes. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBASendSize (double? val=null) |
| Max size of each message sent from server to client. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAHost (object val=null) |
| Which ip UBA server should listen to for connections. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAPort (double? val=null) |
| Which port UBA server should listen to for connections. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBARootDir (object val=null) |
| Which directory to store files for UBA. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAQuic (bool present=true) |
| Use Quic protocol instead of Tcp (experimental) | |
| virtual UnrealBuildAcceleratorConfigConfig | UBALog (bool present=true) |
| Enable logging of UBA processes. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAPrintSummary (bool present=true) |
| Prints summary of UBA stats at end of build. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAVisualizer (bool present=true) |
| Launch visualizer application which shows build progress. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAResetCas (bool present=true) |
| Resets the cas cache. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBATraceOutputFile (object val=null) |
| Provide custom path for trace output file. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBADetailedTrace (bool present=true) |
| Add verbose details to the UBA trace. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBADisableWaitOnMem (bool present=true) |
| Disable UBA waiting on available memory before spawning new processes. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAAllowKillOnMem (bool present=true) |
| Let UBA kill running processes when close to out of memory. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAOutputStatsThresholdMs (double? val=null) |
| Threshold for when executor should output logging for the process. Defaults to never. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBANoWrite (bool present=true) |
| Skip writing intermediate and output files to disk. Useful for validation builds where we don't need the output. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBANoCustomMalloc (bool present=true) |
| Set to true to disable mimalloc and detouring of memory allocations. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAZone (object val=null) |
| The zone to use for UBA. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBACrypto (bool present=true) |
| Set to true to enable encryption when transferring files over the network. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAUseKnownInputs (bool present=true) |
| Set to true to provide known inputs to processes that are run remote. This is an experimental feature to speed up build times when ping is higher. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAActionsOutputFile (object val=null) |
| Write yaml file with all actions that are queued for build. This can be used to replay using "UbaCli.exe local file.yaml". | |
| virtual UnrealBuildAcceleratorConfigConfig | UBADetailedLog (bool present=true) |
| Set to true to see more info about what is happening inside uba and also log output from agents. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAForcedRetryRemote (bool? val=null) |
| When set to true, actions that fail remotely with UBA will be retried locally with UBA. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAStoreObjFilesCompressed (bool present=true) |
| Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBACache (object val=null) |
| Address of the uba cache service. Will automatically use cache if connected. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAWriteCache (bool? val=null) |
| Set cache to write instead of fetch Set cache to write, expects one of [True, False, BuildMachineOnly]. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBACacheMaxWorkers (double? val=null) |
| Max number of cache download tasks that can execute in parallel. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAReportCacheMissReason (bool? val=null) |
| Report reason a cache miss happened. Useful when searching for determinism/portability issues. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAProviders (params object[] values) |
| List of provider names for remote connections from ini It is recommended to set Providers in ini so the setting can be shared with the uba controller in editor, such as Windows: ProgramData%/Epic/Unreal Engine/Engine/Config/SystemEngine.ini Mac: ~/Library/Application Support/Epic/Unreal Engine/Engine/Config/SystemEngine.ini Linux: ~/.config/Epic/Unreal Engine/Engine/Config/SystemEngine.ini. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBACacheProviders (params object[] values) |
| List of provider names for remote cache from ini. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBANoRetry (bool present=true) |
| When set to true, actions that fail locally with certain error codes will retry without uba. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBADisableStoreObjFilesCompressed (bool present=true) |
| Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBANoDetour (bool present=true) |
| Disable all detouring making all actions run outside uba. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBAShuffleCache (bool? val=null) |
| Shuffle the list of cache servers before each read attempt. | |
| virtual UnrealBuildAcceleratorConfigConfig | UBACompressionLevel (object val=null) |
| Compression level. Options are None, SuperFast, VeryFast, Fast, Normal, Optimal1 to Optimal5. | |
| virtual UnrealBuildAcceleratorConfigConfig | Nocompress (bool present=true) |
| Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again. | |
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 = [] |
Configuration for Unreal Build Accelerator.
Definition at line 19336 of file UbtConfigGenerated.cs.
|
virtual |
Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.
Definition at line 20229 of file UbtConfigGenerated.cs.
|
virtual |
Write yaml file with all actions that are queued for build. This can be used to replay using "UbaCli.exe local file.yaml".
Definition at line 19911 of file UbtConfigGenerated.cs.
|
virtual |
Let UBA kill running processes when close to out of memory.
Definition at line 19764 of file UbtConfigGenerated.cs.
|
virtual |
Address of the uba cache service. Will automatically use cache if connected.
Definition at line 19995 of file UbtConfigGenerated.cs.
|
virtual |
Max number of cache download tasks that can execute in parallel.
Definition at line 20036 of file UbtConfigGenerated.cs.
|
virtual |
List of provider names for remote cache from ini.
Definition at line 20103 of file UbtConfigGenerated.cs.
|
virtual |
Compression level. Options are None, SuperFast, VeryFast, Fast, Normal, Optimal1 to Optimal5.
Definition at line 20208 of file UbtConfigGenerated.cs.
|
virtual |
Set to true to enable encryption when transferring files over the network.
Definition at line 19869 of file UbtConfigGenerated.cs.
|
virtual |
Set to true to see more info about what is happening inside uba and also log output from agents.
Definition at line 19932 of file UbtConfigGenerated.cs.
|
virtual |
Add verbose details to the UBA trace.
Definition at line 19722 of file UbtConfigGenerated.cs.
|
virtual |
When set to true, UBA will not use any remote help.
Definition at line 19345 of file UbtConfigGenerated.cs.
|
virtual |
Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.
Definition at line 20145 of file UbtConfigGenerated.cs.
|
virtual |
Disable UBA waiting on available memory before spawning new processes.
Definition at line 19743 of file UbtConfigGenerated.cs.
|
virtual |
When set to true, actions that fail locally with UBA will be retried without UBA. When set to true, all actions that fail locally with UBA will be retried without UBA.
Definition at line 19386 of file UbtConfigGenerated.cs.
|
virtual |
When set to true, actions that fail remotely with UBA will be retried locally with UBA.
Definition at line 19953 of file UbtConfigGenerated.cs.
|
virtual |
When set to true, UBA will force all actions that can be built remotely to be built remotely. This will hang if there are no remote agents available.
Definition at line 19366 of file UbtConfigGenerated.cs.
|
virtual |
Which ip UBA server should listen to for connections.
Definition at line 19533 of file UbtConfigGenerated.cs.
|
virtual |
If UBA should distribute linking to remote workers. This needs bandwidth but can be an optimization.
Definition at line 19449 of file UbtConfigGenerated.cs.
|
virtual |
Enable logging of UBA processes.
Definition at line 19617 of file UbtConfigGenerated.cs.
|
virtual |
Max number of worker threads that can handle messages from remotes.
Definition at line 19491 of file UbtConfigGenerated.cs.
|
virtual |
Set to true to disable mimalloc and detouring of memory allocations.
Definition at line 19827 of file UbtConfigGenerated.cs.
|
virtual |
Disable all detouring making all actions run outside uba.
Definition at line 20166 of file UbtConfigGenerated.cs.
|
virtual |
When set to true, actions that fail locally with certain error codes will retry without uba.
Definition at line 20124 of file UbtConfigGenerated.cs.
|
virtual |
Skip writing intermediate and output files to disk. Useful for validation builds where we don't need the output.
Definition at line 19806 of file UbtConfigGenerated.cs.
|
virtual |
Threshold for when executor should output logging for the process. Defaults to never.
Definition at line 19785 of file UbtConfigGenerated.cs.
|
virtual |
Which port UBA server should listen to for connections.
Definition at line 19554 of file UbtConfigGenerated.cs.
|
virtual |
Prints summary of UBA stats at end of build.
Definition at line 19638 of file UbtConfigGenerated.cs.
|
virtual |
List of provider names for remote connections from ini It is recommended to set Providers in ini so the setting can be shared with the uba controller in editor, such as Windows: ProgramData%/Epic/Unreal Engine/Engine/Config/SystemEngine.ini Mac: ~/Library/Application Support/Epic/Unreal Engine/Engine/Config/SystemEngine.ini Linux: ~/.config/Epic/Unreal Engine/Engine/Config/SystemEngine.ini.
Definition at line 20082 of file UbtConfigGenerated.cs.
|
virtual |
Use Quic protocol instead of Tcp (experimental)
Definition at line 19596 of file UbtConfigGenerated.cs.
|
virtual |
Report reason a cache miss happened. Useful when searching for determinism/portability issues.
Definition at line 20057 of file UbtConfigGenerated.cs.
|
virtual |
Resets the cas cache.
Definition at line 19680 of file UbtConfigGenerated.cs.
|
virtual |
Which directory to store files for UBA.
Definition at line 19575 of file UbtConfigGenerated.cs.
|
virtual |
Max size of each message sent from server to client.
Definition at line 19512 of file UbtConfigGenerated.cs.
|
virtual |
Shuffle the list of cache servers before each read attempt.
Definition at line 20187 of file UbtConfigGenerated.cs.
|
virtual |
The amount of gigabytes UBA is allowed to use to store workset and cached data. It is a good idea to have this >10gb.
Definition at line 19470 of file UbtConfigGenerated.cs.
|
virtual |
Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.
Definition at line 19974 of file UbtConfigGenerated.cs.
|
virtual |
If UBA should store cas compressed or raw.
Definition at line 19428 of file UbtConfigGenerated.cs.
|
virtual |
When set to true, all errors and warnings from UBA will be output at the appropriate severity level to the log (rather than being output as 'information' and attempting to continue regardless).
Definition at line 19407 of file UbtConfigGenerated.cs.
|
virtual |
Provide custom path for trace output file.
Definition at line 19701 of file UbtConfigGenerated.cs.
|
virtual |
Set to true to provide known inputs to processes that are run remote. This is an experimental feature to speed up build times when ping is higher.
Definition at line 19890 of file UbtConfigGenerated.cs.
|
virtual |
Launch visualizer application which shows build progress.
Definition at line 19659 of file UbtConfigGenerated.cs.
|
virtual |
Set cache to write instead of fetch Set cache to write, expects one of [True, False, BuildMachineOnly].
Definition at line 20015 of file UbtConfigGenerated.cs.
|
virtual |
The zone to use for UBA.
Definition at line 19848 of file UbtConfigGenerated.cs.
|
private |
Definition at line 20247 of file UbtConfigGenerated.cs.
|
get |
Definition at line 19339 of file UbtConfigGenerated.cs.
|
get |
Definition at line 19340 of file UbtConfigGenerated.cs.
|
getprotected |
Definition at line 20248 of file UbtConfigGenerated.cs.
|
get |
Definition at line 19338 of file UbtConfigGenerated.cs.