FStringTable

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

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FStringTable

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/StringTableCore.h

Include

#include "Internationalization/StringTableCore.h"

Syntax

Remarks

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

Constructors

Name Description

Public function

FStringTable()

Default constructor

Destructors

Name Description

Public function

~FStringTable()

Destructor

Functions

Name Description

Public function

void

 

ClearMetaData

(
    const int32 InSlack
)

Clear all meta-data from the table

Public function

void

 

ClearMetaData

(
    const FString & 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

 

EnumerateMetaData

(
    const FString & InKey,
    const TFunctionRef < bool , con...
)

Enumerate all meta-data associated with the given entry.

Public function Const

void

 

EnumerateSourceStrings

(
    const TFunctionRef < bool ...
)

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

FStringTable ...

 

FindEntry

(
    const FString & InKey
)

Find the entry with the given key (if any)

Public function Const

bool

 

FindKey

(
    const FTextDisplayStringRef & InDis...,
    FString & OutKey
)

Given the display string of an entry, check to see if it exists in this table, and if so, get its key

Public function Const

bool

 

FindKey

(
    const FStringTableEntryConstRef & I...,
    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 FString & 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

 

GetNamespace()

Public function Const

UStringTable ...

 

GetOwnerAsset()

Public function Const

bool

 

GetSourceString

(
    const FString & 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

 

IsLoaded

(
    const bool bInIsLoaded
)

Set whether this string table has been fully loaded yet

Public function Const

bool

 

IsLoaded()

Has this string table been fully loaded yet? (used during asset loading)

Public function Static

FStringTable ...

 

NewStringTable()

Create a new string table

Public function

void

 

RemoveMetaData

(
    const FString & InKey,
    const FName InMetaDataId
)

Remove the meta-data with the given ID associated with the given entry

Public function

void

 

RemoveSourceString

(
    const FString & InKey
)

Remove the given entry (including its meta-data)

Public function

void

 

Serialize

(
    FArchive & Ar
)

Serialize this string table to/from an archive

Public function

void

 

SetMetaData

(
    const FString & 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 FString & 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 FString & 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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback