Helper class to manage the action queue. More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig:

Public Member Functions
virtual ImmediateActionQueueConfig	ActionStallReportTime (double? val=null)
	Number of second of no completed actions to trigger an action stall report. If zero, stall reports will not be enabled.

virtual ImmediateActionQueueConfig	ActionStallTerminateTime (double? val=null)
	Number of second of no completed actions to trigger to terminate the queue. If zero, force termination not be enabled.

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 = []

Detailed Description

Helper class to manage the action queue.

Running the queue can be done with a mixture of automatic and manual runners. Runners are responsible for performing the work associated with an action. Automatic runners will have actions automatically queued to them up to the point that any runtime limits aren't exceeded (such as maximum number of concurrent processes). Manual runners must have jobs queued to them by calling TryStartOneAction or StartManyActions with the runner specified.

For example:

ParallelExecutor uses an automatic runner exclusively. UBAExecutor uses an automatic runner to run jobs locally and a manual runner to run jobs remotely as processes become available.

Definition at line 19275 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ ActionStallReportTime()

virtual ImmediateActionQueueConfig Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig.ActionStallReportTime ( double? val = null )

virtual

Number of second of no completed actions to trigger an action stall report. If zero, stall reports will not be enabled.

Definition at line 19285 of file UbtConfigGenerated.cs.

◆ ActionStallTerminateTime()

virtual ImmediateActionQueueConfig Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig.ActionStallTerminateTime ( double? val = null )

virtual

Number of second of no completed actions to trigger to terminate the queue. If zero, force termination not be enabled.

Definition at line 19307 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig._configs = null

private

Definition at line 19325 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig.CliName

get

Definition at line 19278 of file UbtConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig.Compatibility

get

Definition at line 19279 of file UbtConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig.Configs

getprotected

Definition at line 19326 of file UbtConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.ImmediateActionQueueConfig.Name

get

Definition at line 19277 of file UbtConfigGenerated.cs.

The documentation for this class was generated from the following file:

/home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/UbtConfigGenerated.cs

Public Member Functions

Properties

Private Attributes

Additional Inherited Members