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

Public Member Functions
virtual LocaliseConfig	UEProjectRoot (params object[] values)
	Optional root-path to the project we're gathering for (defaults to CmdEnv.LocalRoot if unset).

virtual LocaliseConfig	UEProjectDirectory (params object[] values)
	Sub-path to the project we're gathering for (relative to UEProjectRoot).

virtual LocaliseConfig	UEProjectName (params object[] values)
	Optional name of the project we're gathering for (should match its .uproject file, eg QAGame).

virtual LocaliseConfig	LocalizationProjectNames (params object[] values)
	Comma separated list of the projects to gather text from.

virtual LocaliseConfig	LocalizationBranch (params object[] values)
	Optional suffix to use when uploading the new data to the localization provider.

virtual LocaliseConfig	LocalizationProvider (params object[] values)
	Optional localization provide override.

virtual LocaliseConfig	LocalizationSteps (params object[] values)
	Optional comma separated list of localization steps to perform [Download, Gather, Import, Export, Compile, GenerateReports, Upload] (default is all). Only valid for projects using a modular config.

virtual LocaliseConfig	IncludePlugins (params object[] values)
	Optional flag to include plugins from within the given UEProjectDirectory as part of the gather. This may optionally specify a comma separated list of the specific plugins to gather (otherwise all plugins will be gathered).

virtual LocaliseConfig	ExcludePlugins (params object[] values)
	Optional comma separated list of plugins to exclude from the gather.

virtual LocaliseConfig	IncludePlatforms (params object[] values)
	Optional flag to include platforms from within the given UEProjectDirectory as part of the gather.

virtual LocaliseConfig	AdditionalCommandletArguments (params object[] values)
	Optional arguments to pass to the gather process.

virtual LocaliseConfig	ParallelGather (params object[] values)
	Run the gather processes for a single batch in parallel rather than sequence.

virtual LocaliseConfig	Preview (params object[] values)
	Run the localization command in preview mode. This passes the -Preview flag along to all commandlets as an additional argument and deletes all temporary files generated by the commandlets in preview mode. Primarily used for build farm automation where localization warnings from localization gathers can be previewed without checking out any files under SCC.

virtual LocaliseConfig	IncludePluginsDirectory (params object[] values)
	Optional parameter that is a list of relative paths to a directory under UEProjectDirectory separated by a ';' character. All plugins under this directory will be gathered from (if not excluded) E.g -IncludePluginsDirectory="Plugins/A;Plugins/B;Plugins/C".

virtual LocaliseConfig	ExcludePluginsDirectory (params object[] values)
	Optional list of relative paths to a directory under UEProjectDirectory separated by the ';' character. All plugins under this directory will be excluded from gather. E.g -ExcludePluginsDirectory="Plugins/A;Plugins/B;Plugins/C".

virtual LocaliseConfig	EnableIncludedPlugins (params object[] values)
	Optional flag that passes all included plugins that aren't excluded to the -EnablePlugins editor argument to ensure content and metadata for plugins are loaded for gathering.

virtual LocaliseConfig	PreserveAutoGeneratedResources (params object[] values)

virtual LocaliseConfig	ConsolidateConfigFiles (params object[] values)

virtual LocaliseConfig	TemplateLocalizationConfigFiles (params object[] values)
	An optional list of paths to localization config files to be used as templates for Auto localization config file generation. If the paths provided are relative, they should be relative to UEProjectDirectory. Else the path should be absolute. All paths should be separated by a ;.

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

Definition at line 21966 of file UatConfigGenerated.cs.

Member Function Documentation

◆ AdditionalCommandletArguments()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.AdditionalCommandletArguments ( params object[] values )

virtual

Optional arguments to pass to the gather process.

Definition at line 22163 of file UatConfigGenerated.cs.

◆ ConsolidateConfigFiles()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.ConsolidateConfigFiles ( params object[] values )

virtual

Definition at line 22296 of file UatConfigGenerated.cs.

◆ EnableIncludedPlugins()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.EnableIncludedPlugins ( params object[] values )

virtual

Optional flag that passes all included plugins that aren't excluded to the -EnablePlugins editor argument to ensure content and metadata for plugins are loaded for gathering.

Definition at line 22258 of file UatConfigGenerated.cs.

◆ ExcludePlugins()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.ExcludePlugins ( params object[] values )

virtual

Optional comma separated list of plugins to exclude from the gather.

Definition at line 22125 of file UatConfigGenerated.cs.

◆ ExcludePluginsDirectory()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.ExcludePluginsDirectory ( params object[] values )

virtual

Optional list of relative paths to a directory under UEProjectDirectory separated by the ';' character. All plugins under this directory will be excluded from gather. E.g -ExcludePluginsDirectory="Plugins/A;Plugins/B;Plugins/C".

Definition at line 22239 of file UatConfigGenerated.cs.

◆ IncludePlatforms()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.IncludePlatforms ( params object[] values )

virtual

Optional flag to include platforms from within the given UEProjectDirectory as part of the gather.

Definition at line 22144 of file UatConfigGenerated.cs.

◆ IncludePlugins()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.IncludePlugins ( params object[] values )

virtual

Optional flag to include plugins from within the given UEProjectDirectory as part of the gather. This may optionally specify a comma separated list of the specific plugins to gather (otherwise all plugins will be gathered).

Definition at line 22106 of file UatConfigGenerated.cs.

◆ IncludePluginsDirectory()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.IncludePluginsDirectory ( params object[] values )

virtual

Optional parameter that is a list of relative paths to a directory under UEProjectDirectory separated by a ';' character. All plugins under this directory will be gathered from (if not excluded) E.g -IncludePluginsDirectory="Plugins/A;Plugins/B;Plugins/C".

Definition at line 22220 of file UatConfigGenerated.cs.

◆ LocalizationBranch()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.LocalizationBranch ( params object[] values )

virtual

Optional suffix to use when uploading the new data to the localization provider.

Definition at line 22049 of file UatConfigGenerated.cs.

◆ LocalizationProjectNames()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.LocalizationProjectNames ( params object[] values )

virtual

Comma separated list of the projects to gather text from.

Definition at line 22030 of file UatConfigGenerated.cs.

◆ LocalizationProvider()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.LocalizationProvider ( params object[] values )

virtual

Optional localization provide override.

Definition at line 22068 of file UatConfigGenerated.cs.

◆ LocalizationSteps()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.LocalizationSteps ( params object[] values )

virtual

Optional comma separated list of localization steps to perform [Download, Gather, Import, Export, Compile, GenerateReports, Upload] (default is all). Only valid for projects using a modular config.

Definition at line 22087 of file UatConfigGenerated.cs.

◆ ParallelGather()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.ParallelGather ( params object[] values )

virtual

Run the gather processes for a single batch in parallel rather than sequence.

Definition at line 22182 of file UatConfigGenerated.cs.

◆ PreserveAutoGeneratedResources()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.PreserveAutoGeneratedResources ( params object[] values )

virtual

Definition at line 22277 of file UatConfigGenerated.cs.

◆ Preview()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.Preview ( params object[] values )

virtual

Run the localization command in preview mode. This passes the -Preview flag along to all commandlets as an additional argument and deletes all temporary files generated by the commandlets in preview mode. Primarily used for build farm automation where localization warnings from localization gathers can be previewed without checking out any files under SCC.

Definition at line 22201 of file UatConfigGenerated.cs.

◆ TemplateLocalizationConfigFiles()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.TemplateLocalizationConfigFiles ( params object[] values )

virtual

An optional list of paths to localization config files to be used as templates for Auto localization config file generation. If the paths provided are relative, they should be relative to UEProjectDirectory. Else the path should be absolute. All paths should be separated by a ;.

Definition at line 22315 of file UatConfigGenerated.cs.

◆ UEProjectDirectory()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.UEProjectDirectory ( params object[] values )

virtual

Sub-path to the project we're gathering for (relative to UEProjectRoot).

Definition at line 21992 of file UatConfigGenerated.cs.

◆ UEProjectName()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.UEProjectName ( params object[] values )

virtual

Optional name of the project we're gathering for (should match its .uproject file, eg QAGame).

Definition at line 22011 of file UatConfigGenerated.cs.

◆ UEProjectRoot()

virtual LocaliseConfig Nuke.Unreal.Tools.UatConfigGenerated.LocaliseConfig.UEProjectRoot ( params object[] values )

virtual

Optional root-path to the project we're gathering for (defaults to CmdEnv.LocalRoot if unset).

Definition at line 21973 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 22333 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 21969 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 21970 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 22334 of file UatConfigGenerated.cs.

◆ Name

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

get

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

◆ AdditionalCommandletArguments()

◆ ConsolidateConfigFiles()

◆ EnableIncludedPlugins()

◆ ExcludePlugins()

◆ ExcludePluginsDirectory()

◆ IncludePlatforms()

◆ IncludePlugins()

◆ IncludePluginsDirectory()

◆ LocalizationBranch()

◆ LocalizationProjectNames()

◆ LocalizationProvider()

◆ LocalizationSteps()

◆ ParallelGather()

◆ PreserveAutoGeneratedResources()

◆ Preview()

◆ TemplateLocalizationConfigFiles()

◆ UEProjectDirectory()

◆ UEProjectName()

◆ UEProjectRoot()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name