FPolyglotTextData

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

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/PolyglotTextData.h

Include

#include "Internationalization/PolyglotTextData.h"

Syntax

struct FPolyglotTextData

Remarks

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

This struct is mirrored in NoExportTypes.h for UHT.

Constructors

Name Description

Public function

FPolyglotTextData()

Default constructor

Public function

FPolyglotTextData

(
    const ELocalizedTextSourceCategory ...,
    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.

Functions

Name Description

Public function

void

 

AddLocalizedString

(
    const FString& InCulture,
    const FString& InLocalizedString
)

Add a localized string to this polyglot data.

Public function

void

 

ClearLocalizedStrings()

Clear the localized strings from this polyglot data.

Public function Const

ELocalizedTe...

 

GetCategory()

Get the category of this polyglot data.

Public function Const

void

 

GetIdentity

(
    FString& OutNamespace,
    FString& OutKey
)

Get the identity of the text created from this polyglot data.

Public function Const

const FStrin...

 

GetKey()

Get the key of the text created from this polyglot data.

Public function Const

TArray< FStr...

 

GetLocalizedCultures()

Get the localized cultures of this polyglot data.

Public function Const

bool

 

GetLocalizedString

(
    const FString& InCulture,
    FString& OutLocalizedString
)

Get a localized string from this polyglot data.

Public function Const

const FStrin...

 

GetNamespace()

Get the namespace of the text created from this polyglot data.

Public function Const

const FStrin...

 

GetNativeCulture()

Get the native culture of this polyglot data.

Public function Const

const FStrin...

 

GetNativeString()

Get the native string of this polyglot data.

Public function Const

FText

 

GetText()

Get the text instance created from this polyglot data.

Public function Const

bool

 

IsMinimalPatch()

Get whether this polyglot data is a minimal patch.

Public function

void

 

IsMinimalPatch

(
    const bool InIsMinimalPatch
)

Set whether this polyglot data is a minimal patch.

Public function Const

bool

 

IsValid

(
    FText* OutFailureReason
)

Is this polyglot data valid and can be registered with the text localization manager?

Public function

void

 

RemoveLocalizedString

(
    const FString& InCulture
)

Remove a localized string from this polyglot data.

Public function Const

FString

 

ResolveNativeCulture()

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

Public function

void

 

SetCategory

(
    const ELocalizedTextSourceCategory ...
)

Set the category of this polyglot data.

Public function

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.

Public function

void

 

SetNativeCulture

(
    const FString& InNativeCulture
)

Set the native culture of this polyglot data.

Public function

void

 

SetNativeString

(
    const FString& InNativeString
)

Set the native string of this polyglot data.

The native string must not be empty.

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