UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
FPolyglotTextSource Class Reference

#include <PolyglotTextSource.h>

+ Inheritance diagram for FPolyglotTextSource:

Public Member Functions

virtual int32 GetPriority () const override
 
virtual bool GetNativeCultureName (const ELocalizedTextSourceCategory InCategory, FString &OutNativeCultureName) override
 
virtual void GetLocalizedCultureNames (const ELocalizationLoadFlags InLoadFlags, TSet< FString > &OutLocalizedCultureNames) override
 
virtual void LoadLocalizedResources (const ELocalizationLoadFlags InLoadFlags, TArrayView< const FString > InPrioritizedCultures, FTextLocalizationResource &InOutNativeResource, FTextLocalizationResource &InOutLocalizedResource) override
 
virtual EQueryLocalizedResourceResult QueryLocalizedResource (const ELocalizationLoadFlags InLoadFlags, TArrayView< const FString > InPrioritizedCultures, const FTextId InTextId, FTextLocalizationResource &InOutNativeResource, FTextLocalizationResource &InOutLocalizedResource) override
 
void RegisterPolyglotTextData (const FPolyglotTextData &InPolyglotTextData)
 
- Public Member Functions inherited from ILocalizedTextSource
virtual ~ILocalizedTextSource ()=default
 

Additional Inherited Members

- Static Public Member Functions inherited from ILocalizedTextSource
static UE_FORCEINLINE_HINT bool ShouldLoadNative (const ELocalizationLoadFlags InLoadFlags)
 
static UE_FORCEINLINE_HINT bool ShouldLoadEditor (const ELocalizationLoadFlags InLoadFlags)
 
static UE_FORCEINLINE_HINT bool ShouldLoadGame (const ELocalizationLoadFlags InLoadFlags)
 
static UE_FORCEINLINE_HINT bool ShouldLoadEngine (const ELocalizationLoadFlags InLoadFlags)
 
static UE_FORCEINLINE_HINT bool ShouldLoadAdditional (const ELocalizationLoadFlags InLoadFlags)
 
static UE_FORCEINLINE_HINT bool ShouldLoadNativeGameData (const ELocalizationLoadFlags InLoadFlags)
 

Detailed Description

Implementation of a localized text source that stores literal polyglot data registered at runtime.

Member Function Documentation

◆ GetLocalizedCultureNames()

void FPolyglotTextSource::GetLocalizedCultureNames ( const ELocalizationLoadFlags  InLoadFlags,
TSet< FString > &  OutLocalizedCultureNames 
)
overridevirtual

Populate a list of culture names that this localized text source has resource data for (ELocalizationLoadFlags controls which resources should be checked).

Implements ILocalizedTextSource.

◆ GetNativeCultureName()

bool FPolyglotTextSource::GetNativeCultureName ( const ELocalizedTextSourceCategory  InCategory,
FString &  OutNativeCultureName 
)
overridevirtual

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

Returns
True if the native culture was populated, or false if the native culture is unknown.

Implements ILocalizedTextSource.

◆ GetPriority()

virtual int32 FPolyglotTextSource::GetPriority ( ) const
inlineoverridevirtual

Get the priority of this source when building the complete list of translations to apply (higher numbers have a higher priority).

Reimplemented from ILocalizedTextSource.

◆ LoadLocalizedResources()

void FPolyglotTextSource::LoadLocalizedResources ( const ELocalizationLoadFlags  InLoadFlags,
TArrayView< const FString >  InPrioritizedCultures,
FTextLocalizationResource &  InOutNativeResource,
FTextLocalizationResource &  InOutLocalizedResource 
)
overridevirtual

Load the localized resources from this localized text source for the given cultures into the given maps (ELocalizationLoadFlags controls which resources should be loaded).

Implements ILocalizedTextSource.

◆ QueryLocalizedResource()

EQueryLocalizedResourceResult FPolyglotTextSource::QueryLocalizedResource ( const ELocalizationLoadFlags  InLoadFlags,
TArrayView< const FString >  InPrioritizedCultures,
const FTextId  InTextId,
FTextLocalizationResource &  InOutNativeResource,
FTextLocalizationResource &  InOutLocalizedResource 
)
overridevirtual

Query a localized resource from this localized text source for the given cultures and ID into the given maps (ELocalizationLoadFlags controls which resources should be queried).

Reimplemented from ILocalizedTextSource.

◆ RegisterPolyglotTextData()

void FPolyglotTextSource::RegisterPolyglotTextData ( const FPolyglotTextData &  InPolyglotTextData)

Register a polyglot text data with this localized text source.

The documentation for this class was generated from the following files: