UE::Net::FSubObjectRegistry Struct Reference

#include <NetSubObjectRegistry.h>

Classes
struct	FEntry

Public Types
enum class	EResult : uint8 { NewEntry , AlreadyRegistered , NetConditionConflict }

Public Member Functions
NETCORE_API FSubObjectRegistry::EResult	AddSubObjectUnique (UObject *InSubObject, ELifetimeCondition InNetCondition)
NETCORE_API bool	RemoveSubObject (UObject *InSubObject)
bool	IsEmpty () const
int32	Num () const
NETCORE_API void	CleanRegistryIndexes (const TArrayView< int32 > &IndexesToClean)
NETCORE_API ELifetimeCondition	GetNetCondition (UObject *SubObject) const
const TArray< FSubObjectRegistry::FEntry > &	GetRegistryList () const
NETCORE_API bool	IsSubObjectInRegistry (const UObject *SubObject) const

Detailed Description

Stores the SubObjects to replicate and the network condition dictating to which connection they can replicate to.

Member Enumeration Documentation

EResult

enum class UE::Net::FSubObjectRegistry::EResult : uint8

strong

Enumerator
NewEntry	SubObject is new in the registry
AlreadyRegistered	SubObject already was in the registry
NetConditionConflict	SubObject was already registered but the NetCondition passed is different from the entry

Member Function Documentation

AddSubObjectUnique()

FSubObjectRegistry::EResult UE::Net::FSubObjectRegistry::AddSubObjectUnique	(	UObject *	InSubObject,
		ELifetimeCondition	InNetCondition
	)

Adds a subobject and returns if it's a new entry or existing entry

CleanRegistryIndexes()

void UE::Net::FSubObjectRegistry::CleanRegistryIndexes

(

const TArrayView< int32 > &

IndexesToClean

)

Remove all the indexes specified by the passed array

Parameters

IndexesToClean

Array of indexes sorted from smallest to biggest. The sorted order is assumed to have been done by the caller

GetNetCondition()

ELifetimeCondition UE::Net::FSubObjectRegistry::GetNetCondition

(

UObject *

SubObject

)

const

Find the NetCondition of a SubObject. Returns COND_MAX if not registered

GetRegistryList()

const TArray< FSubObjectRegistry::FEntry > & UE::Net::FSubObjectRegistry::GetRegistryList ( ) const

inline

Returns the list of registered subobjects

IsEmpty()

bool UE::Net::FSubObjectRegistry::IsEmpty ( ) const

inline

IsSubObjectInRegistry()

bool UE::Net::FSubObjectRegistry::IsSubObjectInRegistry

(

const UObject *

SubObject

)

const

Returns true if the subobject is contained in this list

Num()

int32 UE::Net::FSubObjectRegistry::Num ( ) const

inline

RemoveSubObject()

bool UE::Net::FSubObjectRegistry::RemoveSubObject

(

UObject *

InSubObject

)

Remove the subobject from the replicated list. Returns true if the subobject had been registered.

---

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

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Misc/NetSubObjectRegistry.h
• Engine/Source/Runtime/Net/Core/Private/Net/Core/Misc/NetSubObjectRegistry.cpp