Initial research

* Fix Windmill Isle Act 1 (Night) chip 'hint' not being shown

* code style adjustments

* Fix Apotos entrance gate first time Chip hint appearing with hints disabled

---------

Co-authored-by: Hyper <34012267+hyperbx@users.noreply.github.com>

UnleashedRecomp/api/Hedgehog/MirageCore/MatrixNode/hhMatrixNodeListener.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <SWA.inl>
+
+namespace Hedgehog::Mirage
+{
+    class CMatrixNodeListener : public Base::CObject
+    {
+    public:
+        SWA_INSERT_PADDING(0x04);
+    };
+}

UnleashedRecomp/api/SWA.h

@@ -31,6 +31,7 @@
 #include "Hedgehog/Math/Quaternion.h"
 #include "Hedgehog/Math/Vector.h"
 #include "Hedgehog/MirageCore/MatrixNode/hhMatrixNode.h"
+#include "Hedgehog/MirageCore/MatrixNode/hhMatrixNodeListener.h"
 #include "Hedgehog/MirageCore/Misc/hhTransform.h"
 #include "Hedgehog/MirageCore/Misc/hhVertexDeclarationPtr.h"
 #include "Hedgehog/MirageCore/RenderData/hhMaterialData.h"
@@ -86,10 +87,12 @@
 #include "SWA/Inspire/InspireTextureAnimationInfo.h"
 #include "SWA/Inspire/InspireTextureOverlay.h"
 #include "SWA/Inspire/InspireTextureOverlayInfo.h"
+#include "SWA/Message/MsgRequestHelp.h"
 #include "SWA/Menu/MenuWindowBase.h"
 #include "SWA/Movie/MovieDisplayer.h"
 #include "SWA/Movie/MovieManager.h"
 #include "SWA/Object/Common/DashPanel/ObjDashPanel.h"
+#include "SWA/Object/Event/Hint/ObjHintRing.h"
 #include "SWA/Object/SonicStage/EU/RollingBarrel/ObjRollingBarrel.h"
 #include "SWA/Player/Character/EvilSonic/EvilSonic.h"
 #include "SWA/Player/Character/EvilSonic/EvilSonicContext.h"

UnleashedRecomp/api/SWA/Message/MsgRequestHelp.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <SWA.inl>
+
+namespace SWA::Message
+{
+    class MsgRequestHelp
+    {
+    public:
+        SWA_INSERT_PADDING(0x1C);
+        Hedgehog::Base::CSharedString m_Name;
+    };
+}

UnleashedRecomp/api/SWA/Object/Event/Hint/ObjHintRing.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#include <SWA.inl>
+
+namespace SWA
+{
+    class CObjHintRing
+    {
+    public:
+        SWA_INSERT_PADDING(0x160);
+        be<uint32_t> m_AnimationID;
+        bool m_Field164;
+    };
+}

UnleashedRecomp/patches/misc_patches.cpp

@@ -13,6 +13,38 @@ bool DisableHintsMidAsmHook()
     return !Config::Hints;
 }
 
+// Disable hint ring visuals.
+PPC_FUNC_IMPL(__imp__sub_82738088);
+PPC_FUNC(sub_82738088)
+{
+    auto pObjHintRing = (SWA::CObjHintRing*)(base + ctx.r3.u32);
+    auto pDeltaTime = (be<float>*)(base + ctx.r4.u32);
+
+    if (!Config::Hints)
+    {
+        auto pAnimationControl = PPC_LOAD_U32(ctx.r3.u32 + 0xF0);
+
+        // how does this even work
+        guest_stack_var<be<float>> time = 0.0f;
+        GuestToHostFunction<int>(sub_82BB4A40, pAnimationControl, time.get());
+        GuestToHostFunction<int>(sub_82BBC050, pAnimationControl, *pDeltaTime);
+
+        return;
+    }
+
+    __imp__sub_82738088(ctx, base);
+}
+
+// Disable hint ring hit event.
+PPC_FUNC_IMPL(__imp__sub_827391E0);
+PPC_FUNC(sub_827391E0)
+{
+    if (!Config::Hints)
+        return;
+
+    __imp__sub_827391E0(ctx, base);
+}
+
 // Disable Perfect Dark Gaia hints.
 PPC_FUNC_IMPL(__imp__sub_82AC36E0);
 PPC_FUNC(sub_82AC36E0)
@@ -24,9 +56,14 @@ PPC_FUNC(sub_82AC36E0)
     __imp__sub_82AC36E0(ctx, base);
 }
 
-bool DisableControlTutorialMidAsmHook()
+// Disable navigation volumes.
+PPC_FUNC_IMPL(__imp__sub_8273C4C8);
+PPC_FUNC(sub_8273C4C8)
 {
-    return !Config::ControlTutorial;
+    if (!Config::ControlTutorial)
+        return;
+
+    __imp__sub_8273C4C8(ctx, base);
 }
 
 bool DisableEvilControlTutorialMidAsmHook(PPCRegister& r4, PPCRegister& r5)
@@ -108,3 +145,42 @@ PPC_FUNC(sub_82586698)
 
     __imp__sub_82586698(ctx, base);
 }
+
+// SWA::CObjHint::MsgNotifyObjectEvent::Impl
+// Disable only certain hints from hint volumes.
+// This hook should be used to allow hint volumes specifically to also prevent them from affecting the player.
+PPC_FUNC_IMPL(__imp__sub_82736E80);
+PPC_FUNC(sub_82736E80)
+{
+    // GroupID parameter text
+    auto* groupId = (const char*)(base + PPC_LOAD_U32(ctx.r3.u32 + 0x100));
+    
+    if (!Config::Hints)
+    {
+        // WhiteIsland_ACT1_001 (Windmill Isle Act 1 Night, Start)
+        // Your friend went off that way, Sonic. Quick, let's go after him!
+        if (strcmp(groupId, "WhiteIsland_ACT1_001") != 0)
+            return;
+    }
+
+    __imp__sub_82736E80(ctx, base);
+}
+
+// SWA::CHelpWindow::MsgRequestHelp::Impl
+// Disable only certain hints from other sequences.
+// This hook should be used to block hint messages from unknown sources.
+PPC_FUNC_IMPL(__imp__sub_824C1E60);
+PPC_FUNC(sub_824C1E60)
+{
+    auto pMsgRequestHelp = (SWA::Message::MsgRequestHelp*)(base + ctx.r4.u32);
+
+    if (!Config::Hints)
+    {
+        // s10d_mykETF_c_navi (Town Mykonos Entrance, First Entry)
+        // Looks like we can get to a bunch of places in the village from here!
+        if (strcmp(pMsgRequestHelp->m_Name.c_str(), "s10d_mykETF_c_navi") == 0)
+            return;
+    }
+
+    __imp__sub_824C1E60(ctx, base);
+}

UnleashedRecomp/ui/options_menu.cpp

@@ -859,16 +859,19 @@ static void DrawConfigOption(int32_t rowIndex, float yOffset, ConfigDef<T>* conf
 
                 if (g_canReset && padState.IsTapped(SWA::eKeyState_X))
                 {
-                    config->MakeDefault();
+                    if (!config->IsDefaultValue())
+                    {
+                        config->MakeDefault();
 
-                    VideoConfigValueChangedCallback(config);
-                    XAudioConfigValueChangedCallback(config);
+                        VideoConfigValueChangedCallback(config);
+                        XAudioConfigValueChangedCallback(config);
 
-                    if (config->Callback)
-                        config->Callback(config);
+                        if (config->Callback)
+                            config->Callback(config);
 
-                    if (config->ApplyCallback)
-                        config->ApplyCallback(config);
+                        if (config->ApplyCallback)
+                            config->ApplyCallback(config);
+                    }
 
                     Game_PlaySound("sys_worldmap_decide");
                 }
@@ -1203,7 +1206,6 @@ static void DrawConfigOptions()
 
     int32_t rowCount = 0;
 
-    bool isStage = OptionsMenu::s_pauseMenuType == SWA::eMenuType_Stage || OptionsMenu::s_pauseMenuType == SWA::eMenuType_Hub;
     auto cmnReason = &Localise("Options_Desc_NotAvailable");
 
     // TODO: Don't use raw numbers here!
@@ -1213,8 +1215,8 @@ static void DrawConfigOptions()
             DrawConfigOption(rowCount++, yOffset, &Config::Language, !OptionsMenu::s_isPause, cmnReason);
             DrawConfigOption(rowCount++, yOffset, &Config::VoiceLanguage, OptionsMenu::s_pauseMenuType == SWA::eMenuType_WorldMap, cmnReason);
             DrawConfigOption(rowCount++, yOffset, &Config::Subtitles, true);
-            DrawConfigOption(rowCount++, yOffset, &Config::Hints, !isStage, cmnReason);
-            DrawConfigOption(rowCount++, yOffset, &Config::ControlTutorial, !isStage, cmnReason);
+            DrawConfigOption(rowCount++, yOffset, &Config::Hints, true);
+            DrawConfigOption(rowCount++, yOffset, &Config::ControlTutorial, true);
             DrawConfigOption(rowCount++, yOffset, &Config::AchievementNotifications, true);
             DrawConfigOption(rowCount++, yOffset, &Config::TimeOfDayTransition, !Config::UseArrowsForTimeOfDayTransition);
             break;

UnleashedRecompLib/CMakeLists.txt

@@ -26,8 +26,11 @@ foreach(i RANGE 0 260)
 endforeach()
 
 add_custom_command(
-    OUTPUT ${UNLEASHED_RECOMP_PPC_RECOMPILED_SOURCES}
-    COMMAND $<TARGET_FILE:XenonRecomp>
+    OUTPUT 
+        "${CMAKE_CURRENT_SOURCE_DIR}/private/default_patched.xex"
+        ${UNLEASHED_RECOMP_PPC_RECOMPILED_SOURCES}
+    COMMAND 
+        $<TARGET_FILE:XenonRecomp>
     DEPENDS 
         "${CMAKE_CURRENT_SOURCE_DIR}/private/default.xex"
         "${CMAKE_CURRENT_SOURCE_DIR}/private/default.xexp"
@@ -49,9 +52,15 @@ file(GLOB XENOS_RECOMP_SOURCES
 )
 
 add_custom_command(
-    OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/shader/shader_cache.cpp"
-    COMMAND $<TARGET_FILE:XenosRecomp>
-    DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/private/shader.ar" ${XENOS_RECOMP_SOURCES} ${XENOS_RECOMP_INCLUDE}
+    OUTPUT 
+        "${CMAKE_CURRENT_SOURCE_DIR}/shader/shader_cache.cpp"
+    COMMAND
+        $<TARGET_FILE:XenosRecomp>
+    DEPENDS 
+        "${CMAKE_CURRENT_SOURCE_DIR}/private/default_patched.xex"
+        "${CMAKE_CURRENT_SOURCE_DIR}/private/shader.ar" 
+        ${XENOS_RECOMP_SOURCES} 
+        ${XENOS_RECOMP_INCLUDE}
 )
 
 add_library(UnleashedRecompLib 

UnleashedRecompLib/config/SWA.toml

@@ -106,17 +106,11 @@ jump_address = 0x82468EE0
 name = "ResetScoreOnRestartMidAsmHook"
 address = 0x82304374
 
-# Disable hint volumes
+# Disable Tornado Defense hints
 [[midasm_hook]]
 name = "DisableHintsMidAsmHook"
-address = 0x827A2504
-jump_address_on_true = 0x827A251C
-
-# Disable hint rings
-[[midasm_hook]]
-name = "DisableHintsMidAsmHook"
-address = 0x827A2E34
-jump_address_on_true = 0x827A2E4C
+address = 0x82AF52BC
+jump_address_on_true = 0x82AF52E4
 
 # Disable Egg Dragoon hint "V_WHG_083" ("That lit-up part on the bottom looks fishy. I'll try aiming for that.")
 [[midasm_hook]]
@@ -184,12 +178,6 @@ name = "DisableHintsMidAsmHook"
 address = 0x82691CB0
 jump_address_on_true = 0x82691E24
 
-# Disable navigation volumes
-[[midasm_hook]]
-name = "DisableControlTutorialMidAsmHook"
-address = 0x827AA5EC
-jump_address_on_true = 0x827AA604
-
 # Disable Werehog button prompts
 [[midasm_hook]]
 name = "DisableEvilControlTutorialMidAsmHook"