FTextKey

Optimized representation of a case-sensitive string, as used by localization keys.

Windows
MacOS
Linux

Syntax

class FTextKey

Remarks

Optimized representation of a case-sensitive string, as used by localization keys. This references an entry within a internal table to avoid memory duplication, as well as offering optimized comparison and hashing performance.

Constructors

Name Description

Public function

FTextKey()

Public function

FTextKey

(
    const TCHAR* InStr
)

Public function

FTextKey

(
    const FString& InStr
)

Public function

FTextKey

(
    FString&& InStr
)

Functions

Name Description

Public function Static

void

 

CompactDataStructures()

Compact any slack within the internal table

Public function Const

const TCHAR ...

 

GetChars()

Get the underlying chars buffer this text key represents

Public function Const

bool

 

IsEmpty()

Is this text key empty?

Public function

void

 

Reset()

Reset this text key to be empty

Public function

void

 

Serialize

(
    FArchive& Ar
)

Serialize this text key

Public function

void

 

SerializeAsString

(
    FArchive& Ar
)

Serialize this text key as if it were an FString

References

Module

Core

Header

Runtime/Core/Public/Internationalization/TextKey.h

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