1. Epic GamesDeveloper
  3. FPolyglotTextData

FPolyglotTextData

Polyglot data that may be registered to the text localization manager at runtime.

API > API/Runtime > API/Runtime/Core

Polyglot data that may be registered to the text localization manager at runtime.

This struct is mirrored in NoExportTypes.h for UHT.

   
Name FPolyglotTextData
Type struct
Header File /Engine/Source/Runtime/Core/Public/Internationalization/PolyglotTextData.h
Include Path #include "Internationalization/PolyglotTextData.h"

Syntax

struct FPolyglotTextData

Constructors

Name Remarks Include Path Unreal Specifiers

FPolyglotTextData ( const ELocalizedTextSourceCategory& InCategory,
const FString& InNamespace,
const FString& InKey,
const FString& InNativeString,
const FString& InNativeCulture
)

 Construct this polyglot data with an identity, optionally immediately providing the source text and native culture. Internationalization/PolyglotTextData.h  
Default constructor Internationalization/PolyglotTextData.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsMinimalPatch bool True if this polyglot data is a minimal patch, and that missing translations should be ignored (falling back to any LocRes data) rather than falling back to the native string. Internationalization/PolyglotTextData.h  
CachedText FText Transient cached text instance from registering this polyglot data with the text localization manager. Internationalization/PolyglotTextData.h  
Category ELocalizedTextSourceCategory The category of this polyglot data. Internationalization/PolyglotTextData.h  
Key FString The key of the text created from this polyglot data.    

This must not be empty. | Internationalization/PolyglotTextData.h | |

LocalizedStrings TMap< FString, FString > Mapping between a culture code and its localized string. Internationalization/PolyglotTextData.h  
Namespace FString The namespace of the text created from this polyglot data.    

This may be empty. | Internationalization/PolyglotTextData.h | |

NativeCulture FString The native culture of this polyglot data. Internationalization/PolyglotTextData.h  
NativeString FString The native string for this polyglot data. Internationalization/PolyglotTextData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddLocalizedString ( const FString& InCulture,
const FString& InLocalizedString
)

 Add a localized string to this polyglot data. Internationalization/PolyglotTextData.h  

void ClearLocalizedStrings()

 Clear the localized strings from this polyglot data. Internationalization/PolyglotTextData.h  
Get the category of this polyglot data. Internationalization/PolyglotTextData.h  

void GetIdentity ( FString& OutNamespace,
FString& OutKey
) const

 Get the identity of the text created from this polyglot data. Internationalization/PolyglotTextData.h  

const FString & GetKey()

 Get the key of the text created from this polyglot data. Internationalization/PolyglotTextData.h  

TArray< FString > GetLocalizedCultures()

 Get the localized cultures of this polyglot data. Internationalization/PolyglotTextData.h  

bool GetLocalizedString ( const FString& InCulture,
FString& OutLocalizedString
) const

 Get a localized string from this polyglot data. Internationalization/PolyglotTextData.h  

const FString & GetNamespace()

 Get the namespace of the text created from this polyglot data. Internationalization/PolyglotTextData.h  

const FString & GetNativeCulture()

 Get the native culture of this polyglot data. Internationalization/PolyglotTextData.h  

const FString & GetNativeString()

 Get the native string of this polyglot data. Internationalization/PolyglotTextData.h  

FText GetText()

 Get the text instance created from this polyglot data. Internationalization/PolyglotTextData.h  

bool IsMinimalPatch ()

 Get whether this polyglot data is a minimal patch. Internationalization/PolyglotTextData.h  

void IsMinimalPatch ( const bool InIsMinimalPatch
)

 Set whether this polyglot data is a minimal patch. Internationalization/PolyglotTextData.h  

bool IsValid ( FText* OutFailureReason
) const

 Is this polyglot data valid and can be registered with the text localization manager? Internationalization/PolyglotTextData.h  

void RemoveLocalizedString ( const FString& InCulture
)

 Remove a localized string from this polyglot data. Internationalization/PolyglotTextData.h  

FString ResolveNativeCulture()

 Resolve the native culture of this polyglot data, either using the native culture if specified, or inferring it from the category. Internationalization/PolyglotTextData.h  

void SetCategory ( const ELocalizedTextSourceCategory InCategory
)

 Set the category of this polyglot data. Internationalization/PolyglotTextData.h  

void SetIdentity ( const FString& InNamespace,
const FString& InKey
)

 Set the identity of the text created from this polyglot data. The key must not be empty. Internationalization/PolyglotTextData.h  

void SetNativeCulture ( const FString& InNativeCulture
)

 Set the native culture of this polyglot data. Internationalization/PolyglotTextData.h  

void SetNativeString ( const FString& InNativeString
)

 Set the native string of this polyglot data. The native string must not be empty. Internationalization/PolyglotTextData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page