FDetailedTickStats | Unreal Engine 5.7 Documentation

Helper struct for gathering detailed per object tick stats.


Name	FDetailedTickStats
Type	struct
Header File	/Engine/Source/Runtime/Engine/Public/UnrealEngine.h
Include Path	#include "UnrealEngine.h"

Syntax

struct FDetailedTickStats

Name	Remarks	Include Path	Unreal Specifiers
FDetailedTickStats ( int32 InNumClassesToReport, float InTimeBetweenLogDumps, float InMinTimeBetweenLogDumps, float InTimesToReport, const TCHAR* InOperationPerformed )	Constructor, initializing all members.	UnrealEngine.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FDetailedTickStats()	DestructorDestructor, unregisters the GC callback	UnrealEngine.h

Name	Type	Remarks	Include Path
AllStats	TArray< FTickStats >	This is the collection of stats; some refer to objects that are long gone.	UnrealEngine.h
GCCallBackRegistered	bool	The GC callback cannot usually be registered at construction because this comes from a static data structure	UnrealEngine.h
GCIndex	int32	Index of GC run.	UnrealEngine.h
LastTimeOfLogDump	double	Last time stats where dumped to the log.	UnrealEngine.h
MinTimeBetweenLogDumps	float	Minimum time between log dumps, used for e.g. slow frames dumping.	UnrealEngine.h
NumObjectsToReport	int32	Number of objects to report. Top X	UnrealEngine.h
ObjectsInFlight	TSet< const UObject * >	Set of objects currently being tracked. Needed to correctly handle recursion.	UnrealEngine.h
ObjectToStatsMap	TMap< const UObject *, int32 >	Mapping from class to an index into the AllStats array.	UnrealEngine.h
OnPreGarbageCollectDelegateHandle	FDelegateHandle	Handle to the registered OnPreGarbageCollect delegate	UnrealEngine.h
OperationPerformed	FString	Name of operation performed that is being tracked.	UnrealEngine.h
TimeBetweenLogDumps	float	Time between dumping to the log in seconds.	UnrealEngine.h
TimesToReport	float	Tick time in ms to report if above.	UnrealEngine.h

Name	Remarks	Include Path
bool BeginObject ( UObject* Object )	Starts tracking an object and returns whether it's a recursive call or not.	UnrealEngine.h
void DumpStats()	Dump gathered stats informatoin to the log.Dump gathered stats information to the log.	UnrealEngine.h
void EndObject ( UObject* Object, float DeltaTime, bool bForSummary )	Finishes tracking the object and updates the time spent.Add instance of object to stats	UnrealEngine.h
void OnPreGarbageCollect()	Delegate handler for pre garbage collect event	UnrealEngine.h
void Reset()	Reset stats to clean slate.	UnrealEngine.h