Localization

Unreal Engine C++ API Reference > Developer

Filters

  • (Serialization)[API\Developer\Localization\Serialization]

Classes

Type Name Description
Public struct FCultureStatistics  
Public struct FExportLocalizationOptions  
Public struct FGatherTextExcludePath  
Public struct FGatherTextFileExtension  
Public struct FGatherTextFromMetaDataConfiguration  
Public struct FGatherTextFromPackagesConfiguration  
Public struct FGatherTextFromTextFilesConfiguration  
Public struct FGatherTextIncludePath  
Public struct FGatherTextSearchDirectory  
Public struct FLocalizationCompilationSettings  
Public struct FLocalizationConfigurationScript  
Public struct FLocalizationExportingSettings  
Public struct FLocalizationGatherPathRootUtil  
Public struct FLocalizationImportDialogueSettings  
Public class FLocalizationSCC  
Public struct FLocalizationSourceControlSettings Struct containing util functions for getting/setting the SCC settings for the localization dashboard
Public struct FLocalizationTargetSettings  
Public class FLocFileSCCNotifies  
Public class FLocTextConflicts Class that tracks any conflicts that occur when gathering source text entries.
Public class FLocTextHelper High-level access to the non-compiled localization resources (manifests and archives) in a way that abstracts some of their quirks.
Public struct FLocTextPlatformSplitUtils Utilities to get manage platforms to split.
Public class FLocTextWordCounts Class that manages the word count reporting of the various cultures.
Public struct FMetaDataKeyGatherSpecification  
Public struct FMetaDataKeyName  
Public struct FMetaDataTextKeyPattern  
Public class FPortableObjectCulture Class for handling language codes used in the Portable Object format.
Public class FPortableObjectEntry Class for representing entries in a Portable Object file(.po) or a Portable Object Template file(.pot).
Public class FPortableObjectEntryKey Class for representing the key of an entry in a Portable Object file(.po) or a Portable Object Template file(.pot).
Public class FPortableObjectFormatDOM Contains all the info we need to represent files in the Portable Object format.
Public class FPortableObjectHeader Class that stores and manipulates PO and POT file header info.
Public class FTextLocalizationResourceGenerator Utility functions for generating compiled LocMeta (Localization MetaData Resource) and LocRes (Localization Resource) files from source localization data
Public struct FUserGeneratedContentLocalizationDescriptor Minimal descriptor needed to generate a localization target for UGC localization.
Public class ILocalizationModule  
Public class ILocFileNotifies Interface for the loc file notify API.
Public class ULocalizationSettings Class for loading/saving configuration settings and the details view objects needed for localization dashboard functionality.
Public class ULocalizationTarget  
Public class ULocalizationTargetSet  
Public class UUserGeneratedContentLocalizationSettings Settings controlling UGC localization.

Typedefs

Name Description
FPortableObjectEntries  

Enums

Type Name Description
Public enum EConflictReportFormat An enum representing all the formats the conflict report can be output in.
Public enum EGenerateLocResFlags  
Public enum ELocalizationGatherPathRoot  
Public enum ELocalizationTargetConflictStatus  
Public enum ELocalizationTargetLoadingPolicy  
Public enum ELocalizedTextCollapseMode  
Public enum ELocTextExportSourceMethod What kind of "source" should we use when looking up translations for export?
Public enum ELocTextHelperLoadFlags Flags controlling the behavior used when loading manifests and archives into FLocTextHelper
Public enum ELocTextPlatformSplitMode How should we split platform specific localization data?
Public enum EPortableObjectFormat  
Public enum UserGeneratedContentLocalization::ELoadLocalizationResult 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.

Functions

Type Name Description  
constexpr bo... operator! ( ELocTextHelperLoadFlags E )    
constexpr bo... operator! ( EGenerateLocResFlags E )    
constexpr EG... operator& ( EGenerateLocResFlags Lhs, EGenerateLocResFlags Rhs )    
constexpr EL... operator& ( ELocTextHelperLoadFlags Lhs, ELocTextHelperLoadFlags Rhs )    
EGenerateLoc... operator&= ( EGenerateLocResFlags& Lhs, EGenerateLocResFlags Rhs )    
ELocTextHelp... operator&= ( ELocTextHelperLoadFlags& Lhs, ELocTextHelperLoadFlags Rhs )    
constexpr EG... operator^ ( EGenerateLocResFlags Lhs, EGenerateLocResFlags Rhs )    
constexpr EL... operator^ ( ELocTextHelperLoadFlags Lhs, ELocTextHelperLoadFlags Rhs )    
EGenerateLoc... operator^= ( EGenerateLocResFlags& Lhs, EGenerateLocResFlags Rhs )    
ELocTextHelp... operator^= ( ELocTextHelperLoadFlags& Lhs, ELocTextHelperLoadFlags Rhs )    
constexpr EG... [operator ](API\Developer\Localization\op_bitor\2) ( EGenerateLocResFlags Lhs, EGenerateLocResFlags Rhs )  
constexpr EL... [operator ](API\Developer\Localization\op_bitor\1) ( ELocTextHelperLoadFlags Lhs, ELocTextHelperLoadFlags Rhs )  
EGenerateLoc... [operator =](API\Developer\Localization\op_bitor_assign\2) ( EGenerateLocResFlags& Lhs, EGenerateLocResFlags Rhs )  
ELocTextHelp... [operator =](API\Developer\Localization\op_bitor_assign\1) ( ELocTextHelperLoadFlags& Lhs, ELocTextHelperLoadFlags Rhs )  
constexpr EG... operator~ ( EGenerateLocResFlags E )    
constexpr EL... operator~ ( ELocTextHelperLoadFlags E )    
FString PortableObjectPipeline::ConditionArchiveStrForPO ( const FString& InStr ) Given a string, condition it so it can be written as a field of a PO file  
FString PortableObjectPipeline::ConditionIdentityForPO ( const FString& Namespace, const FString& Key, const TSharedPtr< FLocMetadataObjec..., const ELocalizedTextCollapseMode In... ) Given a namespace and key, condition this information so it can be written to the "msgctxt" or "msgid" field of a PO file  
FString PortableObjectPipeline::ConditionPOStringForArchive ( const FString& InStr ) Given the field of a PO file, condition it back to a clean string  
bool PortableObjectPipeline::Export ( FLocTextHelper& InLocTextHelper, const FString& InCulture, const FString& InPOFilePath, const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor..., const bool bShouldPersistComments ) Use the given LocTextHelper to generate a new PO file using the translation data for the given culture  
bool PortableObjectPipeline::ExportAll ( FLocTextHelper& InLocTextHelper, const FString& InPOCultureRootPath, const FString& InPOFilename, const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor..., const bool bShouldPersistComments, const bool bUseCultureDirectory ) Use the given LocTextHelper to generate a new PO file using the translation data for all cultures  
FString PortableObjectPipeline::GetConditionedInfoMetaDataForExtractedComment ( const FString& KeyName, const FString& ValueString ) Given a meta-data value string, condition it so it can be written as the extracted comment field of a PO file  
FString PortableObjectPipeline::GetConditionedKeyForExtractedComment ( const FString& Key ) Given a key string, condition it so it can be written as the extracted comment field of a PO file  
FString PortableObjectPipeline::GetConditionedReferenceForExtractedComment ( const FString& PORefString ) Given a source location string, condition it so it can be written as the extracted comment field of a PO file  
bool PortableObjectPipeline::Import ( FLocTextHelper& InLocTextHelper, const FString& InCulture, const FString& InPOFilePath, const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor... ) Update the given LocTextHelper with the translation data imported from the PO file for the given culture  
bool PortableObjectPipeline::ImportAll ( FLocTextHelper& InLocTextHelper, const FString& InPOCultureRootPath, const FString& InPOFilename, const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor..., const bool bUseCultureDirectory ) Update the given LocTextHelper with the translation data imported from the PO file for all cultures  
void PortableObjectPipeline::ParseBasicPOFileEntry ( const FPortableObjectEntry& POEntr..., FString& OutNamespace, FString& OutKey, FString& OutSourceString, FString& OutTranslation, const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor... ) Parse the basic data (msgctxt, msgid, msgstr) from a PO entry  
void PortableObjectPipeline::ParseIdentityFromPO ( const FString& InIdentity, FString& OutNamespace, FString& OutKey ) Given the "msgctxt" or "msgid" field of a PO file, split it into the namespace and key  
void PortableObjectPipeline::PopulateBasicPOFileEntry ( FPortableObjectEntry& POEntry, const FString& InNamespace, const FString& InKey, const TSharedPtr< FLocMetadataObjec..., const FString& InSourceString, const FString& InTranslation, const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor... ) Populate the basic data (msgctxt, msgid, msgstr) within a PO entry  
void PortableObjectPipeline::UpdatePOFileHeaderForSettings ( FPortableObjectFormatDOM& Portable..., const ELocalizedTextCollapseMode In..., const EPortableObjectFormat InPOFor... ) Given the collapse mode and PO format, append any extra required meta-data to the PO file header  

Variables

Type Name Description
TMulticastDeleg... OnLocalizationTargetDataUpdated Delegate called when any on-disk data for the given localization target is updated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library