1. Epic GamesDeveloper
  3. FPersistentStatContainerBase

FPersistentStatContainerBase

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

API > API/Runtime > API/Runtime/InstallBundleManager

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

   
Name FPersistentStatContainerBase
Type class
Header File /Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleUtils.h
Include Path #include "InstallBundleUtils.h"

Syntax

class FPersistentStatContainerBase

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FPersistentStatContainerBase()

   InstallBundleUtils.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPersistentStatContainerBase()

   InstallBundleUtils.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual const FBundlePersistentStats * GetBundleStat ( FName BundleName
) const

   InstallBundleUtils.h  

virtual const FSessionPersistentStats * GetSessionStat ( const FString& SessionName
) const

   InstallBundleUtils.h  

virtual void IncrementBundlePersistentCounter ( FName BundleName,
ECountStatNames CounterToUpdate
)

   InstallBundleUtils.h  

virtual void IncrementSessionPersistentCounter ( const FString& SessionName,
ECountStatNames CounterToUpdate
)

   InstallBundleUtils.h  

void InitializeBase()

 NOTE! These 2 functions are not virtual as we call them in the construct/deconstructor! InstallBundleUtils.h  

virtual void RemoveBundleStats ( FName BundleName
)

   InstallBundleUtils.h  

virtual void RemoveSessionStats ( const FString& SessionName
)

 Deletes persistent stat information from our stats for this Session/Bundle to reduce memory useage. InstallBundleUtils.h  

virtual void SaveAllDirtyStatsToDisk()

   InstallBundleUtils.h  

void ShutdownBase()

   InstallBundleUtils.h  

virtual void StartBundlePersistentStatTimer ( FName BundleName,
ETimingStatNames TimerToStart
)

   InstallBundleUtils.h  

virtual void StartBundlePersistentStatTracking ( FName BundleName,
const FString& ExpectedAnalyticsID,
bool bForceResetStatData
)

 Starts Bundle Persistent Stat Tracking for the given BundleName. InstallBundleUtils.h  

virtual void StartSessionPersistentStatTimer ( const FString& SessionName,
ETimingStatNames TimerToStart
)

   InstallBundleUtils.h  

virtual void StartSessionPersistentStatTracking ( const FString& SessionName,
const TArray< FName >& RequiredBundles,
const FString& ExpectedAnalyticsID,
bool bForceResetStatData
)

 Starts Session Persistent Stat Tracking under the given SessionName. InstallBundleUtils.h  

virtual void StopBundlePersistentStatTimer ( FName BundleName,
ETimingStatNames TimerToStop
)

   InstallBundleUtils.h  

virtual void StopBundlePersistentStatTracking ( FName BundleName,
bool bStopAllActiveTimers
)

   InstallBundleUtils.h  

virtual void StopSessionPersistentStatTimer ( const FString& SessionName,
ETimingStatNames TimerToStop
)

   InstallBundleUtils.h  

virtual void StopSessionPersistentStatTracking ( const FString& SessionName,
bool bStopAllActiveTimers
)

   InstallBundleUtils.h  

virtual void UpdateBundlePersistentStatTimer ( FName BundleName,
ETimingStatNames TimerToUpdate
)

   InstallBundleUtils.h  

virtual void UpdateSessionPersistentStatTimer ( const FString& SessionName,
ETimingStatNames TimerToUpdate
)

   InstallBundleUtils.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void LoadRequiredBundleDataFromDiskForSession ( const FString& SessionName
)

 Goes through this Session's RequiredBundles and loads data from disk for those bundles. InstallBundleUtils.h  

virtual void OnApp_EnteringBackground()

   InstallBundleUtils.h  

virtual void OnApp_EnteringForeground()

   InstallBundleUtils.h  

virtual void OnBackground_HandleBundleStats()

   InstallBundleUtils.h  

virtual void OnBackground_HandleSessionStats()

   InstallBundleUtils.h  

virtual void OnForeground_HandleBundleStats()

   InstallBundleUtils.h  

virtual void OnForeground_HandleSessionStats()

   InstallBundleUtils.h  

virtual void OnTimerStartedForStat ( FPersistentStatsBase& BundleStatForTimer,
ETimingStatNames TimerStarted
)

 Called whenever we start a timer NOTE: doesn't get called by timer's being Start/Stopped for bShouldAutoHandleFGBGStats InstallBundleUtils.h  

virtual void OnTimerStoppedForStat ( FPersistentStatsBase& BundleStatForTimer,
ETimingStatNames TimerStarted
)

 Called whenever we stop a timer NOTE: doesn't get called by timer's being Start/Stopped for bShouldAutoHandleFGBGStats InstallBundleUtils.h  

virtual void ResetDirtyStatUpdate()

   InstallBundleUtils.h  

virtual void ResetTimerUpdate()

   InstallBundleUtils.h  

virtual bool Tick ( float dt
)

   InstallBundleUtils.h  

virtual void UpdateAllBundlesActiveTimers()

   InstallBundleUtils.h  

virtual void UpdateAllSessionActiveTimers()

   InstallBundleUtils.h  

virtual void UpdateStatsForBackground ( FPersistentStatsBase& StatToUpdate
)

 Stops active foreground timers when going to background and starts applicable background version Also increments background counters InstallBundleUtils.h  

virtual void UpdateStatsForForeground ( FPersistentStatsBase& StatToUpdate
)

 Stops active background timers and resumes applicable foreground timers Also increments foreground counters InstallBundleUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page