1. Epic GamesDeveloper
  3. FPersistentStatContainerBase

FPersistentStatContainerBase

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

API > API/Runtime > API/Runtime/InstallBundleManager

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual Const const FBundlePersistentStats *

GetBundleStat ( FName BundleName
)

  
Public function Virtual Const const FSessionPersistentStats *

GetSessionStat ( const FString& SessionName
)

  
Public function Virtual void

IncrementBundlePersistentCounter ( FName BundleName,
ECountStatNames CounterToUpdate
)

  
Public function Virtual void

IncrementSessionPersistentCounter ( const FString& SessionName,
ECountStatNames CounterToUpdate
)

  
Public function void NOTE! These 2 functions are not virtual as we call them in the construct/deconstructor!
Protected function Virtual void Goes through this Session's RequiredBundles and loads data from disk for those bundles.
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function 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
Protected function 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
Public function Virtual void

RemoveBundleStats ( FName BundleName
)

  
Public function Virtual void

RemoveSessionStats ( const FString& SessionName
)

 Deletes persistent stat information from our stats for this Session/Bundle to reduce memory useage.
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void  
Public function void  
Public function Virtual void  
Public function Virtual void

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

 Starts Bundle Persistent Stat Tracking for the given BundleName.
Public function Virtual void

StartSessionPersistentStatTimer ( const FString& SessionName,
ETimingStatNames TimerToStart
)

  
Public function Virtual void

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

 Starts Session Persistent Stat Tracking under the given SessionName.
Public function Virtual void  
Public function Virtual void

StopBundlePersistentStatTracking ( FName BundleName,
bool bStopAllActiveTimers
)

  
Public function Virtual void

StopSessionPersistentStatTimer ( const FString& SessionName,
ETimingStatNames TimerToStop
)

  
Public function Virtual void

StopSessionPersistentStatTracking ( const FString& SessionName,
bool bStopAllActiveTimers
)

  
Protected function Virtual bool

Tick ( float dt
)

  
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void  
Public function Virtual void

UpdateSessionPersistentStatTimer ( const FString& SessionName,
ETimingStatNames TimerToUpdate
)

  
Protected function Virtual void Stops active foreground timers when going to background and starts applicable background version Also increments background counters
Protected function Virtual void Stops active background timers and resumes applicable foreground timers Also increments foreground counters

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page