SimulationManager::SetSpeed Method

Sets the game speed multiplier.

Syntax

void SimulationManager::SetSpeed(
    float speed
)

Parameters

float speed
The new speed multiplier.

Return value

None.

Remarks

This function has the same effect as setting the speed console variable.

All characteristics of setting the global speed apply. It is not recommended to set the speed to high factors (such as >100), which could cause the game to skip running some subsystems such as the input subsystem.

This variable does not affect simulation contexts in which debug mode is disabled. When debug mode is disabled (default), the game runs only the simulation subsystem.