Describes all of the information needed to initialize a UEBuildTarget object. More...

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

Public Member Functions
virtual TargetDescriptorConfig	Plugin (object val=null)
	Foreign plugin to compile against this target.

virtual TargetDescriptorConfig	Module (params object[] values)
	Set of module names to compile.

virtual TargetDescriptorConfig	SingleFile (params object[] values)
	Individual file(s) to compile.

virtual TargetDescriptorConfig	NoHotReload (HotReloadMode? val=null)
	Whether to perform hot reload for this target.

virtual TargetDescriptorConfig	ForceHotReload (HotReloadMode? val=null)
	Whether to perform hot reload for this target.

virtual TargetDescriptorConfig	LiveCoding (HotReloadMode? val=null)
	Whether to perform hot reload for this target.

virtual TargetDescriptorConfig	WriteActions (params object[] values)
	Export the actions for the target to a file.

virtual TargetDescriptorConfig	LiveCodingModules (object val=null)
	Path to a file containing a list of modules that may be modified for live coding.

virtual TargetDescriptorConfig	LiveCodingManifest (object val=null)
	Path to the manifest for passing info about the output to live coding.

virtual TargetDescriptorConfig	Quiet (bool? val=null)
	Suppress messages about building this target.

virtual TargetDescriptorConfig	FileList (params object[] values)
	Lists of files to compile.

virtual TargetDescriptorConfig	File (params object[] values)
	Individual file(s) to compile.

virtual TargetDescriptorConfig	LiveCodingLimit (double? val=null)
	If a non-zero value, a live coding request will be terminated if more than the given number of actions are required.

virtual TargetDescriptorConfig	Rebuild (bool? val=null)
	Clean the target before trying to build it.

virtual TargetDescriptorConfig	BuildPluginAsLocal (bool? val=null)
	Whether we should treat the ForeignPlugin argument as a local plugin for building purposes.

virtual TargetDescriptorConfig	Files (params object[] values)
	Relative path to file(s) to compile.

virtual TargetDescriptorConfig	WorkingDir (object val=null)
	Working directory when compiling with RelativePathsToSpecificFilesToCompile.

virtual TargetDescriptorConfig	SingleFileBuildDependents (bool? val=null)
	Will build all files that directly include any of the files provided in -SingleFile Will build all files that directly include any of the files provided in -SingleFile, not including generated code.

virtual TargetDescriptorConfig	DisableUnity (bool present=true)
	Whether to unify C++ code into larger files for faster compilation.

virtual TargetDescriptorConfig	ForceUnity (bool? val=null)
	Whether to force C++ source files to be combined into larger files for faster compilation.

virtual TargetDescriptorConfig	IWYU (bool? val=null)
	Enables "include what you use" mode.

virtual TargetDescriptorConfig	BuildDependantPlugins (bool? val=null)
	When building a foreign plugin, whether to build plugins it depends on as well.

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

Describes all of the information needed to initialize a UEBuildTarget object.

Definition at line 9919 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ BuildDependantPlugins()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.BuildDependantPlugins ( bool? val = null )

virtual

When building a foreign plugin, whether to build plugins it depends on as well.

Definition at line 10388 of file UbtConfigGenerated.cs.

◆ BuildPluginAsLocal()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.BuildPluginAsLocal ( bool? val = null )

virtual

Whether we should treat the ForeignPlugin argument as a local plugin for building purposes.

Definition at line 10242 of file UbtConfigGenerated.cs.

◆ DisableUnity()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.DisableUnity ( bool present = true )

virtual

Whether to unify C++ code into larger files for faster compilation.

Definition at line 10325 of file UbtConfigGenerated.cs.

◆ File()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.File ( params object[] values )

virtual

Individual file(s) to compile.

Definition at line 10175 of file UbtConfigGenerated.cs.

◆ FileList()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.FileList ( params object[] values )

virtual

Lists of files to compile.

Definition at line 10150 of file UbtConfigGenerated.cs.

◆ Files()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.Files ( params object[] values )

virtual

Relative path to file(s) to compile.

Definition at line 10263 of file UbtConfigGenerated.cs.

◆ ForceHotReload()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.ForceHotReload ( HotReloadMode? val = null )

virtual

Whether to perform hot reload for this target.

Definition at line 10020 of file UbtConfigGenerated.cs.

◆ ForceUnity()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.ForceUnity ( bool? val = null )

virtual

Whether to force C++ source files to be combined into larger files for faster compilation.

Definition at line 10346 of file UbtConfigGenerated.cs.

◆ IWYU()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.IWYU ( bool? val = null )

virtual

Enables "include what you use" mode.

Definition at line 10367 of file UbtConfigGenerated.cs.

◆ LiveCoding()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.LiveCoding ( HotReloadMode? val = null )

virtual

Whether to perform hot reload for this target.

Definition at line 10041 of file UbtConfigGenerated.cs.

◆ LiveCodingLimit()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.LiveCodingLimit ( double? val = null )

virtual

If a non-zero value, a live coding request will be terminated if more than the given number of actions are required.

Definition at line 10200 of file UbtConfigGenerated.cs.

◆ LiveCodingManifest()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.LiveCodingManifest ( object val = null )

virtual

Path to the manifest for passing info about the output to live coding.

Definition at line 10108 of file UbtConfigGenerated.cs.

◆ LiveCodingModules()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.LiveCodingModules ( object val = null )

virtual

Path to a file containing a list of modules that may be modified for live coding.

Definition at line 10087 of file UbtConfigGenerated.cs.

◆ Module()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.Module ( params object[] values )

virtual

Set of module names to compile.

Definition at line 9949 of file UbtConfigGenerated.cs.

◆ NoHotReload()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.NoHotReload ( HotReloadMode? val = null )

virtual

Whether to perform hot reload for this target.

Definition at line 9999 of file UbtConfigGenerated.cs.

◆ Plugin()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.Plugin ( object val = null )

virtual

Foreign plugin to compile against this target.

Definition at line 9928 of file UbtConfigGenerated.cs.

◆ Quiet()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.Quiet ( bool? val = null )

virtual

Suppress messages about building this target.

Definition at line 10129 of file UbtConfigGenerated.cs.

◆ Rebuild()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.Rebuild ( bool? val = null )

virtual

Clean the target before trying to build it.

Definition at line 10221 of file UbtConfigGenerated.cs.

◆ SingleFile()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.SingleFile ( params object[] values )

virtual

Individual file(s) to compile.

Definition at line 9974 of file UbtConfigGenerated.cs.

◆ SingleFileBuildDependents()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.SingleFileBuildDependents ( bool? val = null )

virtual

Will build all files that directly include any of the files provided in -SingleFile Will build all files that directly include any of the files provided in -SingleFile, not including generated code.

Definition at line 10304 of file UbtConfigGenerated.cs.

◆ WorkingDir()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.WorkingDir ( object val = null )

virtual

Working directory when compiling with RelativePathsToSpecificFilesToCompile.

Definition at line 10284 of file UbtConfigGenerated.cs.

◆ WriteActions()

virtual TargetDescriptorConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetDescriptorConfig.WriteActions ( params object[] values )

virtual

Export the actions for the target to a file.

Definition at line 10062 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 10406 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 9922 of file UbtConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 9923 of file UbtConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 10407 of file UbtConfigGenerated.cs.

◆ Name

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

get

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

Detailed Description

Member Function Documentation

◆ BuildDependantPlugins()

◆ BuildPluginAsLocal()

◆ DisableUnity()

◆ File()

◆ FileList()

◆ Files()

◆ ForceHotReload()

◆ ForceUnity()

◆ IWYU()

◆ LiveCoding()

◆ LiveCodingLimit()

◆ LiveCodingManifest()

◆ LiveCodingModules()

◆ Module()

◆ NoHotReload()

◆ Plugin()

◆ Quiet()

◆ Rebuild()

◆ SingleFile()

◆ SingleFileBuildDependents()

◆ WorkingDir()

◆ WriteActions()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name