1. Epic GamesDeveloper
  3. FStringTable

FStringTable

String table implementation. Holds Key->SourceString pairs of text.

API > API/Runtime > API/Runtime/Core

String table implementation. Holds Key->SourceString pairs of text.

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

Syntax

class FStringTable : public TSharedFromThis< FStringTable, ESPMode::ThreadSafe >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FStringTable()

 Default constructor Internationalization/StringTableCore.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FStringTable()

 Destructor Internationalization/StringTableCore.h  

Typedefs

Name Type Remarks Include Path
FMetaDataMap TMap< FName, FString > Mapping between the text key and its meta-data map Internationalization/StringTableCore.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsInternal bool True if this table is internal and shouldn't appear in pickers Internationalization/StringTableCore.h  
bIsLoaded bool True if this table has been fully loaded (used for assets) Internationalization/StringTableCore.h  
KeyMappingCS FTransactionallySafeCriticalSection Critical section preventing concurrent modification of KeysToEntries Internationalization/StringTableCore.h  
KeysToEntries TMap< FTextKey, FStringTableEntryPtr > Mapping between the text key and entry data for the strings within this table Internationalization/StringTableCore.h  
KeysToMetaData TMap< FTextKey, FMetaDataMap >   Internationalization/StringTableCore.h  
KeysToMetaDataCS FTransactionallySafeCriticalSection Critical section preventing concurrent modification of KeysToMetaData Internationalization/StringTableCore.h  
OwnerAsset UStringTable * Pointer back to the asset that owns this table Internationalization/StringTableCore.h  
TableNamespace FTextKey The namespace to use for all the strings in this table Internationalization/StringTableCore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearMetaData ( const int32 InSlack
)

 Clear all meta-data from the table Internationalization/StringTableCore.h  

void ClearMetaData ( const FTextKey& InKey
)

 Remove all meta-data associated with the given entry Internationalization/StringTableCore.h  

void ClearSourceStrings ( const int32 InSlack
)

 Clear all entries from the table (including their meta-data) Internationalization/StringTableCore.h  

void EnumerateKeysAndSourceStrings ( const TFunctionRef< bool(const FTextKey&, const FString&)>& InEnumerator
) const

   Internationalization/StringTableCore.h  

void EnumerateMetaData ( const FTextKey& InKey,
const TFunctionRef< bool(FName, const FString&)>& InEnumerator
) const

 Enumerate all meta-data associated with the given entry. Internationalization/StringTableCore.h  

void EnumerateSourceStrings ( const TFunctionRef< bool(const FString&, const FString&)>& InEnumerator
) const

 Enumerate all source strings in the table. Internationalization/StringTableCore.h  

bool ExportStrings ( const FString& InFilename
) const

 Export the key, string, and meta-data information in this string table to a CSV file (does not export the namespace) Internationalization/StringTableCore.h  

FStringTableEntryConstPtr FindEntry ( const FTextKey& InKey
) const

 Find the entry with the given key (if any) Internationalization/StringTableCore.h  

bool FindKey ( const FStringTableEntryConstRef& InEntry,
FTextKey& OutKey
) const

   Internationalization/StringTableCore.h  

bool FindKey ( const FStringTableEntryConstRef& InEntry,
FString& OutKey
) const

 Given an entry, check to see if it exists in this table, and if so, get its key Internationalization/StringTableCore.h  

FString GetMetaData ( const FTextKey& InKey,
const FName InMetaDataId
) const

 Get the meta-data with the given ID associated with the given entry, or an empty string if not found Internationalization/StringTableCore.h  

FString GetNamespace()

   Internationalization/StringTableCore.h  

UStringTable * GetOwnerAsset()

   Internationalization/StringTableCore.h  

bool GetSourceString ( const FTextKey& InKey,
FString& OutSourceString
) const

 Get the source string used by the given entry (if any) Internationalization/StringTableCore.h  

bool ImportStrings ( const FString& InFilename
)

 Import key, string, and meta-data information from a CSV file to this string table (does not import the namespace) Internationalization/StringTableCore.h  

void IsInternal ( const bool bInIsInternal
)

 Set whether this string table is considered internal Internationalization/StringTableCore.h  

bool IsInternal ()

 Is this string table considered internal (ie, shouldn't appear in pickers) Internationalization/StringTableCore.h  

void IsLoaded ( const bool bInIsLoaded
)

 Set whether this string table has been fully loaded Internationalization/StringTableCore.h  

bool IsLoaded ()

 Has this string table been fully loaded yet? (used during asset loading) Internationalization/StringTableCore.h  

void RemoveMetaData ( const FTextKey& InKey,
const FName InMetaDataId
)

 Remove the meta-data with the given ID associated with the given entry Internationalization/StringTableCore.h  

void RemoveSourceString ( const FTextKey& InKey
)

 Remove the given entry (including its meta-data) Internationalization/StringTableCore.h  

void Serialize ( FArchive& Ar
)

 Serialize this string table to/from an archive Internationalization/StringTableCore.h  

void SetMetaData ( const FTextKey& InKey,
const FName InMetaDataId,
const FString& InMetaDataValue
)

 Set the meta-data with the given ID associated with the given entry Internationalization/StringTableCore.h  

void SetNamespace ( const FTextKey& InNamespace
)

 Set the namespace used by all entries in this string table Internationalization/StringTableCore.h  

void SetOwnerAsset ( UStringTable* InOwnerAsset
)

 Set the asset that owns this string table instance (if any) Internationalization/StringTableCore.h  

void SetSourceString ( const FTextKey& InKey,
const FString& InSourceString
)

 Set the source string used by the given entry (will replace any existing data for that entry) Internationalization/StringTableCore.h  

Static

Name Remarks Include Path Unreal Specifiers

static FStringTableRef NewStringTable()

 Create a new string table Internationalization/StringTableCore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page