Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig Class Reference

Fixes the include paths found in a header and source file. More...

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

Public Member Functions
virtual FixIncludePathsConfig	Filter (params object[] values)
	Set of filters for files to include in the database. Relative to the root directory, or to the project file.
virtual FixIncludePathsConfig	CheckoutWithP4 (bool? val=null)
	Flags that this task should use p4 to check out the file before updating it.
virtual FixIncludePathsConfig	NoOutput (bool? val=null)
	Flags that the updated files shouldn't be saved.
virtual FixIncludePathsConfig	NoIncludeSorting (bool? val=null)
	Flags that includes should not be sorted.
virtual FixIncludePathsConfig	IncludeFilter (params object[] values)
	Set of filters for #include'd lines to allow updating. Relative to the root directory, or to the project file.
virtual FixIncludePathsConfig	ForceUpdate (bool? val=null)
	Forces updating and sorting the includes.
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

Fixes the include paths found in a header and source file.

Definition at line 17742 of file UbtConfigGenerated.cs.

Member Function Documentation

CheckoutWithP4()

virtual FixIncludePathsConfig Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig.CheckoutWithP4 ( bool? val = null )

virtual

Flags that this task should use p4 to check out the file before updating it.

Definition at line 17772 of file UbtConfigGenerated.cs.

Filter()

virtual FixIncludePathsConfig Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig.Filter ( params object[] values )

virtual

Set of filters for files to include in the database. Relative to the root directory, or to the project file.

Definition at line 17749 of file UbtConfigGenerated.cs.

ForceUpdate()

virtual FixIncludePathsConfig Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig.ForceUpdate ( bool? val = null )

virtual

Forces updating and sorting the includes.

Definition at line 17852 of file UbtConfigGenerated.cs.

IncludeFilter()

virtual FixIncludePathsConfig Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig.IncludeFilter ( params object[] values )

virtual

Set of filters for #include'd lines to allow updating. Relative to the root directory, or to the project file.

Definition at line 17829 of file UbtConfigGenerated.cs.

NoIncludeSorting()

virtual FixIncludePathsConfig Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig.NoIncludeSorting ( bool? val = null )

virtual

Flags that includes should not be sorted.

Definition at line 17810 of file UbtConfigGenerated.cs.

NoOutput()

virtual FixIncludePathsConfig Nuke.Unreal.Tools.UbtConfigGenerated.FixIncludePathsConfig.NoOutput ( bool? val = null )

virtual

Flags that the updated files shouldn't be saved.

Definition at line 17791 of file UbtConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 17870 of file UbtConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 17745 of file UbtConfigGenerated.cs.

Compatibility

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

get

Definition at line 17746 of file UbtConfigGenerated.cs.

Configs

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

getprotected

Definition at line 17871 of file UbtConfigGenerated.cs.

Name

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

get

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