Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig Class Reference

Builds a plugin, and packages it for distribution. More...

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

Public Member Functions
virtual BuildPluginConfig	Plugin (params object[] values)
	Specify the path to the descriptor file for the plugin that should be packaged.
virtual BuildPluginConfig	NoHostPlatform (params object[] values)
	Prevent compiling for the editor platform on the host.
virtual BuildPluginConfig	TargetPlatforms (params object[] values)
	Specify a list of target platforms to build, separated by '+' characters (eg. -TargetPlatforms=Win32+Win64). Default is all the Rocket target platforms.
virtual BuildPluginConfig	Package (params object[] values)
	The path which the build artifacts should be packaged to, ready for distribution.
virtual BuildPluginConfig	StrictIncludes (params object[] values)
	Disables precompiled headers and unity build in order to check all source files have self-contained headers.
virtual BuildPluginConfig	Unversioned (params object[] values)
	Do not embed the current engine version into the descriptor.
virtual BuildPluginConfig	VS2019 (params object[] values)
virtual BuildPluginConfig	NoDeleteHostProject (params object[] values)
virtual BuildPluginConfig	NoTargetPlatforms (params object[] values)
virtual BuildPluginConfig	EngineDir (params object[] values)
	Root Directory of the engine that will be used to build plugin(s) (optional)
virtual BuildPluginConfig	HostPlatforms (params object[] values)
	Specify a list of host platforms to build, separated by '+' characters (eg. -HostPlatforms=Win32+Win64). Default is the current host platforms.
virtual BuildPluginConfig	Architecture_ (params object[] values)
	Control architecture to compile for a platform (eg. -Architecture_Mac=arm64+x86). Default is to use UBT defaults for the platform.
virtual BuildPluginConfig	PackageAppendPluginSubdir (params object[] values)
	Package the build artifacts in a subfolder named after the plugin.
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 plugin, and packages it for distribution.

Definition at line 18853 of file UatConfigGenerated.cs.

Member Function Documentation

Architecture_()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.Architecture_ ( params object[] values )

virtual

Control architecture to compile for a platform (eg. -Architecture_Mac=arm64+x86). Default is to use UBT defaults for the platform.

Definition at line 19069 of file UatConfigGenerated.cs.

EngineDir()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.EngineDir ( params object[] values )

virtual

Root Directory of the engine that will be used to build plugin(s) (optional)

Definition at line 19031 of file UatConfigGenerated.cs.

HostPlatforms()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.HostPlatforms ( params object[] values )

virtual

Specify a list of host platforms to build, separated by '+' characters (eg. -HostPlatforms=Win32+Win64). Default is the current host platforms.

Definition at line 19050 of file UatConfigGenerated.cs.

NoDeleteHostProject()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.NoDeleteHostProject ( params object[] values )

virtual

Definition at line 18993 of file UatConfigGenerated.cs.

NoHostPlatform()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.NoHostPlatform ( params object[] values )

virtual

Prevent compiling for the editor platform on the host.

Definition at line 18879 of file UatConfigGenerated.cs.

NoTargetPlatforms()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.NoTargetPlatforms ( params object[] values )

virtual

Definition at line 19012 of file UatConfigGenerated.cs.

Package()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.Package ( params object[] values )

virtual

The path which the build artifacts should be packaged to, ready for distribution.

Definition at line 18917 of file UatConfigGenerated.cs.

PackageAppendPluginSubdir()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.PackageAppendPluginSubdir ( params object[] values )

virtual

Package the build artifacts in a subfolder named after the plugin.

Definition at line 19088 of file UatConfigGenerated.cs.

Plugin()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.Plugin ( params object[] values )

virtual

Specify the path to the descriptor file for the plugin that should be packaged.

Definition at line 18860 of file UatConfigGenerated.cs.

StrictIncludes()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.StrictIncludes ( params object[] values )

virtual

Disables precompiled headers and unity build in order to check all source files have self-contained headers.

Definition at line 18936 of file UatConfigGenerated.cs.

TargetPlatforms()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.TargetPlatforms ( params object[] values )

virtual

Specify a list of target platforms to build, separated by '+' characters (eg. -TargetPlatforms=Win32+Win64). Default is all the Rocket target platforms.

Definition at line 18898 of file UatConfigGenerated.cs.

Unversioned()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.Unversioned ( params object[] values )

virtual

Do not embed the current engine version into the descriptor.

Definition at line 18955 of file UatConfigGenerated.cs.

VS2019()

virtual BuildPluginConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildPluginConfig.VS2019 ( params object[] values )

virtual

Definition at line 18974 of file UatConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 19106 of file UatConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 18856 of file UatConfigGenerated.cs.

Compatibility

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

get

Definition at line 18857 of file UatConfigGenerated.cs.

Configs

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

getprotected

Definition at line 19107 of file UatConfigGenerated.cs.

Name

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

get

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