Tool for creating extensible build processes in UE4 which can be run locally or in parallel across a build farm. Tool for creating extensible build processes in UE which can be run locally or in parallel across a build farm. More...

Inheritance diagram for Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig:

Public Member Functions
virtual BuildGraphConfig	Script (params object[] values)
	Path to the script describing the graph.

virtual BuildGraphConfig	Target (params object[] values)
	Name of the node or output tag to be built.

virtual BuildGraphConfig	Schema (params object[] values)
	Generates a schema to the default location Generate a schema describing valid script documents, including all the known tasks.

virtual BuildGraphConfig	ImportSchema (params object[] values)
	Imports a schema from an existing schema file.

virtual BuildGraphConfig	Set (params object[] values)
	Sets a named property to the given value.

virtual BuildGraphConfig	Clean (params object[] values)
	Cleans all cached state of completed build nodes before running.

virtual BuildGraphConfig	CleanNode (params object[] values)
	Cleans just the given nodes before running.

virtual BuildGraphConfig	Resume (params object[] values)
	Resumes a local build from the last node that completed successfully.

virtual BuildGraphConfig	ListOnly (params object[] values)
	Shows the contents of the preprocessed graph, but does not execute it.

virtual BuildGraphConfig	ShowDiagnostics (params object[] values)
	When running with -ListOnly, causes diagnostic messages entered when parsing the graph to be shown.

virtual BuildGraphConfig	ShowDeps (params object[] values)
	Show node dependencies in the graph output.

virtual BuildGraphConfig	ShowNotifications (params object[] values)
	Show notifications that will be sent for each node in the output.

virtual BuildGraphConfig	Trigger (params object[] values)
	Executes only nodes behind the given trigger.

virtual BuildGraphConfig	SkipTrigger (params object[] values)
	Skips the given triggers, including all the nodes behind them in the graph.

virtual BuildGraphConfig	SkipTriggers (params object[] values)
	Skips all triggers.

virtual BuildGraphConfig	TokenSignature (params object[] values)
	Specifies the signature identifying the current job, to be written to tokens for nodes that require them. Tokens are ignored if this parameter is not specified.

virtual BuildGraphConfig	SkipTargetsWithoutTokens (params object[] values)
	Excludes targets which we can't acquire tokens for, rather than failing.

virtual BuildGraphConfig	Preprocess (params object[] values)
	Writes the preprocessed graph to the given file.

virtual BuildGraphConfig	Export (params object[] values)
	Exports a JSON file containing the preprocessed build graph, for use as part of a build system.

virtual BuildGraphConfig	HordeExport (params object[] values)
	Exports a JSON file containing the full build graph for use by Horde.

virtual BuildGraphConfig	PublicTasksOnly (params object[] values)
	Only include built-in tasks in the schema, excluding any other UAT modules.

virtual BuildGraphConfig	SharedStorageDir (params object[] values)
	Sets the directory to use to transfer build products between agents in a build farm.

virtual BuildGraphConfig	SingleNode (params object[] values)
	Run only the given node. Intended for use on a build system after running with -Export.

virtual BuildGraphConfig	WriteToSharedStorage (params object[] values)
	Allow writing to shared storage. If not set, but -SharedStorageDir is specified, build products will read but not written.

virtual BuildGraphConfig	Documentation (params object[] values)

virtual BuildGraphConfig	ReportName (params object[] values)

virtual BuildGraphConfig	Branch (params object[] values)
	Overrides the auto-detection of the current branch.

virtual BuildGraphConfig	SkipValidation (params object[] values)

virtual BuildGraphConfig	Class (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 = []

Detailed Description

Tool for creating extensible build processes in UE4 which can be run locally or in parallel across a build farm. Tool for creating extensible build processes in UE which can be run locally or in parallel across a build farm.

Definition at line 9502 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Branch()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Branch ( params object[] values )

virtual

Overrides the auto-detection of the current branch.

Definition at line 10004 of file UatConfigGenerated.cs.

◆ Class()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Class ( params object[] values )

virtual

Definition at line 10042 of file UatConfigGenerated.cs.

◆ Clean()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Clean ( params object[] values )

virtual

Cleans all cached state of completed build nodes before running.

Definition at line 9605 of file UatConfigGenerated.cs.

◆ CleanNode()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.CleanNode ( params object[] values )

virtual

Cleans just the given nodes before running.

Definition at line 9624 of file UatConfigGenerated.cs.

◆ Documentation()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Documentation ( params object[] values )

virtual

Definition at line 9966 of file UatConfigGenerated.cs.

◆ Export()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Export ( params object[] values )

virtual

Exports a JSON file containing the preprocessed build graph, for use as part of a build system.

Definition at line 9852 of file UatConfigGenerated.cs.

◆ HordeExport()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.HordeExport ( params object[] values )

virtual

Exports a JSON file containing the full build graph for use by Horde.

Definition at line 9871 of file UatConfigGenerated.cs.

◆ ImportSchema()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.ImportSchema ( params object[] values )

virtual

Imports a schema from an existing schema file.

Definition at line 9567 of file UatConfigGenerated.cs.

◆ ListOnly()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.ListOnly ( params object[] values )

virtual

Shows the contents of the preprocessed graph, but does not execute it.

Definition at line 9662 of file UatConfigGenerated.cs.

◆ Preprocess()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Preprocess ( params object[] values )

virtual

Writes the preprocessed graph to the given file.

Definition at line 9833 of file UatConfigGenerated.cs.

◆ PublicTasksOnly()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.PublicTasksOnly ( params object[] values )

virtual

Only include built-in tasks in the schema, excluding any other UAT modules.

Definition at line 9890 of file UatConfigGenerated.cs.

◆ ReportName()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.ReportName ( params object[] values )

virtual

Definition at line 9985 of file UatConfigGenerated.cs.

◆ Resume()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Resume ( params object[] values )

virtual

Resumes a local build from the last node that completed successfully.

Definition at line 9643 of file UatConfigGenerated.cs.

◆ Schema()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Schema ( params object[] values )

virtual

Generates a schema to the default location Generate a schema describing valid script documents, including all the known tasks.

Definition at line 9548 of file UatConfigGenerated.cs.

◆ Script()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Script ( params object[] values )

virtual

Path to the script describing the graph.

Definition at line 9509 of file UatConfigGenerated.cs.

◆ Set()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Set ( params object[] values )

virtual

Sets a named property to the given value.

Definition at line 9586 of file UatConfigGenerated.cs.

◆ SharedStorageDir()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.SharedStorageDir ( params object[] values )

virtual

Sets the directory to use to transfer build products between agents in a build farm.

Definition at line 9909 of file UatConfigGenerated.cs.

◆ ShowDeps()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.ShowDeps ( params object[] values )

virtual

Show node dependencies in the graph output.

Definition at line 9700 of file UatConfigGenerated.cs.

◆ ShowDiagnostics()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.ShowDiagnostics ( params object[] values )

virtual

When running with -ListOnly, causes diagnostic messages entered when parsing the graph to be shown.

Definition at line 9681 of file UatConfigGenerated.cs.

◆ ShowNotifications()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.ShowNotifications ( params object[] values )

virtual

Show notifications that will be sent for each node in the output.

Definition at line 9719 of file UatConfigGenerated.cs.

◆ SingleNode()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.SingleNode ( params object[] values )

virtual

Run only the given node. Intended for use on a build system after running with -Export.

Definition at line 9928 of file UatConfigGenerated.cs.

◆ SkipTargetsWithoutTokens()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.SkipTargetsWithoutTokens ( params object[] values )

virtual

Excludes targets which we can't acquire tokens for, rather than failing.

Definition at line 9814 of file UatConfigGenerated.cs.

◆ SkipTrigger()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.SkipTrigger ( params object[] values )

virtual

Skips the given triggers, including all the nodes behind them in the graph.

Definition at line 9757 of file UatConfigGenerated.cs.

◆ SkipTriggers()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.SkipTriggers ( params object[] values )

virtual

Skips all triggers.

Definition at line 9776 of file UatConfigGenerated.cs.

◆ SkipValidation()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.SkipValidation ( params object[] values )

virtual

Definition at line 10023 of file UatConfigGenerated.cs.

◆ Target()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Target ( params object[] values )

virtual

Name of the node or output tag to be built.

Definition at line 9528 of file UatConfigGenerated.cs.

◆ TokenSignature()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.TokenSignature ( params object[] values )

virtual

Specifies the signature identifying the current job, to be written to tokens for nodes that require them. Tokens are ignored if this parameter is not specified.

Definition at line 9795 of file UatConfigGenerated.cs.

◆ Trigger()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Trigger ( params object[] values )

virtual

Executes only nodes behind the given trigger.

Definition at line 9738 of file UatConfigGenerated.cs.

◆ WriteToSharedStorage()

virtual BuildGraphConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.WriteToSharedStorage ( params object[] values )

virtual

Allow writing to shared storage. If not set, but -SharedStorageDir is specified, build products will read but not written.

Definition at line 9947 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig._configs = null

private

Definition at line 10060 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.CliName

get

Definition at line 9505 of file UatConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Compatibility

get

Definition at line 9506 of file UatConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Configs

getprotected

Definition at line 10061 of file UatConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildGraphConfig.Name

get

Definition at line 9504 of file UatConfigGenerated.cs.

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

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

Public Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Branch()

◆ Class()

◆ Clean()

◆ CleanNode()

◆ Documentation()

◆ Export()

◆ HordeExport()

◆ ImportSchema()

◆ ListOnly()

◆ Preprocess()

◆ PublicTasksOnly()

◆ ReportName()

◆ Resume()

◆ Schema()

◆ Script()

◆ Set()

◆ SharedStorageDir()

◆ ShowDeps()

◆ ShowDiagnostics()

◆ ShowNotifications()

◆ SingleNode()

◆ SkipTargetsWithoutTokens()

◆ SkipTrigger()

◆ SkipTriggers()

◆ SkipValidation()

◆ Target()

◆ TokenSignature()

◆ Trigger()

◆ WriteToSharedStorage()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name