UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LocalizedTextSourceTypes.h File Reference
#include "CoreTypes.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/UEOps.h"
#include "Templates/RefCounting.h"
#include "Templates/Requires.h"
#include "Templates/SharedPointer.h"
#include <type_traits>

Go to the source code of this file.

Classes

struct  ELocalizedTextSourcePriority
 
class  UE::Text::Private::FRefCountedDisplayString
 
class  UE::Text::Private::TDisplayStringPtrBase< ObjectType >
 
class  UE::Text::Private::TDisplayStringRef< ObjectType >
 
class  UE::Text::Private::TDisplayStringPtr< ObjectType >
 

Namespaces

namespace  UE
 
namespace  UE::Text
 
namespace  UE::Text::Private
 

Typedefs

using FTextDisplayStringRef = UE::Text::Private::TDisplayStringRef< FString >
 
using FTextDisplayStringPtr = UE::Text::Private::TDisplayStringPtr< FString >
 
using FTextConstDisplayStringRef = UE::Text::Private::TDisplayStringRef< const FString >
 
using FTextConstDisplayStringPtr = UE::Text::Private::TDisplayStringPtr< const FString >
 

Enumerations

enum class  ELocalizedTextSourceCategory : uint8 { Game , Engine , Editor }
 
enum class  EQueryLocalizedResourceResult : uint8 { Found , NotFound , NotImplemented }
 
enum class  ELocalizationLoadFlags : uint8 {
  None = 0 , Native = 1<<0 , Editor = 1<<1 , Game = 1<<2 ,
  Engine = 1<<3 , Additional = 1<<4 , ForceLocalizedGame = 1<<5 , SkipExisting = 1<<6
}
 

Functions

 ENUM_CLASS_FLAGS (ELocalizationLoadFlags)
 
template<typename ObjectType >
uint32 GetTypeHash (const UE::Text::Private::TDisplayStringRef< ObjectType > &A)
 
template<typename ObjectType >
uint32 GetTypeHash (const UE::Text::Private::TDisplayStringPtr< ObjectType > &A)
 
FTextDisplayStringRef MakeTextDisplayString (FString &&InDisplayString)
 

Typedef Documentation

◆ FTextConstDisplayStringPtr

◆ FTextConstDisplayStringRef

◆ FTextDisplayStringPtr

◆ FTextDisplayStringRef

Enumeration Type Documentation

◆ ELocalizationLoadFlags

Load flags used in localization initialization.

Enumerator
None 

Load no data

Native 

Load native data

Editor 

Load editor localization data

Game 

Load game localization data

Engine 

Load engine localization data

Additional 

Load additional (eg, plugin) localization data

ForceLocalizedGame 

Force localized game data to be loaded, even when running in the editor

SkipExisting 

Skip updating any entries that already exist in the live table

Note
Not useful when performing a full update, but has utility when patching in new untrusted localization data (eg, loading UGC localization data over the base localization data)

◆ ELocalizedTextSourceCategory

Categories of localized text.

Note
This enum is mirrored in NoExportTypes.h for UHT.
Enumerator
Game 
Engine 
Editor 

◆ EQueryLocalizedResourceResult

Result codes from calling QueryLocalizedResourceResult.

Enumerator
Found 

Indicates the query found a matching entry and added its result

NotFound 

Indicates that the query failed to find a matching entry

NotImplemented 

Indicates that the query failed as this text source doesn't support queries

Function Documentation

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( ELocalizationLoadFlags  )

◆ GetTypeHash() [1/2]

template<typename ObjectType >
uint32 GetTypeHash ( const UE::Text::Private::TDisplayStringPtr< ObjectType > &  A)

◆ GetTypeHash() [2/2]

template<typename ObjectType >
uint32 GetTypeHash ( const UE::Text::Private::TDisplayStringRef< ObjectType > &  A)

◆ MakeTextDisplayString()

FTextDisplayStringRef MakeTextDisplayString ( FString &&  InDisplayString)
inline