Create stub code for platform extension. More...

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

Public Member Functions
virtual CreatePlatformExtensionConfig	Source (params object[] values)
	Path to source .uplugin, .build.cs or .target.cs, or a source folder to search.

virtual CreatePlatformExtensionConfig	Platform (params object[] values)
	Platform(s) or Platform Groups to generate for.

virtual CreatePlatformExtensionConfig	Project (params object[] values)
	Optional path to project (only required if not creating code for Engine modules/plugins.

virtual CreatePlatformExtensionConfig	SkipPluginModules (params object[] values)
	Do not generate platform extension module files when generating a platform extension plugin.

virtual CreatePlatformExtensionConfig	AllowOverwrite (params object[] values)
	If target files already exist they'll be overwritten rather than skipped.

virtual CreatePlatformExtensionConfig	AllowUnknownPlatforms (params object[] values)
	Allow platform & platform groups that are not known, for example when generating code for extensions we do not have access to.

virtual CreatePlatformExtensionConfig	AllowPlatformExtensionsAsParents (params object[] values)
	When creating a platform extension from another platform extension, use the source platform as the parent.

virtual CreatePlatformExtensionConfig	P4 (params object[] values)
	Create a changelist for the new files Enables Perforce functionality {default if run on a build machine}.

virtual CreatePlatformExtensionConfig	CL (params object[] values)
	Override the changelist #.

virtual CreatePlatformExtensionConfig	DebugTest (params object[] values)

virtual CreatePlatformExtensionConfig	Verbose (params object[] values)
	Enables verbose logging.

virtual CreatePlatformExtensionConfig	VeryVerbose (params object[] values)
	Enables very verbose logging.

virtual CreatePlatformExtensionConfig	TimeStamps (params object[] values)

virtual CreatePlatformExtensionConfig	Submit (params object[] values)
	Allows UAT command to submit changes.

virtual CreatePlatformExtensionConfig	NoSubmit (params object[] values)
	Prevents any submit attempts.

virtual CreatePlatformExtensionConfig	NoP4 (params object[] values)
	Disables Perforce functionality {default if not run on a build machine}.

virtual CreatePlatformExtensionConfig	IgnoreDependencies (params object[] values)

virtual CreatePlatformExtensionConfig	Help (params object[] values)
	Displays help.

virtual CreatePlatformExtensionConfig	List (params object[] values)
	Lists all available commands.

virtual CreatePlatformExtensionConfig	NoKill (params object[] values)
	Does not kill any spawned processes on exit.

virtual CreatePlatformExtensionConfig	UTF8Output (params object[] values)

virtual CreatePlatformExtensionConfig	AllowStdOutLogVerbosity (params object[] values)

virtual CreatePlatformExtensionConfig	NoAutoSDK (params object[] values)

virtual CreatePlatformExtensionConfig	Compile (params object[] values)
	Force all script modules to be compiled.

virtual CreatePlatformExtensionConfig	NoCompile (params object[] values)
	Do not attempt to compile any script modules - attempts to run with whatever is up to date.

virtual CreatePlatformExtensionConfig	IgnoreBuildRecords (params object[] values)
	Ignore build records (Intermediate/ScriptModule/ProjectName.json) files when determining if script modules are up to date.

virtual CreatePlatformExtensionConfig	UseLocalBuildStorage (params object[] values)
	Allows you to use local storage for your root build storage dir {default of P:\Builds {on PC} is changed to Engine\Saved\LocalBuilds}. Used for local testing.

virtual CreatePlatformExtensionConfig	WaitForDebugger (params object[] values)
	Waits for a debugger to be attached, and breaks once debugger successfully attached.

virtual CreatePlatformExtensionConfig	BuildMachine (params object[] values)

virtual CreatePlatformExtensionConfig	WaitForUATMutex (params object[] values)

virtual CreatePlatformExtensionConfig	WaitForStdStreams (params object[] values)
	Time in milliseconds to wait for std streams to close in child processes.

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

Create stub code for platform extension.

Definition at line 32621 of file UatConfigGenerated.cs.

Member Function Documentation

◆ AllowOverwrite()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.AllowOverwrite ( params object[] values )

virtual

If target files already exist they'll be overwritten rather than skipped.

Definition at line 32704 of file UatConfigGenerated.cs.

◆ AllowPlatformExtensionsAsParents()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.AllowPlatformExtensionsAsParents ( params object[] values )

virtual

When creating a platform extension from another platform extension, use the source platform as the parent.

Definition at line 32742 of file UatConfigGenerated.cs.

◆ AllowStdOutLogVerbosity()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.AllowStdOutLogVerbosity ( params object[] values )

virtual

Definition at line 33028 of file UatConfigGenerated.cs.

◆ AllowUnknownPlatforms()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.AllowUnknownPlatforms ( params object[] values )

virtual

Allow platform & platform groups that are not known, for example when generating code for extensions we do not have access to.

Definition at line 32723 of file UatConfigGenerated.cs.

◆ BuildMachine()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.BuildMachine ( params object[] values )

virtual

Definition at line 33161 of file UatConfigGenerated.cs.

◆ CL()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.CL ( params object[] values )

virtual

Override the changelist #.

Definition at line 32781 of file UatConfigGenerated.cs.

◆ Compile()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Compile ( params object[] values )

virtual

Force all script modules to be compiled.

Definition at line 33066 of file UatConfigGenerated.cs.

◆ DebugTest()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.DebugTest ( params object[] values )

virtual

Definition at line 32800 of file UatConfigGenerated.cs.

◆ Help()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Help ( params object[] values )

virtual

Displays help.

Definition at line 32952 of file UatConfigGenerated.cs.

◆ IgnoreBuildRecords()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.IgnoreBuildRecords ( params object[] values )

virtual

Ignore build records (Intermediate/ScriptModule/ProjectName.json) files when determining if script modules are up to date.

Definition at line 33104 of file UatConfigGenerated.cs.

◆ IgnoreDependencies()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.IgnoreDependencies ( params object[] values )

virtual

Definition at line 32933 of file UatConfigGenerated.cs.

◆ List()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.List ( params object[] values )

virtual

Lists all available commands.

Definition at line 32971 of file UatConfigGenerated.cs.

◆ NoAutoSDK()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.NoAutoSDK ( params object[] values )

virtual

Definition at line 33047 of file UatConfigGenerated.cs.

◆ NoCompile()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.NoCompile ( params object[] values )

virtual

Do not attempt to compile any script modules - attempts to run with whatever is up to date.

Definition at line 33085 of file UatConfigGenerated.cs.

◆ NoKill()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.NoKill ( params object[] values )

virtual

Does not kill any spawned processes on exit.

Definition at line 32990 of file UatConfigGenerated.cs.

◆ NoP4()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.NoP4 ( params object[] values )

virtual

Disables Perforce functionality {default if not run on a build machine}.

Definition at line 32914 of file UatConfigGenerated.cs.

◆ NoSubmit()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.NoSubmit ( params object[] values )

virtual

Prevents any submit attempts.

Definition at line 32895 of file UatConfigGenerated.cs.

◆ P4()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.P4 ( params object[] values )

virtual

Create a changelist for the new files Enables Perforce functionality {default if run on a build machine}.

Definition at line 32762 of file UatConfigGenerated.cs.

◆ Platform()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Platform ( params object[] values )

virtual

Platform(s) or Platform Groups to generate for.

Definition at line 32647 of file UatConfigGenerated.cs.

◆ Project()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Project ( params object[] values )

virtual

Optional path to project (only required if not creating code for Engine modules/plugins.

Definition at line 32666 of file UatConfigGenerated.cs.

◆ SkipPluginModules()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.SkipPluginModules ( params object[] values )

virtual

Do not generate platform extension module files when generating a platform extension plugin.

Definition at line 32685 of file UatConfigGenerated.cs.

◆ Source()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Source ( params object[] values )

virtual

Path to source .uplugin, .build.cs or .target.cs, or a source folder to search.

Definition at line 32628 of file UatConfigGenerated.cs.

◆ Submit()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Submit ( params object[] values )

virtual

Allows UAT command to submit changes.

Definition at line 32876 of file UatConfigGenerated.cs.

◆ TimeStamps()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.TimeStamps ( params object[] values )

virtual

Definition at line 32857 of file UatConfigGenerated.cs.

◆ UseLocalBuildStorage()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.UseLocalBuildStorage ( params object[] values )

virtual

Allows you to use local storage for your root build storage dir {default of P:\Builds {on PC} is changed to Engine\Saved\LocalBuilds}. Used for local testing.

Definition at line 33123 of file UatConfigGenerated.cs.

◆ UTF8Output()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.UTF8Output ( params object[] values )

virtual

Definition at line 33009 of file UatConfigGenerated.cs.

◆ Verbose()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.Verbose ( params object[] values )

virtual

Enables verbose logging.

Definition at line 32819 of file UatConfigGenerated.cs.

◆ VeryVerbose()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.VeryVerbose ( params object[] values )

virtual

Enables very verbose logging.

Definition at line 32838 of file UatConfigGenerated.cs.

◆ WaitForDebugger()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.WaitForDebugger ( params object[] values )

virtual

Waits for a debugger to be attached, and breaks once debugger successfully attached.

Definition at line 33142 of file UatConfigGenerated.cs.

◆ WaitForStdStreams()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.WaitForStdStreams ( params object[] values )

virtual

Time in milliseconds to wait for std streams to close in child processes.

Definition at line 33199 of file UatConfigGenerated.cs.

◆ WaitForUATMutex()

virtual CreatePlatformExtensionConfig Nuke.Unreal.Tools.UatConfigGenerated.CreatePlatformExtensionConfig.WaitForUATMutex ( params object[] values )

virtual

Definition at line 33180 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 33217 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 32624 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 32625 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 33218 of file UatConfigGenerated.cs.

◆ Name

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

get

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

◆ AllowOverwrite()

◆ AllowPlatformExtensionsAsParents()

◆ AllowStdOutLogVerbosity()

◆ AllowUnknownPlatforms()

◆ BuildMachine()

◆ CL()

◆ Compile()

◆ DebugTest()

◆ Help()

◆ IgnoreBuildRecords()

◆ IgnoreDependencies()

◆ List()

◆ NoAutoSDK()

◆ NoCompile()

◆ NoKill()

◆ NoP4()

◆ NoSubmit()

◆ P4()

◆ Platform()

◆ Project()

◆ SkipPluginModules()

◆ Source()

◆ Submit()

◆ TimeStamps()

◆ UseLocalBuildStorage()

◆ UTF8Output()

◆ Verbose()

◆ VeryVerbose()

◆ WaitForDebugger()

◆ WaitForStdStreams()

◆ WaitForUATMutex()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name