Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > Misc > FExclusiveLoadPackageTimeTracker

Light Theme

Dark Theme

FExclusiveLoadPackageTimeTracker

A singleton to keep track of the exclusive load time of every package.

Windows

MacOS

Linux

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/Misc/ExclusiveLoadPackageTimeTracker.h
Include	#include "Misc/ExclusiveLoadPackageTimeTracker.h"

Syntax

class FExclusiveLoadPackageTimeTracker

Remarks

A singleton to keep track of the exclusive load time of every package. Also reports inclusive load time for convenience. The code that loads packages "pushes" a load on the tracker which will record the time the package started loading. Later that package will be "popped" which will cause the tracker to record the time spent. If another package is pushed while this is happening, it will pause the time recorded from the first package and start a new time for the second. This is recursive. DumpReport() can be used to log out all the recorded values in a couple different ways to get an idea about what packages are the slowest to load.

Functions

	Name	Description
void	DumpReport ( const TArray< FString >& Args )	Displays the data gathered in various ways.
double	GetExclusiveLoadTime ( FName PackageName )	Returns the load time for the specified package, excluding its dependencies
double	GetInclusiveLoadTime ( FName PackageName )	Returns the load time for the specified package, including its dependencies
void	PopEndLoad()	Records some time spent in "EndLoad"
void	PopLoadPackage ( UPackage* LoadedPackage )	Records a time and stats for the loaded package.
void	PopPostLoad ( UObject* PostLoadObject )	Records a time and stats for the loaded package.
void	PushEndLoad()	Starts a time for time spent in "EndLoad"
void	PushLoadPackage ( FName PackageName )	Starts a time for the specified package name.
bool	PushPostLoad ( UObject* PostLoadObject )	Starts a time for the specified package name.
void	ResetReport()	Resets the data.

Classes

	Name	Description
	FScopedEndLoadTracker	Scoped helper for EndLoad
	FScopedPackageTracker	Scoped helper for LoadPackage
	FScopedPostLoadTracker	Scoped helper for PostLoad

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss