UE::Net::Private::FObjectScopeHysteresisUpdater Class Reference

#include <ObjectScopeHysteresisUpdater.h>

Public Member Functions
void	Init (uint32 MaxObjectCount)
void	Deinit ()
void	OnMaxInternalNetRefIndexIncreased (FInternalNetRefIndex NewMaxInternalIndex)
void	SetHysteresisFrameCount (FInternalNetRefIndex NetRefIndex, uint16 HysteresisFrameCount)
void	RemoveHysteresis (FInternalNetRefIndex NetRefIndex)
void	RemoveHysteresis (const FNetBitArrayView &ObjectsToRemove)
void	RemoveHysteresis (TArrayView< const uint32 > ObjectsToRemove)
void	Update (uint8 FramesSinceLastUpdate, TArray< FInternalNetRefIndex > &OutObjectsToFilterOut)
bool	HasObjectsToUpdate () const
FNetBitArrayView	GetUpdatedObjects () const
bool	IsObjectUpdated (FInternalNetRefIndex NetRefIndex) const

Member Function Documentation

Deinit()

void UE::Net::Private::FObjectScopeHysteresisUpdater::Deinit

(

)

GetUpdatedObjects()

FNetBitArrayView UE::Net::Private::FObjectScopeHysteresisUpdater::GetUpdatedObjects ( ) const

inline

Returns the bitarray of objects affected by hysteresis

HasObjectsToUpdate()

bool UE::Net::Private::FObjectScopeHysteresisUpdater::HasObjectsToUpdate ( ) const

inline

Whether any objects are updated for hysteresis. If not there's no point in calling Update().

Init()

void UE::Net::Private::FObjectScopeHysteresisUpdater::Init

(

uint32

MaxObjectCount

)

IsObjectUpdated()

bool UE::Net::Private::FObjectScopeHysteresisUpdater::IsObjectUpdated ( FInternalNetRefIndex  NetRefIndex ) const

inline

Returns true if the object is currently updated.

OnMaxInternalNetRefIndexIncreased()

void UE::Net::Private::FObjectScopeHysteresisUpdater::OnMaxInternalNetRefIndexIncreased

(

FInternalNetRefIndex

NewMaxInternalIndex

)

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

RemoveHysteresis() [1/3]

void UE::Net::Private::FObjectScopeHysteresisUpdater::RemoveHysteresis

(

const FNetBitArrayView &

ObjectsToRemove

)

Removes all objects in the bitarray from hysteresis.

Removes all objects in the bitarray vfrom hysteresis.

RemoveHysteresis() [2/3]

void UE::Net::Private::FObjectScopeHysteresisUpdater::RemoveHysteresis

(

FInternalNetRefIndex

NetRefIndex

)

Remove an object from hysteresis update. Needed when an object goes out of scope. An object is automatically removed from hysteresis updates when a previously set frame count has expired.

RemoveHysteresis() [3/3]

void UE::Net::Private::FObjectScopeHysteresisUpdater::RemoveHysteresis

(

TArrayView< const uint32 >

ObjectsToRemove

)

Removes all objects in the array from hysteresis.

SetHysteresisFrameCount()

void UE::Net::Private::FObjectScopeHysteresisUpdater::SetHysteresisFrameCount	(	FInternalNetRefIndex	NetRefIndex,
		uint16	HysteresisFrameCount
	)

Sets an hysteresis frame count such that an object will be kept in scope until such many frames has passed.

Update()

void UE::Net::Private::FObjectScopeHysteresisUpdater::Update	(	uint8	FramesSinceLastUpdate,
		TArray< FInternalNetRefIndex > &	OutObjectsToFilterOut
	)

Adjusts the connection relevant objects based on hysteresis frame counts.

---

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

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