FUniqueNetIdRepl Struct Reference

#include <OnlineReplStructs.h>

Inheritance diagram for FUniqueNetIdRepl:

Public Member Functions
	FUniqueNetIdRepl ()
	FUniqueNetIdRepl (TYPE_OF_NULLPTR)
	FUniqueNetIdRepl (const FUniqueNetIdRepl &InWrapper)
	FUniqueNetIdRepl (const FUniqueNetIdWrapper &InWrapper)
	FUniqueNetIdRepl (const FUniqueNetIdRef &InUniqueNetId)
	FUniqueNetIdRepl (const FUniqueNetIdPtr &InUniqueNetId)
	FUniqueNetIdRepl (const FUniqueNetId &InUniqueNetId)
virtual	~FUniqueNetIdRepl ()
virtual void	SetUniqueNetId (const FUniqueNetIdPtr &UniqueNetId) override
virtual void	SetAccountId (const UE::Online::FAccountId &AccountId) override
bool	ExportTextItem (FString &ValueStr, FUniqueNetIdRepl const &DefaultValue, UObject *Parent, int32 PortFlags, UObject *ExportRootScope) const
bool	ImportTextItem (const TCHAR *&Buffer, int32 PortFlags, UObject *Parent, FOutputDevice *ErrorText)
ENGINE_API bool	NetSerialize (FArchive &Ar, class UPackageMap *Map, bool &bOutSuccess)
void	NetSerializeLoadV1Encoded (FArchive &Ar, const EUniqueIdEncodingFlags EncodingFlags, bool &bOutSuccess)
void	NetSerializeLoadV1Unencoded (FArchive &Ar, const EUniqueIdEncodingFlags EncodingFlags, bool &bOutSuccess)
void	NetSerializeLoadV2 (FArchive &Ar, const EUniqueIdEncodingFlags EncodingFlags, bool &bOutSuccess)
bool	Serialize (FArchive &Ar)
ENGINE_API TSharedRef< FJsonValue >	ToJson () const
ENGINE_API void	FromJson (const FString &InValue)
Public Member Functions inherited from FUniqueNetIdWrapper
	FUniqueNetIdWrapper ()=default
virtual	~FUniqueNetIdWrapper ()=default
	FUniqueNetIdWrapper (const FUniqueNetIdRef &InUniqueNetId)
	FUniqueNetIdWrapper (const FUniqueNetIdPtr &InUniqueNetId)
	FUniqueNetIdWrapper (const FVariantType &InVariant)
	FUniqueNetIdWrapper (const UE::Online::FAccountId &AccountId)
	FUniqueNetIdWrapper (const FUniqueNetId &InUniqueNetId)
bool	IsV1 () const
FUniqueNetIdPtr	GetV1 () const
const FUniqueNetIdPtr &	GetV1Unsafe () const
bool	IsV2 () const
UE::Online::FAccountId	GetV2 () const
const UE::Online::FAccountId &	GetV2Unsafe () const
FName	GetType () const
COREONLINE_API FString	ToString () const
COREONLINE_API FString	ToDebugString () const
bool	IsValid () const
FUniqueNetIdPtr	GetUniqueNetId () const
const FUniqueNetId &	operator* () const
const FUniqueNetId *	operator-> () const

Protected Member Functions
void	UniqueIdFromString (FName Type, const FString &Contents)
void	MakeReplicationData ()
void	MakeReplicationDataV1 ()
void	MakeReplicationDataV2 ()

Static Protected Member Functions
static bool	ShouldExportTextItemAsQuotedString (const FString &NetIdStr)

Protected Attributes
TArray< uint8 >	ReplicationBytes
Protected Attributes inherited from FUniqueNetIdWrapper
FVariantType	Variant

Friends
ENGINE_API friend FArchive &	operator<< (FArchive &Ar, FUniqueNetIdRepl &UniqueNetId)
uint32	GetTypeHash (FUniqueNetIdRepl const &Value)

Additional Inherited Members
Public Types inherited from FUniqueNetIdWrapper
using	FVariantType = TVariant< FUniqueNetIdPtr, UE::Online::FAccountId >
Static Public Member Functions inherited from FUniqueNetIdWrapper
static FUniqueNetIdWrapper	Invalid ()

Detailed Description

Wrapper for opaque type FUniqueNetId

Makes sure that the opaque aspects of FUniqueNetId are properly handled/serialized over network RPC and actor replication

Constructor & Destructor Documentation

FUniqueNetIdRepl() [1/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( )

inline

FUniqueNetIdRepl() [2/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( TYPE_OF_NULLPTR  )

inline

FUniqueNetIdRepl() [3/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( const FUniqueNetIdRepl &  InWrapper )

inline

FUniqueNetIdRepl() [4/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( const FUniqueNetIdWrapper &  InWrapper )

inline

FUniqueNetIdRepl() [5/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( const FUniqueNetIdRef &  InUniqueNetId )

inline

FUniqueNetIdRepl() [6/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( const FUniqueNetIdPtr &  InUniqueNetId )

inline

FUniqueNetIdRepl() [7/7]

FUniqueNetIdRepl::FUniqueNetIdRepl ( const FUniqueNetId &  InUniqueNetId )

inline

~FUniqueNetIdRepl()

virtual FUniqueNetIdRepl::~FUniqueNetIdRepl ( )

inlinevirtual

Member Function Documentation

ExportTextItem()

bool FUniqueNetIdRepl::ExportTextItem	(	FString &	ValueStr,
		FUniqueNetIdRepl const &	DefaultValue,
		UObject *	Parent,
		int32	PortFlags,
		UObject *	ExportRootScope
	)		const

Export contents of this struct as a string

FromJson()

void FUniqueNetIdRepl::FromJson

(

const FString &

InValue

)

Create a unique id from a json string

ImportTextItem()

bool FUniqueNetIdRepl::ImportTextItem	(	const TCHAR *&	Buffer,
		int32	PortFlags,
		UObject *	Parent,
		FOutputDevice *	ErrorText
	)

Import string contexts and try to map them into a unique id

MakeReplicationData()

void FUniqueNetIdRepl::MakeReplicationData ( )

protected

Helper to make network serializable representation

Possibly encode the unique net id in a smaller form

Empty: <uint8 flags> noted it is encoded and empty NonEmpty:

• Encoded - <uint8 flags/type> <uint8 encoded size> <encoded bytes>
• Encoded (out of engine oss type) - <uint8 flags/type> <serialized FName> <uint8 encoded size> <encoded bytes>
• Unencoded - <uint8 flags/type> <serialized FString>
• Unencoded (out of engine oss type) - <uint8 flags/type> <serialized FName> <serialized FString>

MakeReplicationDataV1()

void FUniqueNetIdRepl::MakeReplicationDataV1 ( )

protected

MakeReplicationDataV2()

void FUniqueNetIdRepl::MakeReplicationDataV2 ( )

protected

NetSerialize()

bool FUniqueNetIdRepl::NetSerialize	(	FArchive &	Ar,
		class UPackageMap *	Map,
		bool &	bOutSuccess
	)

Network serialization

NetSerializeLoadV1Encoded()

void FUniqueNetIdRepl::NetSerializeLoadV1Encoded	(	FArchive &	Ar,
		const EUniqueIdEncodingFlags	EncodingFlags,
		bool &	bOutSuccess
	)

NetSerializeLoadV1Unencoded()

void FUniqueNetIdRepl::NetSerializeLoadV1Unencoded	(	FArchive &	Ar,
		const EUniqueIdEncodingFlags	EncodingFlags,
		bool &	bOutSuccess
	)

NetSerializeLoadV2()

void FUniqueNetIdRepl::NetSerializeLoadV2	(	FArchive &	Ar,
		const EUniqueIdEncodingFlags	EncodingFlags,
		bool &	bOutSuccess
	)

Serialize()

bool FUniqueNetIdRepl::Serialize

(

FArchive &

Ar

)

Serialization to any FArchive

SetAccountId()

virtual void FUniqueNetIdRepl::SetAccountId ( const UE::Online::FAccountId &  AccountId )

inlineoverridevirtual

Reimplemented from FUniqueNetIdWrapper.

SetUniqueNetId()

virtual void FUniqueNetIdRepl::SetUniqueNetId ( const FUniqueNetIdPtr &  InUniqueNetId )

inlineoverridevirtual

Assign a unique id to this wrapper object

Parameters

InUniqueNetId

id to associate

Reimplemented from FUniqueNetIdWrapper.

ShouldExportTextItemAsQuotedString()

bool FUniqueNetIdRepl::ShouldExportTextItemAsQuotedString ( const FString &  NetIdStr )

staticprotected

ToJson()

TSharedRef< FJsonValue > FUniqueNetIdRepl::ToJson

(

)

const

Convert this unique id to a json value

UniqueIdFromString()

void FUniqueNetIdRepl::UniqueIdFromString ( FName  Type, const FString &  Contents  )

protected

Helper to create an FUniqueNetId from a string and its type

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( FUniqueNetIdRepl const &  Value )

friend

For FUniqueNetIdRepl objects, we use the same hashing function as any other wrapper.

operator<<

ENGINE_API friend FArchive & operator<< ( FArchive &  Ar, FUniqueNetIdRepl &  UniqueNetId  )

friend

Serialization to any FArchive

Member Data Documentation

ReplicationBytes

TArray<uint8> FUniqueNetIdRepl::ReplicationBytes

protected

Network serialized data cache

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/GameFramework/OnlineReplStructs.h
• Engine/Source/Runtime/Engine/Private/OnlineReplStructs.cpp