cmd: fix /kill sometimes freezing the game

Resolves #2297. The previous implementation was too frugal in its size which led to an infinite loop bug when an item was deemed unkillable.
LostArtefacts · Jan 14, 2025 · 057a213 · 057a213
1 parent 944642e
commit 057a213
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 18 deletions.
diff --git a/docs/tr2/CHANGELOG.md b/docs/tr2/CHANGELOG.md
@@ -23,6 +23,7 @@
 - fixed item counter always hidden in NG+, even for keys (#2223, regression from 0.3)
 - fixed the passport object not being selected when exiting to title (#2192, regression from 0.8)
 - fixed the upside-down camera fix to no longer limit Lara's vision (#2276, regression from 0.8)
+- fixed /kill command freezing the game under rare circumstances (#2297, regression from 0.3)
 
 ## [0.8](https://github.com/LostArtefacts/TRX/compare/tr2-0.8...tr2-0.8) - 2025-01-01
 - completed decompilation efforts – TR2X.dll is gone, Tomb2.exe no longer needed (#1694)

diff --git a/src/libtrx/game/console/cmd/kill.c b/src/libtrx/game/console/cmd/kill.c
@@ -15,6 +15,8 @@
 #include "strings.h"
 
 static bool M_CanTargetObjectCreature(GAME_OBJECT_ID object_id);
+static bool M_KillSingleEnemyInRange(int32_t max_dist);
+static int32_t M_KillAllEnemiesInRange(int32_t max_dist);
 static COMMAND_RESULT M_KillAllEnemies(void);
 static COMMAND_RESULT M_KillNearestEnemies(void);
 static COMMAND_RESULT M_KillEnemyType(const char *enemy_name);
@@ -27,6 +29,50 @@ static bool M_CanTargetObjectCreature(const GAME_OBJECT_ID object_id)
         && Object_GetObject(object_id)->loaded;
 }
 
+static bool M_KillSingleEnemyInRange(const int32_t max_dist)
+{
+    const ITEM *const lara_item = Lara_GetItem();
+    int32_t best_dist = -1;
+    int16_t best_item_num = NO_ITEM;
+    for (int16_t item_num = 0; item_num < Item_GetTotalCount(); item_num++) {
+        const ITEM *const item = Item_Get(item_num);
+        if (Creature_IsEnemy(item)) {
+            const int32_t dist = Item_GetDistance(item, &lara_item->pos);
+            if (dist <= max_dist) {
+                if (best_item_num == NO_ITEM || dist < best_dist) {
+                    best_dist = dist;
+                    best_item_num = item_num;
+                }
+            }
+        }
+    }
+    if (best_item_num != NO_ITEM) {
+        if (Lara_Cheat_KillEnemy(best_item_num)) {
+            return true;
+        }
+    }
+    return false;
+}
+
+static int32_t M_KillAllEnemiesInRange(const int32_t max_dist)
+{
+    int32_t kill_count = 0;
+    const ITEM *const lara_item = Lara_GetItem();
+    for (int16_t item_num = 0; item_num < Item_GetTotalCount(); item_num++) {
+        const ITEM *const item = Item_Get(item_num);
+        if (Creature_IsEnemy(item)) {
+            const int32_t dist = Item_GetDistance(item, &lara_item->pos);
+            if (dist <= max_dist) {
+                // Kill this enemy
+                if (Lara_Cheat_KillEnemy(item_num)) {
+                    kill_count++;
+                }
+            }
+        }
+    }
+    return kill_count;
+}
+
 static COMMAND_RESULT M_KillAllEnemies(void)
 {
     int32_t num_killed = 0;
@@ -51,29 +97,21 @@ static COMMAND_RESULT M_KillAllEnemies(void)
 
 static COMMAND_RESULT M_KillNearestEnemies(void)
 {
-    bool found = false;
-    while (true) {
-        const int16_t best_item_num = Lara_GetNearestEnemy();
-        if (best_item_num == NO_ITEM) {
-            break;
-        }
-
-        const ITEM *const lara_item = Lara_GetItem();
-        const ITEM *const item = Item_Get(best_item_num);
-        const int32_t distance = Item_GetDistance(item, &lara_item->pos);
-        found |= Lara_Cheat_KillEnemy(best_item_num);
-        if (distance >= WALL_L) {
-            break;
-        }
+    const ITEM *const lara_item = Lara_GetItem();
+    int32_t kill_count = M_KillAllEnemiesInRange(WALL_L);
+    if (kill_count == 0) {
+        kill_count = M_KillSingleEnemyInRange(5 * WALL_L);
     }
 
-    if (!found) {
+    if (kill_count == 0) {
+        // No enemies killed
         Console_Log(GS(OSD_KILL_FAIL));
         return CR_FAILURE;
+    } else {
+        // At least one enemy was killed.
+        Console_Log(GS(OSD_KILL));
+        return CR_SUCCESS;
     }
-
-    Console_Log(GS(OSD_KILL));
-    return CR_SUCCESS;
 }
 
 static COMMAND_RESULT M_KillEnemyType(const char *const enemy_name)