UE::Net::FNetIDVariant Class Reference

#include <NetIDVariant.h>

Classes
struct	FEmptyID

Public Types
using	FVariantType = TVariant< FEmptyID, FNetworkGUID, FNetRefHandle >

Public Member Functions
	FNetIDVariant ()=default
ENGINE_API	FNetIDVariant (FNetworkGUID NetGUID)
ENGINE_API	FNetIDVariant (FNetRefHandle NetRefHandle)
bool ENGINE_API	IsValid () const
FVariantType	GetVariant () const
bool ENGINE_API	operator== (const FNetIDVariant &RHS) const
ENGINE_API FString	ToString () const

Friends
ENGINE_API FArchive &	operator<< (FArchive &Ar, FNetIDVariant &NetID)

Detailed Description

Simple variant wrapper to hold a generic or Iris network object ID (FNetworkGUID or FNetRefHandle). Intended for transitioning systems that were using FNetworkGUID directly to Iris, not intended for general use.

Member Typedef Documentation

FVariantType

using UE::Net::FNetIDVariant::FVariantType = TVariant<FEmptyID, FNetworkGUID, FNetRefHandle>

Constructor & Destructor Documentation

FNetIDVariant() [1/3]

UE::Net::FNetIDVariant::FNetIDVariant ( )

default

Constructs a variant holding an FEmptyID

FNetIDVariant() [2/3]

UE::Net::FNetIDVariant::FNetIDVariant ( FNetworkGUID  NetGUID )

explicit

FNetIDVariant() [3/3]

UE::Net::FNetIDVariant::FNetIDVariant ( FNetRefHandle  NetRefHandle )

explicit

Member Function Documentation

GetVariant()

FVariantType UE::Net::FNetIDVariant::GetVariant ( ) const

inline

Returns the stored TVariant

IsValid()

bool UE::Net::FNetIDVariant::IsValid

(

)

const

Returns whether the stored ID or handle is valid

operator==()

bool UE::Net::FNetIDVariant::operator==

(

const FNetIDVariant &

RHS

)

const

Equality comparison

ToString()

FString UE::Net::FNetIDVariant::ToString

(

)

const

Output to string

Friends And Related Symbol Documentation

operator<<

ENGINE_API FArchive & operator<< ( FArchive &  Ar, FNetIDVariant &  NetID  )

friend

Serializes or deserializes the stored ID or handle, suitable for networking

---

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

• Engine/Source/Runtime/Engine/Public/Net/NetIDVariant.h
• Engine/Source/Runtime/Engine/Private/Net/NetIDVariant.cpp