UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUniqueNetId Class Referenceabstract

#include <CoreOnline.h>

+ Inheritance diagram for FUniqueNetId:

Public Member Functions

virtual ~FUniqueNetId ()=default
 
virtual FName GetType () const
 
virtual const uint8GetBytes () const =0
 
virtual int32 GetSize () const =0
 
virtual bool IsValid () const =0
 
virtual FString ToString () const =0
 
virtual FString ToDebugString () const =0
 
virtual uint32 GetTypeHash () const
 
FString GetHexEncodedString () const
 
- Public Member Functions inherited from TSharedFromThis< FUniqueNetId >
TSharedRef< FUniqueNetId, Mode > AsShared ()
 
TSharedRef< FUniqueNetId const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FUniqueNetId, Mode > AsWeak ()
 
TWeakPtr< FUniqueNetId const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

 FUniqueNetId ()=default
 
 FUniqueNetId (const FUniqueNetId &Src)=default
 
FUniqueNetIdoperator= (const FUniqueNetId &Src)=default
 
virtual bool Compare (const FUniqueNetId &Other) const
 
- Protected Member Functions inherited from TSharedFromThis< FUniqueNetId >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Friends

bool operator== (const FUniqueNetId &Lhs, const FUniqueNetId &Rhs)
 
bool operator!= (const FUniqueNetId &Lhs, const FUniqueNetId &Rhs)
 
uint32 GetTypeHash (const FUniqueNetId &Value)
 

Additional Inherited Members

- Static Protected Member Functions inherited from TSharedFromThis< FUniqueNetId >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Abstraction of a profile service online Id The class is meant to be opaque

Constructor & Destructor Documentation

◆ FUniqueNetId() [1/2]

FUniqueNetId::FUniqueNetId ( )
protecteddefault

Only constructible by derived type

◆ FUniqueNetId() [2/2]

FUniqueNetId::FUniqueNetId ( const FUniqueNetId Src)
protecteddefault

◆ ~FUniqueNetId()

virtual FUniqueNetId::~FUniqueNetId ( )
virtualdefault

Member Function Documentation

◆ Compare()

virtual bool FUniqueNetId::Compare ( const FUniqueNetId Other) const
inlineprotectedvirtual

◆ GetBytes()

virtual const uint8 * FUniqueNetId::GetBytes ( ) const
pure virtual

Get the raw byte representation of this opaque data This data is platform dependent and shouldn't be manipulated directly

Returns
byte array of size GetSize()

◆ GetHexEncodedString()

FString FUniqueNetId::GetHexEncodedString ( ) const
inline
Returns
hex encoded string representation of unique id

◆ GetSize()

virtual int32 FUniqueNetId::GetSize ( ) const
pure virtual

Get the size of the opaque data

Returns
size in bytes of the data representation

◆ GetType()

virtual FName FUniqueNetId::GetType ( ) const
inlinevirtual

Get the type token for this opaque data This is useful for inferring UniqueId subclasses and knowing which OSS it "goes with"

Returns
FName representing the Type

◆ GetTypeHash()

virtual uint32 FUniqueNetId::GetTypeHash ( ) const
inlinevirtual

◆ IsValid()

virtual bool FUniqueNetId::IsValid ( ) const
pure virtual

Check the validity of the opaque data

Returns
true if this is well formed data, false otherwise

◆ operator=()

FUniqueNetId & FUniqueNetId::operator= ( const FUniqueNetId Src)
protecteddefault

◆ ToDebugString()

virtual FString FUniqueNetId::ToDebugString ( ) const
pure virtual

Get a human readable representation of the opaque data Shouldn't be used for anything other than logging/debugging

Returns
data in string form

◆ ToString()

virtual FString FUniqueNetId::ToString ( ) const
pure virtual

Platform specific conversion to string representation of data

Returns
data in string form

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FUniqueNetId Value)
friend

◆ operator!=

bool operator!= ( const FUniqueNetId Lhs,
const FUniqueNetId Rhs 
)
friend

◆ operator==

bool operator== ( const FUniqueNetId Lhs,
const FUniqueNetId Rhs 
)
friend

Comparison operator


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