UE::Net::Private::FNetObjectGroups Class Reference

#include <NetObjectGroups.h>

Public Member Functions
	FNetObjectGroups ()
	~FNetObjectGroups ()
void	Init (const FNetObjectGroupInitParams &Params)
FNetObjectGroupHandle	CreateGroup (FName GroupName)
void	DestroyGroup (FNetObjectGroupHandle GroupHandle)
void	ClearGroup (FNetObjectGroupHandle GroupHandle)
FNetObjectGroupHandle	FindGroupHandle (FName GroupName) const
const FNetObjectGroup *	GetGroup (FNetObjectGroupHandle GroupHandle) const
FNetObjectGroup *	GetGroup (FNetObjectGroupHandle GroupHandle)
const FNetObjectGroup *	GetGroupFromIndex (FNetObjectGroupHandle::FGroupIndexType GroupIndex) const
FNetObjectGroup *	GetGroupFromIndex (FNetObjectGroupHandle::FGroupIndexType GroupIndex)
FNetObjectGroupHandle	GetHandleFromGroup (const FNetObjectGroup *InGroup) const
FNetObjectGroupHandle	GetHandleFromIndex (FNetObjectGroupHandle::FGroupIndexType GroupIndex) const
FName	GetGroupName (FNetObjectGroupHandle GroupHandle) const
FString	GetGroupNameString (FNetObjectGroupHandle GroupHandle) const
bool	IsValidGroup (FNetObjectGroupHandle GroupHandle) const
bool	Contains (FNetObjectGroupHandle GroupHandle, FInternalNetRefIndex InternalIndex) const
void	AddToGroup (FNetObjectGroupHandle GroupHandle, FInternalNetRefIndex InternalIndex)
void	RemoveFromGroup (FNetObjectGroupHandle GroupHandle, FInternalNetRefIndex InternalIndex)
void	AddExclusionFilterTrait (FNetObjectGroupHandle GroupHandle)
void	RemoveExclusionFilterTrait (FNetObjectGroupHandle GroupHandle)
void	AddInclusionFilterTrait (FNetObjectGroupHandle GroupHandle)
void	RemoveInclusionFilterTrait (FNetObjectGroupHandle GroupHandle)
bool	IsFilterGroup (FNetObjectGroupHandle GroupHandle) const
bool	IsExclusionFilterGroup (FNetObjectGroupHandle GroupHandle) const
bool	IsInclusionFilterGroup (FNetObjectGroupHandle GroupHandle) const
const TArrayView< const FNetObjectGroupHandle::FGroupIndexType >	GetGroupIndexesOfNetObject (FInternalNetRefIndex InternalIndex) const
void	GetGroupHandlesOfNetObject (FInternalNetRefIndex InternalIndex, TArray< FNetObjectGroupHandle > &OutHandles) const
const FNetBitArrayView	GetGroupFilteredOutObjects () const
void	OnMaxInternalNetRefIndexIncreased (FInternalNetRefIndex NewMaxInternalIndex)

Constructor & Destructor Documentation

FNetObjectGroups()

UE::Net::Private::FNetObjectGroups::FNetObjectGroups

(

)

~FNetObjectGroups()

UE::Net::Private::FNetObjectGroups::~FNetObjectGroups

(

)

Member Function Documentation

AddExclusionFilterTrait()

void UE::Net::Private::FNetObjectGroups::AddExclusionFilterTrait

(

FNetObjectGroupHandle

GroupHandle

)

Called when a group is to be used as an exclusion filter group

AddInclusionFilterTrait()

void UE::Net::Private::FNetObjectGroups::AddInclusionFilterTrait

(

FNetObjectGroupHandle

GroupHandle

)

Called when a group is to be used as an inclusion filter group

AddToGroup()

void UE::Net::Private::FNetObjectGroups::AddToGroup	(	FNetObjectGroupHandle	GroupHandle,
		FInternalNetRefIndex	InternalIndex
	)

ClearGroup()

void UE::Net::Private::FNetObjectGroups::ClearGroup

(

FNetObjectGroupHandle

GroupHandle

)

Contains()

bool UE::Net::Private::FNetObjectGroups::Contains	(	FNetObjectGroupHandle	GroupHandle,
		FInternalNetRefIndex	InternalIndex
	)		const

CreateGroup()

FNetObjectGroupHandle UE::Net::Private::FNetObjectGroups::CreateGroup

(

FName

GroupName

)

DestroyGroup()

void UE::Net::Private::FNetObjectGroups::DestroyGroup

(

FNetObjectGroupHandle

GroupHandle

)

FindGroupHandle()

FNetObjectGroupHandle UE::Net::Private::FNetObjectGroups::FindGroupHandle ( FName  GroupName ) const

inline

GetGroup() [1/2]

FNetObjectGroup * UE::Net::Private::FNetObjectGroups::GetGroup

(

FNetObjectGroupHandle

GroupHandle

)

GetGroup() [2/2]

const FNetObjectGroup * UE::Net::Private::FNetObjectGroups::GetGroup

(

FNetObjectGroupHandle

GroupHandle

)

const

GetGroupFilteredOutObjects()

const FNetBitArrayView UE::Net::Private::FNetObjectGroups::GetGroupFilteredOutObjects ( ) const

inline

Returns a list of all objects currently part of a group with the filter trait

GetGroupFromIndex() [1/2]

FNetObjectGroup * UE::Net::Private::FNetObjectGroups::GetGroupFromIndex

(

FNetObjectGroupHandle::FGroupIndexType

GroupIndex

)

GetGroupFromIndex() [2/2]

const FNetObjectGroup * UE::Net::Private::FNetObjectGroups::GetGroupFromIndex

(

FNetObjectGroupHandle::FGroupIndexType

GroupIndex

)

const

GetGroupHandlesOfNetObject()

void UE::Net::Private::FNetObjectGroups::GetGroupHandlesOfNetObject	(	FInternalNetRefIndex	InternalIndex,
		TArray< FNetObjectGroupHandle > &	OutHandles
	)		const

Get a list of all group handles the NetObject is a member of

GetGroupIndexesOfNetObject()

const TArrayView< const FNetObjectGroupHandle::FGroupIndexType > UE::Net::Private::FNetObjectGroups::GetGroupIndexesOfNetObject

(

FInternalNetRefIndex

InternalIndex

)

const

Get a reference to the indexes of all groups that the NetObject is a member of

GetGroupName()

FName UE::Net::Private::FNetObjectGroups::GetGroupName ( FNetObjectGroupHandle  GroupHandle ) const

inline

GetGroupNameString()

FString UE::Net::Private::FNetObjectGroups::GetGroupNameString ( FNetObjectGroupHandle  GroupHandle ) const

inline

GetHandleFromGroup()

FNetObjectGroupHandle UE::Net::Private::FNetObjectGroups::GetHandleFromGroup

(

const FNetObjectGroup *

InGroup

)

const

GetHandleFromIndex()

FNetObjectGroupHandle UE::Net::Private::FNetObjectGroups::GetHandleFromIndex ( FNetObjectGroupHandle::FGroupIndexType  GroupIndex ) const

inline

Init()

void UE::Net::Private::FNetObjectGroups::Init

(

const FNetObjectGroupInitParams &

Params

)

IsExclusionFilterGroup()

bool UE::Net::Private::FNetObjectGroups::IsExclusionFilterGroup

(

FNetObjectGroupHandle

GroupHandle

)

const

Does the group have the exclusion filter trait

IsFilterGroup()

bool UE::Net::Private::FNetObjectGroups::IsFilterGroup

(

FNetObjectGroupHandle

GroupHandle

)

const

Does the group have a filter trait, either exclusion or inclusion

IsInclusionFilterGroup()

bool UE::Net::Private::FNetObjectGroups::IsInclusionFilterGroup

(

FNetObjectGroupHandle

GroupHandle

)

const

Does the group have the inclusion filter trait

IsValidGroup()

bool UE::Net::Private::FNetObjectGroups::IsValidGroup ( FNetObjectGroupHandle  GroupHandle ) const

inline

OnMaxInternalNetRefIndexIncreased()

void UE::Net::Private::FNetObjectGroups::OnMaxInternalNetRefIndexIncreased

(

FInternalNetRefIndex

NewMaxInternalIndex

)

Called when the maximum InternalNetRefIndex increased and we need to realloc our lists

RemoveExclusionFilterTrait()

void UE::Net::Private::FNetObjectGroups::RemoveExclusionFilterTrait

(

FNetObjectGroupHandle

GroupHandle

)

Called when a group is no longer used as an exclusion filter group

RemoveFromGroup()

void UE::Net::Private::FNetObjectGroups::RemoveFromGroup	(	FNetObjectGroupHandle	GroupHandle,
		FInternalNetRefIndex	InternalIndex
	)

RemoveInclusionFilterTrait()

void UE::Net::Private::FNetObjectGroups::RemoveInclusionFilterTrait

(

FNetObjectGroupHandle

GroupHandle

)

Called when a group is no longer used as an inclusion filter group

---

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

• Engine/Source/Runtime/Net/Iris/Private/Iris/ReplicationSystem/Filtering/NetObjectGroups.h
• Engine/Source/Runtime/Net/Iris/Private/Iris/ReplicationSystem/Filtering/NetObjectGroups.cpp