UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAsyncPackage2 Struct Reference
+ Inheritance diagram for FAsyncPackage2:

Public Member Functions

 FAsyncPackage2 (FAsyncLoadingThreadState2 &ThreadState, const FAsyncPackageDesc2 &InDesc, FAsyncLoadingThread2 &InAsyncLoadingThread, FAsyncLoadEventGraphAllocator &InGraphAllocator, const FAsyncLoadEventSpec *EventSpecs)
 
virtual ~FAsyncPackage2 ()
 
void AddRef ()
 
bool TryAddRef ()
 
void Release ()
 
void ClearImportedPackages ()
 
double GetLoadStartTime () const
 
void AddCompletionCallback (TUniquePtr< FLoadPackageAsyncDelegate > &&Callback)
 
void AddProgressCallback (TSharedPtr< FLoadPackageAsyncProgressDelegate > Callback)
 
FORCEINLINE UPackageGetLinkerRoot () const
 
FORCEINLINE bool HasLoadFailed () const
 
FORCEINLINE EAsyncLoadingResult::Type GetLoadStatus () const
 
void AddRequestID (FAsyncLoadingThreadState2 &ThreadState, int32 Id)
 
uint64 GetSyncLoadContextId () const
 
void AddConstructedObject (UObject *Object, bool bSubObjectThatAlreadyExists)
 
void MoveConstructedObjectsToPhase2 ()
 
void ClearConstructedObjects ()
 
EAsyncPackageState::Type PostLoadInstances (FAsyncLoadingThreadState2 &ThreadState)
 
EAsyncPackageState::Type CreateClusters (FAsyncLoadingThreadState2 &ThreadState)
 
void ImportPackagesRecursive (FAsyncLoadingThreadState2 &ThreadState, FIoBatch &IoBatch, FPackageStore &PackageStore)
 
void StartLoading (FAsyncLoadingThreadState2 &ThreadState, FIoBatch &IoBatch)
 
void InitializeLinkerLoadState (const FLinkerInstancingContext *InstancingContext)
 
void CreateLinker (const FLinkerInstancingContext *InstancingContext)
 
void DetachLinker ()
 
FAsyncLoadingThread2GetAsyncLoadingThread ()
 
FAsyncLoadEventGraphAllocatorGetGraphAllocator ()
 
bool CanRunNodeAsync (const FAsyncLoadEventSpec *Spec) const
 
void EventDrivenCreateExport (const FAsyncPackageHeaderData &Header, int32 LocalExportIndex)
 
bool EventDrivenSerializeExport (const FAsyncPackageHeaderData &Header, int32 LocalExportIndex, FExportArchive *Ar)
 
void EventDrivenCreateCellExport (const FAsyncPackageHeaderData &Header, int32 LocalExportIndex, FExportArchive *Ar)
 
bool EventDrivenSerializeCellExport (const FAsyncPackageHeaderData &Header, int32 LocalExportIndex, FExportArchive *Ar)
 
UObjectEventDrivenIndexToObject (const FAsyncPackageHeaderData &Header, FPackageObjectIndex Index, bool bCheckSerialized)
 
template<class T >
T * CastEventDrivenIndexToObject (const FAsyncPackageHeaderData &Header, FPackageObjectIndex Index, bool bCheckSerialized)
 
FEventLoadNode2GetPackageNode (EEventLoadNode2 Phase)
 
FEventLoadNode2GetExportBundleNode (EEventLoadNode2 Phase, uint32 ExportBundleIndex)
 
void CallProgressCallback (FLoadPackageAsyncProgressDelegate &ProgressCallback, EAsyncLoadingProgress ProgressType)
 
void CallProgressCallbacks (EAsyncLoadingProgress ProgressType)
 
void DumpState ()
 
FUObjectSerializeContextGetSerializeContext ()
 
- Public Member Functions inherited from FRefCountBase
 FRefCountBase ()=default
 
virtual ~FRefCountBase ()=default
 
 FRefCountBase (const FRefCountBase &Rhs)=delete
 
FRefCountBaseoperator= (const FRefCountBase &Rhs)=delete
 
FReturnedRefCountValue AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 

Static Public Member Functions

static FAsyncPackage2GetCurrentlyExecutingPackage (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *PackageToFilter=nullptr)
 
static EEventLoadNodeExecutionResult Event_ProcessExportBundle (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32 ExportBundleIndex)
 
static EEventLoadNodeExecutionResult Event_CreateLinkerLoadExports (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_ResolveLinkerLoadImports (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_PreloadLinkerLoadExports (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_ProcessPackageSummary (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_ProcessDependencies (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_DependenciesReady (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_ExportsDone (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32)
 
static EEventLoadNodeExecutionResult Event_PostLoadExportBundle (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32 ExportBundleIndex)
 
static EEventLoadNodeExecutionResult Event_DeferredPostLoadExportBundle (FAsyncLoadingThreadState2 &ThreadState, FAsyncPackage2 *Package, int32 ExportBundleIndex)
 

Friends

struct FAsyncPackageScope2
 
class FAsyncLoadingThread2
 
class FAsyncLoadEventQueue2
 
class FAsyncLoadingVerseRoot
 

Detailed Description

Structure containing intermediate data required for async loading of all exports of a package.

Constructor & Destructor Documentation

◆ FAsyncPackage2()

FAsyncPackage2::FAsyncPackage2 ( FAsyncLoadingThreadState2 ThreadState,
const FAsyncPackageDesc2 InDesc,
FAsyncLoadingThread2 InAsyncLoadingThread,
FAsyncLoadEventGraphAllocator InGraphAllocator,
const FAsyncLoadEventSpec EventSpecs 
)

Constructor

◆ ~FAsyncPackage2()

FAsyncPackage2::~FAsyncPackage2 ( )
virtual

Member Function Documentation

◆ AddCompletionCallback()

void FAsyncPackage2::AddCompletionCallback ( TUniquePtr< FLoadPackageAsyncDelegate > &&  Callback)

◆ AddConstructedObject()

void FAsyncPackage2::AddConstructedObject ( UObject Object,
bool  bSubObjectThatAlreadyExists 
)
inline

◆ AddProgressCallback()

void FAsyncPackage2::AddProgressCallback ( TSharedPtr< FLoadPackageAsyncProgressDelegate Callback)

◆ AddRef()

void FAsyncPackage2::AddRef ( )
inline

◆ AddRequestID()

void FAsyncPackage2::AddRequestID ( FAsyncLoadingThreadState2 ThreadState,
int32  Id 
)

Adds new request ID to the existing package

◆ CallProgressCallback()

void FAsyncPackage2::CallProgressCallback ( FLoadPackageAsyncProgressDelegate ProgressCallback,
EAsyncLoadingProgress  ProgressType 
)

[EDL] End Event driven loader specific stuff

◆ CallProgressCallbacks()

void FAsyncPackage2::CallProgressCallbacks ( EAsyncLoadingProgress  ProgressType)

◆ CanRunNodeAsync()

bool FAsyncPackage2::CanRunNodeAsync ( const FAsyncLoadEventSpec Spec) const

◆ CastEventDrivenIndexToObject()

template<class T >
T * FAsyncPackage2::CastEventDrivenIndexToObject ( const FAsyncPackageHeaderData Header,
FPackageObjectIndex  Index,
bool  bCheckSerialized 
)
inline

◆ ClearConstructedObjects()

void FAsyncPackage2::ClearConstructedObjects ( )

◆ ClearImportedPackages()

void FAsyncPackage2::ClearImportedPackages ( )

◆ CreateClusters()

EAsyncPackageState::Type FAsyncPackage2::CreateClusters ( FAsyncLoadingThreadState2 ThreadState)

Creates GC clusters from loaded objects

◆ CreateLinker()

void FAsyncPackage2::CreateLinker ( const FLinkerInstancingContext InstancingContext)

◆ DetachLinker()

void FAsyncPackage2::DetachLinker ( )

◆ DumpState()

void FAsyncPackage2::DumpState ( )

◆ Event_CreateLinkerLoadExports()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_CreateLinkerLoadExports ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ Event_DeferredPostLoadExportBundle()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_DeferredPostLoadExportBundle ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32  ExportBundleIndex 
)
static

◆ Event_DependenciesReady()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_DependenciesReady ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ Event_ExportsDone()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_ExportsDone ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ Event_PostLoadExportBundle()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_PostLoadExportBundle ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32  ExportBundleIndex 
)
static

◆ Event_PreloadLinkerLoadExports()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_PreloadLinkerLoadExports ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ Event_ProcessDependencies()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_ProcessDependencies ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ Event_ProcessExportBundle()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_ProcessExportBundle ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32  ExportBundleIndex 
)
static

[EDL] Begin Event driven loader specific stuff

◆ Event_ProcessPackageSummary()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_ProcessPackageSummary ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ Event_ResolveLinkerLoadImports()

EEventLoadNodeExecutionResult FAsyncPackage2::Event_ResolveLinkerLoadImports ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 Package,
int32   
)
static

◆ EventDrivenCreateCellExport()

void FAsyncPackage2::EventDrivenCreateCellExport ( const FAsyncPackageHeaderData Header,
int32  LocalExportIndex,
FExportArchive Ar 
)

◆ EventDrivenCreateExport()

void FAsyncPackage2::EventDrivenCreateExport ( const FAsyncPackageHeaderData Header,
int32  LocalExportIndex 
)

◆ EventDrivenIndexToObject()

UObject * FAsyncPackage2::EventDrivenIndexToObject ( const FAsyncPackageHeaderData Header,
FPackageObjectIndex  Index,
bool  bCheckSerialized 
)

◆ EventDrivenSerializeCellExport()

bool FAsyncPackage2::EventDrivenSerializeCellExport ( const FAsyncPackageHeaderData Header,
int32  LocalExportIndex,
FExportArchive Ar 
)

◆ EventDrivenSerializeExport()

bool FAsyncPackage2::EventDrivenSerializeExport ( const FAsyncPackageHeaderData Header,
int32  LocalExportIndex,
FExportArchive Ar 
)

◆ GetAsyncLoadingThread()

FAsyncLoadingThread2 & FAsyncPackage2::GetAsyncLoadingThread ( )
inline

◆ GetCurrentlyExecutingPackage()

FAsyncPackage2 * FAsyncPackage2::GetCurrentlyExecutingPackage ( FAsyncLoadingThreadState2 ThreadState,
FAsyncPackage2 PackageToFilter = nullptr 
)
static

◆ GetExportBundleNode()

FEventLoadNode2 & FAsyncPackage2::GetExportBundleNode ( EEventLoadNode2  Phase,
uint32  ExportBundleIndex 
)

◆ GetGraphAllocator()

FAsyncLoadEventGraphAllocator & FAsyncPackage2::GetGraphAllocator ( )
inline

◆ GetLinkerRoot()

FORCEINLINE UPackage * FAsyncPackage2::GetLinkerRoot ( ) const
inline

◆ GetLoadStartTime()

double FAsyncPackage2::GetLoadStartTime ( ) const
Returns
Time load begun. This is NOT the time the load was requested in the case of other pending requests.

◆ GetLoadStatus()

FORCEINLINE EAsyncLoadingResult::Type FAsyncPackage2::GetLoadStatus ( ) const
inline

◆ GetPackageNode()

FEventLoadNode2 & FAsyncPackage2::GetPackageNode ( EEventLoadNode2  Phase)

◆ GetSerializeContext()

FUObjectSerializeContext * FAsyncPackage2::GetSerializeContext ( )

Serialization context for this package

◆ GetSyncLoadContextId()

uint64 FAsyncPackage2::GetSyncLoadContextId ( ) const
inline

◆ HasLoadFailed()

FORCEINLINE bool FAsyncPackage2::HasLoadFailed ( ) const
inline

Returns true if loading has failed

◆ ImportPackagesRecursive()

void FAsyncPackage2::ImportPackagesRecursive ( FAsyncLoadingThreadState2 ThreadState,
FIoBatch IoBatch,
FPackageStore PackageStore 
)

◆ InitializeLinkerLoadState()

void FAsyncPackage2::InitializeLinkerLoadState ( const FLinkerInstancingContext InstancingContext)

◆ MoveConstructedObjectsToPhase2()

void FAsyncPackage2::MoveConstructedObjectsToPhase2 ( )

◆ PostLoadInstances()

EAsyncPackageState::Type FAsyncPackage2::PostLoadInstances ( FAsyncLoadingThreadState2 ThreadState)

Class specific callback for initializing non-native objects

◆ Release()

void FAsyncPackage2::Release ( )

◆ StartLoading()

void FAsyncPackage2::StartLoading ( FAsyncLoadingThreadState2 ThreadState,
FIoBatch IoBatch 
)

◆ TryAddRef()

bool FAsyncPackage2::TryAddRef ( )
inline

Friends And Related Symbol Documentation

◆ FAsyncLoadEventQueue2

◆ FAsyncLoadingThread2

◆ FAsyncLoadingVerseRoot

friend class FAsyncLoadingVerseRoot
friend

◆ FAsyncPackageScope2


The documentation for this struct was generated from the following file: