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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual BuildConfig	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 BuildConfig	SkipTargetsWithoutTokens (params object[] values)
	Excludes targets which we can't acquire tokens for, rather than failing.

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

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

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

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

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

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

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

virtual BuildConfig	Documentation (params object[] values)

virtual BuildConfig	ReportName (params object[] values)

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

virtual BuildConfig	SkipValidation (params object[] values)

virtual BuildConfig	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

Definition at line 10069 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Branch()

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

virtual

Overrides the auto-detection of the current branch.

Definition at line 10571 of file UatConfigGenerated.cs.

◆ Class()

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

virtual

Definition at line 10609 of file UatConfigGenerated.cs.

◆ Clean()

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

virtual

Cleans all cached state of completed build nodes before running.

Definition at line 10172 of file UatConfigGenerated.cs.

◆ CleanNode()

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

virtual

Cleans just the given nodes before running.

Definition at line 10191 of file UatConfigGenerated.cs.

◆ Documentation()

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

virtual

Definition at line 10533 of file UatConfigGenerated.cs.

◆ Export()

virtual BuildConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildConfig.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 10419 of file UatConfigGenerated.cs.

◆ HordeExport()

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

virtual

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

Definition at line 10438 of file UatConfigGenerated.cs.

◆ ImportSchema()

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

virtual

Imports a schema from an existing schema file.

Definition at line 10134 of file UatConfigGenerated.cs.

◆ ListOnly()

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

virtual

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

Definition at line 10229 of file UatConfigGenerated.cs.

◆ Preprocess()

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

virtual

Writes the preprocessed graph to the given file.

Definition at line 10400 of file UatConfigGenerated.cs.

◆ PublicTasksOnly()

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

virtual

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

Definition at line 10457 of file UatConfigGenerated.cs.

◆ ReportName()

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

virtual

Definition at line 10552 of file UatConfigGenerated.cs.

◆ Resume()

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

virtual

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

Definition at line 10210 of file UatConfigGenerated.cs.

◆ Schema()

virtual BuildConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildConfig.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 10115 of file UatConfigGenerated.cs.

◆ Script()

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

virtual

Path to the script describing the graph.

Definition at line 10076 of file UatConfigGenerated.cs.

◆ Set()

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

virtual

Sets a named property to the given value.

Definition at line 10153 of file UatConfigGenerated.cs.

◆ SharedStorageDir()

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

virtual

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

Definition at line 10476 of file UatConfigGenerated.cs.

◆ ShowDeps()

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

virtual

Show node dependencies in the graph output.

Definition at line 10267 of file UatConfigGenerated.cs.

◆ ShowDiagnostics()

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

virtual

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

Definition at line 10248 of file UatConfigGenerated.cs.

◆ ShowNotifications()

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

virtual

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

Definition at line 10286 of file UatConfigGenerated.cs.

◆ SingleNode()

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

virtual

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

Definition at line 10495 of file UatConfigGenerated.cs.

◆ SkipTargetsWithoutTokens()

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

virtual

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

Definition at line 10381 of file UatConfigGenerated.cs.

◆ SkipTrigger()

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

virtual

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

Definition at line 10324 of file UatConfigGenerated.cs.

◆ SkipTriggers()

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

virtual

Skips all triggers.

Definition at line 10343 of file UatConfigGenerated.cs.

◆ SkipValidation()

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

virtual

Definition at line 10590 of file UatConfigGenerated.cs.

◆ Target()

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

virtual

Name of the node or output tag to be built.

Definition at line 10095 of file UatConfigGenerated.cs.

◆ TokenSignature()

virtual BuildConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildConfig.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 10362 of file UatConfigGenerated.cs.

◆ Trigger()

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

virtual

Executes only nodes behind the given trigger.

Definition at line 10305 of file UatConfigGenerated.cs.

◆ WriteToSharedStorage()

virtual BuildConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildConfig.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 10514 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 10627 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 10072 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 10073 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 10628 of file UatConfigGenerated.cs.

◆ Name

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

get

Definition at line 10071 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