code: bool LoadForeignArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InArchiveFilePath, const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description:
Attempt to load (or create) the manifest file from the given file path.
True if the file was loaded (or created), false otherwise.

module: Localization

code: bool LoadManifest ( const [FString](API\Runtime\Core\Containers\FString) & InManifestFilePath, const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description:
Attempt to load (or create) the manifest file.
True if the file was loaded (or created), false otherwise.

code: bool LoadManifest ( const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description:
The manifest must have been loaded prior to loading archives.
True if the file was loaded (or created), false otherwise.

code: bool LoadNativeArchive ( const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


code: bool LoadNativeArchive ( const [FString](API\Runtime\Core\Containers\FString) & InArchiveFilePath, const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description: Sanitize any output from the given string that may cause the build machine to generate erroneous errors.

code: static [FString](API\Runtime\Core\Containers\FString) SanitizeLogOutput ( FStringView InString )


code: static [FString](API\Runtime\Core\Containers\FString) SanitizeLogOutput ( [FString](API\Runtime\Core\Containers\FString) && InString )


description:
Attempt to save the manifest and all archive files specified during construction.
True if all files were saved, false otherwise.

code: bool SaveAll ( [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Attempt to save all (native and foreign) archive files.
True if the file was saved, false otherwise.

code: bool SaveAllArchives ( [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
This requires that the given culture is is in the native culture, or in the list of foreign cultures set during construction.
True if the file was saved, false otherwise.

code: bool SaveArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


code: bool SaveArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InArchiveFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Save the conflict report summary to disk.
True if the file was saved, false otherwise.

code: bool SaveConflictReport ( const [FString](API\Runtime\Core\Containers\FString) & InReportFilePath, [EConflictReportFormat](API\Developer\Localization\EConflictReportFormat) InConflictReportFormat, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
This requires that the given culture is in the list of foreign cultures set during construction.
True if the file was saved, false otherwise.

code: bool SaveForeignArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


code: bool SaveForeignArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InArchiveFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Attempt to save the manifest file.
True if the file was saved, false otherwise.

code: bool SaveManifest ( [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Attempt to save the manifest file to the given file path.
True if the file was saved, false otherwise.

code: bool SaveManifest ( const [FString](API\Runtime\Core\Containers\FString) & InManifestFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Attempt to save the native archive file.
True if the file was saved, false otherwise.

code: bool SaveNativeArchive ( [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Attempt to save the native archive file to the given file path.
True if the file was saved, false otherwise.

code: bool SaveNativeArchive ( const [FString](API\Runtime\Core\Containers\FString) & InArchiveFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Save the word count report for the current state of the manifest and archives to disk.
True if the file was saved, false otherwise.

code: bool SaveWordCountReport ( const [FDateTime](API\Runtime\Core\Misc\FDateTime) & InTimestamp, const [FString](API\Runtime\Core\Containers\FString) & InReportFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError ) const


description:
Attempt to serialize the entire manifest to an input json object
True if the serialization succeeds false otherwise.

code: bool SerializeManifestToJson ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObject )


description: Set the optional copyright notice to insert into files that support it.

code: void SetCopyrightNotice ( const [FString](API\Runtime\Core\Containers\FString) & InCopyrightNotice )


description: Are we splitting localization data per-platform?

code: bool ShouldSplitPlatformData() const


description: Trim the given archive by remove any entries that no longer exist in the manifest.

code: void TrimArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture )


description: Trim the currently loaded manifest by remove all dependency entries from it.

code: void TrimManifest()


description: Update an existing source text entry in the manifest.

code: void UpdateSourceText ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > & InOldEntry, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > & InNewEntry )


description:
Update an existing translation in the given archive.
Returns true if it was updated successfully, false otherwise.

code: bool UpdateTranslation ( 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 )


description: Update an existing translation in the given archive.

code: void UpdateTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchiveEntry](API\Runtime\Core\Internationalization\FArchiveEntry) > & InOldEntry, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchiveEntry](API\Runtime\Core\Internationalization\FArchiveEntry) > & InNewEntry )


description: Non-copyable

code: FLocTextHelper &40; const FLocTextHelper & &41;


description: This kind of helper is only suitable for dealing with manifests,notarchives.

code: FLocTextHelper ( [FString](API\Runtime\Core\Containers\FString) InTargetName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILocFileNotifies](API\Developer\Localization\ILocFileNotifies) > InLocFileNotifies, const [ELocTextPlatformSplitMode](API\Developer\Localization\ELocTextPlatformSplitMode) InPlatformSplitMode )


description: Nothing is loaded or created at this point.

code: FLocTextHelper ( [FString](API\Runtime\Core\Containers\FString) InTargetPath, [FString](API\Runtime\Core\Containers\FString) InManifestName, [FString](API\Runtime\Core\Containers\FString) InArchiveName, [FString](API\Runtime\Core\Containers\FString) InNativeCulture, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > InForeignCultures, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILocFileNotifies](API\Developer\Localization\ILocFileNotifies) > InLocFileNotifies, const [ELocTextPlatformSplitMode](API\Developer\Localization\ELocTextPlatformSplitMode) InPlatformSplitMode )


className: FLocTextHelper

description: High-level access to the non-compiled localization resources (manifests and archives) in a way that abstracts some of their quirks. Each instance gives access to a single localization target consisting of a single manifest and several archives (a native archive, and one for each foreign culture).

code: class FLocTextHelper


description: Get the platforms names that should be split, based on the given split mode

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetPlatformsToSplit ( const [ELocTextPlatformSplitMode](API\Developer\Localization\ELocTextPlatformSplitMode) & InSplitMode )


description: True if the given split mode is actually splitting localization data

code: static bool ShouldSplitPlatformData ( const [ELocTextPlatformSplitMode](API\Developer\Localization\ELocTextPlatformSplitMode) & InSplitMode )


className: FLocTextPlatformSplitUtils

description: Utilities to get manage platforms to split.

code: struct FLocTextPlatformSplitUtils


description:
Add a new row and get its data.
The row data.

code: [FRowData](API\Developer\Localization\FLocTextWordCounts\FRowData) & AddRow ( int32 * OutIndex )


className: ColHeadingDateTime

description: Constant column headings for the CSV.

code: static const [FString](API\Runtime\Core\Containers\FString) ColHeadingDateTime = TEXT("Date/Time");


className: ColHeadingWordCount

code: static const [FString](API\Runtime\Core\Containers\FString) ColHeadingWordCount = TEXT("Word Count");


description:
Populate this word count report from a CSV string (clears any existing data).
True if the CSV string was imported, false otherwise.

code: bool FromCSV ( const [FString](API\Runtime\Core\Containers\FString) & InCSVString, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


code: void ResetWordCounts&40;&41;


code: bool IdenticalWordCounts &40; const FRowData & InOther &41; const


className: FRowData

description: Data representing a single word count row

code: struct FRowData

PerCultureWordCounts

type: TMap<FString, ...

Timestamp

type: FDateTime


description:
Get the data for a row from its index.
The row data, or null if no row exists with that index.

code: [FRowData](API\Developer\Localization\FLocTextWordCounts\FRowData) * GetRow ( const int32 InIndex )


code: const [FRowData](API\Developer\Localization\FLocTextWordCounts\FRowData) * GetRow ( const int32 InIndex ) const


description: The number of rows in this report.

code: int32 GetRowCount() const


description:
Write this word count report to a CSV string.
A string containing this report in CSV format.


description: Trim entries from the report for the cases where the word counts haven't changed between consecutive rows (as ordered by date).

code: void TrimReport()


className: FLocTextWordCounts

description: Class that manages the word count reporting of the various cultures.

code: class FLocTextWordCounts


code: bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const


className: FMetaDataKeyGatherSpecification

code: struct FMetaDataKeyGatherSpecification

MetaDataKey

type: FMetaDataKeyNam...

description: The metadata key for which values will be gathered as text.

TextKeyPattern

type: FMetaDataTextKe...

description: The pattern which will be formatted to form the localization key for the metadata value gathered as text.

TextNamespace

type: FString

description: The localization namespace in which the gathered text will be output.


className: FMetaDataKeyName

code: struct FMetaDataKeyName


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetPossiblePlaceHolders()


className: FMetaDataTextKeyPattern

code: struct FMetaDataTextKeyPattern


description: Retrieves the country info of the culture


description: Retrieves the display name for the language.


description: Retrieves the English name for the language.


description: Retrieves the culture equivalent that matches the set language code.

code: FCulturePtr GetCulture() const


description: Retrieves the language code

code: const [FString](API\Runtime\Core\Containers\FString) & GetLanguageCode() const


description: Retrieves the language plural forms.


description: Checks to see if we have a language code and if we were able to match a culture to that code

code: bool IsValid() const


description: Retrieves the two or three letter language code for the culture


description: Sets the language code

code: void SetLanguageCode ( const [FString](API\Runtime\Core\Containers\FString) & LangCode )


description: Sets the language plural forms. This is only required if we wish to override the default plural forms associated with a language.

code: void SetPluralForms ( const [FString](API\Runtime\Core\Containers\FString) & InPluralForms )


description: Retrieves the variant info for the culture


code: FPortableObjectCulture ( const [FString](API\Runtime\Core\Containers\FString) & LangCode, const [FString](API\Runtime\Core\Containers\FString) & PluralForms )


className: FPortableObjectEntries

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [FPortableObjectEntryKey](API\Developer\Localization\FPortableObjectEntryKey), [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > > FPortableObjectEntries


className: FPortableObjectCulture

description: Class for handling language codes used in the Portable Object format.

code: class FPortableObjectCulture


description: Helper function that adds to the extracted comments.

code: void AddExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & InComment )


code: void AddExtractedComments ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InComments )


description: Helper function that adds to the reference comments.

code: void AddReference ( const [FString](API\Runtime\Core\Containers\FString) & InReference )


code: void AddReferences ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InReferences )


description: Helper function that adds to the translator comments.

code: void AddTranslatorComment ( const [FString](API\Runtime\Core\Containers\FString) & InComment )


code: void AddTranslatorComments ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InComments )


description:
Function to convert the entry to a string.
String representing the entry that can be written directly to the .po file.


className: FPortableObjectEntry

description: Class for representing entries in a Portable Object file(.po) or a Portable Object Template file(.pot).

code: class FPortableObjectEntry : public [FPortableObjectEntryKey](API\Developer\Localization\FPortableObjectEntryKey)

ExtractedComments

type: TArray<FString...

MsgStr

description: Represents the translated text.

UnknownElements

description: Stores any unknown elements we may encounter when processing a Portable Object file.


code: bool operator== ( const [FPortableObjectEntryKey](API\Developer\Localization\FPortableObjectEntryKey) & Other ) const


code: FPortableObjectEntryKey ( const [FString](API\Runtime\Core\Containers\FString) & InMsgId, const [FString](API\Runtime\Core\Containers\FString) & InMsgIdPlural, const [FString](API\Runtime\Core\Containers\FString) & InMsgCtxt )


className: FPortableObjectEntryKey

description: Class for representing the key of an entry in a Portable Object file(.po) or a Portable Object Template file(.pot).

code: class FPortableObjectEntryKey

MsgCtxt

description: Represents the disambiguating context for the source text.

MsgId

description: Represents the original source text(also called the id or context).

MsgIdPlural

description: Represents the plural form of the source text.


description:
Adds a translation entry to the Portable Object.
Returns true if successful, false otherwise.

code: bool AddEntry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > LocEntry )


description: Creates a header entry based on the project and language info.

code: void CreateNewHeader ( const [FString](API\Runtime\Core\Containers\FString) & InCopyrightNotice )


description: Returns the Portable Object entry that matches the passed in entry or NULL if not found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > FindEntry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > LocEntry ) const


description: Returns the Portable Object file entry that matches the passed in parameters or NULL if not found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > FindEntry ( const [FString](API\Runtime\Core\Containers\FString) & MsgId, const [FString](API\Runtime\Core\Containers\FString) & MsgIdPlural, const [FString](API\Runtime\Core\Containers\FString) & MsgCtxt ) const


description:
Parses Portable Object elements from a string.
Returns true if successful, false otherwise.

code: bool FromString ( const [FString](API\Runtime\Core\Containers\FString) & InStr, [FText](API\Runtime\Core\Internationalization\FText) * OutErrorMsg )


description: Sets the project name from the Project-Id-Version header entry


code: [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & operator= ( const [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & )


description: Must be called after CreateNewHeader.

code: void SetHeaderValue ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey, const [FString](API\Runtime\Core\Containers\FString) & EntryValue )


description:
Sets the language.
Returns true if the function was able to successfully set the language code and pair it with a known culture, false otherwise.

code: bool SetLanguage ( const [FString](API\Runtime\Core\Containers\FString) & LanguageCode, const [FString](API\Runtime\Core\Containers\FString) & LangPluralForms )


description: Sets the project name that will appear in the Project-Id-Version header entry

code: void SetProjectName ( const [FString](API\Runtime\Core\Containers\FString) & ProjName )


description:
Creates a string representation of the Portable Object.
String representing the Portable Object that can be written directly to a file.


code: FPortableObjectFormatDOM ( const [FString](API\Runtime\Core\Containers\FString) & LanguageCode )


description: Copying is not supported

code: FPortableObjectFormatDOM ( const [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & )


className: FPortableObjectFormatDOM

description: Contains all the info we need to represent files in the Portable Object format.

code: class FPortableObjectFormatDOM


description: Clears the header entries.

code: void Clear()


className: FPOHeaderData

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FPOHeaderEntry](API\Developer\Localization\FPortableObjectHeader\FPOHeaderEntry) > FPOHeaderData


className: FPOHeaderEntry

code: typedef TPair< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > FPOHeaderEntry


description:
Parses out header info from aFPortableObjectEntrywith an empty ID.
Returns true if successful, false otherwise.

code: bool FromLocPOEntry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > LocEntry )


description:
Parses out header key/value pair entries.
Returns true if successful, false otherwise.

code: bool FromString ( const [FString](API\Runtime\Core\Containers\FString) & InStr )


description: Gets the header entry value for the given key or the empty string if the key does not exist

code: [FString](API\Runtime\Core\Containers\FString) GetEntryValue ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey ) const


description: Checks if a header entry exists with the given key

code: bool HasEntry ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey ) const


description: Sets a header entry value

code: void SetEntryValue ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey, const [FString](API\Runtime\Core\Containers\FString) & EntryValue )


description:
Creates a string representation of the Portable Object header.
String representing the header that can be written directly to the .po file.


description: Puts the current time into POT-Creation-Date and PO-Revision-Date entries

code: void UpdateTimeStamp()


className: FPortableObjectHeader

description: Class that stores and manipulates PO and POT file header info.

code: class FPortableObjectHeader

Comments

description: Stores the header comment block

HeaderEntries

type: FPOHeaderData

description: Stores all the header key/value pairs


description: Given a loc text helper, generate a compiled LocMeta resource.

code: static bool GenerateLocMeta ( const [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InResourceName, [FTextLocalizationMetaDataResource](API\Runtime\Core\Internationalization\FTextLocalizationMetaDataResourc-) & OutLocMeta )


description: Given a loc text helper, generate a compiled LocRes resource for the given culture.

code: static bool GenerateLocRes ( const [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InCultureToGenerate, const [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) InGenerateFlags, const [FTextKey](API\Runtime\Core\Internationalization\FTextKey) & InLocResID, [FTextLocalizationResource](API\Runtime\Core\Internationalization\FTextLocalizationResource) & OutPlatformAgnosticLocRes, [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextLocalizationResource](API\Runtime\Core\Internationalization\FTextLocalizationResource) >> & OutPerPlatformLocRes, const int32 InPriority )


description: Given a config file, generate a compiled LocRes resource for the active culture and use it to update the live-entries in the localization manager.

code: static bool GenerateLocResAndUpdateLiveEntriesFromConfig ( const [FString](API\Runtime\Core\Containers\FString) & InConfigFilePath, const [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) InGenerateFlags )


className: FTextLocalizationResourceGenerator

description: Utility functions for generating compiled LocMeta (Localization MetaData Resource) and LocRes (Localization Resource) files from source localization data


code: bool FromJsonFile ( const TCHAR * InFilename )


description: Load the settings from a JSON object/file.

code: bool FromJsonObject ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObject )


code: bool FromJsonString ( const [FString](API\Runtime\Core\Containers\FString) & InJsonString )


description: Initialize the NativeCulture and CulturesToGenerate values based on the settings of the currently loaded Unreal project.

code: void InitializeFromProject ( const ELocalizedTextSourceCategory LocalizationCategory )


code: bool ToJsonFile ( const TCHAR * InFilename ) const


description: Save the settings to a JSON object/file.

code: bool ToJsonObject ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & OutJsonObject ) const


code: bool ToJsonString ( [FString](API\Runtime\Core\Containers\FString) & OutJsonString ) const


description: Validate that this descriptor isn't using cultures that aren't present in the CulturesToGenerate of the given default.

code: bool Validate ( const [FUserGeneratedContentLocalizationDescriptor](API\Developer\Localization\FUserGeneratedContentLocalizatio-) & DefaultDescriptor )


description: Minimal descriptor needed to generate a localization target for UGC localization.

CulturesToGenerate

description: The cultures that we should generate localization data for.

NativeCulture

description: The culture that the source text is authored in.

PoFormat

type: EPortableObject...

description: What format of PO file should we use?


code: static [ILocalizationModule](API\Developer\Localization\ILocalizationModule) & Get()


code: [ULocalizationTarget](API\Developer\Localization\ULocalizationTarget) * GetLocalizationTargetByName ( [FString](API\Runtime\Core\Containers\FString) TargetName, bool bIsEngineTarget )


description: Given a config file, generate a compiled LocRes file for the active culture and use it to update the live-entries in the localization manager.

code: bool HandleRegenLocCommand ( const [FString](API\Runtime\Core\Containers\FString) & InConfigFilePath )


className: ILocalizationModule

code: class ILocalizationModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Called after reading the given file from disk

code: void PostFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Called after writing the given file to disk

code: void PostFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Called prior to reading the given file on disk

code: void PreFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Called prior to writing the given file to disk

code: void PreFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Virtual destructor

code: virtual ~ILocFileNotifies()


className: ILocFileNotifies

description: Interface for the loc file notify API. This can be used to integrate with services like source control.

code: class ILocFileNotifies


className: operator&

code: constexpr [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) operator& ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )


code: constexpr [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) operator& ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )


className: operator&=

code: [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & operator&= ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )


code: [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & operator&= ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )


className: operator~

code: constexpr [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) operator~ ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) E )


code: constexpr [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) operator~ ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) E )


className: operator^

code: constexpr [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) operator^ ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )


code: constexpr [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) operator^ ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )


className: operator^=

code: [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & operator^= ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )


code: [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & operator^= ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )


className: operator!

code: constexpr bool operator! ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) E )


code: constexpr bool operator! ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) E )


description: Given a key string, condition it so it can be written as the extracted comment field of a PO file

code: namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::GetConditionedKeyForExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & Key ) }


description: Given a source location string, condition it so it can be written as the extracted comment field of a PO file

code: namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::GetConditionedReferenceForExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & PORefString ) }


description: Given a meta-data value string, condition it so it can be written as the extracted comment field of a PO file

code: namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::GetConditionedInfoMetaDataForExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & KeyName, const [FString](API\Runtime\Core\Containers\FString) & ValueString ) }


description: Given a namespace and key, condition this information so it can be written to the "msgctxt" or "msgid" field of a PO file

code: namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::ConditionIdentityForPO ( const [FString](API\Runtime\Core\Containers\FString) & Namespace, const [FString](API\Runtime\Core\Containers\FString) & Key, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & KeyMetaData, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode ) }


description: Given the field of a PO file, condition it back to a clean string

code: namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::ConditionPOStringForArchive ( const [FString](API\Runtime\Core\Containers\FString) & InStr ) }


description: Given a string, condition it so it can be written as a field of a PO file

code: namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::ConditionArchiveStrForPO ( const [FString](API\Runtime\Core\Containers\FString) & InStr ) }


description: Use the given LocTextHelper to generate a new PO file using the translation data for the given culture

code: namespace PortableObjectPipeline { bool PortableObjectPipeline::Export ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InPOFilePath, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat, const bool bShouldPersistComments ) }


description: Use the given LocTextHelper to generate a new PO file using the translation data for all cultures

code: namespace PortableObjectPipeline { bool PortableObjectPipeline::ExportAll ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InPOCultureRootPath, const [FString](API\Runtime\Core\Containers\FString) & InPOFilename, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat, const bool bShouldPersistComments, const bool bUseCultureDirectory ) }


description: Update the given LocTextHelper with the translation data imported from the PO file for the given culture

code: namespace PortableObjectPipeline { bool PortableObjectPipeline::Import ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InPOFilePath, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }


description: Update the given LocTextHelper with the translation data imported from the PO file for all cultures

code: namespace PortableObjectPipeline { bool PortableObjectPipeline::ImportAll ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InPOCultureRootPath, const [FString](API\Runtime\Core\Containers\FString) & InPOFilename, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat, const bool bUseCultureDirectory ) }


description: Parse the basic data (msgctxt, msgid, msgstr) from a PO entry

code: namespace PortableObjectPipeline { void PortableObjectPipeline::ParseBasicPOFileEntry ( const [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) & POEntry, [FString](API\Runtime\Core\Containers\FString) & OutNamespace, [FString](API\Runtime\Core\Containers\FString) & OutKey, [FString](API\Runtime\Core\Containers\FString) & OutSourceString, [FString](API\Runtime\Core\Containers\FString) & OutTranslation, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }


description: Given the "msgctxt" or "msgid" field of a PO file, split it into the namespace and key

code: namespace PortableObjectPipeline { void PortableObjectPipeline::ParseIdentityFromPO ( const [FString](API\Runtime\Core\Containers\FString) & InIdentity, [FString](API\Runtime\Core\Containers\FString) & OutNamespace, [FString](API\Runtime\Core\Containers\FString) & OutKey ) }


description: Given the collapse mode and PO format, append any extra required meta-data to the PO file header

code: namespace PortableObjectPipeline { void PortableObjectPipeline::UpdatePOFileHeaderForSettings ( [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & PortableObject, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }


description: Populate the basic data (msgctxt, msgid, msgstr) within a PO entry

code: namespace PortableObjectPipeline { void PortableObjectPipeline::PopulateBasicPOFileEntry ( [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) & POEntry, const [FString](API\Runtime\Core\Containers\FString) & InNamespace, const [FString](API\Runtime\Core\Containers\FString) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetaData, const [FString](API\Runtime\Core\Containers\FString) & InSourceString, const [FString](API\Runtime\Core\Containers\FString) & InTranslation, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }


description:
Deserializes an archive from a JSON file.
true if deserialization was successful, false otherwise.

code: static bool DeserializeArchiveFromFile ( const [FString](API\Runtime\Core\Containers\FString) & InJsonFile, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )


description:
Deserializes an archive from a JSON string.
true if deserialization was successful, false otherwise.

code: static bool DeserializeArchive ( const [FString](API\Runtime\Core\Containers\FString) & InStr, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )


description:
Deserializes an archive from a JSON object.
true if deserialization was successful, false otherwise.

code: static bool DeserializeArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )


code: static bool DeserializeInternal ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )


description: Takes a Internationalization archive and arranges the data into a hierarchy based on namespace.

code: static void GenerateStructuredData ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStructuredArchiveEntry](API\Developer\Localization\Serialization\FStructuredArchiveEntry) > RootElement )


description:
Recursive function that will traverse the JSON object and populate an archive.
true if successful, false otherwise.

code: static bool JsonObjToArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, const [FString](API\Runtime\Core\Containers\FString) & ParentNamespace, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )


code: static const [FString](API\Runtime\Core\Containers\FString) NAMESPACE_DELIMITER = TEXT(".");


description:
Serializes an archive to a JSON object.
true if serialization was successful, false otherwise.

code: static bool SerializeArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj )


description:
Serializes an archive to a JSON string.
true if serialization was successful, false otherwise.

code: static bool SerializeArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [FString](API\Runtime\Core\Containers\FString) & Str )


code: static bool SerializeArchiveToFile ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, const [FString](API\Runtime\Core\Containers\FString) & InJsonFile )


description:
Convert a Internationalization archive to a JSON object.
true if serialization was successful, false otherwise.

code: static bool SerializeInternal ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj )


description: Goes through the structured, hierarchy based, archive data and does a non-culture specific sort on namespaces and default text.

code: static void SortStructuredData ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStructuredArchiveEntry](API\Developer\Localization\Serialization\FStructuredArchiveEntry) > InElement )


description: Populates a JSON object from Internationalization archive data that has been structured based on namespace.

code: static void StructuredDataToJsonObj ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FStructuredArchiveEntry](API\Developer\Localization\Serialization\FStructuredArchiveEntry) > InElement, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj )


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_CHILDREN = TEXT("Children");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_DEPRECATED_TRANSLATEDTEXT = TEXT("TranslatedText");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_DEPRECATED_DEFAULTTEXT = TEXT("DefaultText");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_FORMATVERSION = TEXT("FormatVersion");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_KEY = TEXT("Key");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_METADATA = TEXT("MetaData");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_METADATA_KEY = TEXT("Key");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_NAMESPACE = TEXT("Namespace");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_OPTIONAL = TEXT("Optional");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_SOURCE = TEXT("Source");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_SOURCE_TEXT = TEXT("Text");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_SUBNAMESPACES = TEXT("Subnamespaces");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_TRANSLATION = TEXT("Translation");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_TRANSLATION_TEXT = FJsonInternationalizationArchiveSerializer::TAG_SOURCE_TEXT;


description: Implements a serializer that serializes to and from Json encoded data.


description:
Convert a JSON object to a Internationalization manifest.
true if deserialization was successful, false otherwise.

code: static bool DeserializeInternal ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, const [FName](API\Runtime\Core\UObject\FName) PlatformName )


description:
Deserializes a Internationalization manifest from a JSON string.
true if deserialization was successful, false otherwise.

code: static bool DeserializeManifest ( const [FString](API\Runtime\Core\Containers\FString) & InStr, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, const [FName](API\Runtime\Core\UObject\FName) PlatformName )


description:
Deserializes a Internationalization manifest from a JSON file.
true if deserialization was successful, false otherwise.

code: static bool DeserializeManifestFromFile ( const [FString](API\Runtime\Core\Containers\FString) & InJsonFile, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, const [FName](API\Runtime\Core\UObject\FName) PlatformName )


description:
Deserializes a Internationalization manifest from a JSON object.
true if deserialization was successful, false otherwise.

code: static bool DeserializeManifest ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, const [FName](API\Runtime\Core\UObject\FName) PlatformName )


description: Takes a Internationalization manifest and arranges the data into a hierarchy based on namespace.

code: static void GenerateStructuredData ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStructuredEntry](API\Developer\Localization\Serialization\FStructuredEntry) > RootElement )


description:
Recursive function that will traverse the JSON object and populate a Internationalization manifest.
true if successful, false otherwise.

code: static bool JsonObjToManifest ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [FString](API\Runtime\Core\Containers\FString) InNamespace, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, const [FName](API\Runtime\Core\UObject\FName) PlatformName )


code: static const [FString](API\Runtime\Core\Containers\FString) NAMESPACE_DELIMITER = TEXT(".");


description:
Convert a Internationalization manifest to a JSON object.
true if serialization was successful, false otherwise.

code: static bool SerializeInternal ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj )


description:
Serializes a Internationalization manifest to a JSON string.
true if serialization was successful, false otherwise.

code: static bool SerializeManifest ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, [FString](API\Runtime\Core\Containers\FString) & Str )


description:
Serializes a Internationalization manifest to a JSON file.
true if serialization was successful, false otherwise.

code: static bool SerializeManifestToFile ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, const [FString](API\Runtime\Core\Containers\FString) & InJsonFile )


description:
Serializes a Internationalization manifest to a JSON object.
true if serialization was successful, false otherwise.

code: static bool SerializeManifest ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > Manifest, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj )


description: Goes through the structured, hierarchy based, manifest data and does a non-culture specific sort on namespaces, default text, and key.

code: static void SortStructuredData ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStructuredEntry](API\Developer\Localization\Serialization\FStructuredEntry) > InElement )


description: Populates a JSON object from Internationalization manifest data that has been structured based on namespace.

code: static void StructuredDataToJsonObj ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FStructuredEntry](API\Developer\Localization\Serialization\FStructuredEntry) > InElement, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj )


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_CHILDREN = TEXT("Children");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_DEPRECATED_DEFAULTTEXT = TEXT("DefaultText");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_FORMATVERSION = TEXT("FormatVersion");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_KEY = TEXT("Key");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_KEYCOLLECTION = TEXT("Keys");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_METADATA = TEXT("MetaData");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_METADATA_INFO = TEXT("Info");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_METADATA_KEY = TEXT("Key");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_OPTIONAL = TEXT("Optional");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_NAMESPACE = TEXT("Namespace");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_PATH = TEXT("Path");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_PLATFORM_NAME;


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_SOURCE = TEXT("Source");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_SOURCE_TEXT = TEXT("Text");


code: static const [FString](API\Runtime\Core\Containers\FString) TAG_SUBNAMESPACES = TEXT("Subnamespaces");


description: Deserializes manifest metadata from a JSON object.

code: static void DeserializeMetadata ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & OutMetadataObj )


description: Utility function that will convert metadata to string using the JSON metadata serializers.

code: static [FString](API\Runtime\Core\Containers\FString) MetadataToString ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > Metadata )


description: Serializes manifest metadata object to a JSON object.

code: static void SerializeMetadata ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > Metadata, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & OutJsonObj )


code: FStructuredArchiveEntry ( const [FString](API\Runtime\Core\Containers\FString) & InNamespace )


className: FStructuredArchiveEntry

description: Used to arrange Internationalization archive data in a hierarchy based on namespace prior to json serialization.

code: struct FStructuredArchiveEntry

ArchiveEntries

type: TArray<TShared...

Namespace

type: constFString


code: FStructuredEntry ( const [FString](API\Runtime\Core\Containers\FString) & InNamespace )


className: FStructuredEntry

code: struct FStructuredEntry


code: static [ULocalizationTargetSet](API\Developer\Localization\ULocalizationTargetSet) * GetEngineTargetSet()


code: static [ULocalizationTargetSet](API\Developer\Localization\ULocalizationTargetSet) * GetGameTargetSet()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


code: ULocalizationSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: ULocalizationSettings

description: Class for loading/saving configuration settings and the details view objects needed for localization dashboard functionality.

code: class ULocalizationSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: bool DeleteFiles ( const [FString](API\Runtime\Core\Containers\FString) *const Culture ) const


code: bool IsMemberOfEngineTargetSet() const


code: bool RenameTargetAndFiles ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


code: void UpdateStatusFromConflictReport()


code: bool UpdateWordCountsFromCSV()


className: ULocalizationTarget

code: class ULocalizationTarget : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Settings

type: FLocalizationTa...


className: ULocalizationTargetSet

code: class ULocalizationTargetSet : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

TargetObjects

type: TArray<TObject...


description:
UGC localization can be used to provide a simplified localization experience for basic plugins (only providing the PO files to be translated), and is primarily designed for DLC plugins where the UGC localization will be compiled during cook (
Support for non-DLC plugins can be provided via project specific tooling built upon this base API. Support for complex plugins (such as those containing different kinds of modules, eg) a mix of game/engine and editor) are not supported via this API.

code: namespace UserGeneratedContentLocalization { enum ELoadLocalizationResult { NoData, Failed, Success, } }


description: Settings controlling UGC localization.

code: class UUserGeneratedContentLocalizationSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bCompileDLCLocalizationDuringCook

type: bool

description: Should we compile UGC localization (if present) for DLC plugins during cook?

bValidateDLCLocalizationDuringCook

description: Should we validate UGC localization (if present) for DLC plugins during cook?

CulturesToDisable

description: List of cultures that should be disabled for UGC localization.


description: Results of a command execution

module: LocalizationService

code: namespace ELocalizationServiceOperationCommandResult { enum Type { Failed, Succeeded, Cancelled, } }


description: Hint to provider when updating state

code: namespace ELocalizationServiceCacheUsage { enum Type { ForceUpdate, Use, } }


description: The modality of the login window.

code: namespace ELocalizationServiceLoginWindowMode { enum Type { Modal, Modeless, } }


description: Login window startup behavior

code: namespace ELocalizationServiceOnLoginWindowStartup { enum Type { ResetProviderToNone, PreserveProvider, } }


description: Hint for how to execute the operation. Note that asynchronous operations requireTick()to be called to manage completed operations.

code: namespace ELocalizationServiceOperationConcurrency { enum Type { Synchronous, Asynchronous, } }


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetErrorText() const


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


description: Get the name of this operation, used as a unique identifier

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetPassword() const


code: void SetErrorText ( const [FText](API\Runtime\Core\Internationalization\FText) & InErrorText )


code: void SetPassword ( const [FString](API\Runtime\Core\Containers\FString) & InPassword )


className: FConnectToProvider

description: Operation used to connect (or test a connection) to localization service

code: class FConnectToProvider : public [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation)

OutErrorText

type: FText

description: Error text for easy diagnosis

Password

description: Password we use for this operation


code: const [FString](API\Runtime\Core\Containers\FString) & GetInRelativeOutputFilePathAndName() const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetInTargetGuid() const


code: void SetInLocale ( [FString](API\Runtime\Core\Containers\FString) NewLocale )


code: void SetInRelativeOutputFilePathAndName ( const [FString](API\Runtime\Core\Containers\FString) & NewInRelativeOutputFilePathAndName )


code: void SetInTargetGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NewInTargetGuid )


code: void SetOutErrorText ( const [FText](API\Runtime\Core\Internationalization\FText) & NewOutErrorText )


className: FDownloadLocalizationTargetFile

description: Operation used to download a localization target file from a localization service

code: class FDownloadLocalizationTargetFile : public [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation)

InLocale

description: The locale (culture code, for example "fr" or "en-us" or "ja-jp") to download the translations for

InRelativeOutputFilePathAndName

description: The path and name to the file downloaded, relative to project directory

InTargetGuid

type: FGuid

description: The GUID of the Localization Target

OutErrorText

description: Place to easily store and access error message


className: FGetLocalizationServiceOperation


className: FLocalizationServiceLoginClosed

description: Delegate called when the localization service login window is closed. Parameter determines if service is enabled or not

code: typedef TBaseDelegate_OneParam< void, bool > FLocalizationServiceLoginClosed


className: FLocalizationServiceOperationComplete

description: Delegate used by providers for when operations finish

code: typedef TBaseDelegate_TwoParams< void, const [FLocalizationServiceOperationRef](API\Developer\LocalizationService\FLocalizationServiceOperationRef) &, [ELocalizationServiceOperationCommandResult::Type](API\Developer\LocalizationService\ELocalizationSer-) > FLocalizationServiceOperationComplete


className: FLocalizationServiceOperationRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > FLocalizationServiceOperationRef


className: FLocalizationServiceOperationSharedRef

description: Delegate used by providers to create localization service operations

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > FLocalizationServiceOperationSharedRef


className: FLocalizationServiceStateRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILocalizationServiceState](API\Developer\LocalizationService\ILocalizationServiceState), ESPMode::ThreadSafe > FLocalizationServiceStateRef


className: FLocalizationServiceStatePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILocalizationServiceState](API\Developer\LocalizationService\ILocalizationServiceState), ESPMode::ThreadSafe > FLocalizationServiceStatePtr


code: FLocalizationServiceTranslationIdentifier ( FCulturePtr InCulturePtr, const [FString](API\Runtime\Core\Containers\FString) & InNamespace, const [FString](API\Runtime\Core\Containers\FString) & InSource )


Culture

type: FCulturePtr


description: Get the provider we are using


description: Constructor; Initializes localization service Provider

code: FScopedLocalizationService()


description: Destructor; Closes localization service Provider

code: ~FScopedLocalizationService()


className: FScopedLocalizationService

description: Helper class that ensures FLocalizationService is properly initialized and shutdown by calling Init/Close in its constructor/destructor respectively.

code: class FScopedLocalizationService


description: Makes sure the dialog is ticked

code: void Tick()


description: Constructor. Progress dialog is shown immediately (if possible) and is closed when this object goes out of scope.

code: FScopedLocalizationServiceProgress ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const FSimpleDelegate & InOnCancelled )


description: Destructor - closes the dialog

code: ~FScopedLocalizationServiceProgress()


className: FScopedLocalizationServiceProgress


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetInRelativeInputFilePathAndName() const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetInTargetGuid() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: bool GetPreserveAllText()


code: void SetInLocale ( [FString](API\Runtime\Core\Containers\FString) NewLocale )


code: void SetInRelativeInputFilePathAndName ( const [FString](API\Runtime\Core\Containers\FString) & NewInRelativeInputFilePathAndName )


code: void SetInTargetGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NewInTargetGuid )


code: void SetOutErrorText ( const [FText](API\Runtime\Core\Internationalization\FText) & NewOutErrorText )


code: void SetPreserveAllText ( bool NewPreserveAllText )


code: FUploadLocalizationTargetFile()


className: FUploadLocalizationTargetFile

description: Operation used to upload a localization file to a localization service

code: class FUploadLocalizationTargetFile : public [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation)

bPreserveAllText

description: Ask the translations service to keep all text, even if not present in the current upload file.

InRelativeInputFilePathAndName

description: The path and name to the file to upload, relative to project directory

InTargetGuid

description: The GUID of the Localization Target


description:
Gets a reference to the localization service module instance.
A reference to the localization service module.

code: static [ILocalizationServiceModule](API\Developer\LocalizationService\ILocalizationServiceModule) & Get()


description:
Get whether we should use global or per-project settings
true if we should use global settings

code: bool GetUseGlobalSettings() const


description: Get the localization service provider that is currently in use.

code: [ILocalizationServiceProvider](API\Developer\LocalizationService\ILocalizationServiceProvider) & GetProvider() const


description: Check whether localization service is enabled.

code: *virtual bool IsEnabled() const


code: *virtual void QueueStatusUpdate ( const [TArray](API\Runtime\Core\Containers\TArray)< [FLocalizationServiceTranslationIdentifier](API\Developer\LocalizationService\FLocalizationServiceTranslationI-) > & InTranslationIds )


description: Set the current localization service provider to the one specified here by name. This will assert if the provider does not exist.

code: void SetProvider ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Set whether we should use global or per-project settings

code: void SetUseGlobalSettings ( bool bIsUseGlobalSettings )


description: Tick the localization service module. This is responsible for dispatching batched/queued status requests & for callingILocalizationServiceProvider::Tick()

code: void Tick()


className: ILocalizationServiceModule

description: Interface for talking to localization service providers

code: class ILocalizationServiceModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Factory method for easier operation creation

code: template<typename Type> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< Type, ESPMode::ThreadSafe > Create()


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


description: Get the name of this operation, used as a unique identifier


description: Virtual destructor


className: ILocalizationServiceOperation

code: class ILocalizationServiceOperation : public [TSharedFromThis< ILocalizationServiceOperation, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: Attempt to cancel an operation in progress.

code: void CancelOperation ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > & InOperation )


description:
Check to see if we can cancel an operation.
true if the operation was cancelled.

code: bool CanCancelOperation ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > & InOperation ) const


description: Shut down localization service provider.

code: void Close()


description:
Create a settings widget for display in the localization dashboard.
a widget used to edit project-specific localization service settings.

code: void CustomizeSettingsDetails ( [IDetailCategoryBuilder](API\Editor\PropertyEditor\IDetailCategoryBuilder) & DetailCategoryBuilder ) const


description:
Create a settings widget for display in the localization target editor.
a widget used to edit target-specific localization service settings.

code: void CustomizeTargetDetails ( [IDetailCategoryBuilder](API\Editor\PropertyEditor\IDetailCategoryBuilder) & DetailCategoryBuilder, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [ULocalizationTarget](API\Developer\Localization\ULocalizationTarget) > LocalizationTarget ) const


description:
Create a settings widget for display in the localization target set editor.
a widget used to edit target set-specific localization service settings.

code: void CustomizeTargetSetToolbar ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > & MenuExtender, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [ULocalizationTargetSet](API\Developer\Localization\ULocalizationTargetSet) > LocalizationTargetSet ) const


code: void CustomizeTargetToolbar ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > & MenuExtender, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [ULocalizationTarget](API\Developer\Localization\ULocalizationTarget) > LocalizationTarget ) const


description: Helper overload for operation execution, seeExecute().

code: virtual [ELocalizationServiceOperationCommandResult::Type](API\Developer\LocalizationService\ELocalizationSer-) Execute ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > & InOperation, const [ELocalizationServiceOperationConcurrency::Type](API\Developer\LocalizationService\ELocalizationServiceOperationCon-) InConcurrency, const [FLocalizationServiceOperationComplete](API\Developer\LocalizationService\FLocalizationServiceOperationCom-) & InOperationCompleteDelegate )


description:
Attempt to execute an operation on the passed-in files (if any are required).
the result of the operation.

code: [ELocalizationServiceOperationCommandResult::Type](API\Developer\LocalizationService\ELocalizationSer-) Execute ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [FLocalizationServiceTranslationIdentifier](API\Developer\LocalizationService\FLocalizationServiceTranslationI-) > & InTranslationIds, [ELocalizationServiceOperationConcurrency::Type](API\Developer\LocalizationService\ELocalizationServiceOperationCon-) InConcurrency, const [FLocalizationServiceOperationComplete](API\Developer\LocalizationService\FLocalizationServiceOperationCom-) & InOperationCompleteDelegate )


code: virtual [ELocalizationServiceOperationCommandResult::Type](API\Developer\LocalizationService\ELocalizationSer-) Execute ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ILocalizationServiceOperation](API\Developer\LocalizationService\ILocalizationServiceOperation), ESPMode::ThreadSafe > & InOperation, const [FLocalizationServiceTranslationIdentifier](API\Developer\LocalizationService\FLocalizationServiceTranslationI-) & InTranslationId, const [ELocalizationServiceOperationConcurrency::Type](API\Developer\LocalizationService\ELocalizationServiceOperationCon-) InConcurrency, const [FLocalizationServiceOperationComplete](API\Developer\LocalizationService\FLocalizationServiceOperationCom-) & InOperationCompleteDelegate )


description: Get the localization service provider name

code: const [FName](API\Runtime\Core\UObject\FName) & GetName() const


description: Get the localization service provider display name

code: const [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const


description: Helper overload for state retrieval, seeGetState().

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILocalizationServiceState](API\Developer\LocalizationService\ILocalizationServiceState), ESPMode::ThreadSafe > GetState ( const [FLocalizationServiceTranslationIdentifier](API\Developer\LocalizationService\FLocalizationServiceTranslationI-) & InTranslationId, [ELocalizationServiceCacheUsage::Type](API\Developer\LocalizationService\ELocalizationServiceCacheUsage__-) InStateCacheUsage )


description: Get the localization service status as plain, human-readable text


description:
Get the state of each of the passed-in files. State may be cached for faster queries. Note states can be NULL!
the result of the operation.

code: [ELocalizationServiceOperationCommandResult::Type](API\Developer\LocalizationService\ELocalizationSer-) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [FLocalizationServiceTranslationIdentifier](API\Developer\LocalizationService\FLocalizationServiceTranslationI-) > & InTranslationIds, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ILocalizationServiceState](API\Developer\LocalizationService\ILocalizationServiceState), ESPMode::ThreadSafe > > & OutState, [ELocalizationServiceCacheUsage::Type](API\Developer\LocalizationService\ELocalizationServiceCacheUsage__-) InStateCacheUsage )


description: Initialize localization service provider.

code: void Init ( bool bForceConnection )


description:
Quick check if localization service is available for use (server-based providers can use this to return whether the server is available or not)
true if localization service is available, false if it is not

code: bool IsAvailable() const


description: Quick check if localization service is enabled

code: bool IsEnabled() const


description:
Login to the localization service server (if any). This is just a wrapper aroundExecute().
the result of the operation.

code: virtual [ELocalizationServiceOperationCommandResult::Type](API\Developer\LocalizationService\ELocalizationSer-) Login ( const [FString](API\Runtime\Core\Containers\FString) & InPassword, [ELocalizationServiceOperationConcurrency::Type](API\Developer\LocalizationService\ELocalizationServiceOperationCon-) InConcurrency, const [FLocalizationServiceOperationComplete](API\Developer\LocalizationService\FLocalizationServiceOperationCom-) & InOperationCompleteDelegate )


description: Called every update.

code: void Tick()


description: Virtual destructor

code: virtual ~ILocalizationServiceProvider()


className: ILocalizationServiceProvider

description: Interface to talking with localization service providers.

code: class ILocalizationServiceProvider : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Date of the revision

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetDate() const


description: String representation of the revision

code: const [FString](API\Runtime\Core\Containers\FString) & GetRevision() const


description: Number of the revision

code: int32 GetRevisionNumber() const


description: User name of the submitter

code: const [FString](API\Runtime\Core\Containers\FString) & GetUserName() const


description: Virtual destructor

code: virtual ~ILocalizationServiceRevision()


className: ILocalizationServiceRevision

description: Abstraction of a localization revision from a localization service provider.

code: class ILocalizationServiceRevision : public [TSharedFromThis< ILocalizationServiceRevision, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: Get whether localization service allows this translation to be edited

code: bool CanEdit() const


description: Get the culture for which the localization of the text is for

code: const FCulturePtr GetCulture() const


description:
Get a text representation of the state
the text to display for this state


description:
Get a tooltip to describe this state
the text to display for this states tooltip


description:
Get an item from the history
a history item or NULL if none exist

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILocalizationServiceRevision](API\Developer\LocalizationService\ILocalizationServiceRevision), ESPMode::ThreadSafe > GetHistoryItem ( int32 HistoryIndex ) const


description:
Get the size of the history. If anFUpdateStatusoperation has been called with the ShouldUpdateHistory() set, there should be history present if the file has been committed to localization service.
the number of items in the history

code: int32 GetHistorySize() const


description:
Get the name of the icon graphic we should use to display the state in a UI.
the name of the icon to display


description:
Get the name of the small icon graphic we should use to display the state in a UI.
the name of the icon to display


description: Get the text in question

code: const [FString](API\Runtime\Core\Containers\FString) & GetSourceString() const


description:
Get the timestamp of the last update that was made to this state.
the timestamp of the last update

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeStamp() const


code: *virtual const [FLocalizationServiceTranslationIdentifier](API\Developer\LocalizationService\FLocalizationServiceTranslationI-) & GetTranslationIdentifier() const


description: Get the text in question

code: const [FString](API\Runtime\Core\Containers\FString) & GetTranslationString() const


code: enum { INVALID_REVISION = -1 }


description: Get whether this translation is up-to-date with the version in localization service

code: bool IsCurrent() const


description: Get whether this text is known to the localization service


description: Get whether this file is modified compared to the version we have from localization service

code: bool IsModified() const


description: Get whether we know anything about this files localization service state

code: bool IsUnknown() const


description: Virtual destructor

code: virtual ~ILocalizationServiceState()


className: ILocalizationServiceState

description: An abstraction of the state of a file under localization service

code: class ILocalizationServiceState : public [TSharedFromThis< ILocalizationServiceState, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


className: FTimelineDebugShapes

module: LogVisualizer

code: struct FTimelineDebugShapes

Arrows

type: TArray<FDebugR...

LogEntriesPath

type: TArray< FVector...


code: void GetDebugShapes ( const [FVisualLogEntry](API\Runtime\Engine\VisualLogger\FVisualLogEntry) & EntryItem, bool bAddEntryLocationPointer, [FTimelineDebugShapes](API\Developer\LogVisualizer\AVisualLoggerRenderingActorBase\FTimelineDebugShapes) & OutDebugShapes )


description: Iterate over each activeFTimelineDebugShapes, and call callback.

code: virtual void IterateDebugShapes ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FTimelineDebugShapes](API\Developer\LogVisualizer\AVisualLoggerRenderingActorBase\FTimelineDebugShapes) &) > Callback )


code: AVisualLoggerRenderingActorBase ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AVisualLoggerRenderingActorBase

description: Transient actor used to draw visual logger data on level Base class shared between RewindDebugger and Visual Logger implementations

code: class AVisualLoggerRenderingActorBase : public [AActor](API\Runtime\Engine\GameFramework\AActor)

RenderingComponent

type: UPrimitiveCompo...


className: FGetAnimationOutlinerFillPercentageFunc

code: typedef TBaseDelegate_NoParams< float > FGetAnimationOutlinerFillPercentageFunc


className: FCategoryFilter

code: struct FCategoryFilter

bIsInUse

type: uint32:  1


code: static [FLogVisualizer](API\Developer\LogVisualizer\FLogVisualizer) & Get()


code: [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetColorForCategory ( int32 Index ) const


code: [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetColorForCategory ( const [FString](API\Runtime\Core\Containers\FString) & InFilterName ) const


code: int32 GetNextItem ( [FName](API\Runtime\Core\UObject\FName) RowName, int32 MoveDistance )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FVisualLoggerTimeSliderController > GetTimeSliderController()


code: int32 GetPreviousItem ( [FName](API\Runtime\Core\UObject\FName) RowName, int32 MoveDistance )


code: void GotoFirstItem ( [FName](API\Runtime\Core\UObject\FName) RowName )


code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * OptionalObject )


code: void GotoLastItem ( [FName](API\Runtime\Core\UObject\FName) RowName )


code: void GotoPreviousItem ( [FName](API\Runtime\Core\UObject\FName) RowName, int32 MoveDistance )


code: void GotoNextItem ( [FName](API\Runtime\Core\UObject\FName) RowName, int32 MoveDistance )


description: Static access

code: static void Initialize()


description: LogVisualizer interface

code: void Reset()


code: void SeekToTime ( float Time )


code: void SetAnimationOutlinerFillPercentage ( float FillPercentage )


code: void SetCurrentVisualizer ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class SVisualLogger > Visualizer )


className: StaticInstance

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FLogVisualizer](API\Developer\LogVisualizer\FLogVisualizer) > StaticInstance;


code: void UpdateCameraPosition ( [FName](API\Runtime\Core\UObject\FName) Rowname, int32 ItemIndes )


className: FLogVisualizer

code: struct FLogVisualizer

AnimationOutlinerFillPercentage

type: float

CurrentVisualizer

type: TWeakPtr< class...

TimeSliderController

type: TSharedPtr< FVi...

VisualLoggerEvents

type: FVisualLoggerEv...


className: FOnFilterCategoryAdded

code: typedef TMulticastDelegate_TwoParams< void, [FString](API\Runtime\Core\Containers\FString), [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) > FOnFilterCategoryAdded


className: FOnFilterCategoryRemoved

code: typedef TMulticastDelegate_OneParam< void, [FString](API\Runtime\Core\Containers\FString) > FOnFilterCategoryRemoved


className: FOnFiltersChanged

code: typedef TMulticastDelegate_NoParams< void > FOnFiltersChanged


className: FOnFiltersSearchChanged

code: typedef TBaseDelegate_OneParam< void, const [FText](API\Runtime\Core\Internationalization\FText) & > FOnFiltersSearchChanged


className: FOnKeyboardEvent

code: typedef TBaseDelegate_TwoParams< [FReply](API\Runtime\SlateCore\Input\FReply), const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) &, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & > FOnKeyboardEvent


className: FOnLogLineSelectionChanged

code: typedef TBaseDelegate_ThreeParams< void, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct FLogEntryItem >, int64, [FName](API\Runtime\Core\UObject\FName) > FOnLogLineSelectionChanged


className: FVisualLoggerEvents

code: struct FVisualLoggerEvents

GetAnimationOutlinerFillPercentageFunc

type: FGetAnimationOu...

OnFiltersChanged

type: FOnFiltersChang...

OnKeyboardEvent

type: FOnKeyboardEven...

OnLogLineSelectionChanged

type: FOnLogLineSelec...


code: void AddCategory ( [FString](API\Runtime\Core\Containers\FString) InName, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InVerbosity )


code: void DeactivateAllButThis ( const [FString](API\Runtime\Core\Containers\FString) & InName )


code: void DisableGraphData ( [FName](API\Runtime\Core\UObject\FName) GraphName, [FName](API\Runtime\Core\UObject\FName) DataName, bool SetAsDisabled )


code: static [FVisualLoggerFilters](API\Developer\LogVisualizer\FVisualLoggerFilters) & Get()


code: [FCategoryFilter](API\Developer\LogVisualizer\FCategoryFilter) & GetCategoryByName ( const [FString](API\Runtime\Core\Containers\FString) & InName )


code: [FCategoryFilter](API\Developer\LogVisualizer\FCategoryFilter) & GetCategoryByName ( const [FName](API\Runtime\Core\UObject\FName) & InName )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetSelectedObjects() const


code: void InitWith ( const [FVisualLoggerFiltersData](API\Developer\LogVisualizer\FVisualLoggerFiltersData) & NewFiltersData )


code: bool IsGraphDataDisabled ( [FName](API\Runtime\Core\UObject\FName) GraphName, [FName](API\Runtime\Core\UObject\FName) DataName )


description: whether given String represents a log category we allow to be displayed at given Verbosity

code: bool MatchCategoryFilters ( [FString](API\Runtime\Core\Containers\FString) String, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity )


code: bool MatchObjectName ( [FString](API\Runtime\Core\Containers\FString) String )


code: bool MatchSearchString ( [FString](API\Runtime\Core\Containers\FString) String )


code: void OnNewItemHandler ( const FVisualLoggerDBRow & BDRow, int32 ItemIndex )


code: void RemoveCategory ( [FString](API\Runtime\Core\Containers\FString) InName )


code: void RemoveObjectFromSelection ( [FString](API\Runtime\Core\Containers\FString) ObjectName )


code: void SelectObject ( [FString](API\Runtime\Core\Containers\FString) ObjectName )


code: void SetSearchString ( [FString](API\Runtime\Core\Containers\FString) InString )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FVisualLoggerFilters](API\Developer\LogVisualizer\FVisualLoggerFilters) > StaticInstance;


className: FVisualLoggerFilters

code: struct FVisualLoggerFilters : public [FVisualLoggerFiltersData](API\Developer\LogVisualizer\FVisualLoggerFiltersData)

OnFilterCategoryAdded

type: FOnFilterCatego...


className: FVisualLoggerFiltersData

code: struct FVisualLoggerFiltersData

Categories

type: TArray<FCatego...

ObjectNameFilter

type: FString

SelectedClasses

type: TArray<FString...


className: ILogVisualizer

code: class ILogVisualizer : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


className: FSettingChangedEvent

code: class FSettingChangedEvent : public TBaseMulticastDelegate_OneParam< void, FName >


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: ULogVisualizerSessionSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: ULogVisualizerSessionSettings

code: class ULogVisualizerSessionSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bEnableGraphsVisualization

type: bool

description: Whether to show trivial logs, i.e. the ones with only one entry.


code: ULogVisualizerSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: ULogVisualizerSettings

code: class ULogVisualizerSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bConstrainGraphToLocalMinMax

description: Graphs will be scaled around local Min/Max values (values being displayed) rather than all historic data

bDrawExtremesOnGraphs

description: Whether to extreme values on graph (data has to be provided for extreme values)

bForceUniqueLogNames

description: Controls how we generate log names.

bLogNavOctreeOnStop

description: Whether to dump Navigation Octree on Stop recording or not

bPersistentFilters

description: Whether to store all filter settings on exit

bResetDataWithNewSession

description: Whether to reset current data or not for each new session.

bSearchInsideLogs

description: Whether to search/filter categories or to get text vlogs into account too

bShowHistogramLabelsOutside

description: Whether to show histogram labels inside graph or outside. Property disabled for now.

bStickToRecentData

description: Whether to show the recent data or not. Property disabled for now.

bUseFilterVolumes

description: Whether to only show events occuring within one of visual logger filter volumes currently in the level

bUsePlayersOnlyForPause

description: Whether to use PlayersOnly during Pause or not

DebugMeshMaterialFakeLight

type: TObjectPtr< cla...

description: A material used to render debug meshes with kind of flat shading, mostly used by Visual Logger tool.

DefaultCameraDistance

description: Camera distance used to setup location during reaction on log item double click

GraphsBackgroundColor

type: FColor

description: Background color for 2d graphs visualization

PersistentFilters

type: FVisualLoggerFi...

TrivialLogsThreshold

description: Threshold for trivial Logs


className: EMaterialBakeMethod

description: Enum to define different types of baking materials

module: MaterialBaking

code: enum EMaterialBakeMethod { IndividualMaterial, AtlasMaterial, BinnedMaterial, }


className: FBakeOutput

description: Structure containing data being processed while baking out materials

code: struct FBakeOutput

EmissiveScale

description: Scale used to allow having wide ranges of emissive values in the source materials, the final proxy material will use this value to scale the emissive texture's pixel values

HDRPropertyData

type: TMap< EMaterial...

description: Contains the resulting HDR texture data for baking out a material's property, may be empty

PropertyData

description: Contains the resulting texture data for baking out a material's property

PropertySizes

description: Contains the resulting texture size for baking out a material's property


className: FBakeOutputEx

description: Structure containing extended data being processed while baking out materials

code: struct FBakeOutputEx

EmissiveScale

type: float

HDRPropertyData

type: TMap<FMaterial...

PropertyData

description: Contains the resulting texture data for baking out a extened material's property

description: Contains the resulting texture size for baking out a extened material's property


description: Shrinks the array to a single pixel if the entire output is monochrome. Params will be adjusted accordingly when this occurs. It's useful to perform this before the border smear as a single non-magenta pixel value would have led to a monochrome image post-smear anyway, so the actual smearing process can be skipped.

code: static void PerformShrinking ( [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > & InOutPixels, int32 & OnOutImageWidth, int32 & InOutImageHeight, [FColor](API\Runtime\Core\Math\FColor) BackgroundColor )


description: Applies a box blur to magenta pixels found in given texture represented by InOutPixels using non-background pixels, this creates a smear across the magenta/filled pixels.

code: static void PerformUVBorderSmear ( [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > & InOutPixels, int32 ImageWidth, int32 ImageHeight, int32 MaxIterations, [FColor](API\Runtime\Core\Math\FColor) BackgroundColor )


description: This version is allowed to shrink the array to a single pixel if the entire output is monochrome. Params will be adjusted accordingly when this occurs.

code: static void PerformUVBorderSmearAndShrink ( [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > & InOutPixels, int32 & InOutImageWidth, int32 & InOutImageHeight, [FColor](API\Runtime\Core\Math\FColor) BackgroundColor )


className: FMaterialBakingHelpers

code: class FMaterialBakingHelpers


className: FMaterialData

description: Structure containing information about the material which is being baked out

code: struct FMaterialData

BackgroundColor

description: Background color used to initially fill the output texture and used for border smear

BlendMode

type: EBlendMode

description: Blend mode to use when baking, allowing for example detection of overlapping UVs

bPerformBorderSmear

description: Whether to smear borders after baking

bPerformShrinking

description: Whether to try to shrink the color values to a single non-magenta color value after baking

bTangentSpaceNormal

description: Whether to transform normals from world-space to tangent-space (does nothing if material already uses tangent-space normals)

Material

type: UMaterialInterf...

description: Material to bake out

PropertySizes

description: Properties and the texture size at which they should be baked out


className: FMaterialDataEx

description: Structure containing extended information about the material and properties which is being baked out

code: struct FMaterialDataEx

bPerformBorderSmear

description: Whether to smear borders after baking

Material

description: Material to bake out

description: Extended properties and the texture size at which they should be baked out


className: ClearCoatBottomNormal

description: The identifier for custom output Clear Coat Bottom Normal (used by shading model Clear Coat)

code: static const [FMaterialPropertyEx](API\Developer\MaterialBaking\FMaterialPropertyEx) ClearCoatBottomNormal;


code: bool IsCustomOutput() const


code: bool operator!= ( const [FMaterialPropertyEx](API\Developer\MaterialBaking\FMaterialPropertyEx) & Other ) const


code: bool operator== ( const [FMaterialPropertyEx](API\Developer\MaterialBaking\FMaterialPropertyEx) & Other ) const


className: TransmittanceColor

description: The identifier for custom output Transmittance Color (used by shading model Thin Translucent)

code: static const [FMaterialPropertyEx](API\Developer\MaterialBaking\FMaterialPropertyEx) TransmittanceColor;


code: FMaterialPropertyEx ( const [FName](API\Runtime\Core\UObject\FName) & CustomOutput )


code: FMaterialPropertyEx ( const TCHAR * CustomOutput )


code: FMaterialPropertyEx ( EMaterialProperty Type, const [FName](API\Runtime\Core\UObject\FName) & CustomOutput )


className: FMaterialPropertyEx

description: Structure extending EMaterialProperty to allow detailed information about custom output

code: struct FMaterialPropertyEx

CustomOutput

type: FName

description: The name of a specific custom output. Only used if property is MP_CustomOutput

Type

type: EMaterialProper...

description: The material property


code: bool operator== ( const [FMeshData](API\Developer\MaterialBaking\FMeshData) & Other ) const


className: FMeshData

description: Struct that defines a mesh (Mesh + LOD + MaterialIndex)

code: struct FMeshData

bMirrored

description: Transform determinant used to detect mirroring

CustomTextureCoordinates

type: TArray< FVector...

description: Set of custom texture coordinates which ensure that the material is baked out with unique/non-overlapping positions

LightMap

type: FLightMapRef

description: Reference to the lightmap texture part of the level in the currently being baked out mesh instance data is resident

LightMapIndex

description: Light map index used to retrieve the light-map UVs from RawMesh

LightmapResourceCluster

type: constFLightmap...

description: Pointer to the LightmapResourceCluster to be passed on the the LightCacheInterface when baking

LOD

type: int

description: Specific LOD of the mesh.

MaterialIndex

description: Specific index of the mesh material (MaterialIndex is an alias of Section).

MaterialIndices

type: TArray< int32 >

description: Material indices to test the Raw Mesh data against, ensuring we only bake out triangles which use the currently baked out material

Mesh

type: constUStaticMe...

description: Ptr to original static mesh this mesh data came from

type: constUObject&...

description: Mesh which it may contain multiple LODs and Materials.

MeshDescription

type: constFMeshDesc...

description: Ptr to raw mesh data to use for baking out the material data, if nullptr a standard quad is used

Node

type: constUCustomiz...

description: Node where the mesh is defined.

PrimitiveData

type: constFPrimitiv...

description: Pointer to primitive data that is accessible through material expressions, if nullptr default values are used

TextureCoordinateBox

description: Box which's space contains the UV coordinates used to bake out the material

TextureCoordinateIndex

description: Specific texture coordinate index to use as texture coordinates to bake out the material (is overruled if CustomTextureCoordinates contains any data)

VertexColorHash

description: A hash of the vertex color buffer for the rawmesh


code: FPrimitiveData ( const FBoxSphereBounds & LocalBounds )


code: FPrimitiveData ( const [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * StaticMesh )


code: FPrimitiveData ( const [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh )


code: FPrimitiveData ( const [UMeshComponent](API\Runtime\Engine\Components\UMeshComponent) * MeshComponent )


className: FPrimitiveData

description: Structure containing primitive information (regarding a mesh or mesh component) that is accessible through material expressions

code: struct FPrimitiveData

ActorPosition

type: FVector

description: The actor's location in world-space

CustomPrimitiveData

type: constFCustomPr...

description: The mesh component's custom primitive data

LocalBounds

type: FBoxSphereBound...

description: The mesh component's bounds in local-space

LocalToWorld

type: FMatrix

description: The mesh component's local-to-world transform

PreSkinnedLocalBounds

description: The mesh component's pre-skinning bounds in local-space

WorldBounds

description: The mesh component's bounds in world-space


code: FPropertyEntry ( EMaterialProperty InProperty )


description: Bakes out material properties according to MaterialSettings using MeshSettings and stores the output in Output

code: void BakeMaterials ( const [TArray](API\Runtime\Core\Containers\TArray)< [FMaterialData](API\Developer\MaterialBaking\FMaterialData) * > & MaterialSettings, const [TArray](API\Runtime\Core\Containers\TArray)< [FMeshData](API\Developer\MaterialBaking\FMeshData) * > & MeshSettings, [FBakeOutput](API\Developer\MaterialBaking\FBakeOutput) & Output )


description: Bakes out material properties according to extended MaterialSettings using MeshSettings and stores the output in Output

code: void BakeMaterials ( const [TArray](API\Runtime\Core\Containers\TArray)< [FMaterialDataEx](API\Developer\MaterialBaking\FMaterialDataEx) * > & MaterialSettings, const [TArray](API\Runtime\Core\Containers\TArray)< [FMeshData](API\Developer\MaterialBaking\FMeshData) * > & MeshSettings, [TArray](API\Runtime\Core\Containers\TArray)< [FBakeOutputEx](API\Developer\MaterialBaking\FBakeOutputEx) > & Output )