UE::Net::FNetObjectGroupHandle Class Reference

#include <NetObjectGroupHandle.h>

Public Types
enum	{ GroupIndexBits = 24U }
enum	{ EpochBits = 8U }
enum	{ EpochMask = (1U << EpochBits) - 1U }
enum	{ MaxGroupIndexCount = 1U << GroupIndexBits }
enum	: FGroupIndexType { InvalidNetObjectGroupIndex = 0 , NotReplicatedNetObjectGroupIndex , NetGroupOwnerNetObjectGroupIndex , NetGroupReplayNetObjectGroupIndex }
typedef uint32	FGroupIndexType

Public Member Functions
	FNetObjectGroupHandle ()
bool	IsValid () const
FGroupIndexType	GetGroupIndex () const
uint32	GetUniqueId () const
bool	IsReservedNetObjectGroup () const
bool	IsNotReplicatedNetObjectGroup () const
bool	IsNetGroupOwnerNetObjectGroup () const
bool	IsNetGroupReplayNetObjectGroup () const
uint64	GetRawValue () const

Static Public Member Functions
static FNetObjectGroupHandle	GetInvalid ()
static bool	IsReservedNetObjectGroupIndex (FGroupIndexType GroupIndex)

Friends
bool	operator== (const FNetObjectGroupHandle &Lhs, const FNetObjectGroupHandle &Rhs)
bool	operator!= (const FNetObjectGroupHandle &Lhs, const FNetObjectGroupHandle &Rhs)

Member Typedef Documentation

FGroupIndexType

typedef uint32 UE::Net::FNetObjectGroupHandle::FGroupIndexType

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
GroupIndexBits

anonymous enum

anonymous enum

Enumerator
EpochBits

anonymous enum

anonymous enum

Enumerator
EpochMask

anonymous enum

anonymous enum

Enumerator
MaxGroupIndexCount

anonymous enum

anonymous enum : FGroupIndexType

Reserved group indices

Enumerator
InvalidNetObjectGroupIndex
NotReplicatedNetObjectGroupIndex
NetGroupOwnerNetObjectGroupIndex
NetGroupReplayNetObjectGroupIndex

Constructor & Destructor Documentation

FNetObjectGroupHandle()

UE::Net::FNetObjectGroupHandle::FNetObjectGroupHandle ( )

inline

Member Function Documentation

GetGroupIndex()

FGroupIndexType UE::Net::FNetObjectGroupHandle::GetGroupIndex ( ) const

inline

Returns the GroupIndex of the group associated with the handle

GetInvalid()

static FNetObjectGroupHandle UE::Net::FNetObjectGroupHandle::GetInvalid ( )

inlinestatic

GetRawValue()

uint64 UE::Net::FNetObjectGroupHandle::GetRawValue ( ) const

inline

GetUniqueId()

uint32 UE::Net::FNetObjectGroupHandle::GetUniqueId ( ) const

inline

Returns the unique id for this group

IsNetGroupOwnerNetObjectGroup()

bool UE::Net::FNetObjectGroupHandle::IsNetGroupOwnerNetObjectGroup ( ) const

inline

Special group, SubObjects assigned to this group will replicate to owner of RootParent

IsNetGroupReplayNetObjectGroup()

bool UE::Net::FNetObjectGroupHandle::IsNetGroupReplayNetObjectGroup ( ) const

inline

Special group, SubObjects assigned to this group will replicate if replay netconditions is met

IsNotReplicatedNetObjectGroup()

bool UE::Net::FNetObjectGroupHandle::IsNotReplicatedNetObjectGroup ( ) const

inline

Special group, NetHandles assigned to this group will be filtered out for all connections

IsReservedNetObjectGroup()

bool UE::Net::FNetObjectGroupHandle::IsReservedNetObjectGroup ( ) const

inline

Returns true if this is a reserved NetObjectsGroups

IsReservedNetObjectGroupIndex()

static bool UE::Net::FNetObjectGroupHandle::IsReservedNetObjectGroupIndex ( FGroupIndexType  GroupIndex )

inlinestatic

Returns true if the provided GroupIndex is a reserved NetObjectsGroupIndex

IsValid()

bool UE::Net::FNetObjectGroupHandle::IsValid ( ) const

inline

Returns true if the handle is valid, note this does not mean that the group is valid

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const FNetObjectGroupHandle &  Lhs, const FNetObjectGroupHandle &  Rhs  )

friend

operator==

bool operator== ( const FNetObjectGroupHandle &  Lhs, const FNetObjectGroupHandle &  Rhs  )

friend

Member Data Documentation

Epoch

uint32 UE::Net::FNetObjectGroupHandle::Epoch

Index

uint32 UE::Net::FNetObjectGroupHandle::Index

UniqueId

uint32 UE::Net::FNetObjectGroupHandle::UniqueId

Value

uint64 UE::Net::FNetObjectGroupHandle::Value

---

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

• Engine/Source/Runtime/Net/Iris/Public/Iris/ReplicationSystem/NetObjectGroupHandle.h