Container class used for C++ compiler warning settings. More...

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

Public Member Functions
virtual CppCompileWarningsConfig	ShadowVariableErrors (WarningLevel? val=null)
	Forces shadow variable warnings to be treated as errors on platforms that support it. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4456 4456 - declaration of 'LocalVariable' hides previous local declaration https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4458 4458 - declaration of 'parameter' hides class member https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4459 4459 - declaration of 'LocalVariable' hides global declaration Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wshadow.

virtual CppCompileWarningsConfig	UndefinedIdentifierWarningLevel (WarningLevel? val=null)
	Indicates what warning/error level to treat undefined identifiers in conditional expressions. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4668 4668 - 'symbol' is not defined as a preprocessor macro, replacing with '0' for 'directives' 44668 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wundef.

virtual CppCompileWarningsConfig	SwitchUnhandledEnumeratorWarningLevel (WarningLevel? val=null)
	Indicates what warning/error level to treat unhandled enumerators in switches on enumeration-typed values. MSVC - 4061 - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4061 44061 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wswitch-enum.

virtual CppCompileWarningsConfig	PCHPerformanceIssueWarningLevel (WarningLevel? val=null)
	Indicates what warning/error level to treat potential PCH performance issues.

virtual CppCompileWarningsConfig	ModuleUnsupportedWarningLevel (WarningLevel? val=null)
	How to treat module unsupported validation messages.

virtual CppCompileWarningsConfig	PluginModuleUnsupportedWarningLevel (WarningLevel? val=null)
	How to treat plugin specific module unsupported validation messages.

virtual CppCompileWarningsConfig	ModuleIncludePathWarningLevel (WarningLevel? val=null)
	How to treat general module include path validation messages.

virtual CppCompileWarningsConfig	ModuleIncludePrivateWarningLevel (WarningLevel? val=null)
	How to treat private module include path validation messages, where a module is adding an include path that exposes private headers.

virtual CppCompileWarningsConfig	ModuleIncludeSubdirectoryWarningLevel (WarningLevel? val=null)
	How to treat unnecessary module sub-directory include path validation messages.

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

Container class used for C++ compiler warning settings.

Definition at line 20969 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ ModuleIncludePathWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.ModuleIncludePathWarningLevel ( WarningLevel? val = null )

virtual

How to treat general module include path validation messages.

Definition at line 21124 of file UbtConfigGenerated.cs.

◆ ModuleIncludePrivateWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.ModuleIncludePrivateWarningLevel ( WarningLevel? val = null )

virtual

How to treat private module include path validation messages, where a module is adding an include path that exposes private headers.

Definition at line 21145 of file UbtConfigGenerated.cs.

◆ ModuleIncludeSubdirectoryWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.ModuleIncludeSubdirectoryWarningLevel ( WarningLevel? val = null )

virtual

How to treat unnecessary module sub-directory include path validation messages.

Definition at line 21166 of file UbtConfigGenerated.cs.

◆ ModuleUnsupportedWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.ModuleUnsupportedWarningLevel ( WarningLevel? val = null )

virtual

How to treat module unsupported validation messages.

Definition at line 21082 of file UbtConfigGenerated.cs.

◆ PCHPerformanceIssueWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.PCHPerformanceIssueWarningLevel ( WarningLevel? val = null )

virtual

Indicates what warning/error level to treat potential PCH performance issues.

Definition at line 21061 of file UbtConfigGenerated.cs.

◆ PluginModuleUnsupportedWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.PluginModuleUnsupportedWarningLevel ( WarningLevel? val = null )

virtual

How to treat plugin specific module unsupported validation messages.

Definition at line 21103 of file UbtConfigGenerated.cs.

◆ ShadowVariableErrors()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.ShadowVariableErrors ( WarningLevel? val = null )

virtual

Forces shadow variable warnings to be treated as errors on platforms that support it. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4456 4456 - declaration of 'LocalVariable' hides previous local declaration https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4458 4458 - declaration of 'parameter' hides class member https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4459 4459 - declaration of 'LocalVariable' hides global declaration Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wshadow.

Definition at line 20987 of file UbtConfigGenerated.cs.

◆ SwitchUnhandledEnumeratorWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.SwitchUnhandledEnumeratorWarningLevel ( WarningLevel? val = null )

virtual

Indicates what warning/error level to treat unhandled enumerators in switches on enumeration-typed values. MSVC - 4061 - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4061 44061 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wswitch-enum.

Definition at line 21040 of file UbtConfigGenerated.cs.

◆ UndefinedIdentifierWarningLevel()

virtual CppCompileWarningsConfig Nuke.Unreal.Tools.UbtConfigGenerated.CppCompileWarningsConfig.UndefinedIdentifierWarningLevel ( WarningLevel? val = null )

virtual

Indicates what warning/error level to treat undefined identifiers in conditional expressions. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4668 4668 - 'symbol' is not defined as a preprocessor macro, replacing with '0' for 'directives' 44668 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wundef.

Definition at line 21014 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 21184 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 20972 of file UbtConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 20973 of file UbtConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 21185 of file UbtConfigGenerated.cs.

◆ Name

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

get

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

◆ ModuleIncludePathWarningLevel()

◆ ModuleIncludePrivateWarningLevel()

◆ ModuleIncludeSubdirectoryWarningLevel()

◆ ModuleUnsupportedWarningLevel()

◆ PCHPerformanceIssueWarningLevel()

◆ PluginModuleUnsupportedWarningLevel()

◆ ShadowVariableErrors()

◆ SwitchUnhandledEnumeratorWarningLevel()

◆ UndefinedIdentifierWarningLevel()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name