Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FTextId Class Reference

#include <TextKey.h>

+ Collaboration diagram for FTextId:

Public Member Functions

 FTextId ()=default
 
 FTextId (const FTextKey &InNamespace, const FTextKey &InKey)
 
FORCEINLINE const FTextKeyGetNamespace () const
 
FORCEINLINE const FTextKeyGetKey () 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
 
FORCEINLINE void Reset ()
 

Private Attributes

FTextKey Namespace
 
FTextKey Key
 

Friends

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

Detailed Description

Optimized representation of a text identity (a namespace and key pair).

Definition at line 135 of file TextKey.h.

Constructor & Destructor Documentation

◆ FTextId() [1/2]

FTextId::FTextId ( )
default

◆ FTextId() [2/2]

FTextId::FTextId ( const FTextKey & InNamespace,
const FTextKey & InKey )
inline

Definition at line 140 of file TextKey.h.

Member Function Documentation

◆ GetKey()

FORCEINLINE const FTextKey & FTextId::GetKey ( ) const
inline

Get the key component of this text identity

Definition at line 153 of file TextKey.h.

◆ GetNamespace()

FORCEINLINE const FTextKey & FTextId::GetNamespace ( ) const
inline

Get the namespace component of this text identity

Definition at line 147 of file TextKey.h.

◆ IsEmpty()

FORCEINLINE bool FTextId::IsEmpty ( ) const
inline

Is this text identity empty?

Definition at line 222 of file TextKey.h.

+ Here is the call graph for this function:

◆ Reset()

FORCEINLINE void FTextId::Reset ( )
inline

Reset this text identity to be empty

Definition at line 228 of file TextKey.h.

+ Here is the call graph for this function:

◆ SerializeAsString() [1/2]

void FTextId::SerializeAsString ( FArchive & Ar)
inline

Serialize this text identity as if it were FStrings

Definition at line 177 of file TextKey.h.

+ Here is the call graph for this function:

◆ SerializeAsString() [2/2]

void FTextId::SerializeAsString ( FStructuredArchiveSlot Slot)
inline

Serialize this text identity as if it were FStrings

Definition at line 198 of file TextKey.h.

+ Here is the call graph for this function:

◆ SerializeDiscardHash() [1/2]

void FTextId::SerializeDiscardHash ( FArchive & Ar)
inline

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

Definition at line 191 of file TextKey.h.

+ Here is the call graph for this function:

◆ SerializeDiscardHash() [2/2]

void FTextId::SerializeDiscardHash ( FStructuredArchiveSlot Slot)
inline

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

Definition at line 214 of file TextKey.h.

+ Here is the call graph for this function:

◆ SerializeWithHash() [1/2]

void FTextId::SerializeWithHash ( FArchive & Ar)
inline

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

Definition at line 184 of file TextKey.h.

+ Here is the call graph for this function:

◆ SerializeWithHash() [2/2]

void FTextId::SerializeWithHash ( FStructuredArchiveSlot Slot)
inline

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

Definition at line 206 of file TextKey.h.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ GetTypeHash

FORCEINLINE uint32 GetTypeHash ( const FTextId & A)
friend

Get the hash of this text identity

Definition at line 171 of file TextKey.h.

◆ operator!=

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

Compare for inequality

Definition at line 165 of file TextKey.h.

◆ operator==

Compare for equality

Definition at line 159 of file TextKey.h.

Member Data Documentation

◆ Key

FTextKey FTextId::Key
private

Key component of this text identity

Definition at line 239 of file TextKey.h.

◆ Namespace

FTextKey FTextId::Namespace
private

Namespace component of this text identity

Definition at line 236 of file TextKey.h.


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