Internationalization

Windows
MacOS
Linux

Classes

Name

Description

Public struct

ELocalizedTextSourcePriority

Pre-defined priorities for ILocalizedTextSource.

Public class

FArchiveEntry

Public struct

FBreakIterator

Public class

FCulture

Public struct

FDecimalNumberFormattingRules

Rules used to format or parse a decimal number

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

Case sensitive immutable hashed string used as a localization key

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 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

FRegexMatcher

Implements a regular expression pattern matcher.

Public class

FRegexPattern

Implements a regular expression pattern.

Public class

FScopedTextIdentityPreserver

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 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

Base class implementation for ITextGenerator.

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

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.

Constants

Typedefs

Enums

Name

Description

Public enum

EDateTimeStyle::Type

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

Public enum

ERoundingMode

Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well

Public enum

EStringTableLoadingPolicy

Loading policy to use with String Table assets

Public enum

ETextComparisonLevel::Type

Public enum

ETextFlag::Type

Public enum

ETextGender

Redeclared in KismetTextLibrary for meta-data extraction purposes, be sure to update there as well

Public enum

ETextPluralForm

Public enum

ETextPluralType

Public enum

TextBiDi::ETextDirection

Lists the potential reading directions for text

Functions

Name Description

Public function

void

 

BeginInitTextLocalization()

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const int32 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const int64 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const uint8 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const uint16 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const uint32 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const uint64 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const float InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const double InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const int8 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const int16 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const int32 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const uint8 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const uint16 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const uint32 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const uint64 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const float InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const double InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const int16 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

FString

 

FastDecimalFormat::NumberToString

(
    const int8 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions
)

Public function

void

 

FastDecimalFormat::NumberToString

(
    const int64 InVal,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberFormattingOptions& InFormattingOptions,
    FString& OutString
)

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,
    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,
    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,
    float& 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 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,
    int8& 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 int32 InStrLen,
    const FDecimalNumberFormattingRules& InFormattingRules,
    const FNumberParsingOptions& InParsingOptions,
    uint32& 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,
    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,
    int16& OutVal,
    int32* OutParsedLen
)

Public function

void

 

InitEngineTextLocalization()

Public function

void

 

InitGameTextLocalization()

Public function

void

 

LexFromString

(
    ERoundingMode& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

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

Public function

void

 

LexFromString

(
    ETextGender& OutValue,
    const TCHAR* Buffer
)

Public function

const TCHAR *

 

LexToString

(
    ETextGender InValue
)

Public function

const TCHAR *

 

LexToString

(
    ERoundingMode InValue
)

Public function

const TCHAR *

 

LexToString

(
    EDateTimeStyle::Type InValue
)

Public function

bool

 

LexTryParseString

(
    ERoundingMode& OutValue,
    const TCHAR* Buffer
)

Public function

bool

 

LexTryParseString

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

Public function

bool

 

LexTryParseString

(
    ETextGender& OutValue,
    const TCHAR* Buffer
)

Public function

constexpr bool

 

operator!

Public function

bool

 

operator!=

(
    const FTextFormatString& LHS,
    const FTextFormatString& RHS
)

Public function

constexpr ELocalizationLoadFlags

 

operator&

Public function

ELocalizationLoadFlags &

 

operator&=

(
    ELocalizationLoadFlags& Lhs,
    ELocalizationLoadFlags Rhs
)

Public function

constexpr ELocalizationLoadFlags

 

operator^

Public function

ELocalizationLoadFlags &

 

operator^=

(
    ELocalizationLoadFlags& Lhs,
    ELocalizationLoadFlags Rhs
)

Public function

constexpr ELocalizationLoadFlags

 

operator|

Public function

ELocalizationLoadFlags &

 

operator|=

(
    ELocalizationLoadFlags& Lhs,
    ELocalizationLoadFlags Rhs
)

Public function

constexpr ELocalizationLoadFlags

 

operator~

Public function

bool

 

operator==

(
    const FTextFormatString& LHS,
    const FTextFormatString& RHS
)

Public function

bool

 

TextBiDi::IsControlCharacter

(
    const TCHAR InChar
)

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

Public function

void

 

TextFormatUtil::FormatNamed

(
    OUTFFormatNamedArguments& Result,
    TName&& Name,
    TValue&& Value
)

Public function

void

 

TextFormatUtil::FormatNamed

(
    OUTFFormatNamedArguments& Result,
    TName&& Name,
    TValue&& Value,
    TArguments&&... Args
)

Public function

void

 

TextFormatUtil::FormatOrdered

(
    OUTFFormatOrderedArguments& Result,
    TValue&& Value
)

Public function

void

 

TextFormatUtil::FormatOrdered

(
    OUTFFormatOrderedArguments& Result,
    TValue&& Value,
    TArguments&&... Args
)

Public function

void

 

TextLocalizationResourceUtil::ClearNativeEditorCultureName()

Clear the native culture for the editor so it will be re-cached on the text call to GetNativeEditorCultureName.

Public function

void

 

TextLocalizationResourceUtil::ClearNativeEngineCultureName()

Clear the native culture for the engine so it will be re-cached on the text call to GetNativeEngineCultureName.

Public function

void

 

TextLocalizationResourceUtil::ClearNativeProjectCultureName()

Clear the native culture for the current project so it will be re-cached on the text call to GetNativeProjectCultureName.

Public function

TArray< FString >

 

TextLocalizationResourceUtil::GetLocalizedCultureNames

(
    const TArray< FString >& InLocalizationPaths
)

Given some paths to look at, populate a list of culture names that we have available localization resource information for.

Public function

FString

 

TextLocalizationResourceUtil::GetNativeCultureName

(
    const ELocalizedTextSourceCategory InCategory
)

Given a localization category, get the native culture for the targets for that category (if known).

Public function

FString

 

TextLocalizationResourceUtil::GetNativeCultureName

(
    const TArray< FString >& InLocalizationPaths
)

Given some paths to look at, get the native culture for the targets within those paths (if known).

Public function

FString

 

TextLocalizationResourceUtil::GetNativeEditorCultureName

(
    const bool bSkipCache
)

Get the native culture for the editor.

Public function

FString

 

TextLocalizationResourceUtil::GetNativeEngineCultureName

(
    const bool bSkipCache
)

Get the native culture for the engine.

Public function

FString

 

TextLocalizationResourceUtil::GetNativeProjectCultureName

(
    const bool bSkipCache
)

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

FString

 

TextNamespaceUtil::ExtractPackageNamespace

(
    const FString& InTextNamespace
)

Given a text namespace, extract any package namespace that may currently be present.

Public function

FString

 

TextNamespaceUtil::GetPackageNamespace

(
    FArchive& InArchive
)

Given an archive, try and get the package namespace it should use for localization.

Public function

FString

 

TextNamespaceUtil::StripPackageNamespace

(
    const FString& InTextNamespace
)

Given a text namespace, strip any package namespace that may currently be present.

Public function

void

 

TextNamespaceUtil::StripPackageNamespaceInline

(
    FString& InOutTextNamespace
)

Given a text namespace, strip any package namespace that may currently be present.

Public function

FCulturePtr

 

UE4LocGen_Private::GetCultureImpl

(
    const TCHAR* InCulture
)

Variables

Name Description

Public variable

FArchiveEntry &

 

OnCultureChanged

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback