UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FStringTableRegistry Class Reference

#include <StringTableRegistry.h>

Public Member Functions

CORE_API void RegisterStringTable (const FName InTableId, FStringTableRef InTable)
 
CORE_API bool UnregisterStringTable (const FName InTableId)
 
CORE_API FStringTablePtr FindMutableStringTable (const FName InTableId) const
 
CORE_API FStringTableConstPtr FindStringTable (const FName InTableId) const
 
CORE_API UStringTableFindStringTableAsset (const FName InTableId) const
 
CORE_API void EnumerateStringTables (const TFunctionRef< bool(const FName &, const FStringTableConstRef &)> &InEnumerator) const
 
CORE_API bool FindTableIdAndKey (const FText &InText, FName &OutTableId, FString &OutKey) const
 
CORE_API void LogMissingStringTableEntry (const FName InTableId, const FTextKey &InKey)
 
CORE_API void Internal_NewLocTable (const FName InTableId, const FTextKey &InNamespace)
 
CORE_API void Internal_LocTableFromFile (const FName InTableId, const FTextKey &InNamespace, const FString &InFilePath, const FString &InRootPath)
 
CORE_API void Internal_SetLocTableEntry (const FName InTableId, const FTextKey &InKey, const FString &InSourceString)
 
CORE_API void Internal_SetLocTableEntryMetaData (const FName InTableId, const FTextKey &InKey, const FName InMetaDataId, const FString &InMetaData)
 
CORE_API FText Internal_FindLocTableEntry (const FName InTableId, const FTextKey &InKey, const EStringTableLoadingPolicy InLoadingPolicy) const
 

Static Public Member Functions

static CORE_API FStringTableRegistryGet ()
 

Detailed Description

Singleton registry of known string table instances

Member Function Documentation

◆ EnumerateStringTables()

void FStringTableRegistry::EnumerateStringTables ( const TFunctionRef< bool(const FName &, const FStringTableConstRef &)> &  InEnumerator) const

Enumerate all registered string tables

◆ FindMutableStringTable()

FStringTablePtr FStringTableRegistry::FindMutableStringTable ( const FName  InTableId) const

Try and find a string table with the given ID

◆ FindStringTable()

FStringTableConstPtr FStringTableRegistry::FindStringTable ( const FName  InTableId) const

Try and find a string table with the given ID

◆ FindStringTableAsset()

UStringTable * FStringTableRegistry::FindStringTableAsset ( const FName  InTableId) const

Try and find a string table asset with the given ID

◆ FindTableIdAndKey()

bool FStringTableRegistry::FindTableIdAndKey ( const FText InText,
FName OutTableId,
FString &  OutKey 
) const

Given an FText, try and find the table ID and key for it

◆ Get()

FStringTableRegistry & FStringTableRegistry::Get ( )
static

Singleton accessor

◆ Internal_FindLocTableEntry()

FText FStringTableRegistry::Internal_FindLocTableEntry ( const FName  InTableId,
const FTextKey InKey,
const EStringTableLoadingPolicy  InLoadingPolicy 
) const

Internal function called by LOCTABLE to find the entry with by the given key within the given string table (redirects, will load assets if needed, and returns a dummy FText if not found)

◆ Internal_LocTableFromFile()

void FStringTableRegistry::Internal_LocTableFromFile ( const FName  InTableId,
const FTextKey InNamespace,
const FString &  InFilePath,
const FString &  InRootPath 
)

Internal function called by LOCTABLE_FROMFILE_X to create and register a FStringTable instance that has been populated from a file

◆ Internal_NewLocTable()

void FStringTableRegistry::Internal_NewLocTable ( const FName  InTableId,
const FTextKey InNamespace 
)

Internal function called by LOCTABLE_NEW to create and register a new FStringTable instance

◆ Internal_SetLocTableEntry()

void FStringTableRegistry::Internal_SetLocTableEntry ( const FName  InTableId,
const FTextKey InKey,
const FString &  InSourceString 
)

Internal function called by LOCTABLE_SETSTRING to set the entry denoted by the given key to the given source string, within the given string table (table must have been registered already)

◆ Internal_SetLocTableEntryMetaData()

void FStringTableRegistry::Internal_SetLocTableEntryMetaData ( const FName  InTableId,
const FTextKey InKey,
const FName  InMetaDataId,
const FString &  InMetaData 
)

Internal function called by LOCTABLE_SETMETA to set meta-data for the entry denoted by the given key, within the given string table (table must have been registered already)

◆ LogMissingStringTableEntry()

void FStringTableRegistry::LogMissingStringTableEntry ( const FName  InTableId,
const FTextKey InKey 
)

Log a missing string table entry (will only log each missing entry once to avoid spam)

◆ RegisterStringTable()

void FStringTableRegistry::RegisterStringTable ( const FName  InTableId,
FStringTableRef  InTable 
)

Register a string table with the given ID

◆ UnregisterStringTable()

bool FStringTableRegistry::UnregisterStringTable ( const FName  InTableId)

Unregister a string table with the given ID, returning true if there was a registered string table with the given ID


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