[Enhancement] Toggle grave hole geometry (#5754)

* Add enhancement to toggle grave hole geometry

* Replace malloc and vector with fixed-size arrays

* Make newSurfaceTypes static

2 files changed, 76 insertions, 0 deletions

diff --git a/soh/soh/Enhancements/Restorations/GraveHoleJumps.cpp b/soh/soh/Enhancements/Restorations/GraveHoleJumps.cpp
new file mode 100644
index 000000000..32157b5ce
--- /dev/null
+++ b/soh/soh/Enhancements/Restorations/GraveHoleJumps.cpp
@@ -0,0 +1,72 @@
+#include "public/bridge/consolevariablebridge.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
+#include "soh/ShipInit.hpp"
+#include "functions.h"
+#include "soh/Enhancements/enhancementTypes.h"
+#include "soh/resource/type/Scene.h"
+#include "soh/resource/type/scenecommand/SceneCommand.h"
+#include "soh/resource/type/scenecommand/SetCollisionHeader.h"
+
+#define CVAR_GRAVE_HOLE_NAME CVAR_ENHANCEMENT("GraveHoles")
+#define GRAVE_HOLES_DEFAULT 0
+#define CVAR_GRAVE_HOLE_VALUE CVarGetInteger(CVAR_GRAVE_HOLE_NAME, GRAVE_HOLES_DEFAULT)
+#define GRAVEYARD_SCENE_FILEPATH "scenes/shared/spot02_scene/spot02_scene"
+#define CUSTOM_SURFACE_TYPE 32
+
+const static std::array<std::pair<std::pair<u16, u16>, std::pair<u16, u16>>, 6> graveyardGeometryPatches = { {
+    // { { startPolygon, endPolygon }, { originalSurfaceType, patchedSurfaceType } }
+    { { 487, 509 }, { 20, CUSTOM_SURFACE_TYPE } }, // Floor around graves
+    { { 651, 658 }, { 20, CUSTOM_SURFACE_TYPE } }, // Floor around Royal Family Tomb
+    { { 613, 620 }, { 0, 15 } },                   // Grave ledges (Hylian Shield)
+    { { 623, 630 }, { 0, 15 } },                   // Grave ledges (Redead)
+    { { 633, 640 }, { 0, 15 } },                   // Grave ledges (Dampe)
+    { { 643, 650 }, { 0, 15 } },                   // Grave ledges (Royal Family)
+} };
+
+CollisionHeader* getGraveyardCollisionHeader() {
+    /*
+     * Load the graveyard collision header manually. Since its position varies between versions, we cannot directly use
+     * dspot02_sceneCollisionHeader_003C54. We have to scroll through the scene cmds to get the header the same way the
+     * game does.
+     */
+    SOH::Scene* scene =
+        (SOH::Scene*)Ship::Context::GetInstance()->GetResourceManager()->LoadResource(GRAVEYARD_SCENE_FILEPATH).get();
+    SOH::ISceneCommand* sceneCmd = nullptr;
+    for (int i = 0; i < scene->commands.size(); i++) {
+        auto cmd = scene->commands[i];
+        if (cmd->cmdId == SOH::SceneCommandID::SetCollisionHeader) {
+            sceneCmd = cmd.get();
+            break;
+        }
+    }
+    CollisionHeader* graveyardColHeader = (CollisionHeader*)((SOH::SetCollisionHeader*)sceneCmd)->GetRawPointer();
+
+    /*
+     * Copy the surface type list and give ourselves some extra space to create another surface type for Link to fall
+     * into graves. NTSC 1.0's graveyard has 31 surface types, while later versions have 32. The contents of the lists
+     * are shifted somewhat between versions, so to be safe we just create an extra slot that is not in any version.
+     */
+    static SurfaceType newSurfaceTypes[33];
+    memcpy(newSurfaceTypes, graveyardColHeader->surfaceTypeList, sizeof(SurfaceType) * 33);
+    newSurfaceTypes[CUSTOM_SURFACE_TYPE].data[0] = 0x24000004;
+    newSurfaceTypes[CUSTOM_SURFACE_TYPE].data[1] = 0xFC8;
+    graveyardColHeader->surfaceTypeList = newSurfaceTypes;
+
+    return graveyardColHeader;
+}
+
+void ApplyGraveyardGeometryPatches() {
+    static CollisionHeader* graveyardColHeader = getGraveyardCollisionHeader();
+    for (auto& mappingPatch : graveyardGeometryPatches) {
+        for (int i = mappingPatch.first.first; i <= mappingPatch.first.second; i++) {
+            CollisionPoly* poly = &graveyardColHeader->polyList[i];
+            poly->type = CVAR_GRAVE_HOLE_VALUE ? mappingPatch.second.first : mappingPatch.second.second;
+        }
+    }
+}
+
+void RegisterGraveHoleJumps() {
+    ApplyGraveyardGeometryPatches();
+}
+
+static RegisterShipInitFunc initFunc_GraveHoleJumps(RegisterGraveHoleJumps, { CVAR_GRAVE_HOLE_NAME });
diff --git a/soh/soh/SohGui/SohMenuEnhancements.cpp b/soh/soh/SohGui/SohMenuEnhancements.cpp
index 2a40cb23c..f7b571118 100644
--- a/soh/soh/SohGui/SohMenuEnhancements.cpp
+++ b/soh/soh/SohGui/SohMenuEnhancements.cpp
@@ -1165,6 +1165,10 @@ void SohMenu::AddMenuEnhancements() {
         .CVar(CVAR_ENHANCEMENT("NGCKaleidoSwitcher"))
         .Options(CheckboxOptions().Tooltip(
             "Makes L and R switch pages like on the GameCube. Z opens the Debug Menu instead."));
+    AddWidget(path, "Grave Hole Jumps", WIDGET_CVAR_CHECKBOX)
+        .CVar(CVAR_ENHANCEMENT("GraveHoles"))
+        .Options(CheckboxOptions().Tooltip(
+            "Restores NTSC 1.0 behavior where Link jumps over grave holes and grabs the ledges."));
 
     // Difficulty Options
     path.sidebarName = "Difficulty";