Deku Butler animation fix

mm/2s2h/BenGui/BenMenu.cpp

@@ -1384,6 +1384,11 @@ void BenMenu::AddEnhancements() {
         .Options(CheckboxOptions().Tooltip(
             "Fixes a bug that results in the wrong audio playing upon receiving a 4th piece of heart to "
             "fill a new heart container."));
+    AddWidget(path, "Fix Deku Butler Shock Animation", WIDGET_CVAR_CHECKBOX)
+        .CVar("gEnhancements.Fixes.DekuButlerFixShockLoopAnimation")
+        .Options(CheckboxOptions().Tooltip(
+            "Fixes a bug where the Deku Butler loops the incorrect animation in the cutscene that plays after "
+            "freeing the Deku Princess."));
 
     // Restorations
     path = { "Enhancements", "Restorations", SECTION_COLUMN_1 };

mm/2s2h/Enhancements/Fixes/FixDekuButlerShockLoopAnimation.cpp

@@ -0,0 +1,17 @@
+#include <libultraship/bridge/consolevariablebridge.h>
+#include "2s2h/GameInteractor/GameInteractor.h"
+#include "2s2h/ShipInit.hpp"
+
+extern "C" {
+#include "variables.h"
+#include "functions.h"
+}
+
+#define CVAR_NAME "gEnhancements.Fixes.DekuButlerFixShockLoopAnimation"
+#define CVAR CVarGetInteger(CVAR_NAME, 0)
+
+void RegisterDekuButlerFixShockLoopAnimation() {
+    COND_VB_SHOULD(VB_DEKU_BUTLER_FIX_SHOCK_ANIM, CVAR, { *should = false; });
+}
+
+static RegisterShipInitFunc initFunc(RegisterDekuButlerFixShockLoopAnimation, { CVAR_NAME });

mm/2s2h/GameInteractor/GameInteractor.h

@@ -218,6 +218,7 @@ typedef enum {
     VB_FISH2_SPAWN_HEART_PIECE,
     VB_PLAY_DEFEAT_CAPTAIN_SEQUENCE,
     VB_CLAMP_ANIMATION_SPEED,
+    VB_DEKU_BUTLER_FIX_SHOCK_ANIM,
     VB_LINK_DIVE_OVER_WATER,
     VB_GIBDO_TRADE_SEQUENCE_SUFFICIENT_QUANTITY_PRESENTED,
     VB_GIBDO_TRADE_SEQUENCE_ACCEPT_RED_POTION,

mm/src/overlays/actors/ovl_En_Dno/z_en_dno.c

@@ -11,6 +11,7 @@
 #include "z_en_dno.h"
 #include "overlays/actors/ovl_Bg_Crace_Movebg/z_bg_crace_movebg.h"
 #include "objects/gameplay_keep/gameplay_keep.h"
+#include "2s2h/GameInteractor/GameInteractor.h"
 
 #define FLAGS                                                                                  \
     (ACTOR_FLAG_ATTENTION_ENABLED | ACTOR_FLAG_FRIENDLY | ACTOR_FLAG_UPDATE_CULLING_DISABLED | \
@@ -961,6 +962,11 @@ void func_80A73408(EnDno* this, PlayState* play) {
                     break;
 
                 case 2:
+                    if (!GameInteractor_Should(VB_DEKU_BUTLER_FIX_SHOCK_ANIM, true)) {
+                        if (this->animIndex == EN_DNO_ANIM_SHOCK_LOOP) {
+                            changeAnim = false;
+                        }
+                    }
                     nextAnimIndex = EN_DNO_ANIM_SHOCK_START;
                     break;