1. Epic GamesDeveloper
  3. Localization

Localization

Unreal Engine C++ API Reference > Developer

Filters

Classes

  Type Name Description
Public struct UStruct FCultureStatistics    
Public struct FExportLocalizationOptions    
Public struct UStruct FGatherTextExcludePath    
Public struct UStruct FGatherTextFileExtension    
Public struct UStruct FGatherTextFromMetaDataConfiguration    
Public struct UStruct FGatherTextFromPackagesConfiguration    
Public struct UStruct FGatherTextFromTextFilesConfiguration    
Public struct UStruct FGatherTextIncludePath    
Public struct UStruct FGatherTextSearchDirectory    
Public struct UStruct FLocalizationCompilationSettings    
Public struct FLocalizationConfigurationScript    
Public struct UStruct FLocalizationExportingSettings    
Public struct FLocalizationGatherPathRootUtil    
Public struct UStruct FLocalizationImportDialogueSettings    
Public class FLocalizationSCC    
Public struct FLocalizationSourceControlSettings Struct containing util functions for getting/setting the SCC settings for the localization dashboard  
Public struct UStruct 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 UStruct FMetaDataKeyGatherSpecification    
Public struct UStruct FMetaDataKeyName    
Public struct UStruct 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 UStruct 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 UClass Config defaultconfig ULocalizationSettings Class for loading/saving configuration settings and the details view objects needed for localization dashboard functionality.  
Public class UClass within ULocalizationTarget    
Public class UClass within ULocalizationTargetSet    
Public class UClass Config defaultconfig 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 UEnum ELocalizationGatherPathRoot    
Public enum UEnum ELocalizationTargetConflictStatus    
Public enum UEnum ELocalizationTargetLoadingPolicy    
Public enum UEnum 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 UEnum ELocTextPlatformSplitMode How should we split platform specific localization data?  
Public enum UEnum 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
Public function    
Public function    
Public function FString Given a string, condition it so it can be written as a field of a PO file
Public function FString

PortableObjectPipeline::ConditionIdentityForPO ( const FString& Namespace,
const FString& Key,
const TSharedPtr< FLocMetadataObject >& KeyMetaData,
const ELocalizedTextCollapseMode InTextCollapseMode
)

 Given a namespace and key, condition this information so it can be written to the "msgctxt" or "msgid" field of a PO file
Public function FString Given the field of a PO file, condition it back to a clean string
Public function bool

PortableObjectPipeline::Export ( FLocTextHelper& InLocTextHelper,
const FString& InCulture,
const FString& InPOFilePath,
const ELocalizedTextCollapseMode InTextCollapseMode,
const EPortableObjectFormat InPOFormat,
const bool bShouldPersistComments
)

 Use the given LocTextHelper to generate a new PO file using the translation data for the given culture
Public function bool

PortableObjectPipeline::ExportAll ( FLocTextHelper& InLocTextHelper,
const FString& InPOCultureRootPath,
const FString& InPOFilename,
const ELocalizedTextCollapseMode InTextCollapseMode,
const EPortableObjectFormat InPOFormat,
const bool bShouldPersistComments,
const bool bUseCultureDirectory
)

 Use the given LocTextHelper to generate a new PO file using the translation data for all cultures
Public function 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
Public function FString Given a key string, condition it so it can be written as the extracted comment field of a PO file
Public function FString Given a source location string, condition it so it can be written as the extracted comment field of a PO file
Public function bool

PortableObjectPipeline::Import ( FLocTextHelper& InLocTextHelper,
const FString& InCulture,
const FString& InPOFilePath,
const ELocalizedTextCollapseMode InTextCollapseMode,
const EPortableObjectFormat InPOFormat
)

 Update the given LocTextHelper with the translation data imported from the PO file for the given culture
Public function bool

PortableObjectPipeline::ImportAll ( FLocTextHelper& InLocTextHelper,
const FString& InPOCultureRootPath,
const FString& InPOFilename,
const ELocalizedTextCollapseMode InTextCollapseMode,
const EPortableObjectFormat InPOFormat,
const bool bUseCultureDirectory
)

 Update the given LocTextHelper with the translation data imported from the PO file for all cultures
Public function void

PortableObjectPipeline::ParseBasicPOFileEntry ( const FPortableObjectEntry& POEntry,
FString& OutNamespace,
FString& OutKey,
FString& OutSourceString,
FString& OutTranslation,
const ELocalizedTextCollapseMode InTextCollapseMode,
const EPortableObjectFormat InPOFormat
)

 Parse the basic data (msgctxt, msgid, msgstr) from a PO entry
Public function 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
Public function void

PortableObjectPipeline::PopulateBasicPOFileEntry ( FPortableObjectEntry& POEntry,
const FString& InNamespace,
const FString& InKey,
const TSharedPtr< FLocMetadataObject >& InKeyMetaData,
const FString& InSourceString,
const FString& InTranslation,
const ELocalizedTextCollapseMode InTextCollapseMode,
const EPortableObjectFormat InPOFormat
)

 Populate the basic data (msgctxt, msgid, msgstr) within a PO entry
Public function void Given the collapse mode and PO format, append any extra required meta-data to the PO file header

Variables

  Type Name Description
Public variable TMulticastDelegate< void(const FString &LocalizationTargetPath)> 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

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.