unreal.GenlockedFixedRateCustomTimeStep

class unreal.GenlockedFixedRateCustomTimeStep(outer: Object | None = None, name: Name | str = 'None')

Bases: GenlockedCustomTimeStep

Control the Engine TimeStep via a fixed frame rate.

Philosophy:

  • Quantized increments but keeping up with platform time.

  • FApp::GetDeltaTime

    • Forced to a multiple of the desired FrameTime.

  • FApp::GetCurrentTime

    • Incremented in multiples of the desired FrameTime.

    • Corresponds to platform time minus any fractional FrameTime.

C++ Source:

  • Module: TimeManagement

  • File: GenlockedFixedRateCustomTimeStep.h

Editor Properties: (see get_editor_property/set_editor_property)

  • force_single_frame_delta_time (bool): [Read-Write] When true, delta time will always be 1/FrameRate, regardless of how much real time has elapsed

  • frame_rate (FrameRate): [Read-Write] Desired frame rate

  • should_block (bool): [Read-Write] Indicates that this custom time step should block to enforce the specified frame rate. Set to false if this is enforced elsewhere.

  • wait_for_both_fields (bool): [Read-Write] When using interlace video as a custom time step, enabling this option will force the engine to wait for both fields to be received before ticking.