1. Epic GamesDeveloper
  3. FStringTable

FStringTable

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

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Internationalization

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Internationalization/StringTableCore.h
Include #include "Internationalization/StringTableCore.h"

Syntax

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

Remarks

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

Constructors

  Type Name Description
Public function   Default constructor

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void

ClearMetaData ( const int32 InSlack
)

 Clear all meta-data from the table
Public function void

ClearMetaData ( const FTextKey& InKey
)

 Remove all meta-data associated with the given entry
Public function void

ClearSourceStrings ( const int32 InSlack
)

 Clear all entries from the table (including their meta-data)
Public function Const void

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

  
Public function Const void

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

 Enumerate all meta-data associated with the given entry.
Public function Const void

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

 Enumerate all source strings in the table.
Public function Const bool

ExportStrings ( const FString& InFilename
)

 Export the key, string, and meta-data information in this string table to a CSV file (does not export the namespace)
Public function Const FStringTableEntryConstPtr

FindEntry ( const FTextKey& InKey
)

 Find the entry with the given key (if any)
Public function Const bool

FindKey ( const FStringTableEntryConstRef& InEntry,
FTextKey& OutKey
)

  
Public function Const bool

FindKey ( const FStringTableEntryConstRef& InEntry,
FString& OutKey
)

 Given an entry, check to see if it exists in this table, and if so, get its key
Public function Const FString

GetMetaData ( const FTextKey& InKey,
const FName InMetaDataId
)

 Get the meta-data with the given ID associated with the given entry, or an empty string if not found
Public function Const FString  
Public function Const UStringTable *  
Public function Const bool

GetSourceString ( const FTextKey& InKey,
FString& OutSourceString
)

 Get the source string used by the given entry (if any)
Public function 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)
Public function void

IsInternal ( const bool bInIsInternal
)

 Set whether this string table is considered internal
Public function Const bool Is this string table considered internal (ie, shouldn't appear in pickers)
Public function void

IsLoaded ( const bool bInIsLoaded
)

 Set whether this string table has been fully loaded
Public function Const bool Has this string table been fully loaded yet? (used during asset loading)
Public function Static FStringTableRef Create a new string table
Public function void

RemoveMetaData ( const FTextKey& InKey,
const FName InMetaDataId
)

 Remove the meta-data with the given ID associated with the given entry
Public function void

RemoveSourceString ( const FTextKey& InKey
)

 Remove the given entry (including its meta-data)
Public function void Serialize this string table to/from an archive
Public function void

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

 Set the meta-data with the given ID associated with the given entry
Public function void

SetNamespace ( const FTextKey& InNamespace
)

 Set the namespace used by all entries in this string table
Public function void

SetOwnerAsset ( UStringTable* InOwnerAsset
)

 Set the asset that owns this string table instance (if any)
Public function 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)

Typedefs

Name Description
FMetaDataMap Mapping between the text key and its meta-data map

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page