FTextKey Class Reference

#include <TextKey.h>

Collaboration diagram for FTextKey:

Public Member Functions
	FTextKey ()
	FTextKey (const TCHAR *InStr)
	FTextKey (const FString &InStr)
	FTextKey (FString &&InStr)
FORCEINLINE const TCHAR *	GetChars () const
void	SerializeAsString (FArchive &Ar)
void	SerializeWithHash (FArchive &Ar)
void	SerializeDiscardHash (FArchive &Ar)
void	SerializeAsString (FStructuredArchiveSlot Slot)
void	SerializeWithHash (FStructuredArchiveSlot Slot)
void	SerializeDiscardHash (FStructuredArchiveSlot Slot)
FORCEINLINE bool	IsEmpty () const
void	Reset ()

Static Public Member Functions
static void	CompactDataStructures ()
static void	TearDown ()

Private Attributes
const TCHAR *	StrPtr
uint32	StrHash

Friends
FORCEINLINE bool	operator== (const FTextKey &A, const FTextKey &B)
FORCEINLINE bool	operator!= (const FTextKey &A, const FTextKey &B)
FORCEINLINE uint32	GetTypeHash (const FTextKey &A)

Detailed Description

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.

Definition at line 59 of file TextKey.h.

Constructor & Destructor Documentation

FTextKey() [1/4]

FTextKey::FTextKey

(

)

FTextKey() [2/4]

FTextKey::FTextKey

(

const TCHAR *

InStr

)

FTextKey() [3/4]

FTextKey::FTextKey

(

const FString &

InStr

)

FTextKey() [4/4]

FTextKey::FTextKey

(

FString &&

InStr

)

Member Function Documentation

CompactDataStructures()

static void FTextKey::CompactDataStructures ( )

static

Compact any slack within the internal table

GetChars()

FORCEINLINE const TCHAR * FTextKey::GetChars ( ) const

inline

Get the underlying chars buffer this text key represents

Definition at line 68 of file TextKey.h.

IsEmpty()

FORCEINLINE bool FTextKey::IsEmpty ( ) const

inline

Is this text key empty?

Definition at line 110 of file TextKey.h.

Here is the caller graph for this function:

Reset()

void FTextKey::Reset

(

)

Reset this text key to be empty

Here is the caller graph for this function:

SerializeAsString() [1/2]

void FTextKey::SerializeAsString

(

FArchive &

Ar

)

Serialize this text key as if it were an FString

Here is the caller graph for this function:

SerializeAsString() [2/2]

void FTextKey::SerializeAsString

(

FStructuredArchiveSlot

Slot

)

Serialize this text key as if it were an FString

Here is the caller graph for this function:

SerializeDiscardHash() [1/2]

void FTextKey::SerializeDiscardHash

(

FArchive &

Ar

)

Serialize this text key including its hash value, discarding the hash on load (to upgrade from an older hashing algorithm)

Here is the caller graph for this function:

SerializeDiscardHash() [2/2]

void FTextKey::SerializeDiscardHash

(

FStructuredArchiveSlot

Slot

)

Serialize this text key including its hash value, discarding the hash on load (to upgrade from an older hashing algorithm)

Here is the caller graph for this function:

SerializeWithHash() [1/2]

void FTextKey::SerializeWithHash

(

FArchive &

Ar

)

Serialize this text key including its hash value (this method is sensitive to hashing algorithm changes, so only use it for generated files that can be rebuilt from another source)

Here is the caller graph for this function:

SerializeWithHash() [2/2]

void FTextKey::SerializeWithHash

(

FStructuredArchiveSlot

Slot

)

Serialize this text key including its hash value (this method is sensitive to hashing algorithm changes, so only use it for generated files that can be rebuilt from another source)

Here is the caller graph for this function:

TearDown()

static void FTextKey::TearDown ( )

static

Do not use any FTextKey or FTextId after calling this

Friends And Related Symbol Documentation

GetTypeHash

FORCEINLINE uint32 GetTypeHash ( const FTextKey & A )

friend

Get the hash of this text key

Definition at line 86 of file TextKey.h.

operator!=

FORCEINLINE bool operator!= ( const FTextKey & A, const FTextKey & B )

friend

Compare for inequality

Definition at line 80 of file TextKey.h.

operator==

FORCEINLINE bool operator== ( const FTextKey & A, const FTextKey & B )

friend

Compare for equality

Definition at line 74 of file TextKey.h.

Member Data Documentation

StrHash

uint32 FTextKey::StrHash

private

Hash of this text key

Definition at line 129 of file TextKey.h.

StrPtr

const TCHAR* FTextKey::StrPtr

private

Pointer to the string buffer we reference from the internal table

Definition at line 126 of file TextKey.h.

---

The documentation for this class was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Internationalization/TextKey.h