UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
BuildPatchServices::FSpeedRecorder Class Reference
+ Inheritance diagram for BuildPatchServices::FSpeedRecorder:

Public Member Functions

 FSpeedRecorder ()
 
virtual ~FSpeedRecorder ()
 
virtual void AddRecord (const FRecord &Record)
 
virtual double GetAverageSpeed (float Seconds) const
 
virtual double GetPeakSpeed () const
 
virtual bool Tick (float DeltaTime)
 
- Public Member Functions inherited from BuildPatchServices::ISpeedRecorder
virtual ~ISpeedRecorder ()
 
- Public Member Functions inherited from FTSTickerObjectBase
 UE_NONCOPYABLE (FTSTickerObjectBase)
 
CORE_API FTSTickerObjectBase (float InDelay=0.0f, FTSTicker &Ticker=FTSTicker::GetCoreTicker())
 
virtual CORE_API ~FTSTickerObjectBase ()
 

Constructor & Destructor Documentation

◆ FSpeedRecorder()

BuildPatchServices::FSpeedRecorder::FSpeedRecorder ( )

◆ ~FSpeedRecorder()

BuildPatchServices::FSpeedRecorder::~FSpeedRecorder ( )
virtual

Member Function Documentation

◆ AddRecord()

void BuildPatchServices::FSpeedRecorder::AddRecord ( const FRecord &  Record)
virtual

Adds a record to the recorder.

Parameters
RecordThe record to add.

Implements BuildPatchServices::ISpeedRecorder.

◆ GetAverageSpeed()

double BuildPatchServices::FSpeedRecorder::GetAverageSpeed ( float  Seconds) const
virtual

Get the current average speed achieved over the last X seconds.

Parameters
SecondsThe time in seconds to take the reading over. Use TNumericLimits<float>::Max() to get the average over all readings.
Returns
the average speed over the past given seconds.

Implements BuildPatchServices::ISpeedRecorder.

◆ GetPeakSpeed()

double BuildPatchServices::FSpeedRecorder::GetPeakSpeed ( ) const
virtual

Get the peak speed achieved so far.

Returns
the peak speed achieved so far.

Implements BuildPatchServices::ISpeedRecorder.

◆ Tick()

bool BuildPatchServices::FSpeedRecorder::Tick ( float  DeltaTime)
virtual

Pure virtual that must be overloaded by the inheriting class.

Parameters
DeltaTimetime passed since the last call.
Returns
true if should continue ticking

Implements FTSTickerObjectBase.

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