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 > Serialization > IAsyncPackageLoader

Light Theme

Dark Theme

IAsyncPackageLoader

Asynchronous package loader interface.

Windows

MacOS

Linux

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/Serialization/AsyncPackageLoader.h
Include	#include "Serialization/AsyncPackageLoader.h"

Syntax

class IAsyncPackageLoader

Remarks

Asynchronous package loader interface.

Destructors

	Name	Description
	~IAsyncPackageLoader()

Functions

	Name	Description
void	CancelLoading()	Cancels streaming. Called from Game Thread.
void	FireCompletedCompiledInImport ( void* AsyncPackage, FPackageIndex Import )
void	FlushLoading ( int32 PackageId )	Flush pending loading request(s). Called from Game Thread.
float	GetAsyncLoadPercentage ( const FName& PackageName )	[GAME THREAD] Gets the load percentage of the specified package
int32	GetNextRequestId()
int32	GetNumAsyncPackages()	Returns the number of loading packages.
int32	GetNumQueuedPackages()	Returns the number of queued packages.
void	InitializeLoading()	Initialize loading.
bool	IsAsyncLoadingPackages()	Returns whether packages are currently being loaded on a background thread.
bool	IsAsyncLoadingSuspended()	Returns whether the package loader is suspended or not.
bool	IsInAsyncLoadThread()	Returns whether in package loader background thread or not.
bool	IsMultithreaded()	Returns whether loading packages with multiple threads.
int32	LoadPackage ( const FString& InPackageName, const FGuid* InGuid, const TCHAR* InPackageToLoadFr..., FLoadPackageAsyncDelegate InComplet..., EPackageFlags InPackageFlags, int32 InPIEInstanceID, int32 InPackagePriority, const FLinkerInstancingContext*... )	Asynchronously load a package.
void	NotifyConstructedDuringAsyncLoading ( UObject* Object, bool bSubObject )
void	NotifyUnreachableObjects ( const TArrayView< FUObjectItem*... )
EAsyncPackag...	ProcessLoading ( bool bUseTimeLimit, bool bUseFullTimeLimit, float TimeLimit )	Process all currently loading package requests.
EAsyncPackag...	ProcessLoadingUntilComplete ( TFunctionRef< bool()> CompletionPre..., float TimeLimit )	Process all loading package requests until completion predicate is satisfied.
void	ResumeLoading()	Resumes async loading thread Called from Game Thread.
void	ShutdownLoading()	Shut down loading.
void	StartThread()
void	SuspendLoading()	Suspends async loading thread Called from Game Thread.

Constants

Name	Description
NextPackageRequestId

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

Take our survey

Dismiss