1. Epic GamesDeveloper
  3. FTextLocalizationManager

FTextLocalizationManager

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

Unreal Engine C++ API Reference > Runtime > Core > Internationalization

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

  Type Name Description
Public variable FTextLocalizationManager::FTextRevisionChangedEvent OnTextRevisionChangedEvent  

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool

AddDisplayString ( const FTextDisplayStringRef& DisplayString,
const FTextKey& Namespace,
const FTextKey& Key
)

 Attempts to register the specified display string, associating it with the specified namespace and key.
Public function void  
Public function void Configure the "preview language" setting used for the game localization preview.
Public function void Disable the game localization preview.
Public function Const void  
Public function void

EnableGameLocalizationPreview ( const FString& CultureName
)

 Enable the game localization preview using the given language, or the native language if the culture name is empty.
Public function void Enable the game localization preview using the current "preview language" setting, or the native culture if no "preview language" is set.
Public function Const FTextConstDisplayStringPtr

FindDisplayString ( const FTextKey& Namespace,
const FTextKey& Key,
const FString*const SourceString
)

 Finds and returns the display string with the given namespace and key, if it exists.
Public function Static FTextLocalizationManager &

Get ()

 Singleton accessor
Public function Const FString Get the configured "preview language" setting used for the game localization preview (if any).
Public function FTextConstDisplayStringRef

GetDisplayString ( const FTextKey& Namespace,
const FTextKey& Key,
const FString*const SourceString
)

 Returns a display string with the given namespace and key.
Public function Const TArray< FString >

GetLocalizedCultureNames ( const ELocalizationLoadFlags InLoadFlags
)

 Get a list of culture names that we have localized resource data for (ELocalizationLoadFlags controls which resources should be checked).
Public function Const uint16

GetLocalRevisionForTextId ( const FTextId& InTextId
)

 Attempts to find a local revision history for the given text ID.
Public function Const 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.
Public function Const FString

GetNativeCultureName ( const ELocalizedTextSourceCategory InCategory
)

 Given a localization category, get the native culture for the category (if known).
Public function Const FString Get the language that will be requested during localization initialization, based on the hierarchy of: command line -> configs -> OS default.
Public function Const FString Get the locale that will be requested during localization initialization, based on the hierarchy of: command line -> configs -> OS default.
Public function Const uint16 Returns the current text revision number.
Public function Const void

GetTextRevisions ( const FTextId& InTextId,
uint16& OutGlobalTextRevision,
uint16& OutLocalTextRevision
)

 Get both the global and local revision for the given text ID.
Public function void

HandleLocalizationTargetsMounted ( TArrayView< const FString > LocalizationTargetPaths
)

 Called when paths containing additional localization target data (LocRes) are mounted, to allow the display strings to dynamically update without waiting for a refresh.
Public function void

HandleLocalizationTargetsUnmounted ( TArrayView< const FString > LocalizationTargetPaths
)

 Called when paths containing additional localization target data (LocRes) are unmounted, to allow the display strings to dynamically update without waiting for a refresh.
Public function Const bool Is the game localization preview enabled for a non-native language?
Public function Const bool Is the localization of this game currently locked? (ie, can it be edited in the UI?).
Public function void 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).
Public function void 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).
Public function void Reloads resources for the current culture. The loading is async, see WaitUntilLoadingCompletes.
Public function void

RegisterPolyglotTextData ( const FPolyglotTextData& InPolyglotTextData,
const bool InAddDisplayString
)

 Register a polyglot text data with the text localization manager.
Public function void

RegisterPolyglotTextData ( TArrayView< const FPolyglotTextData > InPolyglotTextDataArray,
const bool InAddDisplayStrings
)

 Register a polyglot text data with the text localization manager.
Public function void

RegisterTextSource ( const TSharedRef< ILocalizedTextSource >& InLocalizedTextSource,
const bool InRefreshResources
)

 Register a localized text source with the text localization manager.
Public function Const bool Should the game localization preview automatically enable itself under certain circumstances?
Public function Static void  
Public function void

UpdateFromLocalizationResource ( const FString& LocalizationResourceFilePath
)

 Updates display string entries and adds new display string entries based on localizations found in a specified localization resource.
Public function void

UpdateFromLocalizationResource ( const FTextLocalizationResource& TextLocalizationResource
)

 Updates display string entries and adds new display string entries based on localizations found in a specified localization resource.
Public function void Wait for any current async tasks to finish.

Operators

  Type Name Description
Public function FTextLocalizationManager &  
Public function FTextLocalizationManager &  

Classes

  Type Name Description
Public class 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.

Deprecated Functions

  Type Name Description
Public function Const bool

FindNamespaceAndKeyFromDisplayString ( const FTextConstDisplayStringPtr& InDisplayString,
FString& OutNamespace,
FString& OutKey
)

 FindNamespaceAndKeyFromDisplayString no longer functions! Use FTextInspector::GetTextId instead.
Public function Const bool

FindNamespaceAndKeyFromDisplayString ( const FTextConstDisplayStringPtr& InDisplayString,
FTextKey& OutNamespace,
FTextKey& OutKey
)

 FindNamespaceAndKeyFromDisplayString no longer functions! Use FTextInspector::GetTextId instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page