Navigation
API > API/Runtime > API/Runtime/TimeManagement
Control the Engine TimeStep via a fixed frame rate that catches up with real time.
- Stays in sync with platform time.
- Blocks to prevent getting ahead of real time.
- Does not block when it needs to catch up
- If it falls behind too much, it will increase simulation delta times.
| Name | UCatchupFixedRateCustomTimeStep |
| Type | class |
| Header File | /Engine/Source/Runtime/TimeManagement/Public/CatchupFixedRateCustomTimeStep.h |
| Include Path | #include "CatchupFixedRateCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew, Meta=(DisplayName="Catchup Fixed Rate"), MinimalAPI)
class UCatchupFixedRateCustomTimeStep : public UFixedFrameRateCustomTimeStep
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep → UFixedFrameRateCustomTimeStep → UCatchupFixedRateCustomTimeStep
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCatchupFixedRateCustomTimeStep
(
const FObjectInitializer& ObjectInitializer |
CatchupFixedRateCustomTimeStep.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FrameRate | FFrameRate | Desired simulation frame rate | CatchupFixedRateCustomTimeStep.h |
|
| MaxCatchupSeconds | double | Maximum catchup time in seconds. | CatchupFixedRateCustomTimeStep.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SimulationSeconds | double | Keeps track of our simulation time, which is intentionally kept close to platform time | CatchupFixedRateCustomTimeStep.h |
Functions
Public
Overridden from UFixedFrameRateCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFrameRate GetFixedFrameRate() |
Get The fixed FrameRate | CatchupFixedRateCustomTimeStep.h |
Overridden from UEngineCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ECustomTimeStepSynchronizationState GetSynchronizationState() |
CatchupFixedRateCustomTimeStep.h | ||
virtual bool Initialize
(
UEngine* InEngine |
CatchupFixedRateCustomTimeStep.h | ||
virtual void Shutdown
(
UEngine* InEngine |
CatchupFixedRateCustomTimeStep.h | ||
virtual bool UpdateTimeStep
(
UEngine* InEngine |
CatchupFixedRateCustomTimeStep.h |