className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
ILauncherWorker::OnOutputReceived
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Gets the output message delegate the delegate
LauncherServices
[FOutputMessageReceivedDelegate](API\Developer\LauncherServices\FOutputMessageReceivedDelegate) & OnOutputReceived()
[]
ILauncherWorker::OnStageCompleted
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Gets the stage completed delegate the delegate
LauncherServices
[FOnStageCompletedDelegate](API\Developer\LauncherServices\FOnStageCompletedDelegate) & OnStageCompleted()
[]
ILauncherWorker::OnStageStarted
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Gets the stage started delegate the delegate
LauncherServices
[FOnStageStartedDelegate](API\Developer\LauncherServices\FOnStageStartedDelegate) & OnStageStarted()
[]
ILauncherWorker::~ILauncherWorker
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Virtual destructor.
LauncherServices
virtual ~ILauncherWorker()
[]
ILauncherWorker
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Interface for launcher worker threads.
LauncherServices
class ILauncherWorker
[]
ILauncherWorkerPtr
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Type definition for shared pointers to instances ofILauncherWorker.
LauncherServices
typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherWorker](API\Developer\LauncherServices\ILauncherWorker) > ILauncherWorkerPtr
[]
ILauncherWorkerRef
/Engine/Source/Developer/LauncherServices/Public/ILauncherWorker.h
Type definition for shared references to instances ofILauncherWorker.
LauncherServices
typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherWorker](API\Developer\LauncherServices\ILauncherWorker) > ILauncherWorkerRef
[]
LexToStringLocalized
/Engine/Source/Developer/LauncherServices/Public/ILauncherProfile.h
LauncherServices
[FString](API\Runtime\Core\Containers\FString) LexToStringLocalized ( [ELauncherProfileValidationErrors::Type](API\Developer\LauncherServices\ELauncherProfileValidationErrors-) Value )
[]
EConflictReportFormat
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
An enum representing all the formats the conflict report can be output in.
Localization
enum EConflictReportFormat { None, Txt, CSV, }
[]
EGenerateLocResFlags
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
enum EGenerateLocResFlags { None = 0, AllowStaleTranslations = 1<<0, ValidateFormatPatterns = 1<<1, ValidateSafeWhitespace = 1<<2, }
[]
ELocalizationGatherPathRoot
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
enum ELocalizationGatherPathRoot { Auto, Engine, Project, }
[]
ELocalizationTargetConflictStatus
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
enum ELocalizationTargetConflictStatus { Unknown, ConflictsPresent, Clear, }
[]
ELocalizationTargetLoadingPolicy
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
enum ELocalizationTargetLoadingPolicy { Never, Always, Editor, Game, PropertyNames, ToolTips, }
[]
ELocalizedTextCollapseMode
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Localization
enum ELocalizedTextCollapseMode { IdenticalTextIdAndSource, IdenticalPackageIdTextIdAndSource, IdenticalNamespaceAndSource, }
[]
ELocTextHelperLoadFlags
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Flags controlling the behavior used when loading manifests and archives intoFLocTextHelper
Localization
enum ELocTextHelperLoadFlags { Load = 1<<0, Create = 1<<1, LoadOrCreate = Load | Create, }
[]
ELocTextExportSourceMethod
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
What kind of "source" should we use when looking up translations for export?
Localization
enum ELocTextExportSourceMethod { SourceText, NativeText, }
[]
ELocTextPlatformSplitMode
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
How should we split platform specific localization data?
Localization
enum ELocTextPlatformSplitMode { None, Confidential, All, }
[]
EPortableObjectFormat
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Localization
enum EPortableObjectFormat { Unreal, Crowdin, }
[]
FCultureStatistics::FCultureStatistics
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FCultureStatistics()
[]
FCultureStatistics::FCultureStatistics
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FCultureStatistics ( const [FString](API\Runtime\Core\Containers\FString) & InCultureName )
[]
FCultureStatistics
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FCultureStatistics
[ { "type": "FString", "name": "CultureName", "description": "The ISO name for this culture." }, { "type": "uint32", "name": "WordCount", "description": "The estimated number of words that have been localized for this culture." } ]
FExportLocalizationOptions
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Localization
struct FExportLocalizationOptions
[ { "type": "bool", "name": "bAutoCleanup", "description": "True to automatically clean-up any scratch data created during the localization export" }, { "type": "bool", "name": "bGatherAssets", "description": "True to gather localization from assets" }, { "type": "bool", "name": "bGatherSource", "description": "True to gather localization from source code (if a plugin has a Config or Source folder)" }, { "type": "bool", "name": "bGatherVerse", "description": "True to gather localization from Verse" }, { "type": "bool", "name": "bUpdatePluginDescriptor", "description": "True to update the plugin descriptors (if needed) so that they contain the exported localization target" }, { "type": "FString", "name": "CopyrightNotice", "description": "An optional copyright notice to insert into the exported files" }, { "type": "ELocalizedTextS...", "name": "LocalizationCategory", "description": "The category to use for the exported localization target (only used when bUpdatePluginDescriptor is true)" }, { "type": "TMap<FString, ...", "name": "PluginNameToCollectionNameFilter", "description": "Optional mapping of plugin names to collection names (to act as a filter for their asset gather step)" }, { "type": "FUserGeneratedC...", "name": "UGCLocDescriptor", "description": "Common export options for all plugins" } ]
FGatherTextExcludePath::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FGatherTextExcludePath
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextExcludePath
[ { "type": "ELocalizationGa...", "name": "PathRoot", "description": "" }, { "type": "FString", "name": "Pattern", "description": "" } ]
FGatherTextFileExtension
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextFileExtension
[ { "type": "FString", "name": "Pattern", "description": "" } ]
FGatherTextFileExtension::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FGatherTextFromMetaDataConfiguration::FGatherTextFromMetaDataConfiguration
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FGatherTextFromMetaDataConfiguration()
[]
FGatherTextFromMetaDataConfiguration::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FGatherTextFromMetaDataConfiguration
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextFromMetaDataConfiguration
[ { "type": "TArray<FGather...", "name": "ExcludePathWildcards", "description": "Metadata from source files whose paths match these wildcard patterns will be excluded from gathering." }, { "type": "TArray<FString...", "name": "FieldOwnerTypesToExclude", "description": "List of field owner types (eg, MyClass, MyStruct, etc) that should have fields within them excluded from the gather." }, { "type": "TArray<FString...", "name": "FieldOwnerTypesToInclude", "description": "List of field owner types (eg, MyClass, MyStruct, etc) that should have fields within them included in the gather, or empty to include everything." }, { "type": "TArray<FString...", "name": "FieldTypesToExclude", "description": "List of field types (eg, Property, Function, ScriptStruct, Enum, etc) the should be excluded from the gather." }, { "type": "TArray<FString...", "name": "FieldTypesToInclude", "description": "List of field types (eg, Property, Function, ScriptStruct, Enum, etc) that should be included in the gather, or empty to include everything." }, { "type": "TArray<FGather...", "name": "IncludePathWildcards", "description": "Metadata from source files whose paths match these wildcard patterns, specified relative to the project's root, may be processed for gathering." }, { "type": "bool", "name": "IsEnabled", "description": "If enabled, metadata will be gathered according to this configuration." }, { "type": "TArray<FMetaDa...", "name": "KeySpecifications", "description": "Specifications for how to gather text from specific metadata keys." }, { "type": "bool", "name": "ShouldGatherFromEditorOnlyData", "description": "If enabled, data that is specified as editor-only may be processed for gathering." } ]
FGatherTextFromPackagesConfiguration::GetDefaultPackageFileExtensions
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
static const [TArray](API\Runtime\Core\Containers\TArray)< [FGatherTextFileExtension](API\Developer\Localization\FGatherTextFileExtension) > & GetDefaultPackageFileExtensions()
[]
FGatherTextFromPackagesConfiguration::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FGatherTextFromPackagesConfiguration::FGatherTextFromPackagesConfiguration
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FGatherTextFromPackagesConfiguration()
[]
FGatherTextFromPackagesConfiguration
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextFromPackagesConfiguration
[ { "type": "TArray<FName>", "name": "Collections", "description": "Packages in these collections may be processed for gathering." }, { "type": "TArray<FSoftCl...", "name": "ExcludeClasses", "description": "Classes that should be excluded from gathering." }, { "type": "TArray<FGather...", "name": "ExcludePathWildcards", "description": "Packages whose paths match these wildcard patterns will be excluded from gathering." }, { "type": "TArray<FGather...", "name": "FileExtensions", "description": "Packages whose names match these wildcard patterns may be processed for text to gather." }, { "type": "TArray<FGather...", "name": "IncludePathWildcards", "description": "Packages whose paths match these wildcard patterns, specified relative to the project's root, may be processed for gathering." }, { "type": "bool", "name": "IsEnabled", "description": "If enabled, text from packages will be gathered according to this configuration." }, { "type": "bool", "name": "ShouldExcludeDerivedClasses", "description": "Should classes derived from those in the exclude classes list also be excluded from gathering?" }, { "type": "bool", "name": "ShouldGatherFromEditorOnlyData", "description": "If enabled, data that is specified as editor-only may be processed for gathering." }, { "type": "bool", "name": "SkipGatherCache", "description": "Should we ignore the cached text in the package header and perform a full package load instead?" } ]
FGatherTextFromTextFilesConfiguration::GetDefaultTextFileExtensions
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
static const [TArray](API\Runtime\Core\Containers\TArray)< [FGatherTextFileExtension](API\Developer\Localization\FGatherTextFileExtension) > & GetDefaultTextFileExtensions()
[]
FGatherTextFromTextFilesConfiguration::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FGatherTextFromTextFilesConfiguration::FGatherTextFromTextFilesConfiguration
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FGatherTextFromTextFilesConfiguration()
[]
FGatherTextFromTextFilesConfiguration
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextFromTextFilesConfiguration
[ { "type": "TArray<FGather...", "name": "ExcludePathWildcards", "description": "Text files whose paths match these wildcard patterns will be excluded from gathering." }, { "type": "TArray<FGather...", "name": "FileExtensions", "description": "Text files whose names match these wildcard patterns may be parsed for text to gather." }, { "type": "bool", "name": "IsEnabled", "description": "If enabled, text from text files will be gathered according to this configuration." }, { "type": "TArray<FGather...", "name": "SearchDirectories", "description": "The paths of directories to be searched recursively for text files, specified relative to the project's root, which may be parsed for text to gather." }, { "type": "bool", "name": "ShouldGatherFromEditorOnlyData", "description": "If enabled, data that is specified as editor-only may be processed for gathering." } ]
FGatherTextIncludePath::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FGatherTextIncludePath
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextIncludePath
[ { "type": "ELocalizationGa...", "name": "PathRoot", "description": "" }, { "type": "FString", "name": "Pattern", "description": "" } ]
FGatherTextSearchDirectory::Validate
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const
[]
FLocalizationCompilationSettings::FLocalizationCompilationSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FLocalizationCompilationSettings()
[]
FGatherTextSearchDirectory
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FGatherTextSearchDirectory
[ { "type": "FString", "name": "Path", "description": "" }, { "type": "ELocalizationGa...", "name": "PathRoot", "description": "" } ]
FLocalizationCompilationSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FLocalizationCompilationSettings
[ { "type": "bool", "name": "SkipSourceCheck", "description": "Should we skip the source check when compiling translations? This will allow translations whose source no longer matches the active source to still be used by the game at runtime." }, { "type": "bool", "name": "ValidateFormatPatterns", "description": "Should we validate that format patterns are valid for the culture being compiled (eg, detect invalid plural rules or broken syntax)." }, { "type": "bool", "name": "ValidateSafeWhitespace", "description": "Should we validate that text doesn't contain any unsafe whitespace (leading or trailing whitespace) that could get lost during the translation process." } ]
FLocalizationConfigurationScript::CommonSettings
/Engine/Source/Developer/Localization/Public/LocalizationConfigurationScript.h
Localization
[FConfigSection](API\Runtime\Core\Misc\FConfigSection) & CommonSettings()
[]
FLocalizationConfigurationScript::GatherTextStep
/Engine/Source/Developer/Localization/Public/LocalizationConfigurationScript.h
Localization
[FConfigSection](API\Runtime\Core\Misc\FConfigSection) & GatherTextStep ( const uint32 Index )
[]
FLocalizationConfigurationScript::WriteWithSCC
/Engine/Source/Developer/Localization/Public/LocalizationConfigurationScript.h
Localization
bool WriteWithSCC ( const [FString](API\Runtime\Core\Containers\FString) & InConfigFilename )
[]
FLocalizationConfigurationScript
/Engine/Source/Developer/Localization/Public/LocalizationConfigurationScript.h
Localization
struct FLocalizationConfigurationScript : public [FConfigFile](API\Runtime\Core\Misc\FConfigFile)
[]
FLocalizationExportingSettings::FLocalizationExportingSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FLocalizationExportingSettings()
[]
FLocalizationExportingSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FLocalizationExportingSettings
[ { "type": "ELocalizedTextC...", "name": "CollapseMode", "description": "How should we collapse down text when exporting to PO?" }, { "type": "EPortableObject...", "name": "POFormat", "description": "Which format of PO file should we use?" }, { "type": "bool", "name": "ShouldAddSourceLocationsAsComments", "description": "Should source locations be added to PO file entries as comments? Useful if a third party service doesn't expose PO file reference comments, which typically store the source location." }, { "type": "bool", "name": "ShouldPersistCommentsOnExport", "description": "Should user comments in existing PO files be persisted after export? Useful if using a third party service that stores editor/translator notes in the PO format's comment fields." } ]
FLocalizationGatherPathRootUtil::GetResolvedPathRootToken
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Get the resolved placeholder token of the path root ("%LOCENGINEROOT%" for Engine or "%LOCPROJECTROOT%" for Project; empty for Auto)
Localization
static [FString](API\Runtime\Core\Containers\FString) GetResolvedPathRootToken ( const [ELocalizationGatherPathRoot](API\Developer\Localization\ELocalizationGatherPathRoot) InPathRoot )
[]
FLocalizationGatherPathRootUtil::GetResolvedPathRootDisplayName
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Get the display name of the resolved path root (either "Engine/" or "{ProjectName/" depending on the setting and target type
Localization
static [FText](API\Runtime\Core\Internationalization\FText) GetResolvedPathRootDisplayName ( const [ELocalizationGatherPathRoot](API\Developer\Localization\ELocalizationGatherPathRoot) InPathRoot, const bool bIsEngineTarget )
[]
FLocalizationGatherPathRootUtil::GetResolvedPathRoot
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Get the path name of the resolved path root (eitherFPaths::EngineDir()orFPaths::ProjectDir()depending on the setting and target type
Localization
static [FString](API\Runtime\Core\Containers\FString) GetResolvedPathRoot ( const [ELocalizationGatherPathRoot](API\Developer\Localization\ELocalizationGatherPathRoot) InPathRoot, const bool bIsEngineTarget )
[]
FLocalizationGatherPathRootUtil
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FLocalizationGatherPathRootUtil
[]
FLocalizationImportDialogueSettings::FLocalizationImportDialogueSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FLocalizationImportDialogueSettings()
[]
FLocalizationImportDialogueSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FLocalizationImportDialogueSettings
[ { "type": "bool", "name": "bImportNativeAsSource", "description": "Should the dialogue for the native culture be imported as if it were source audio? If false, the native culture dialogue will be imported as localized data for the native culture." }, { "type": "FString", "name": "ImportedDialogueFolder", "description": "Folder in which to create the generated sound waves." }, { "type": "FDirectoryPath", "name": "RawAudioPath", "description": "Path to the folder to import the audio from." } ]
FLocalizationSCC::CheckinFiles
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
bool CheckinFiles ( const [FText](API\Runtime\Core\Internationalization\FText) & InChangeDescription, [FText](API\Runtime\Core\Internationalization\FText) & OutError )
[]
FLocalizationSCC::CheckOutFile
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
bool CheckOutFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [FText](API\Runtime\Core\Internationalization\FText) & OutError )
[]
FLocalizationSCC::CleanUp
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
bool CleanUp ( [FText](API\Runtime\Core\Internationalization\FText) & OutError )
[]
FLocalizationSCC::IsReady
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
bool IsReady ( [FText](API\Runtime\Core\Internationalization\FText) & OutError )
[]
FLocalizationSCC::FLocalizationSCC
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
FLocalizationSCC()
[]
FLocalizationSCC::RevertFile
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
bool RevertFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [FText](API\Runtime\Core\Internationalization\FText) & OutError )
[]
FLocalizationSCC::~FLocalizationSCC
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
~FLocalizationSCC()
[]
FLocalizationSCC
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
class FLocalizationSCC
[]
FLocalizationSourceControlSettings::IsSourceControlAvailable
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Checks to see whether source control is available based upon the current editor SCC settings.
Localization
static bool IsSourceControlAvailable()
[]
FLocalizationSourceControlSettings::IsSourceControlAutoSubmitEnabled
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Check to see whether we should automatically submit changed files after running the commandlet. This should be used to optionally pass "-DisableSCCSubmit" to the commandlet.
Localization
static bool IsSourceControlAutoSubmitEnabled()
[]
FLocalizationSourceControlSettings::IsSourceControlEnabled
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Check to see whether we should use SCC when running the localization commandlets. This should be used to optionally pass "-EnableSCC" to the commandlet.
Localization
static bool IsSourceControlEnabled()
[]
LocalizationSourceControlSettingsCategoryName
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Localization
static const [FString](API\Runtime\Core\Containers\FString) LocalizationSourceControlSettingsCategoryName = TEXT("LocalizationSourceControlSettings");
[]
FLocalizationSourceControlSettings::SetSourceControlEnabled
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Set whether we should use SCC when running the localization commandlets.
Localization
static void SetSourceControlEnabled ( const bool bIsEnabled )
[]
FLocalizationSourceControlSettings::SetSourceControlAutoSubmitEnabled
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Set whether we should automatically submit changed files after running the commandlet.
Localization
static void SetSourceControlAutoSubmitEnabled ( const bool bIsEnabled )
[]
SourceControlAutoSubmitEnabledSettingName
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Localization
static const [FString](API\Runtime\Core\Containers\FString) SourceControlAutoSubmitEnabledSettingName = TEXT("SourceControlAutoSubmitEnabled");
[]
SourceControlEnabledSettingName
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Localization
static const [FString](API\Runtime\Core\Containers\FString) SourceControlEnabledSettingName = TEXT("SourceControlEnabled");
[]
FLocalizationSourceControlSettings
/Engine/Source/Developer/Localization/Public/LocalizationSettings.h
Struct containing util functions for getting/setting the SCC settings for the localization dashboard
Localization
struct FLocalizationSourceControlSettings
[]
FLocalizationTargetSettings::FLocalizationTargetSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
FLocalizationTargetSettings()
[]
FLocalizationTargetSettings
/Engine/Source/Developer/Localization/Public/LocalizationTargetTypes.h
Localization
struct FLocalizationTargetSettings
[ { "type": "TArray<FFilePa...", "name": "AdditionalManifestDependencies", "description": "Text present in these manifests will not be duplicated in this target." }, { "type": "FLocalizationCo...", "name": "CompileSettings", "description": "Settings for compiling translations." }, { "type": "ELocalizationTa...", "name": "ConflictStatus", "description": "Whether the target has outstanding conflicts that require resolution." }, { "type": "FLocalizationEx...", "name": "ExportSettings", "description": "Settings for exporting translations." }, { "type": "FGatherTextFrom...", "name": "GatherFromMetaData", "description": "Parameters for defining what text is gathered from metadata and how." }, { "type": "FGatherTextFrom...", "name": "GatherFromPackages", "description": "Parameters for defining what text is gathered from packages and how." }, { "type": "FGatherTextFrom...", "name": "GatherFromTextFiles", "description": "Parameters for defining what text is gathered from text files and how." }, { "type": "FGuid", "name": "Guid", "description": "" }, { "type": "FLocalizationIm...", "name": "ImportDialogueSettings", "description": "Settings for importing dialogue from WAV files." }, { "type": "FString", "name": "Name", "description": "Unique name for the target." }, { "type": "int32", "name": "NativeCultureIndex", "description": "The index of the native culture among the supported cultures." }, { "type": "TArray<FString...", "name": "RequiredModuleNames", "description": "The names of modules which must be loaded when gathering text." }, { "type": "TArray<FCultur...", "name": "SupportedCulturesStatistics", "description": "Cultures for which the source text is being localized for." }, { "type": "TArray<FGuid>", "name": "TargetDependencies", "description": "Text present in these targets will not be duplicated in this target." } ]
FLocFileSCCNotifies::PostFileRead
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Called after reading the given file from disk
Localization
virtual void PostFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
FLocFileSCCNotifies::PostFileWrite
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Called after writing the given file to disk
Localization
virtual void PostFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
FLocFileSCCNotifies::PreFileRead
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Called prior to reading the given file on disk
Localization
virtual void PreFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
FLocFileSCCNotifies::PreFileWrite
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Called prior to writing the given file to disk
Localization
virtual void PreFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
FLocFileSCCNotifies::FLocFileSCCNotifies
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
FLocFileSCCNotifies ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocalizationSCC](API\Developer\Localization\FLocalizationSCC) > & InSourceControlInfo )
[]
FLocFileSCCNotifies::~FLocFileSCCNotifies
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Virtual destructor
Localization
virtual ~FLocFileSCCNotifies()
[]
FLocFileSCCNotifies
/Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h
Localization
class FLocFileSCCNotifies : public [ILocFileNotifies](API\Developer\Localization\ILocFileNotifies)
[]
FLocTextConflicts::GetConflictReport
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Convert the conflicts to a string format that can be easily saved as a .txt report summary.
Localization
[FString](API\Runtime\Core\Containers\FString) GetConflictReport() const
[]
FLocTextConflicts::AddConflict
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Add a new conflict entry.
Localization
void AddConflict ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetadata, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FString](API\Runtime\Core\Containers\FString) & InSourceLocation )
[]
FConflictMap
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
typedef [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< [FLocKey](API\Runtime\Core\Internationalization\FLocKey), [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FConflict > > FConflictMap
[]
FLocTextConflicts::FLocTextConflicts
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
FLocTextConflicts()
[]
FLocTextConflicts::FLocTextConflicts
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
FLocTextConflicts &40; const FLocTextConflicts & &41;
[]
FLocTextConflicts::GetConflictReportAsCSV
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Convert the conflicts to a string format that can be easily saved as a .csv report summary.
Localization
[FString](API\Runtime\Core\Containers\FString) GetConflictReportAsCSV() const
[]
FLocTextConflicts
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Class that tracks any conflicts that occur when gathering source text entries.
Localization
class FLocTextConflicts
[]
FLocTextHelper::AddConflict
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Add a new conflict entry.
Localization
void AddConflict ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetadata, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FString](API\Runtime\Core\Containers\FString) & InSourceLocation )
[]
FLocTextHelper::AddSourceText
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Add a new source text entry to the manifest. Returns true if it was added successfully (or if a matching entry already exists), false if a duplicate entry was found with different text (an identity conflict).
Localization
bool AddSourceText ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FManifestContext](API\Runtime\Core\Internationalization\FManifestContext) & InContext, const [FString](API\Runtime\Core\Containers\FString) * InDescription )
[]
FLocTextHelper::AddDependency
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Attempt to add a manifest dependency. True if the file was load, false otherwise.
Localization
bool AddDependency ( const [FString](API\Runtime\Core\Containers\FString) & InDependencyFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError )
[]
FLocTextHelper::AddTranslation
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Add a new translation to the given archive. Returns true if it was added successfully, false otherwise.
Localization
bool AddTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchiveEntry](API\Runtime\Core\Internationalization\FArchiveEntry) > & InEntry )
[]
FLocTextHelper::AddTranslation
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Add a new translation to the given archive. Returns true if it was added successfully, false otherwise.
Localization
bool AddTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetadataObj, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InTranslation, const bool InOptional )
[]
FLocTextHelper::EnumerateTranslations
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
void EnumerateTranslations ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FEnumerateTranslationsFuncPtr](API\Developer\Localization\FLocTextHelper\FEnumerateTranslationsFuncPtr) & InCallback, const bool InCheckDependencies ) const
[]
FLocTextHelper::EnumerateSourceTexts
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
void EnumerateSourceTexts ( const [FEnumerateSourceTextsFuncPtr](API\Developer\Localization\FLocTextHelper\FEnumerateSourceTextsFuncPtr) & InCallback, const bool InCheckDependencies ) const
[]
FEnumerateSourceTextsFuncPtr
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Enumerate all the source texts in the manifest, optionally skipping those entries from a dependent manifest.
Localization
typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) >)> FEnumerateSourceTextsFuncPtr
[]
FLocTextHelper::FindDependencyEntry
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Find an existing dependency entry using its namespace and context. The entry, or null if it couldn't be found.
Localization
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > FindDependencyEntry ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FManifestContext](API\Runtime\Core\Internationalization\FManifestContext) & InContext, [FString](API\Runtime\Core\Containers\FString) * OutDependencyFilePath ) const
[]
FEnumerateTranslationsFuncPtr
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
This only enumerates translations that have a source in the manifest.
Localization
typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchiveEntry](API\Runtime\Core\Internationalization\FArchiveEntry) >)> FEnumerateTranslationsFuncPtr
[]
FLocTextHelper::FindDependencyEntry
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Find an dependency entry using its namespace and key. The entry, or null if it couldn't be found.
Localization
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > FindDependencyEntry ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [FString](API\Runtime\Core\Containers\FString) * InSourceText, [FString](API\Runtime\Core\Containers\FString) * OutDependencyFilePath ) const
[]
FLocTextHelper::FindKeysForLegacyTranslation
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
This should only be used to upgrade old non-keyed archive entries when importing legacy data. True if keys were found, false otherwise.
Localization
bool FindKeysForLegacyTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FString](API\Runtime\Core\Containers\FString) & InSource, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj, [TArray](API\Runtime\Core\Containers\TArray)< [FLocKey](API\Runtime\Core\Internationalization\FLocKey) > & OutKeys ) const
[]