FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
0027 — The default real-time-factor tooltip names F4 for the simulation controls, which are on F3
ID 0027
Class DOCUMENTATION
Severity 1
Status ready
Models — (FhSimUI Prefs menu, MainMenuController)
Found 2026-09-26, implementing the HUD plan (plans/hud.md) at 2145672c
Decision needed —

Evidence

src/visual/ui/MainMenuController.cpp:273-276, the tooltip of the default real-time-factor field in the Prefs menu:

ImGui::SetTooltip("Default real-time factor for new simulations.\n"
                  "0 = Unpaced (max speed). Range: 0-100.\n"
                  "Current simulation speed is controlled in the\n"
                  "simulation overlay (F4).");

The simulation controls, where the running speed is set, toggle on F3: src/visual/ui/FhCameraControllerSDL.cpp:229-230 ("Toggle simulation controls with F3", SDLK_F3), and the "Sim Controls" menu item gives "F3" as its shortcut (MainMenuController.cpp:333). F4 toggles the inspector (FhCameraControllerSDL.cpp:241-242), and doc/user/running-simulations/visualization.md lists F3 as Sim Controls and F4 as the Inspector.

Effect

A viewer who follows the tooltip and presses F4 opens the inspector instead of the controls that set the simulation speed.

Possible fix

Change "(F4)" to "(F3)" in that string (and "simulation overlay" to "simulation controls", the name the menu uses). The same slip in the "Overlay Text" tooltip was fixed in 2145672c, because that text was being rewritten by the HUD work anyway; this one was left because the HUD plan does not touch it.

Test that would prove it

None automated; the tooltip is ImGui text. Inspection against the key handler above.

Risk

None; a display string.