UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
InstallBundleUtil::PersistentStats::FPersistentStatContainerBase Class Reference

#include <InstallBundleUtils.h>

Public Member Functions

INSTALLBUNDLEMANAGER_API FPersistentStatContainerBase ()
 
virtual INSTALLBUNDLEMANAGER_API ~FPersistentStatContainerBase ()
 
INSTALLBUNDLEMANAGER_API void InitializeBase ()
 
INSTALLBUNDLEMANAGER_API void ShutdownBase ()
 
virtual INSTALLBUNDLEMANAGER_API void StartBundlePersistentStatTracking (FName BundleName, const FString &ExpectedAnalyticsID=FString(), bool bForceResetStatData=false)
 
virtual INSTALLBUNDLEMANAGER_API void StartSessionPersistentStatTracking (const FString &SessionName, const TArray< FName > &RequiredBundles=TArray< FName >(), const FString &ExpectedAnalyticsID=FString(), bool bForceResetStatData=false)
 
virtual INSTALLBUNDLEMANAGER_API void StopBundlePersistentStatTracking (FName BundleName, bool bStopAllActiveTimers=true)
 
virtual INSTALLBUNDLEMANAGER_API void StopSessionPersistentStatTracking (const FString &SessionName, bool bStopAllActiveTimers=true)
 
virtual INSTALLBUNDLEMANAGER_API void StartBundlePersistentStatTimer (FName BundleName, ETimingStatNames TimerToStart)
 
virtual INSTALLBUNDLEMANAGER_API void StartSessionPersistentStatTimer (const FString &SessionName, ETimingStatNames TimerToStart)
 
virtual INSTALLBUNDLEMANAGER_API void StopBundlePersistentStatTimer (FName BundleName, ETimingStatNames TimerToStop)
 
virtual INSTALLBUNDLEMANAGER_API void StopSessionPersistentStatTimer (const FString &SessionName, ETimingStatNames TimerToStop)
 
virtual INSTALLBUNDLEMANAGER_API void UpdateBundlePersistentStatTimer (FName BundleName, ETimingStatNames TimerToUpdate)
 
virtual INSTALLBUNDLEMANAGER_API void UpdateSessionPersistentStatTimer (const FString &SessionName, ETimingStatNames TimerToUpdate)
 
virtual INSTALLBUNDLEMANAGER_API void IncrementBundlePersistentCounter (FName BundleName, ECountStatNames CounterToUpdate)
 
virtual INSTALLBUNDLEMANAGER_API void IncrementSessionPersistentCounter (const FString &SessionName, ECountStatNames CounterToUpdate)
 
virtual INSTALLBUNDLEMANAGER_API const FBundlePersistentStatsGetBundleStat (FName BundleName) const
 
virtual INSTALLBUNDLEMANAGER_API const FSessionPersistentStatsGetSessionStat (const FString &SessionName) const
 
virtual INSTALLBUNDLEMANAGER_API void SaveAllDirtyStatsToDisk ()
 
virtual INSTALLBUNDLEMANAGER_API void RemoveSessionStats (const FString &SessionName)
 
virtual INSTALLBUNDLEMANAGER_API void RemoveBundleStats (FName BundleName)
 

Protected Member Functions

virtual INSTALLBUNDLEMANAGER_API bool Tick (float dt)
 
virtual INSTALLBUNDLEMANAGER_API void ResetTimerUpdate ()
 
virtual INSTALLBUNDLEMANAGER_API void ResetDirtyStatUpdate ()
 
virtual INSTALLBUNDLEMANAGER_API void UpdateAllBundlesActiveTimers ()
 
virtual INSTALLBUNDLEMANAGER_API void UpdateAllSessionActiveTimers ()
 
virtual INSTALLBUNDLEMANAGER_API void OnApp_EnteringBackground ()
 
virtual INSTALLBUNDLEMANAGER_API void OnApp_EnteringForeground ()
 
virtual INSTALLBUNDLEMANAGER_API void OnBackground_HandleBundleStats ()
 
virtual INSTALLBUNDLEMANAGER_API void OnForeground_HandleBundleStats ()
 
virtual INSTALLBUNDLEMANAGER_API void OnBackground_HandleSessionStats ()
 
virtual INSTALLBUNDLEMANAGER_API void OnForeground_HandleSessionStats ()
 
virtual INSTALLBUNDLEMANAGER_API void OnTimerStartedForStat (FPersistentStatsBase &BundleStatForTimer, ETimingStatNames TimerStarted)
 
virtual INSTALLBUNDLEMANAGER_API void OnTimerStoppedForStat (FPersistentStatsBase &BundleStatForTimer, ETimingStatNames TimerStarted)
 
virtual INSTALLBUNDLEMANAGER_API void UpdateStatsForBackground (FPersistentStatsBase &StatToUpdate)
 
virtual INSTALLBUNDLEMANAGER_API void UpdateStatsForForeground (FPersistentStatsBase &StatToUpdate)
 
virtual INSTALLBUNDLEMANAGER_API void LoadRequiredBundleDataFromDiskForSession (const FString &SessionName)
 

Protected Attributes

TMap< FName, FBundlePersistentStatsPerBundlePersistentStatMap
 
TMap< FString, FSessionPersistentStatsSessionPersistentStatMap
 
FTSTicker::FDelegateHandle TickHandle
 
FDelegateHandle OnApp_EnteringForegroundHandle
 
FDelegateHandle OnApp_EnteringBackgroundHandle
 
float TimerAutoUpdateTimeRemaining
 
float TimerDirtyStatUpdateTimeRemaining
 
bool bShouldAutoUpdateTimersInTick
 
float TimerAutoUpdateRate
 
bool bShouldSaveDirtyStatsOnTick
 
float DirtyStatSaveToDiskRate
 
bool bShouldAutoHandleFGBGStats
 

Constructor & Destructor Documentation

◆ FPersistentStatContainerBase()

InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::FPersistentStatContainerBase ( )

◆ ~FPersistentStatContainerBase()

InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::~FPersistentStatContainerBase ( )
virtual

Member Function Documentation

◆ GetBundleStat()

const FBundlePersistentStats * InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::GetBundleStat ( FName  BundleName) const
virtual

◆ GetSessionStat()

const FSessionPersistentStats * InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::GetSessionStat ( const FString &  SessionName) const
virtual

◆ IncrementBundlePersistentCounter()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::IncrementBundlePersistentCounter ( FName  BundleName,
ECountStatNames  CounterToUpdate 
)
virtual

◆ IncrementSessionPersistentCounter()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::IncrementSessionPersistentCounter ( const FString &  SessionName,
ECountStatNames  CounterToUpdate 
)
virtual

◆ InitializeBase()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::InitializeBase ( )

◆ LoadRequiredBundleDataFromDiskForSession()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::LoadRequiredBundleDataFromDiskForSession ( const FString &  SessionName)
protectedvirtual

◆ OnApp_EnteringBackground()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnApp_EnteringBackground ( )
protectedvirtual

◆ OnApp_EnteringForeground()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnApp_EnteringForeground ( )
protectedvirtual

◆ OnBackground_HandleBundleStats()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnBackground_HandleBundleStats ( )
protectedvirtual

◆ OnBackground_HandleSessionStats()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnBackground_HandleSessionStats ( )
protectedvirtual

◆ OnForeground_HandleBundleStats()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnForeground_HandleBundleStats ( )
protectedvirtual

◆ OnForeground_HandleSessionStats()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnForeground_HandleSessionStats ( )
protectedvirtual

◆ OnTimerStartedForStat()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnTimerStartedForStat ( FPersistentStatsBase BundleStatForTimer,
ETimingStatNames  TimerStarted 
)
protectedvirtual

◆ OnTimerStoppedForStat()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnTimerStoppedForStat ( FPersistentStatsBase BundleStatForTimer,
ETimingStatNames  TimerStarted 
)
protectedvirtual

◆ RemoveBundleStats()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::RemoveBundleStats ( FName  BundleName)
virtual

◆ RemoveSessionStats()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::RemoveSessionStats ( const FString &  SessionName)
virtual

◆ ResetDirtyStatUpdate()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::ResetDirtyStatUpdate ( )
protectedvirtual

◆ ResetTimerUpdate()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::ResetTimerUpdate ( )
protectedvirtual

◆ SaveAllDirtyStatsToDisk()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::SaveAllDirtyStatsToDisk ( )
virtual

◆ ShutdownBase()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::ShutdownBase ( )

◆ StartBundlePersistentStatTimer()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StartBundlePersistentStatTimer ( FName  BundleName,
ETimingStatNames  TimerToStart 
)
virtual

◆ StartBundlePersistentStatTracking()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StartBundlePersistentStatTracking ( FName  BundleName,
const FString &  ExpectedAnalyticsID = FString(),
bool  bForceResetStatData = false 
)
virtual

◆ StartSessionPersistentStatTimer()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StartSessionPersistentStatTimer ( const FString &  SessionName,
ETimingStatNames  TimerToStart 
)
virtual

◆ StartSessionPersistentStatTracking()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StartSessionPersistentStatTracking ( const FString &  SessionName,
const TArray< FName > &  RequiredBundles = TArray<FName>(),
const FString &  ExpectedAnalyticsID = FString(),
bool  bForceResetStatData = false 
)
virtual

◆ StopBundlePersistentStatTimer()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StopBundlePersistentStatTimer ( FName  BundleName,
ETimingStatNames  TimerToStop 
)
virtual

◆ StopBundlePersistentStatTracking()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StopBundlePersistentStatTracking ( FName  BundleName,
bool  bStopAllActiveTimers = true 
)
virtual

◆ StopSessionPersistentStatTimer()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StopSessionPersistentStatTimer ( const FString &  SessionName,
ETimingStatNames  TimerToStop 
)
virtual

◆ StopSessionPersistentStatTracking()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::StopSessionPersistentStatTracking ( const FString &  SessionName,
bool  bStopAllActiveTimers = true 
)
virtual

◆ Tick()

bool InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::Tick ( float  dt)
protectedvirtual

◆ UpdateAllBundlesActiveTimers()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::UpdateAllBundlesActiveTimers ( )
protectedvirtual

◆ UpdateAllSessionActiveTimers()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::UpdateAllSessionActiveTimers ( )
protectedvirtual

◆ UpdateBundlePersistentStatTimer()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::UpdateBundlePersistentStatTimer ( FName  BundleName,
ETimingStatNames  TimerToUpdate 
)
virtual

◆ UpdateSessionPersistentStatTimer()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::UpdateSessionPersistentStatTimer ( const FString &  SessionName,
ETimingStatNames  TimerToUpdate 
)
virtual

◆ UpdateStatsForBackground()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::UpdateStatsForBackground ( FPersistentStatsBase StatToUpdate)
protectedvirtual

◆ UpdateStatsForForeground()

void InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::UpdateStatsForForeground ( FPersistentStatsBase StatToUpdate)
protectedvirtual

Member Data Documentation

◆ bShouldAutoHandleFGBGStats

bool InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::bShouldAutoHandleFGBGStats
protected

◆ bShouldAutoUpdateTimersInTick

bool InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::bShouldAutoUpdateTimersInTick
protected

◆ bShouldSaveDirtyStatsOnTick

bool InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::bShouldSaveDirtyStatsOnTick
protected

◆ DirtyStatSaveToDiskRate

float InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::DirtyStatSaveToDiskRate
protected

◆ OnApp_EnteringBackgroundHandle

FDelegateHandle InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnApp_EnteringBackgroundHandle
protected

◆ OnApp_EnteringForegroundHandle

FDelegateHandle InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::OnApp_EnteringForegroundHandle
protected

◆ PerBundlePersistentStatMap

TMap<FName, FBundlePersistentStats> InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::PerBundlePersistentStatMap
protected

◆ SessionPersistentStatMap

TMap<FString, FSessionPersistentStats> InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::SessionPersistentStatMap
protected

◆ TickHandle

FTSTicker::FDelegateHandle InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::TickHandle
protected

◆ TimerAutoUpdateRate

float InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::TimerAutoUpdateRate
protected

◆ TimerAutoUpdateTimeRemaining

float InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::TimerAutoUpdateTimeRemaining
protected

◆ TimerDirtyStatUpdateTimeRemaining

float InstallBundleUtil::PersistentStats::FPersistentStatContainerBase::TimerDirtyStatUpdateTimeRemaining
protected

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