UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::AssetRegistry::Impl::FTickContext Struct Reference

#include <AssetRegistryImpl.h>

Public Member Functions

 FTickContext (FAssetRegistryImpl &InGuardedData, Impl::FEventContext &InEventContext, Impl::FClassInheritanceContext &InInheritanceContext)
 
void LazyStartTimer ()
 
void RecordTimer ()
 
int32 GetNumPending ()
 
int32 GetNumGatherFromDiskPending ()
 
void SetNumGatherFromDiskPendingDirty ()
 
int32 CalculateNumGatherFromDiskPending ()
 
EGatherStatus SetIntermediateStatus (EGatherStatus Status)
 
EGatherStatus UpdateIntermediateStatus ()
 
void RunAssetSearchDataGathered (TMultiMap< FName, TUniquePtr< FAssetData > > &InAssetResults, TMultiMap< FName, TUniquePtr< FAssetData > > &OutDeferredAssetResults)
 
void RunDependencyDataGathered (TMultiMap< FName, FPackageDependencyData > &DependenciesToProcess, TMultiMap< FName, FPackageDependencyData > &OutDeferredDependencies, TSet< FName > *OutPackagesNeedingDependencyCalculation)
 

Public Attributes

UE::AssetDataGather::FResultContext ResultContext
 
Impl::FInterruptionContext InterruptionContext
 
FAssetRegistryImplGuardedData
 
Impl::FEventContextEventContext
 
Impl::FClassInheritanceContextInheritanceContext
 
TOptional< TSet< FString > > MountPointsForVerifyAfterGather
 
double TimingStartTime = -1.
 
int32 NumGatherFromDiskPending = 0
 
bool bHandleCompletion = false
 
bool bHandleDeferred = false
 
bool bNumGatherFromDiskPendingDirty = true
 
bool bHadAssetsToProcess = false
 
bool bIsInGameThread = false
 

Detailed Description

Input and output variables for the TickGatherer function.

Constructor & Destructor Documentation

◆ FTickContext()

FTickContext::FTickContext ( FAssetRegistryImpl InGuardedData,
Impl::FEventContext InEventContext,
Impl::FClassInheritanceContext InInheritanceContext 
)

Member Function Documentation

◆ CalculateNumGatherFromDiskPending()

int32 FTickContext::CalculateNumGatherFromDiskPending ( )

Run the expression to calculate the value used in GetNumGatherFromDiskPending.

◆ GetNumGatherFromDiskPending()

int32 FTickContext::GetNumGatherFromDiskPending ( )

Return the portion of GetNumPending that is handled during gathering from disk; does not include the calculations that we do once the gather from disk is done. This function is cached, it does not redo the calculation until SetNumPendingDirty is called.

◆ GetNumPending()

int32 FTickContext::GetNumPending ( )

Return progress-bar metric for how many elements remain in the various lists of work to do. A portion of this calculation is cached (the GetNumGatherFromDiskPending) and it will not get the most up to date data until SetNumGatherFromDiskPendingDirty is called.

◆ LazyStartTimer()

void FTickContext::LazyStartTimer ( )

Start the timer to measure time spent in the current call to TickGatherer, if not already started.

◆ RecordTimer()

void FTickContext::RecordTimer ( )

Record the time that was spent in the current call to TickGatherer onto the metric for it on GuardedData, if LazyStartTimer has been called and RecordTimer has not already been called.

◆ RunAssetSearchDataGathered()

void FTickContext::RunAssetSearchDataGathered ( TMultiMap< FName, TUniquePtr< FAssetData > > &  InAssetResults,
TMultiMap< FName, TUniquePtr< FAssetData > > &  OutDeferredAssetResults 
)

◆ RunDependencyDataGathered()

void FTickContext::RunDependencyDataGathered ( TMultiMap< FName, FPackageDependencyData > &  DependenciesToProcess,
TMultiMap< FName, FPackageDependencyData > &  OutDeferredDependencies,
TSet< FName > *  OutPackagesNeedingDependencyCalculation 
)

◆ SetIntermediateStatus()

EGatherStatus FTickContext::SetIntermediateStatus ( EGatherStatus  Status)

Store the result of TickGatherer in the AssetRegistry's status variable and send the progress event. Returns the input Status so it can be used in a return line.

◆ SetNumGatherFromDiskPendingDirty()

void FTickContext::SetNumGatherFromDiskPendingDirty ( )

Invalidate the cache in GetNumGatherFromDiskPending

◆ UpdateIntermediateStatus()

EGatherStatus FTickContext::UpdateIntermediateStatus ( )

Calculate the result of TickGatherer from the current gather data on the TickContext and call SetIntermediateStatus. Returns the input Status so it can be used in a return line.

Member Data Documentation

◆ bHadAssetsToProcess

bool UE::AssetRegistry::Impl::FTickContext::bHadAssetsToProcess = false

◆ bHandleCompletion

bool UE::AssetRegistry::Impl::FTickContext::bHandleCompletion = false

◆ bHandleDeferred

bool UE::AssetRegistry::Impl::FTickContext::bHandleDeferred = false

◆ bIsInGameThread

bool UE::AssetRegistry::Impl::FTickContext::bIsInGameThread = false

◆ bNumGatherFromDiskPendingDirty

bool UE::AssetRegistry::Impl::FTickContext::bNumGatherFromDiskPendingDirty = true

◆ EventContext

Impl::FEventContext& UE::AssetRegistry::Impl::FTickContext::EventContext

◆ GuardedData

FAssetRegistryImpl& UE::AssetRegistry::Impl::FTickContext::GuardedData

◆ InheritanceContext

Impl::FClassInheritanceContext& UE::AssetRegistry::Impl::FTickContext::InheritanceContext

◆ InterruptionContext

Impl::FInterruptionContext UE::AssetRegistry::Impl::FTickContext::InterruptionContext

◆ MountPointsForVerifyAfterGather

TOptional<TSet<FString> > UE::AssetRegistry::Impl::FTickContext::MountPointsForVerifyAfterGather

◆ NumGatherFromDiskPending

int32 UE::AssetRegistry::Impl::FTickContext::NumGatherFromDiskPending = 0

◆ ResultContext

UE::AssetDataGather::FResultContext UE::AssetRegistry::Impl::FTickContext::ResultContext

◆ TimingStartTime

double UE::AssetRegistry::Impl::FTickContext::TimingStartTime = -1.

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