tr2/flares: fix flare effects in shallow water

This ensures we test water height at a flare's exact positions rather
than using Lara's general room number, so to determine if bubbles
should spawn and how to play sound effects.

Resolves #1590.

docs/tr2/CHANGELOG.md

@@ -12,6 +12,8 @@
 - fixed software renderer not applying underwater tint (#2066, regression from 0.7)
 - fixed some enemies not looking at Lara (#2080, regression from 0.6)
 - fixed the camera getting stuck at the start of Home Sweet Home (#2129, regression from 0.7)
+- fixed bubbles spawning from flares if Lara is in shallow water (#1590)
+- fixed flare sound effects not always playing when Lara is in shallow water (#1590)
 
 ## [0.7.1](https://github.com/LostArtefacts/TRX/compare/tr2-0.7...tr2-0.7.1) - 2024-12-17
 - fixed a crash when selecting the sound option (#2057, regression from 0.6)

docs/tr2/README.md

@@ -101,6 +101,7 @@ game with new enhancements and features.
 - fixed Lara's underwater hue being retained when re-entering a boat
 - fixed distant rooms sometimes not appearing, causing the skybox to be visible when it shouldn't
 - fixed rendering problems on certain Intel GPUs
+- fixed bubbles spawning from flares if Lara is in shallow water
 - improved FMV mode behavior - stopped switching screen resolutions
 - improved vertex movement when looking through water portals
 - improved support for non-4:3 aspect ratios
@@ -110,6 +111,7 @@ game with new enhancements and features.
 - fixed the audio not being in sync when Lara strikes the gong in Ice Palace
 - fixed sound settings resuming the music
 - fixed wrong default music volume (being very loud on some setups)
+- fixed flare sound effects not always playing when Lara is in shallow water
 
 #### Mods
 - added developer console (accessible with `/`, see [COMMANDS.md](COMMANDS.md) for details)

src/tr2/decomp/flares.c

@@ -23,6 +23,9 @@
 #define FLARE_YOUNG_AGE (FRAMES_PER_SECOND) // = 30
 
 static bool M_CanThrowFlare(void);
+static void M_DoIgniteEffects(XYZ_32 flare_pos, int16_t room_num);
+static void M_DoBurnEffects(
+    XYZ_32 sound_pos, XYZ_32 flare_pos, int16_t room_num);
 
 static bool M_CanThrowFlare(void)
 {
@@ -37,6 +40,29 @@ static bool M_CanThrowFlare(void)
         || g_LaraItem->current_anim_state == LS_FAST_DIVE;
 }
 
+static void M_DoIgniteEffects(const XYZ_32 flare_pos, int16_t room_num)
+{
+    Room_GetSector(flare_pos.x, flare_pos.y, flare_pos.z, &room_num);
+    const ROOM *const room = Room_Get(room_num);
+    const SOUND_PLAY_MODE mode =
+        (room->flags & RF_UNDERWATER) != 0 ? SPM_UNDERWATER : SPM_NORMAL;
+    Sound_Effect(SFX_LARA_FLARE_IGNITE, &flare_pos, mode);
+}
+
+static void M_DoBurnEffects(
+    const XYZ_32 sound_pos, const XYZ_32 flare_pos, int16_t room_num)
+{
+    Room_GetSector(flare_pos.x, flare_pos.y, flare_pos.z, &room_num);
+    if ((Room_Get(room_num)->flags & RF_UNDERWATER) != 0) {
+        Sound_Effect(SFX_LARA_FLARE_BURN, &sound_pos, SPM_UNDERWATER);
+        if (Random_GetDraw() < 0x4000) {
+            Spawn_Bubble(&flare_pos, room_num);
+        }
+    } else {
+        Sound_Effect(SFX_LARA_FLARE_BURN, &sound_pos, SPM_NORMAL);
+    }
+}
+
 int32_t Flare_DoLight(const XYZ_32 *const pos, const int32_t flare_age)
 {
     if (flare_age >= MAX_FLARE_AGE) {
@@ -80,18 +106,15 @@ void Flare_DoInHand(const int32_t flare_age)
     };
     Lara_GetJointAbsPosition(&vec, LM_HAND_L);
 
+    if (flare_age == 0) {
+        M_DoIgniteEffects(vec, g_LaraItem->room_num);
+    }
+
     g_Lara.left_arm.flash_gun = Flare_DoLight(&vec, flare_age);
 
     if (g_Lara.flare_age < MAX_FLARE_AGE) {
         g_Lara.flare_age++;
-        if (g_Rooms[g_LaraItem->room_num].flags & RF_UNDERWATER) {
-            Sound_Effect(SFX_LARA_FLARE_BURN, &g_LaraItem->pos, SPM_UNDERWATER);
-            if (Random_GetDraw() < 0x4000) {
-                Spawn_Bubble(&vec, g_LaraItem->room_num);
-            }
-        } else {
-            Sound_Effect(SFX_LARA_FLARE_BURN, &g_LaraItem->pos, SPM_NORMAL);
-        }
+        M_DoBurnEffects(g_LaraItem->pos, vec, g_LaraItem->room_num);
     } else if (M_CanThrowFlare()) {
         g_Lara.gun_status = LGS_UNDRAW;
     }
@@ -227,13 +250,6 @@ void Flare_Draw(void)
         }
     } else if (frame_num >= LF_FL_IGNITE && frame_num <= LF_FL_2_HOLD - 2) {
         if (frame_num == LF_FL_IGNITE) {
-            if ((g_Rooms[g_LaraItem->room_num].flags & RF_UNDERWATER) != 0) {
-                Sound_Effect(
-                    SFX_LARA_FLARE_IGNITE, &g_LaraItem->pos, SPM_UNDERWATER);
-            } else {
-                Sound_Effect(
-                    SFX_LARA_FLARE_IGNITE, &g_LaraItem->pos, SPM_NORMAL);
-            }
             g_Lara.flare_age = 0;
         }
         Flare_DoInHand(g_Lara.flare_age);
@@ -427,14 +443,7 @@ void Flare_Control(const int16_t item_num)
 
     if (Flare_DoLight(&item->pos, flare_age)) {
         flare_age |= 0x8000u;
-        if ((g_Rooms[item->room_num].flags & RF_UNDERWATER)) {
-            Sound_Effect(SFX_LARA_FLARE_BURN, &item->pos, SPM_UNDERWATER);
-            if (Random_GetDraw() < 0x4000) {
-                Spawn_Bubble(&item->pos, item->room_num);
-            }
-        } else {
-            Sound_Effect(SFX_LARA_FLARE_BURN, &item->pos, SPM_NORMAL);
-        }
+        M_DoBurnEffects(item->pos, item->pos, item->room_num);
     }
 
     item->data = (void *)flare_age;