Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Internationalization > FTextLocalizationManager

Light Theme

Dark Theme

FTextLocalizationManager

Singleton class that manages display strings for [FText](API\Runtime\Core\Internationalization\FText).

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Internationalization/TextLocalizationManager.h
Include	#include "Internationalization/TextLocalizationManager.h"

Syntax

class FTextLocalizationManager

Remarks

Singleton class that manages display strings for FText.

Variables

		Name	Description
	FTextLocalizati...	OnTextRevisionChangedEvent

Constructors

No constructors are accessible with public or protected access.

Functions

	Name	Description
bool	AddDisplayString ( const FTextDisplayStringRef& Displ..., const FTextKey& Namespace, const FTextKey& Key )	Attempts to register the specified display string, associating it with the specified namespace and key.
void	CompactDataStructures()
void	ConfigureGameLocalizationPreviewLanguage ( const FString& CultureName )	Configure the "preview language" setting used for the game localization preview.
void	DisableGameLocalizationPreview()	Disable the game localization preview.
void	DumpMemoryInfo()
void	EnableGameLocalizationPreview ( const FString& CultureName )	Enable the game localization preview using the given language, or the native language if the culture name is empty.
void	EnableGameLocalizationPreview()	Enable the game localization preview using the current "preview language" setting, or the native culture if no "preview language" is set.
FTextDisplay...	FindDisplayString ( const FTextKey& Namespace, const FTextKey& Key, const FString*const SourceStri... )	Finds and returns the display string with the given namespace and key, if it exists.
bool	FindNamespaceAndKeyFromDisplayString ( const FTextDisplayStringRef& InDis..., FTextKey& OutNamespace, FTextKey& OutKey )	Finds the namespace and key associated with the specified display string.
bool	FindNamespaceAndKeyFromDisplayString ( const FTextDisplayStringRef& InDis..., FString& OutNamespace, FString& OutKey )	Finds the namespace and key associated with the specified display string.
FTextLocaliz...	Get()	Singleton accessor
FString	GetConfiguredGameLocalizationPreviewLanguage()	Get the configured "preview language" setting used for the game localization preview (if any).
FTextDisplay...	GetDisplayString ( const FTextKey& Namespace, const FTextKey& Key, const FString*const SourceStri... )	Returns a display string with the given namespace and key.
TArray< FStr...	GetLocalizedCultureNames ( const ELocalizationLoadFlags InLoad... )	Get a list of culture names that we have localized resource data for (ELocalizationLoadFlags controls which resources should be checked).
uint16	GetLocalRevisionForDisplayString ( const FTextDisplayStringRef& InDis... )	Attempts to find a local revision history for the given display string.
bool	GetLocResID ( const FTextKey& Namespace, const FTextKey& Key, FString& OutLocResId )	If an entry exists for the specified namespace and key, returns true and provides the localization resource identifier from which it was loaded.
FString	GetNativeCultureName ( const ELocalizedTextSourceCategory ... )	Given a localization category, get the native culture for the category (if known).
FString	GetRequestedLanguageName()	Get the language that will be requested during localization initialization, based on the hierarchy of: command line -> configs -> OS default.
FString	GetRequestedLocaleName()	Get the locale that will be requested during localization initialization, based on the hierarchy of: command line -> configs -> OS default.
uint16	GetTextRevision()	Returns the current text revision number.
bool	IsGameLocalizationPreviewEnabled()	Is the game localization preview enabled for a non-native language?
bool	IsLocalizationLocked()	Is the localization of this game currently locked? (ie, can it be edited in the UI?).
void	PopAutoEnableGameLocalizationPreview()	Notify that the game localization preview should no longer automatically enable itself under certain circumstances (such as changing the preview language via the UI) due to a state change (such as PIE ending).
void	PushAutoEnableGameLocalizationPreview()	Notify that the game localization preview should automatically enable itself under certain circumstances (such as changing the preview language via the UI) due to a state change (such as PIE starting).
void	RefreshResources()	Reloads resources for the current culture.
void	RegisterPolyglotTextData ( const FPolyglotTextData& InPolyglo..., const bool InAddDisplayString )	Register a polyglot text data with the text localization manager.
void	RegisterPolyglotTextData ( TArrayView< const FPolyglotTextData..., const bool InAddDisplayStrings )	Register a polyglot text data with the text localization manager.
void	RegisterTextSource ( const TSharedRef< ILocalizedTextSou..., const bool InRefreshResources )	Register a localized text source with the text localization manager.
bool	ShouldGameLocalizationPreviewAutoEnable()	Should the game localization preview automatically enable itself under certain circumstances?
void	TearDown()
bool	UpdateDisplayString ( const FTextDisplayStringRef& Displ..., const FString& Value, const FTextKey& Namespace, const FTextKey& Key )	Updates the underlying value of a display string and associates it with a specified namespace and key, then returns true.
void	UpdateFromLocalizationResource ( const FString& LocalizationResourc... )	Updates display string entries and adds new display string entries based on localizations found in a specified localization resource.
void	UpdateFromLocalizationResource ( const FTextLocalizationResource& T... )	Updates display string entries and adds new display string entries based on localizations found in a specified localization resource.

Classes

	Name	Description
	FTextRevisionChangedEvent	Event type for immediately reacting to changes in display strings for text.

Typedefs

Name	Description
FDisplayStringLookupTable	Manages the currently loaded or registered text localizations.
FNamespaceKeyLookupTable	Manages the identity associated with a display string, for use in looking up namespace and key from a display string.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss