UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
BuildPatchServices::ISpeedRecorder Class Referenceabstract

#include <SpeedRecorder.h>

+ Inheritance diagram for BuildPatchServices::ISpeedRecorder:

Classes

struct  FRecord
 

Public Member Functions

virtual ~ISpeedRecorder ()
 
virtual void AddRecord (const FRecord &Record)=0
 
virtual double GetAverageSpeed (float Seconds) const =0
 
virtual double GetPeakSpeed () const =0
 

Detailed Description

A helper implementation for recording unit speeds.

Constructor & Destructor Documentation

◆ ~ISpeedRecorder()

virtual BuildPatchServices::ISpeedRecorder::~ISpeedRecorder ( )
inlinevirtual

Member Function Documentation

◆ AddRecord()

virtual void BuildPatchServices::ISpeedRecorder::AddRecord ( const FRecord &  Record)
pure virtual

Adds a record to the recorder.

Parameters
RecordThe record to add.

Implemented in BuildPatchServices::FSpeedRecorder.

◆ GetAverageSpeed()

virtual double BuildPatchServices::ISpeedRecorder::GetAverageSpeed ( float  Seconds) const
pure 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.

Implemented in BuildPatchServices::FSpeedRecorder.

◆ GetPeakSpeed()

virtual double BuildPatchServices::ISpeedRecorder::GetPeakSpeed ( ) const
pure virtual

Get the peak speed achieved so far.

Returns
the peak speed achieved so far.

Implemented in BuildPatchServices::FSpeedRecorder.

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