misc: reconfigure UI toggling mechanism

data/tr2/ship/cfg/TR2X_gameflow.json5

@@ -405,6 +405,8 @@
         "OSD_SAVE_GAME_FAIL_INVALID_SLOT": "Invalid save slot %d",
         "OSD_SOUND_AVAILABLE_SAMPLES": "Available sounds: %s",
         "OSD_SOUND_PLAYING_SAMPLE": "Playing sound %d",
+        "OSD_UI_OFF": "UI disabled",
+        "OSD_UI_ON": "UI enabled",
         "OSD_UNKNOWN_COMMAND": "Unknown command: %s",
     },
 }

src/libtrx/game/ui/common.c

@@ -1,6 +1,8 @@
 #include "game/ui/common.h"
 
-#include "vector.h"
+#include "config.h"
+#include "game/console/common.h"
+#include "game/game_string.h"
 
 void UI_Init(void)
 {
@@ -12,6 +14,13 @@ void UI_Shutdown(void)
     UI_Events_Shutdown();
 }
 
+void UI_ToggleState(bool *const config_setting)
+{
+    *config_setting ^= true;
+    Config_Write();
+    Console_Log(*config_setting ? GS(OSD_UI_ON) : GS(OSD_UI_OFF));
+}
+
 void UI_HandleKeyDown(const uint32_t key)
 {
     const EVENT event = {

src/libtrx/include/libtrx/game/game_string.def

@@ -43,3 +43,5 @@ GS_DEFINE(OSD_FLIPMAP_FAIL_ALREADY_ON, "Flipmap is already ON")
 GS_DEFINE(OSD_FLIPMAP_FAIL_ALREADY_OFF, "Flipmap is already OFF")
 GS_DEFINE(OSD_AMBIGUOUS_INPUT_2, "Ambiguous input: %s and %s")
 GS_DEFINE(OSD_AMBIGUOUS_INPUT_3, "Ambiguous input: %s, %s, ...")
+GS_DEFINE(OSD_UI_ON, "UI enabled")
+GS_DEFINE(OSD_UI_OFF, "UI disabled")

src/libtrx/include/libtrx/game/ui/common.h

@@ -14,6 +14,7 @@ typedef enum {
 
 void UI_Init(void);
 void UI_Shutdown(void);
+void UI_ToggleState(bool *config_setting);
 
 void UI_HandleKeyDown(uint32_t key);
 void UI_HandleKeyUp(uint32_t key);

src/tr1/config.h

@@ -124,7 +124,8 @@ typedef struct {
     } rendering;
 
     struct {
-        bool enable_ui;
+        bool enable_game_ui;
+        bool enable_photo_mode_ui;
         double text_scale;
         double bar_scale;
         UI_STYLE menu_style;

src/tr1/config_map.def

@@ -109,4 +109,5 @@ CFG_BOOL(g_Config, profile.new_game_plus_unlock, false)
 CFG_BOOL(g_Config, fix_animated_sprites, true)
 CFG_BOOL(g_Config, enable_skybox, true)
 CFG_BOOL(g_Config, enable_ps1_crystals, true)
-CFG_BOOL(g_Config, ui.enable_ui, true)
+CFG_BOOL(g_Config, ui.enable_game_ui, true)
+CFG_BOOL(g_Config, ui.enable_photo_mode_ui, true)

src/tr1/game/game/game.c

@@ -17,6 +17,7 @@
 #include "game/stats.h"
 #include "global/vars.h"
 
+#include <libtrx/game/ui/common.h>
 #include <libtrx/log.h>
 
 #define FRAME_BUFFER(key)                                                      \
@@ -58,6 +59,10 @@ void Game_ProcessInput(void)
             FRAME_BUFFER(toggle_fps_counter);
         }
     }
+
+    if (g_InputDB.toggle_ui) {
+        UI_ToggleState(&g_Config.ui.enable_game_ui);
+    }
 }
 
 bool Game_Start(int32_t level_num, GAMEFLOW_LEVEL_TYPE level_type)

src/tr1/game/game_string.def

@@ -156,8 +156,6 @@ GS_DEFINE(OSD_PERSPECTIVE_FILTER_OFF, "Perspective filter disabled")
 GS_DEFINE(OSD_PHOTO_MODE_LAUNCHED, "Entering photo mode, press %s for help")
 GS_DEFINE(OSD_FPS_COUNTER_ON, "FPS counter enabled")
 GS_DEFINE(OSD_FPS_COUNTER_OFF, "FPS counter disabled")
-GS_DEFINE(OSD_UI_ON, "UI enabled")
-GS_DEFINE(OSD_UI_OFF, "UI disabled")
 GS_DEFINE(OSD_DOOR_OPEN, "Open Sesame!")
 GS_DEFINE(OSD_DOOR_CLOSE, "Close Sesame!")
 GS_DEFINE(OSD_DOOR_OPEN_FAIL, "No doors in Lara's proximity")

src/tr1/game/overlay.c

@@ -251,7 +251,7 @@ static void M_BarGetLocation(
 
 void Overlay_BarDraw(BAR_INFO *bar_info, RENDER_SCALE_REF scale_ref)
 {
-    if (!g_Config.ui.enable_ui) {
+    if (!g_Config.ui.enable_game_ui) {
         return;
     }
 
@@ -324,7 +324,7 @@ static float M_Ease(int32_t cur_frame, int32_t max_frames)
 
 static void M_DrawPickup3D(DISPLAY_PICKUP *pu)
 {
-    if (!g_Config.ui.enable_ui) {
+    if (!g_Config.ui.enable_game_ui) {
         return;
     }
 
@@ -490,7 +490,7 @@ static void M_DrawPickupsSprites(void)
             continue;
         }
 
-        if (!g_Config.ui.enable_ui) {
+        if (!g_Config.ui.enable_game_ui) {
             return;
         }
 
@@ -600,7 +600,7 @@ static void M_RemoveAmmoText(void)
 
 static void M_DrawAmmoInfo(void)
 {
-    if (!g_Config.ui.enable_ui) {
+    if (!g_Config.ui.enable_game_ui) {
         M_RemoveAmmoText();
         return;
     }
@@ -742,7 +742,7 @@ void Overlay_DrawGameInfo(void)
 
 void Overlay_DrawFPSInfo(void)
 {
-    if (g_Config.rendering.enable_fps_counter && g_Config.ui.enable_ui
+    if (g_Config.rendering.enable_fps_counter && g_Config.ui.enable_game_ui
         && Phase_Get() != PHASE_PHOTO_MODE) {
         const int32_t text_offset_x = 3;
         const int32_t text_height = 17;

src/tr1/game/phase/phase_inventory.c

@@ -136,7 +136,7 @@ static void Inv_Draw(RING_INFO *ring, IMOTION_INFO *motion)
     switch (inv_item->object_id) {
     case O_MEDI_OPTION:
     case O_BIGMEDI_OPTION:
-        if (g_Config.ui.enable_ui) {
+        if (g_Config.ui.enable_game_ui) {
             Overlay_BarDrawHealth();
         }
         break;

src/tr1/game/phase/phase_photo_mode.c

@@ -13,6 +13,7 @@
 
 #include <libtrx/game/console/common.h>
 #include <libtrx/game/game_string.h>
+#include <libtrx/game/ui/common.h>
 
 #include <assert.h>
 #include <stdio.h>
@@ -23,7 +24,6 @@ typedef enum {
     PS_COOLDOWN,
 } PHOTO_STATUS;
 
-static bool m_OldUIState;
 static PHASE_PHOTO_MODE_ARGS m_Args;
 
 static PHOTO_STATUS m_Status = PS_NONE;
@@ -41,15 +41,14 @@ static void M_Start(const PHASE_PHOTO_MODE_ARGS *const args)
 
     m_Status = PS_NONE;
     g_OldInputDB = g_Input;
-    m_OldUIState = g_Config.ui.enable_ui;
     Camera_EnterPhotoMode();
 
     Overlay_HideGameInfo();
     Music_Pause();
     Sound_PauseAll();
 
     m_PhotoMode = UI_PhotoMode_Create();
-    if (!g_Config.ui.enable_ui) {
+    if (!g_Config.ui.enable_photo_mode_ui) {
         Console_Log(
             GS(OSD_PHOTO_MODE_LAUNCHED),
             Input_GetKeyName(
@@ -63,11 +62,6 @@ static void M_End(void)
 
     g_Input = g_OldInputDB;
 
-    if (m_OldUIState != g_Config.ui.enable_ui) {
-        g_Config.ui.enable_ui ^= true;
-        Config_Write();
-    }
-
     m_PhotoMode->free(m_PhotoMode);
     m_PhotoMode = NULL;
 
@@ -88,6 +82,10 @@ static PHASE_CONTROL M_Control(int32_t nframes)
     Input_Update();
     Shell_ProcessInput();
 
+    if (g_InputDB.toggle_ui) {
+        UI_ToggleState(&g_Config.ui.enable_photo_mode_ui);
+    }
+
     if (g_InputDB.toggle_photo_mode || g_InputDB.option) {
         Phase_Set(m_Args.phase_to_return_to, m_Args.phase_arg);
         return (PHASE_CONTROL) { .end = false };

src/tr1/game/shell.c

@@ -338,12 +338,6 @@ void Shell_ProcessInput(void)
         Config_Write();
     }
 
-    if (g_InputDB.toggle_ui) {
-        g_Config.ui.enable_ui ^= true;
-        Console_Log(g_Config.ui.enable_ui ? GS(OSD_UI_ON) : GS(OSD_UI_OFF));
-        Config_Write();
-    }
-
     if (g_InputDB.turbo_cheat) {
         Clock_CycleTurboSpeed(!g_Input.slow);
     }

src/tr1/game/ui/widgets/photo_mode.c

@@ -60,7 +60,7 @@ static void M_Control(UI_PHOTO_MODE *const self)
         self->window->control(self->window);
     }
 
-    self->shown = g_Config.ui.enable_ui;
+    self->shown = g_Config.ui.enable_photo_mode_ui;
 }
 
 static void M_Draw(UI_PHOTO_MODE *const self)