Navigation
API > API/Runtime > API/Runtime/CoreUObject
Asynchronous package loader interface.
| Name | IAsyncPackageLoader |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/Serialization/AsyncPackageLoader.h |
| Include Path | #include "Serialization/AsyncPackageLoader.h" |
Syntax
class IAsyncPackageLoader
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAsyncPackageLoader() |
Serialization/AsyncPackageLoader.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NextPackageRequestId | FThreadSafeCounter | Serialization/AsyncPackageLoader.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelLoading() |
Cancels streaming.Note: Called from Game Thread. | Serialization/AsyncPackageLoader.h | |
void FlushLoading
(
TConstArrayView< int32 > RequestIds |
Flush pending loading request(s).Note: Called from Game Thread. | Serialization/AsyncPackageLoader.h | |
float GetAsyncLoadPercentage
(
const FName& PackageName |
[GAME THREAD] Gets the load percentage of the specified package | Serialization/AsyncPackageLoader.h | |
ELoaderType GetLoaderType() |
Serialization/AsyncPackageLoader.h | ||
int32 GetNumAsyncPackages() |
Returns the number of loading packages. | Serialization/AsyncPackageLoader.h | |
int32 GetNumQueuedPackages() |
Returns the number of queued packages. | Serialization/AsyncPackageLoader.h | |
void InitializeLoading() |
Initialize loading. | Serialization/AsyncPackageLoader.h | |
bool IsAsyncLoadingPackages () |
Returns whether packages are currently being loaded on a background thread. | Serialization/AsyncPackageLoader.h | |
bool IsAsyncLoadingSuspended() |
Returns whether the package loader is suspended or not. | Serialization/AsyncPackageLoader.h | |
bool IsInAsyncLoadThread() |
Returns whether in package loader background thread or not. | Serialization/AsyncPackageLoader.h | |
bool IsMultithreaded () |
Returns whether loading packages with multiple threads. | Serialization/AsyncPackageLoader.h | |
int32 LoadPackage
(
const FPackagePath& PackagePath, |
Asynchronously load a package. | Serialization/AsyncPackageLoader.h | |
virtual int32 LoadPackage
(
const FPackagePath& PackagePath, |
Asynchronously load a package. | Serialization/AsyncPackageLoader.h | |
void NotifyConstructedDuringAsyncLoading
(
UObject* Object, |
Serialization/AsyncPackageLoader.h | ||
void NotifyRegistrationComplete() |
Serialization/AsyncPackageLoader.h | ||
void NotifyRegistrationEvent
(
FName PackageName, |
Serialization/AsyncPackageLoader.h | ||
virtual void NotifyScriptVersePackage
(
Verse::VPackage* Package |
Called for built in packages (currently only VVMIntrinsics.cpp) to allow them to be imported. | Serialization/AsyncPackageLoader.h | |
void NotifyUnreachableObjects
(
const TArrayView< FUObjectItem* >& UnreachableObjects |
Serialization/AsyncPackageLoader.h | ||
EAsyncPackageState::Type ProcessLoading
(
bool bUseTimeLimit, |
Process all currently loading package requests. | Serialization/AsyncPackageLoader.h | |
EAsyncPackageState::Type ProcessLoadingUntilComplete
(
TFunctionRef< bool()> CompletionPredicate, |
Process all loading package requests until completion predicate is satisfied. | Serialization/AsyncPackageLoader.h | |
void ResumeLoading() |
Resumes async loading threadNote: Called from Game Thread. | Serialization/AsyncPackageLoader.h | |
bool ShouldAlwaysLoadPackageAsync
(
const FPackagePath& PackagePath |
Serialization/AsyncPackageLoader.h | ||
void ShutdownLoading() |
Shut down loading. | Serialization/AsyncPackageLoader.h | |
void StartThread() |
Serialization/AsyncPackageLoader.h | ||
void SuspendLoading() |
Suspends async loading threadNote: Called from Game Thread. | Serialization/AsyncPackageLoader.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 GetNextRequestId() |
Serialization/AsyncPackageLoader.h |