Class TimeSettings

Time and game simulation settings container.

Assembly: FlaxEngine.dll
File: Engine/Core/Config/TimeSettings.h
Syntax
public class TimeSettings : public SettingsBase

Fields

DrawFPS

The target amount of the frames rendered per second (actual game FPS).

Declaration
public float DrawFPS = 60.0f
Field Value
float

MaxUpdateDeltaTime

The maximum allowed delta time (in seconds) for the game logic update step.

Declaration
public float MaxUpdateDeltaTime = 0.1f
Field Value
float

PhysicsFPS

The target amount of the physics simulation updates per second (also fixed updates frequency).

Declaration
public float PhysicsFPS = 60.0f
Field Value
float

TimeScale

The game time scale factor. Default is 1.

Declaration
public float TimeScale = 1.0f
Field Value
float

UpdateFPS

The target amount of the game logic updates per second (script updates frequency).

Declaration
public float UpdateFPS = 60.0f
Field Value
float

Methods

Apply()

Applies the settings to the target system.

Declaration
public virtual void Apply() override
Overrides

Get()

Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.

Declaration
public static TimeSettings* Get()
Returns
TimeSettings