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 > InstallBundleManager > FPersistentStatContainerBase

Light Theme

Dark Theme

FPersistentStatContainerBase

Helper class to handle holding a collection of Bundle and Session stats.

Windows

MacOS

Linux

References

Module	InstallBundleManager
Header	/Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleUtils.h
Include	#include "InstallBundleUtils.h"

Syntax

class FPersistentStatContainerBase

Remarks

Helper class to handle holding a collection of Bundle and Session stats.

Variables

	Name	Description
bool	bShouldAutoHandleFGBGStats	Determines if we should automatically Start,Stop,and Update the FG and BG versions of our timer stats.
bool	bShouldAutoUpdateTimersInTick	These settings determine if we auto-update our Timer stats on a tick.
bool	bShouldSaveDirtyStatsOnTick	These settings determine how we handle saving our stats to disk.
float	DirtyStatSaveToDiskRate
FDelegateHandle	OnApp_EnteringBackgroundHandle
FDelegateHandle	OnApp_EnteringForegroundHandle
TMap< FName, FB...	PerBundlePersistentStatMap
TMap< FString, ...	SessionPersistentStatMap
FDelegateHandle	TickHandle
float	TimerAutoUpdateRate
float	TimerAutoUpdateTimeRemaining	Internal counter used to track when we need to run our timer update during tick.
float	TimerDirtyStatUpdateTimeRemaining	Internal counter used to track when we need to update all of our dirty stats.

Constructors

	Name	Description
	FPersistentStatContainerBase()

Destructors

	Name	Description
	~FPersistentStatContainerBase()

Functions

	Name	Description
const FBundl...	GetBundleStat ( FName BundleName )
const FSessi...	GetSessionStat ( const FString& SessionName )
void	IncrementBundlePersistentCounter ( FName BundleName, ECountStatNames CounterToUpdate )
void	IncrementSessionPersistentCounter ( FString SessionName, ECountStatNames CounterToUpdate )
void	InitializeBase()	NOTE! These 2 functions are not virtual as we call them in the construct/deconstructor!
void	LoadRequiredBundleDataFromDiskForSession ( const FString& SessionName )	Goes through this Session's RequiredBundles and loads data from disk for those bundles.
void	OnApp_EnteringBackground()
void	OnApp_EnteringForeground()
void	OnBackground_HandleBundleStats()
void	OnBackground_HandleSessionStats()
void	OnForeground_HandleBundleStats()
void	OnForeground_HandleSessionStats()
void	OnTimerStartedForStat ( FPersistentStatsBase& BundleStatFo..., ETimingStatNames TimerStarted )	Called whenever we start a timer NOTE: doesn't get called by timer's being Start/Stopped for bShouldAutoHandleFGBGStats
void	OnTimerStoppedForStat ( FPersistentStatsBase& BundleStatFo..., ETimingStatNames TimerStarted )	Called whenever we stop a timer NOTE: doesn't get called by timer's being Start/Stopped for bShouldAutoHandleFGBGStats
void	ResetDirtyStatUpdate()
void	ResetTimerUpdate()
void	SaveAllDirtyStatsToDisk()
void	ShutdownBase()
void	StartBundlePersistentStatTimer ( FName BundleName, ETimingStatNames TimerToStart )
void	StartBundlePersistentStatTracking ( FName BundleName, const FString& ExpectedAnalyticsID, bool bForceResetStatData )	Starts Bundle Persistent Stat Tracking for the given BundleName.
void	StartSessionPersistentStatTimer ( FString SessionName, ETimingStatNames TimerToStart )
void	StartSessionPersistentStatTracking ( const FString& SessionName, const TArray< FName >& RequiredBun..., const FString& ExpectedAnalyticsID, bool bForceResetStatData )	Starts Session Persistent Stat Tracking under the given SessionName.
void	StopBundlePersistentStatTimer ( FName BundleName, ETimingStatNames TimerToStop )
void	StopBundlePersistentStatTracking ( FName BundleName, bool bStopAllActiveTimers )
void	StopSessionPersistentStatTimer ( FString SessionName, ETimingStatNames TimerToStop )
void	StopSessionPersistentStatTracking ( FString SessionName, bool bStopAllActiveTimers )
bool	Tick ( float dt )
void	UpdateAllBundlesActiveTimers()
void	UpdateAllSessionActiveTimers()
void	UpdateBundlePersistentStatTimer ( FName BundleName, ETimingStatNames TimerToUpdate )
void	UpdateSessionPersistentStatTimer ( FString SessionName, ETimingStatNames TimerToUpdate )
void	UpdateStatsForBackground ( FPersistentStatsBase& StatToUpdate )	Stops active foreground timers when going to background and starts applicable background version Also increments background counters
void	UpdateStatsForForeground ( FPersistentStatsBase& StatToUpdate )	Stops active background timers and resumes applicable foreground timers Also increments foreground counters

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

Take our survey

Dismiss