Builds a third party library using the CMake build system. More...

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

Public Member Functions
virtual BuildCMakeLibConfig	TargetLib (params object[] values)
	Specify the target library to build.

virtual BuildCMakeLibConfig	TargetLibVersion (params object[] values)
	Specify the target library version to build.

virtual BuildCMakeLibConfig	TargetLibSourcePath (params object[] values)
	Override the path to source, if external to the engine. (eg. -TargetLibSourcePath=path). Default is empty.

virtual BuildCMakeLibConfig	TargetPlatform (params object[] values)
	Specify the name of the target platform to build (eg. -TargetPlatform=IOS).

virtual BuildCMakeLibConfig	TargetConfigs (params object[] values)
	Specify a list of configurations to build, separated by '+' characters (eg. -TargetConfigs=release+debug). Default is release+debug.

virtual BuildCMakeLibConfig	LibOutputPath (params object[] values)
	Override the path to output the libs to. (eg. -LibOutputPath=lib). Default is empty. Override the path to output libraries to. (eg. -LibOutputPath=lib). Default is empty.

virtual BuildCMakeLibConfig	CMakeGenerator (params object[] values)
	Specify the CMake generator to use.

virtual BuildCMakeLibConfig	CMakeProjectIncludeFile (params object[] values)
	Specify the name of the CMake project include file to use, first looks in current directory then looks in global directory.

virtual BuildCMakeLibConfig	CMakeAdditionalArguments (params object[] values)
	Specify the additional commandline to pass to cmake. Specify the additional arguments to pass to CMake when generating the build system.

virtual BuildCMakeLibConfig	MakeTarget (params object[] values)
	Override the target to pass to make.

virtual BuildCMakeLibConfig	SkipCreateChangelist (params object[] values)
	Do not create a P4 changelist for source or libs. If this argument is not supplied source and libs will be added to a Perforce changelist.

virtual BuildCMakeLibConfig	SkipSubmit (params object[] values)
	Do not perform P4 submit of source or libs. If this argument is not supplied source and libs will be automatically submitted to Perforce. If SkipCreateChangelist is specified, this argument applies by default.

virtual BuildCMakeLibConfig	Robomerge (params object[] values)
	Which robomerge action to apply to the submission. If we're skipping submit, this is not used. Which RoboMerge action to apply to the submission. If we're skipping submit, this is not used.

virtual BuildCMakeLibConfig	TargetArchitecture (params object[] values)
	Specify the name of the target architecture to build (eg. -TargetArchitecture=x86_64).

virtual BuildCMakeLibConfig	BinOutputPath (params object[] values)
	Override the path to output binaries to. (eg. -BinOutputPath=bin). Default is empty.

virtual BuildCMakeLibConfig	TargetLibRoot (params object[] values)
	Override the path to the library's root dir.

virtual BuildCMakeLibConfig	TargetRootDir (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

Builds a third party library using the CMake build system.

WARNING: This command might require Perforce

Definition at line 11419 of file UatConfigGenerated.cs.

Member Function Documentation

◆ BinOutputPath()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.BinOutputPath ( params object[] values )

virtual

Override the path to output binaries to. (eg. -BinOutputPath=bin). Default is empty.

Definition at line 11695 of file UatConfigGenerated.cs.

◆ CMakeAdditionalArguments()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.CMakeAdditionalArguments ( params object[] values )

virtual

Specify the additional commandline to pass to cmake. Specify the additional arguments to pass to CMake when generating the build system.

Definition at line 11580 of file UatConfigGenerated.cs.

◆ CMakeGenerator()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.CMakeGenerator ( params object[] values )

virtual

Specify the CMake generator to use.

Definition at line 11541 of file UatConfigGenerated.cs.

◆ CMakeProjectIncludeFile()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.CMakeProjectIncludeFile ( params object[] values )

virtual

Specify the name of the CMake project include file to use, first looks in current directory then looks in global directory.

Definition at line 11560 of file UatConfigGenerated.cs.

◆ LibOutputPath()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.LibOutputPath ( params object[] values )

virtual

Override the path to output the libs to. (eg. -LibOutputPath=lib). Default is empty. Override the path to output libraries to. (eg. -LibOutputPath=lib). Default is empty.

Definition at line 11522 of file UatConfigGenerated.cs.

◆ MakeTarget()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.MakeTarget ( params object[] values )

virtual

Override the target to pass to make.

Definition at line 11599 of file UatConfigGenerated.cs.

◆ Robomerge()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.Robomerge ( params object[] values )

virtual

Which robomerge action to apply to the submission. If we're skipping submit, this is not used. Which RoboMerge action to apply to the submission. If we're skipping submit, this is not used.

Definition at line 11657 of file UatConfigGenerated.cs.

◆ SkipCreateChangelist()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.SkipCreateChangelist ( params object[] values )

virtual

Do not create a P4 changelist for source or libs. If this argument is not supplied source and libs will be added to a Perforce changelist.

Definition at line 11618 of file UatConfigGenerated.cs.

◆ SkipSubmit()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.SkipSubmit ( params object[] values )

virtual

Do not perform P4 submit of source or libs. If this argument is not supplied source and libs will be automatically submitted to Perforce. If SkipCreateChangelist is specified, this argument applies by default.

Definition at line 11637 of file UatConfigGenerated.cs.

◆ TargetArchitecture()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetArchitecture ( params object[] values )

virtual

Specify the name of the target architecture to build (eg. -TargetArchitecture=x86_64).

Definition at line 11676 of file UatConfigGenerated.cs.

◆ TargetConfigs()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetConfigs ( params object[] values )

virtual

Specify a list of configurations to build, separated by '+' characters (eg. -TargetConfigs=release+debug). Default is release+debug.

Definition at line 11502 of file UatConfigGenerated.cs.

◆ TargetLib()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetLib ( params object[] values )

virtual

Specify the target library to build.

Definition at line 11426 of file UatConfigGenerated.cs.

◆ TargetLibRoot()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetLibRoot ( params object[] values )

virtual

Override the path to the library's root dir.

Definition at line 11714 of file UatConfigGenerated.cs.

◆ TargetLibSourcePath()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetLibSourcePath ( params object[] values )

virtual

Override the path to source, if external to the engine. (eg. -TargetLibSourcePath=path). Default is empty.

Definition at line 11464 of file UatConfigGenerated.cs.

◆ TargetLibVersion()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetLibVersion ( params object[] values )

virtual

Specify the target library version to build.

Definition at line 11445 of file UatConfigGenerated.cs.

◆ TargetPlatform()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetPlatform ( params object[] values )

virtual

Specify the name of the target platform to build (eg. -TargetPlatform=IOS).

Definition at line 11483 of file UatConfigGenerated.cs.

◆ TargetRootDir()

virtual BuildCMakeLibConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCMakeLibConfig.TargetRootDir ( params object[] values )

virtual

Definition at line 11733 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 11751 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 11422 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 11423 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 11752 of file UatConfigGenerated.cs.

◆ Name

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

get

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

◆ BinOutputPath()

◆ CMakeAdditionalArguments()

◆ CMakeGenerator()

◆ CMakeProjectIncludeFile()

◆ LibOutputPath()

◆ MakeTarget()

◆ Robomerge()

◆ SkipCreateChangelist()

◆ SkipSubmit()

◆ TargetArchitecture()

◆ TargetConfigs()

◆ TargetLib()

◆ TargetLibRoot()

◆ TargetLibSourcePath()

◆ TargetLibVersion()

◆ TargetPlatform()

◆ TargetRootDir()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name