Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig Class Reference

Audits the current branch for comments denoting a hack that was not meant to leave another branch, following a given format ("BEGIN XXXX HACK", where XXXX is one or more tags separated by spaces). Allowed tags may be specified manually on the command line. At least one must match, otherwise it will print a warning. The current branch name and fragments of the branch path will also be added by default, so running from //UE4/Main will add "//UE4/Main", "UE4", and "Main". Audits the current branch for comments denoting a hack that was not meant to leave another branch, following a given format ("BEGIN XXXX HACK", where XXXX is one or more tags separated by spaces). Allowed tags may be specified manually on the command line. At least one must match, otherwise it will print a warning. The current branch name and fragments of the branch path will also be added by default, so running from //UE5/Main will add "//UE5/Main", "UE5", and "Main". More...

Inheritance diagram for Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig:
Nuke.Unreal.Tools.ToolConfig

Public Member Functions

virtual CheckForHacksConfig Allow (params object[] values)
 Specifies additional tags which are allowed in the BEGIN ... HACK tag list.
 
- 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< UnrealToolArgumentUsingArguments = []
 
readonly Dictionary< string, ToolConfigUsingSubtools = []
 

Detailed Description

Audits the current branch for comments denoting a hack that was not meant to leave another branch, following a given format ("BEGIN XXXX HACK", where XXXX is one or more tags separated by spaces). Allowed tags may be specified manually on the command line. At least one must match, otherwise it will print a warning. The current branch name and fragments of the branch path will also be added by default, so running from //UE4/Main will add "//UE4/Main", "UE4", and "Main". Audits the current branch for comments denoting a hack that was not meant to leave another branch, following a given format ("BEGIN XXXX HACK", where XXXX is one or more tags separated by spaces). Allowed tags may be specified manually on the command line. At least one must match, otherwise it will print a warning. The current branch name and fragments of the branch path will also be added by default, so running from //UE5/Main will add "//UE5/Main", "UE5", and "Main".

Definition at line 19997 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Allow()

virtual CheckForHacksConfig Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig.Allow ( params object[] values)
virtual

Specifies additional tags which are allowed in the BEGIN ... HACK tag list.

Definition at line 20004 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig._configs = null
private

Definition at line 20022 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig.CliName
get

Definition at line 20000 of file UatConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig.Compatibility
get

Definition at line 20001 of file UatConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig.Configs
getprotected

Definition at line 20023 of file UatConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UatConfigGenerated.CheckForHacksConfig.Name
get

Definition at line 19999 of file UatConfigGenerated.cs.


The documentation for this class was generated from the following file: