Navigation
API > API/Plugins > API/Plugins/VPUtilities
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UEngineCustomTimeStep
- UFixedFrameRateCustomTimeStep
- UVPTimecodeCustomTimeStep
References
| Module | VPUtilities |
| Header | /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/VPTimecodeCustomTimeStep.h |
| Include | #include "VPTimecodeCustomTimeStep.h" |
Syntax
UCLASS&40;Blueprintable, EditInlineNew, Meta&61;&40;DisplayName&61;"Timecode Custom Time Step"&41;&41;
class UVPTimecodeCustomTimeStep : public UFixedFrameRateCustomTimeStep
Remarks
Control the engine's time step via the engine's TimecodeProvider. Will sleep and wake up engine when the a new frame is available.
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
bool | bErrorIfFrameAreNotConsecutive | If true, stop the CustomTimeStep if the new timecode value doesn't follow the previous timecode value. |
   |
bool | bErrorIfTimecodeProviderChanged | If true, stop the CustomTimeStep if the engine's TimeProvider changed since last frame. |
   |
float | MaxDeltaTime | If the timecode doesn't change after that amount of time, stop the CustomTimeStep. |
Overridden from UFixedFrameRateCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
   |
FFrameRate | Get The fixed FrameRate |
Overridden from UEngineCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
   |
ECustomTimeStepSynchronizationState | The state of the CustomTimeStep. | |
  |
bool | Initialize
(
UEngine* InEngine |
This CustomTimeStep became the Engine's CustomTimeStep. |
  |
void | This CustomTimeStep stop being the Engine's CustomTimeStep. | |
  |
bool | UpdateTimeStep
(
UEngine* InEngine |
Update FApp::CurrentTime/FApp::DeltaTime and optionally wait until the end of the frame. |