Nuke.Unreal.Tools.UatConfigGenerated.GeneratePlatformReportConfig Class Reference

Generates a report about all platforms and their configuration settings. More...

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

Public Member Functions
virtual GeneratePlatformReportConfig	Platforms (params object[] values)
	Limit report to these platforms. e.g. Windows+iOS. Default is all platforms.
virtual GeneratePlatformReportConfig	CsvOut (params object[] values)
	<filename> - Generate a CSV file instead of an html file
virtual GeneratePlatformReportConfig	DDPISection (params object[] values)
	ShaderPlatform,DataDrivenPlatformInfo - which config section to check.
virtual GeneratePlatformReportConfig	UseFieldNames (params object[] values)
	Use field names instead of friendly names.
virtual GeneratePlatformReportConfig	OpenReport (params object[] values)
	Opens the html report once it has been generated.
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

Generates a report about all platforms and their configuration settings.

Definition at line 33241 of file UatConfigGenerated.cs.

Member Function Documentation

CsvOut()

virtual GeneratePlatformReportConfig Nuke.Unreal.Tools.UatConfigGenerated.GeneratePlatformReportConfig.CsvOut ( params object[] values )

virtual

<filename> - Generate a CSV file instead of an html file

Definition at line 33267 of file UatConfigGenerated.cs.

DDPISection()

virtual GeneratePlatformReportConfig Nuke.Unreal.Tools.UatConfigGenerated.GeneratePlatformReportConfig.DDPISection ( params object[] values )

virtual

ShaderPlatform,DataDrivenPlatformInfo - which config section to check.

Definition at line 33286 of file UatConfigGenerated.cs.

OpenReport()

virtual GeneratePlatformReportConfig Nuke.Unreal.Tools.UatConfigGenerated.GeneratePlatformReportConfig.OpenReport ( params object[] values )

virtual

Opens the html report once it has been generated.

Definition at line 33324 of file UatConfigGenerated.cs.

Platforms()

virtual GeneratePlatformReportConfig Nuke.Unreal.Tools.UatConfigGenerated.GeneratePlatformReportConfig.Platforms ( params object[] values )

virtual

Limit report to these platforms. e.g. Windows+iOS. Default is all platforms.

Definition at line 33248 of file UatConfigGenerated.cs.

UseFieldNames()

virtual GeneratePlatformReportConfig Nuke.Unreal.Tools.UatConfigGenerated.GeneratePlatformReportConfig.UseFieldNames ( params object[] values )

virtual

Use field names instead of friendly names.

Definition at line 33305 of file UatConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 33342 of file UatConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 33244 of file UatConfigGenerated.cs.

Compatibility

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

get

Definition at line 33245 of file UatConfigGenerated.cs.

Configs

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

getprotected

Definition at line 33343 of file UatConfigGenerated.cs.

Name

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

get

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