UE::Net::Private::ObjectBridgeDebugging Namespace Reference

Classes
struct	FLogContext
struct	FRootObjectData

Enumerations
enum class	EPrintTraits : uint32 {   Default = 0x0000 , LogSubObjects = 0x0001 , LogTraits = EPrintTraits::LogSubObjects , SortByClass = 0x0100 ,   SortByNetRefHandle = 0x0200 , SortTraits = EPrintTraits::SortByNetRefHandle | EPrintTraits::SortByClass }
enum class	EDynamicFilterPrintTraits : uint32 {   Default = 0x0000 , Config = 0x0001 , IssueDetection = 0x0002 , SkipBPIssueDetection = 0x0004 ,   SkipActorChildIssueDetection = 0x0008 }

Functions
void	RemoteProtocolMismatchDetected (TMap< FObjectKey, bool > &ArchetypesAlreadyPrinted, UReplicationSystem *, uint32, const FReplicationFragments &, const UObject *, const UObject *)
	ENUM_CLASS_FLAGS (EPrintTraits)
EPrintTraits	FindPrintTraitsFromArgs (const TArray< FString > &Args)
	ENUM_CLASS_FLAGS (EDynamicFilterPrintTraits)
EDynamicFilterPrintTraits	FindDynamicFilterPrintTraitsFromArgs (const TArray< FString > &Args)
void	FillRootObjectArrayFromBitArray (TArray< FRootObjectData > &OutRootObjects, const FNetBitArrayView RootObjectList, FNetRefHandleManager *NetRefHandleManager)
void	SortByClassName (TArray< FRootObjectData > &OutArray)
void	SortByNetRefHandle (TArray< FRootObjectData > &OutArray)
void	SortViaTrait (TArray< FRootObjectData > &OutArray, EPrintTraits ArgTraits, EPrintTraits DefaultTraits)
void	PrintDefaultNetObjectState (UReplicationSystem *ReplicationSystem, uint32 ConnectionId, const FReplicationFragments &RegisteredFragments, FStringBuilderBase &StringBuilder)
UReplicationSystem *	FindReplicationSystemFromArg (const TArray< FString > &Args)
FString	PrintNetObject (FNetRefHandleManager *NetRefHandleManager, FInternalNetRefIndex ObjectIndex)
void	LogRootObjectList (FLogContext &LogContext, bool bLogSubObjects)
void	LogViaTrait (FLogContext &LogContext, EPrintTraits ArgTraits, EPrintTraits DefaultTraits)
TArray< FNetRefHandle >	FindNetRefHandlesFromArg (UReplicationSystem *RepSystem, const TArray< FString > &Args)

Detailed Description

This class contains misc console commands that log the state of different Iris systems.

Most cmds support common optional parameters that are listed here: RepSystemId=X => Execute the cmd on a specific ReplicationSystem. Useful in PIE WithSubObjects => Print the subobjects attached to each RootObject SortByClass => Log the rootobjects alphabetically by ClassName (usually the default) SortByNetRefHandle => Log the rootobjects by their NetRefHandle Id starting with static objects (odd Id) then dynamic objects (even Id)

Enumeration Type Documentation

EDynamicFilterPrintTraits

enum class UE::Net::Private::ObjectBridgeDebugging::EDynamicFilterPrintTraits : uint32

strong

Print traits to control the dynamic filter debug commands

Enumerator
Default
Config
IssueDetection
SkipBPIssueDetection
SkipActorChildIssueDetection

EPrintTraits

enum class UE::Net::Private::ObjectBridgeDebugging::EPrintTraits : uint32

strong

Generic traits to control what and how we log debug information

Enumerator
Default
LogSubObjects
LogTraits
SortByClass
SortByNetRefHandle
SortTraits

Function Documentation

ENUM_CLASS_FLAGS() [1/2]

UE::Net::Private::ObjectBridgeDebugging::ENUM_CLASS_FLAGS

(

EDynamicFilterPrintTraits

)

ENUM_CLASS_FLAGS() [2/2]

UE::Net::Private::ObjectBridgeDebugging::ENUM_CLASS_FLAGS

(

EPrintTraits

)

FillRootObjectArrayFromBitArray()

void UE::Net::Private::ObjectBridgeDebugging::FillRootObjectArrayFromBitArray	(	TArray< FRootObjectData > &	OutRootObjects,
		const FNetBitArrayView	RootObjectList,
		FNetRefHandleManager *	NetRefHandleManager
	)

FindDynamicFilterPrintTraitsFromArgs()

EDynamicFilterPrintTraits UE::Net::Private::ObjectBridgeDebugging::FindDynamicFilterPrintTraitsFromArgs

(

const TArray< FString > &

Args

)

Extract dynamic filter print traits from console arguments

FindNetRefHandlesFromArg()

TArray< FNetRefHandle > UE::Net::Private::ObjectBridgeDebugging::FindNetRefHandlesFromArg	(	UReplicationSystem *	RepSystem,
		const TArray< FString > &	Args
	)

Returns a list of NetRefHandles of replicated objects from console arguments

FindPrintTraitsFromArgs()

EPrintTraits UE::Net::Private::ObjectBridgeDebugging::FindPrintTraitsFromArgs

(

const TArray< FString > &

Args

)

Extracts the print traits from console arguments

FindReplicationSystemFromArg()

UReplicationSystem * UE::Net::Private::ObjectBridgeDebugging::FindReplicationSystemFromArg

(

const TArray< FString > &

Args

)

Find the replication system from console arguments: 'RepSystemId=0...'

LogRootObjectList()

void UE::Net::Private::ObjectBridgeDebugging::LogRootObjectList	(	FLogContext &	LogContext,
		bool	bLogSubObjects
	)

LogViaTrait()

void UE::Net::Private::ObjectBridgeDebugging::LogViaTrait	(	FLogContext &	LogContext,
		EPrintTraits	ArgTraits,
		EPrintTraits	DefaultTraits
	)

PrintDefaultNetObjectState()

void UE::Net::Private::ObjectBridgeDebugging::PrintDefaultNetObjectState	(	UReplicationSystem *	ReplicationSystem,
		uint32	ConnectionId,
		const FReplicationFragments &	RegisteredFragments,
		FStringBuilderBase &	StringBuilder
	)

Print all the protocols of the default state of an object (so it's CDO/Archetype baseline)

PrintNetObject()

FString UE::Net::Private::ObjectBridgeDebugging::PrintNetObject	(	FNetRefHandleManager *	NetRefHandleManager,
		FInternalNetRefIndex	ObjectIndex
	)

RemoteProtocolMismatchDetected()

void UE::Net::Private::ObjectBridgeDebugging::RemoteProtocolMismatchDetected ( TMap< FObjectKey, bool > &  ArchetypesAlreadyPrinted, UReplicationSystem *  ReplicationSystem, uint32  ConnectionId, const FReplicationFragments &  RegisteredFragments, const UObject *  ArchetypeOrCDOKey, const UObject *  InstancePtr  )

extern

SortByClassName()

void UE::Net::Private::ObjectBridgeDebugging::SortByClassName

(

TArray< FRootObjectData > &

OutArray

)

SortByNetRefHandle()

void UE::Net::Private::ObjectBridgeDebugging::SortByNetRefHandle

(

TArray< FRootObjectData > &

OutArray

)

SortViaTrait()

void UE::Net::Private::ObjectBridgeDebugging::SortViaTrait	(	TArray< FRootObjectData > &	OutArray,
		EPrintTraits	ArgTraits,
		EPrintTraits	DefaultTraits
	)

Sort the array with the selected trait. If no traits were selected, sort via the default one