1. Epic GamesDeveloper
  3. FStringTableRegistry

FStringTableRegistry

Singleton registry of known string table instances

API > API/Runtime > API/Runtime/Core

Singleton registry of known string table instances

   
Name FStringTableRegistry
Type class
Header File /Engine/Source/Runtime/Core/Public/Internationalization/StringTableRegistry.h
Include Path #include "Internationalization/StringTableRegistry.h"

Syntax

class FStringTableRegistry

Constructors

Name Remarks Include Path Unreal Specifiers

FStringTableRegistry()

 Private constructor - use singleton accessor Internationalization/StringTableRegistry.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FStringTableRegistry()

   Internationalization/StringTableRegistry.h  

Typedefs

Name Type Remarks Include Path
FLocKeySet TSet< FTextKey > Mapping from a table ID to a set of keys that we've logged warnings for Internationalization/StringTableRegistry.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CSVFilesToWatch TMap< FString, FName > Mapping of absolute CSV file paths to the table ID that imported them using Internal_LocTableFromFile Internationalization/StringTableRegistry.h  
CSVFilesToWatchCS FCriticalSection Critical section preventing concurrent modification of CSVFilesToWatch Internationalization/StringTableRegistry.h  
EngineDirectoryWatcherHandle FDelegateHandle Delegate handle watching the Engine directory Internationalization/StringTableRegistry.h  
GameDirectoryWatcherHandle FDelegateHandle Delegate handle watching the Game directory Internationalization/StringTableRegistry.h  
LoggedMissingEntries TMap< FName, FLocKeySet >   Internationalization/StringTableRegistry.h  
LoggedMissingEntriesCS FTransactionallySafeCriticalSection Critical section preventing concurrent modification of LoggedMissingEntries Internationalization/StringTableRegistry.h  
RegisteredStringTables TMap< FName, FStringTablePtr > Mapping from a table ID to a string table instance Internationalization/StringTableRegistry.h  
RegisteredStringTablesCS FTransactionallySafeCriticalSection Critical section preventing concurrent modification of RegisteredStringTables Internationalization/StringTableRegistry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Enumerate all registered string tables Internationalization/StringTableRegistry.h  

FStringTablePtr FindMutableStringTable ( const FName InTableId
) const

 Try and find a string table with the given ID Internationalization/StringTableRegistry.h  

FStringTableConstPtr FindStringTable ( const FName InTableId
) const

 Try and find a string table with the given ID Internationalization/StringTableRegistry.h  

UStringTable * FindStringTableAsset ( const FName InTableId
) const

 Try and find a string table asset with the given ID Internationalization/StringTableRegistry.h  

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

 Given an FText, try and find the table ID and key for it Internationalization/StringTableRegistry.h  

FText 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) Internationalization/StringTableRegistry.h  

void 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 Internationalization/StringTableRegistry.h  

void Internal_NewLocTable ( const FName InTableId,
const FTextKey& InNamespace
)

 Internal function called by LOCTABLE_NEW to create and register a new FStringTable instance Internationalization/StringTableRegistry.h  

void 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) Internationalization/StringTableRegistry.h  

void 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) Internationalization/StringTableRegistry.h  

void LogMissingStringTableEntry ( const FName InTableId,
const FTextKey& InKey
)

 Log a missing string table entry (will only log each missing entry once to avoid spam) Internationalization/StringTableRegistry.h  

void RegisterStringTable ( const FName InTableId,
FStringTableRef InTable
)

 Register a string table with the given ID Internationalization/StringTableRegistry.h  

bool 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 Internationalization/StringTableRegistry.h  

Static

Name Remarks Include Path Unreal Specifiers

static FStringTableRegistry & Get()

 Singleton accessor Internationalization/StringTableRegistry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page