1. Epic GamesDeveloper
  3. Internationalization

Internationalization

API > API/Runtime > API/Runtime/Core

Classes

  Type Name Description
Public struct ELocalizedTextSourcePriority Pre-defined priorities for ILocalizedTextSource.  
Public class FArchiveEntry    
Public struct FBreakIterator Copyright Epic Games, Inc. All Rights Reserved.  
Public class FCulture    
Public class FCultureFilter Cache of enabled/disabled cultures loaded from config data  
Public struct FDecimalNumberFormattingRules Rules used to format or parse a decimal number  
Public struct FDecimalNumberFractionalLimits    
Public struct FDecimalNumberIntegralLimits    
Public struct FFormatArgumentData Used to pass argument/value pairs into FText::Format via UKismetTextLibrary::Format.  
Public class FFormatArgumentValue    
Public struct FGatherableTextData    
Public class FHistoricTextFormatData Used to gather information about a historic text format operation  
Public class FHistoricTextNumericData Used to gather information about a historic numeric format operation  
Public class FInternationalization    
Public class FInternationalizationArchive    
Public class FInternationalizationManifest    
Public struct FLocItem    
Public class FLocKey Copyright Epic Games, Inc. All Rights Reserved.  
Public struct FLocKeyMapFuncs Case sensitive hashing function for TMap  
Public struct FLocKeyMultiMapFuncs Case sensitive hashing function for TMultiMap  
Public struct FLocKeySetFuncs Case sensitive hashing function for TSet  
Public struct FLocKeySortedMapLess Case sensitive comparison function for TSortedMap  
Public class FLocMetadataObject A LocMetadata Object is a structure holding an unordered set of name/value pairs.  
Public class FLocMetadataValue A Metadata Value is a structure that can be a number of types.  
Public class FLocMetadataValueArray A LocMetadata Array Value.  
Public class FLocMetadataValueBoolean A LocMetadata Boolean Value.  
Public class FLocMetadataValueObject A LocMetadata Object Value.  
Public class FLocMetadataValueString A LocMetadata String Value.  
Public struct FManifestContext    
Public class FManifestEntry    
Public struct FNumberFormattingOptions    
Public struct FNumberParsingOptions    
Public struct FPolyglotTextData Polyglot data that may be registered to the text localization manager at runtime.  
Public class FRefCountedDisplayString    
Public class FRegexMatcher Implements a regular expression pattern matcher.  
Public class FRegexPattern Implements a regular expression pattern.  
Public class FStringTable String table implementation. Holds Key->SourceString pairs of text.  
Public class FStringTableEntry Entry within a string table  
Public struct FStringTableRedirects String table redirect utils  
Public class FStringTableRegistry Singleton registry of known string table instances  
Public class FText    
Public class FTextBuilder    
Public class FTextChronoFormatter Utility for performing low-level localized chronological formats.  
Public class FTextComparison Utility for performing low-level text comparison.  
Public struct FTextDirectionInfo A single complex layout entry.  
Public class FTextFormat Cached compiled expression used by the text formatter.  
Public class FTextFormatPatternDefinition Definition of the pattern used during a text format.  
Public class FTextFormatString Type used as a string literal by the text formatter.  
Public class FTextFormatter A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.  
Public class FTextGeneratorBase Copyright Epic Games, Inc. All Rights Reserved.  
Public class FTextId Optimized representation of a text identity (a namespace and key pair).  
Public class FTextInspector    
Public class FTextKey Optimized representation of a case-sensitive string, as used by localization keys.  
Public class FTextLocalizationManager Singleton class that manages display strings for FText.  
Public class FTextLocalizationMetaDataResource Utility class for working with Localization MetaData Resource (LocMeta) files.  
Public class FTextLocalizationResource Utility class for working with Localization Resource (LocRes) files.  
Public struct FTextLocalizationResourceVersion Version information for compiled LocMeta (Localization MetaData Resource) and LocRes (Localization Resource) files  
Public class FTextSnapshot A snapshot of an FText at a point in time that can be used to detect changes in the FText, including live-culture changes  
Public struct FTextSourceData    
Public struct FTextSourceSiteContext    
Public class FTextStringHelper    
Public class FTextTransformer Utility for performing low-level localized transforms.  
Public struct FUnicodeChar Unicode character helper functions  
Public class IBreakIterator Copyright Epic Games, Inc. All Rights Reserved.  
Public class ICustomCulture Interface for a custom culture.  
Public class ILocalizedTextSource Interface for a localized text source.  
Public class IStringTableEngineBridge Interface to allow Core code to access String Table assets from the Engine  
Public class ITextBiDi Defines the interface for a re-usable BiDi object  
Public class ITextData Interface to the internal data for an FText.  
Public class ITextFormatArgumentModifier Interface for a format argument modifier.  
Public class ITextGenerator Interface to an object that generates a localized string.  
Public class TDisplayStringPtr Wrapper to give TRefCountPtr a minimal TSharedPtr interface for backwards compatibility with code that was already using FTextDisplayStringPtr  
Public class TDisplayStringPtrBase Wrapper to give TRefCountPtr a minimal TSharedRef/TSharedPtr interface for backwards compatibility with code that was already using FTextDisplayStringRef/FTextDisplayStringPtr  
Public class TDisplayStringRef Wrapper to give TRefCountPtr a minimal TSharedRef interface for backwards compatibility with code that was already using FTextDisplayStringRef  

Typedefs

Name Description
FArchiveEntryByLocKeyContainer  
FArchiveEntryByStringContainer  
FCultureImplementation  
FCulturePtr  
FCultureRef  
FFormatNamedArguments  
FFormatOrderedArguments  
FManifestEntryByLocKeyContainer  
FManifestEntryByStringContainer  
FStringTableConstPtr  
FStringTableConstRef  
FStringTableConstWeakPtr  
FStringTableEntryConstPtr  
FStringTableEntryConstRef  
FStringTableEntryConstWeakPtr  
FStringTableEntryPtr  
FStringTableEntryRef  
FStringTableEntryWeakPtr  
FStringTablePtr  
FStringTableRef  
FStringTableWeakPtr  
FTextConstDisplayStringPtr  
FTextConstDisplayStringRef  
FTextDisplayStringPtr  
FTextDisplayStringRef  
FTextFormatPatternDefinitionConstPtr  
FTextFormatPatternDefinitionConstRef  
FTextFormatPatternDefinitionPtr  
FTextFormatPatternDefinitionRef  

Enums

  Type Name Description
Public enum EDateTimeStyle::Type Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well  
Public enum EFormatArgumentType::Type Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well  
Public enum ELocalizationLoadFlags Load flags used in localization initialization.  
Public enum ELocalizedTextSourceCategory Categories of localized text. This enum is mirrored in NoExportTypes.h for UHT.  
Public enum ELocMetadataType Represents all the types a LocMetadata Value can be.  
Public enum EMemoryUnitStandard Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well  
Public enum EQueryLocalizedResourceResult Result codes from calling QueryLocalizedResourceResult.  
Public enum ERegexPatternFlags    
Public enum ERoundingMode Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well  
Public enum EStringTableLoadingPolicy Copyright Epic Games, Inc. All Rights Reserved.  
Public enum ETextComparisonLevel::Type    
Public enum ETextFlag::Type    
Public enum ETextFormatFlags    
Public enum ETextGender Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well  
Public enum ETextIdenticalModeFlags    
Public enum ETextLocalizationManagerInitializedFlags    
Public enum ETextPluralForm    
Public enum ETextPluralType    
Public enum TextBiDi::ETextDirection Lists the potential reading directions for text  
Public enum TextNamespaceUtil::ETextCopyMethod    

Functions

  Type Name Description
Public function void  
Public function void  
Public function void

FastDecimalFormat::NumberToString ( const T InVal,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberFormattingOptions& InFormattingOptions,
FString& OutString
)

  
Public function FString

FastDecimalFormat::NumberToString ( const T InVal,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberFormattingOptions& InFormattingOptions
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int8& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int16& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int32& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int64& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint8& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint16& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint32& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint64& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
double& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int8& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int16& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int32& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
int64& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint8& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint16& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
float& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
float& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
double& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint64& OutVal,
int32* OutParsedLen
)

  
Public function bool

FastDecimalFormat::StringToNumber ( const TCHAR* InStr,
const int32 InStrLen,
const FDecimalNumberFormattingRules& InFormattingRules,
const FNumberParsingOptions& InParsingOptions,
uint32& OutVal,
int32* OutParsedLen
)

  
Public function uint32  
Public function uint32  
Public function void  
Public function void  
Public function void

LexFromString ( EDateTimeStyle::Type& OutValue,
const TCHAR* Buffer
)

  
Public function void

LexFromString ( ERoundingMode& OutValue,
const TCHAR* Buffer
)

  
Public function void

LexFromString ( ETextGender& OutValue,
const TCHAR* Buffer
)

  
Public function const TCHAR *

LexToString ( ETextGender InValue
)

  
Public function const TCHAR *  
Public function const TCHAR *  
Public function bool

LexTryParseString ( EDateTimeStyle::Type& OutValue,
const TCHAR* Buffer
)

  
Public function bool

LexTryParseString ( ERoundingMode& OutValue,
const TCHAR* Buffer
)

  
Public function bool

LexTryParseString ( ETextGender& OutValue,
const TCHAR* Buffer
)

  
Public function FTextDisplayStringRef

MakeTextDisplayString ( FString&& InDisplayString
)

  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool

operator!= ( const UE::Text::Private::TDisplayStringPtr< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringPtr< ObjectTypeB >& B
)

  
Public function bool

operator!= ( const UE::Text::Private::TDisplayStringPtr< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringRef< ObjectTypeB >& B
)

  
Public function bool

operator!= ( const UE::Text::Private::TDisplayStringRef< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringPtr< ObjectTypeB >& B
)

  
Public function bool

operator!= ( const UE::Text::Private::TDisplayStringRef< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringRef< ObjectTypeB >& B
)

  
Public function bool

operator!= ( const FTextFormatString& LHS,
const FTextFormatString& RHS
)

  
Public function ERegexPatternFlags  
Public function ETextIdenticalModeFlags  
Public function ETextFormatFlags  
Public function ETextLocalizationManagerInitializedFlags  
Public function ELocalizationLoadFlags  
Public function ELocalizationLoadFlags &  
Public function ERegexPatternFlags &  
Public function ETextIdenticalModeFlags &  
Public function ETextLocalizationManagerInitializedFlags &  
Public function ETextFormatFlags &  
Public function ERegexPatternFlags  
Public function ETextIdenticalModeFlags  
Public function ETextFormatFlags  
Public function ETextLocalizationManagerInitializedFlags  
Public function ELocalizationLoadFlags  
Public function ELocalizationLoadFlags &  
Public function ETextIdenticalModeFlags &  
Public function ETextFormatFlags &  
Public function ETextLocalizationManagerInitializedFlags &  
Public function ERegexPatternFlags &  
Public function ETextIdenticalModeFlags  
Public function ELocalizationLoadFlags  
Public function ETextLocalizationManagerInitializedFlags  
Public function ERegexPatternFlags  
Public function ETextFormatFlags  
Public function ETextLocalizationManagerInitializedFlags &  
Public function ETextFormatFlags &  
Public function ETextIdenticalModeFlags &  
Public function ERegexPatternFlags &  
Public function ELocalizationLoadFlags &  
Public function ETextLocalizationManagerInitializedFlags  
Public function ETextFormatFlags  
Public function ETextIdenticalModeFlags  
Public function ELocalizationLoadFlags  
Public function ERegexPatternFlags  
Public function bool

operator== ( const FTextFormatString& LHS,
const FTextFormatString& RHS
)

  
Public function bool

operator== ( const UE::Text::Private::TDisplayStringRef< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringPtr< ObjectTypeB >& B
)

  
Public function bool

operator== ( const UE::Text::Private::TDisplayStringPtr< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringRef< ObjectTypeB >& B
)

  
Public function bool

operator== ( const UE::Text::Private::TDisplayStringPtr< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringPtr< ObjectTypeB >& B
)

  
Public function bool

operator== ( const UE::Text::Private::TDisplayStringRef< ObjectTypeA >& A,
const UE::Text::Private::TDisplayStringRef< ObjectTypeB >& B
)

  
Public function bool Utility function which tests to see whether the given character is a bidirectional control character.
Public function void

TextFormatUtil::FormatNamed ( FFormatNamedArguments& Result,
TName&& Name,
TValue&& Value,
TArguments&&... Args
)

  
Public function void

TextFormatUtil::FormatNamed ( FFormatNamedArguments& Result,
TName&& Name,
TValue&& Value
)

  
Public function void

TextFormatUtil::FormatOrdered ( FFormatOrderedArguments& Result,
TValue&& Value,
TArguments&&... Args
)

  
Public function void  
Public function uint32

TextKeyUtil::HashString ( const TCHAR* InStr,
const int32 InStrLen
)

 Utility to produce a hash for a string (as used by FTextKey)
Public function uint32

TextKeyUtil::HashString ( const TCHAR* InStr,
const uint32 InBaseHash
)

  
Public function uint32

TextKeyUtil::HashString ( const FTCHARToUTF16& InStr,
const uint32 InBaseHash
)

  
Public function uint32 Utility to produce a hash for a string (as used by FTextKey)
Public function uint32

TextKeyUtil::HashString ( const FString& InStr
)

 Utility to produce a hash for a string (as used by FTextKey)
Public function uint32

TextKeyUtil::HashString ( const TCHAR* InStr
)

 Utility to produce a hash for a string (as used by FTextKey)
Public function uint32

TextKeyUtil::HashString ( FStringView InStr,
const uint32 InBaseHash
)

  
Public function uint32

TextKeyUtil::HashString ( const FString& InStr,
const uint32 InBaseHash
)

  
Public function uint32

TextKeyUtil::HashString ( const TCHAR* InStr,
const int32 InStrLen,
const uint32 InBaseHash
)

  
Public function void Clear the native culture for the editor so it will be re-cached on the text call to GetNativeEditorCultureName.
Public function void Clear the native culture for the engine so it will be re-cached on the text call to GetNativeEngineCultureName.
Public function void Clear the native culture for the current project so it will be re-cached on the text call to GetNativeProjectCultureName.
Public function const TArray< FString > & Get the array of localization targets that have been disabled for the current configuration.
Public function FString

TextLocalizationResourceUtil::GetLocalizationTargetNameForChunkId ( const FString& InLocalizationTargetName,
const int32 InChunkId
)

 Get the name that the given localization target should have for the given chunk ID.
Public function TArray< FString > Given some paths to look at, populate a list of culture names that we have available localization resource information for.
Public function FString Given a localization category, get the native culture for the targets for that category (if known).
Public function FString Given some paths to look at, get the native culture for the targets within those paths (if known).
Public function FString Get the native culture for the editor.
Public function FString Get the native culture for the engine.
Public function FString Get the native culture for the current project (if known).
Public function FString

TextNamespaceUtil::BuildFullNamespace ( const FString& InTextNamespace,
const FString& InPackageNamespace,
const bool bAlwaysApplyPackageNamespace
)

 Given a text and package namespace, build the full version that should be used by the localization system.
Public function FText

TextNamespaceUtil::CopyTextToPackage ( const FText& InText,
const FString& InPackageNamespace,
const ETextCopyMethod InCopyMethod,
const bool bAlwaysApplyPackageNamespace
)

 Make a copy of the given text that's valid to use with the given package namespace, optionally preserving its existing key.
Public function FString Given a text namespace, extract any package namespace that may currently be present.
Public function FString Given an archive, try and get the package namespace it should use for localization.
Public function FString Given a text namespace, strip any package namespace that may currently be present.
Public function void  
Public function FCulturePtr  

Variables

  Type Name Description
Public variable TCHAR PackageNamespaceEndMarker  
Public variable TCHAR PackageNamespaceStartMarker  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page