Implemented Hints and Control Tutorial options

These may need further review in terms of blocking hints initiated by volumes that suggest things to the player and hints about bosses after death.

Author: hyperbx

MarathonRecomp/api/Marathon.h

@@ -25,6 +25,7 @@
 #include "Sonicteam/Camera/CameraModeManager.h"
 #include "Sonicteam/Camera/Cameraman.h"
 #include "Sonicteam/Camera/SonicCamera.h"
+#include "Sonicteam/CommonObjectHint.h"
 #include "Sonicteam/CsdLink.h"
 #include "Sonicteam/CsdManager.h"
 #include "Sonicteam/CsdObject.h"
@@ -122,6 +123,7 @@
 #include "Sonicteam/Player/Unit/ITestCase.h"
 #include "Sonicteam/Player/Weapon/SonicWeapons.h"
 #include "Sonicteam/Player/Zock.h"
+#include "Sonicteam/PropFixture.h"
 #include "Sonicteam/RaderMapManager.h"
 #include "Sonicteam/SaveDataTask.h"
 #include "Sonicteam/SaveDataTaskXENON.h"

MarathonRecomp/api/Sonicteam/CommonObjectHint.h

@@ -0,0 +1,32 @@
+#pragma once
+
+#include <Marathon.inl>
+#include <Sonicteam/PropFixture.h>
+
+namespace Sonicteam
+{
+    class CommonObjectHint : public PropFixture
+    {
+    public:
+        enum CommonObjectHintType : uint32_t
+        {
+            CommonObjectHintType_HintRing,
+            CommonObjectHintType_HintVolume
+        };
+
+        MARATHON_INSERT_PADDING(4);
+        char m_MessageName[20];
+        MARATHON_INSERT_PADDING(0x40);
+        be<CommonObjectHintType> m_Type;
+        bool m_IsFastAnim;
+        bool m_IsHitAnim;
+        MARATHON_INSERT_PADDING(2);
+        be<float> m_HitTime;
+    };
+
+    MARATHON_ASSERT_OFFSETOF(CommonObjectHint, m_MessageName, 0x184);
+    MARATHON_ASSERT_OFFSETOF(CommonObjectHint, m_Type, 0x1D8);
+    MARATHON_ASSERT_OFFSETOF(CommonObjectHint, m_IsFastAnim, 0x1DC);
+    MARATHON_ASSERT_OFFSETOF(CommonObjectHint, m_IsHitAnim, 0x1DD);
+    MARATHON_ASSERT_OFFSETOF(CommonObjectHint, m_HitTime, 0x1E0);
+}

MarathonRecomp/api/Sonicteam/GameImp.h

@@ -79,7 +79,9 @@ namespace Sonicteam
         stdx::vector<stdx::vector<boost::shared_ptr<SoX::Scenery::Camera>>> m_vvspCameras;
         MARATHON_INSERT_PADDING(0x1B4);
         xpointer<SoX::Audio::Cue> m_pBgmCue;
-        MARATHON_INSERT_PADDING(0x61C);
+        MARATHON_INSERT_PADDING(0x36C);
+        xpointer<TextBook> m_pHintTextBook;
+        MARATHON_INSERT_PADDING(0x2AC);
         SoX::RefSharedPointer<SoX::Physics::World> m_spPhysicsWorld;
         xpointer<void> m_pMyCollisionFilter;
 

MarathonRecomp/api/Sonicteam/PropFixture.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <Marathon.inl>
+#include <Sonicteam/Fixture.h>
+
+namespace Sonicteam
+{
+    class PropFixture : public Fixture
+    {
+    public:
+        MARATHON_INSERT_PADDING(4);
+    };
+}

MarathonRecomp/api/Sonicteam/SoX/Audio/Cue.h

@@ -28,7 +28,7 @@ namespace Sonicteam::SoX::Audio
 
         void SetPause(bool isPaused)
         {
-            GuestToHostFunction<int>(((Vftable*)m_pVftable.get())->fpSetPause.get(), this, isPaused);
+            GuestToHostFunction<int>(((Vftable*)m_pVftable.get())->fpSetPause, this, isPaused);
         }
     };
 }

MarathonRecomp/api/Sonicteam/SoX/MessageReceiver.h

@@ -16,6 +16,11 @@ namespace Sonicteam::SoX
 
         xpointer<Vftable> m_pVftable;
 
+        void Destroy(uint8_t flags = 1)
+        {
+            GuestToHostFunction<int>(m_pVftable->fpDestroy, this, flags);
+        }
+
         bool OnMessageReceived(IMessage* pMessage)
         {
             return GuestToHostFunction<bool>(m_pVftable->fpOnMessageReceived, this, pMessage);

MarathonRecomp/gpu/video.cpp

@@ -3273,26 +3273,26 @@ void Video::ComputeViewportDimensions()
 
     switch (Config::AspectRatio)
     {
-    case EAspectRatio::Wide:
-    {
-        if (aspectRatio > WIDE_ASPECT_RATIO)
-        {
-            s_viewportWidth = height * 16 / 9;
-            s_viewportHeight = height;
-        }
-        else
+        case EAspectRatio::Original:
         {
-            s_viewportWidth = width;
-            s_viewportHeight = width * 9 / 16;
-        }
+            if (aspectRatio > WIDE_ASPECT_RATIO)
+            {
+                s_viewportWidth = height * 16 / 9;
+                s_viewportHeight = height;
+            }
+            else
+            {
+                s_viewportWidth = width;
+                s_viewportHeight = width * 9 / 16;
+            }
 
-        break;
-    }
+            break;
+        }
 
-    default:
-        s_viewportWidth = width;
-        s_viewportHeight = height;
-        break;
+        default:
+            s_viewportWidth = width;
+            s_viewportHeight = height;
+            break;
     }
 
     AspectRatioPatches::ComputeOffsets();

MarathonRecomp/patches/misc_patches.cpp

@@ -2,6 +2,7 @@
 #include <ui/black_bar.h>
 #include <user/config.h>
 #include <user/achievement_manager.h>
+#include <app.h>
 
 // TODO (Hyper): implement achievements menu.
 void AchievementManagerUnlockMidAsmHook(PPCRegister& id)
@@ -103,9 +104,60 @@ void PedestrianAnimationLOD(PPCRegister& val)
     val.u32 = 0;
 }
 
-bool DisableHints()
+bool IsTextCardHint(Sonicteam::TextCard* pTextCard)
 {
-    return !Config::Hints;
+    return pTextCard->m_pVariables && strstr(pTextCard->m_pVariables, "picture(button_");
+}
+
+bool DisableControlTutorialHints(PPCRegister& r3)
+{
+    if (Config::ControlTutorial)
+        return false;
+
+    auto pspTextCard = (boost::shared_ptr<Sonicteam::TextCard>*)g_memory.Translate(r3.u32);
+
+    if (auto pTextCard = pspTextCard->get())
+    {
+        if (IsTextCardHint(pTextCard))
+            return true;
+    }
+
+    return false;
+}
+
+// Sonicteam::CommonObjectHint::Update
+PPC_FUNC_IMPL(__imp__sub_822CE930);
+PPC_FUNC(sub_822CE930)
+{
+    auto pCommonObjectHint = (Sonicteam::CommonObjectHint*)(base + ctx.r3.u32);
+
+    if (pCommonObjectHint->m_Type == Sonicteam::CommonObjectHint::CommonObjectHintType_HintRing)
+    {
+        if (!Config::Hints)
+        {
+            pCommonObjectHint->Destroy();
+            return;
+        }
+
+        if (!Config::ControlTutorial)
+        {
+            guest_stack_var<int> stack{};
+
+            auto pspTextCard = GuestToHostFunction<boost::shared_ptr<Sonicteam::TextCard>*>(sub_825ECB48,
+                stack.get(), App::s_pApp->GetGame()->m_pHintTextBook.get(), (const char*)&pCommonObjectHint->m_MessageName);
+
+            if (auto pTextCard = pspTextCard->get())
+            {
+                if (IsTextCardHint(pTextCard))
+                {
+                    pCommonObjectHint->Destroy();
+                    return;
+                }
+            }
+        }
+    }
+
+    __imp__sub_822CE930(ctx, base);
 }
 
 PPC_FUNC_IMPL(__imp__sub_824A6EA8);

MarathonRecomp/user/config.cpp

@@ -317,8 +317,8 @@ CONFIG_DEFINE_ENUM_TEMPLATE(EWindowState)
 
 CONFIG_DEFINE_ENUM_TEMPLATE(EAspectRatio)
 {
-    { "Auto", EAspectRatio::Auto },
-    { "16:9", EAspectRatio::Wide }
+    { "Auto",     EAspectRatio::Auto },
+    { "Original", EAspectRatio::Original }
 };
 
 CONFIG_DEFINE_ENUM_TEMPLATE(ETripleBuffering)

MarathonRecomp/user/config.h

@@ -81,7 +81,7 @@ enum class EWindowState : uint32_t
 enum class EAspectRatio : uint32_t
 {
     Auto,
-    Wide
+    Original
 };
 
 enum class ETripleBuffering : uint32_t