create cheat manager

Author: Yanis002

include/cheats.inl

@@ -0,0 +1,7 @@
+// To add a new cheat define it here and add an implementation in the update function
+
+DEFINE_CHEAT(Health, "Health")
+DEFINE_CHEAT(Rupees, "Rupees")
+DEFINE_CHEAT(Arrows, "Arrows")
+DEFINE_CHEAT(Bombs, "Bombs")
+DEFINE_CHEAT(Postcards, "Postcards")

include/gz_cheats.hpp

@@ -0,0 +1,30 @@
+#pragma once
+
+#include "gz_menu.hpp"
+
+#include <types.h>
+
+#define DEFINE_CHEAT(enum, _) GZCheat_##enum,
+typedef u32 GZCheat;
+enum GZCheat_ {
+#include "cheats.inl"
+    GZCheat_Max
+};
+#undef DEFINE_CHEAT
+
+class GZCheatManager {
+  private:
+    GZMenu mMenu;
+    u32* mpCheatBitfield;
+
+  public:
+    GZMenu* GetMenu() { return &this->mMenu; }
+
+    GZCheatManager();
+    void SetCheatBitfieldPtr(u32* pBitfield);
+    bool Check(GZCheat eCheat);
+    void Toggle(GZCheat eCheat);
+    void Update();
+};
+
+extern GZCheatManager gCheatManager;

include/gz_settings.hpp

@@ -30,6 +30,7 @@ typedef struct GZProfile {
     s16 mPositionIndex;
     Vec3p mLandPosSlots[MAX_POS_SLOTS];
     Vec3p mTrainPosSlots[MAX_POS_SLOTS];
+    u32 mCheatBitfield[4]; // way more than enough
 } GZProfile;
 
 // profiles first because they might take a lot of space

resources/decomp

@@ -1,5 +1,6 @@
 #include "gz.hpp"
 #include "build.hpp"
+#include "gz_cheats.hpp"
 #include "gz_commands.hpp"
 #include "gz_settings.hpp"
 
@@ -18,4 +19,5 @@ void GZ::OnGameModeInit() {}
 void GZ::OnGameModeUpdate() {
     gCommandManager.Update();
     gSettings.Update();
+    gCheatManager.Update();
 }

src/gz.cpp

@@ -0,0 +1,84 @@
+#include "gz_cheats.hpp"
+#include "gz_settings.hpp"
+#include "mem.hpp"
+
+#include <Unknown/UnkStruct_027e0ce0.hpp>
+#include <Unknown/UnkStruct_ov024_020d86b0.hpp>
+
+static bool CheckCheat(int itemIndex) {
+    if (itemIndex < GZCheat_Max) {
+        return gCheatManager.Check(itemIndex);
+    }
+
+    return false;
+}
+
+static void ToggleCheat(u32 params) {
+    if (params < GZCheat_Max) {
+        gCheatManager.Toggle(params);
+    }
+}
+
+#define DEFINE_CHEAT(enum, name) {name, GZMenuItemType_Bool, CheckCheat, ToggleCheat, GZCheat_##enum, NULL, 0},
+static GZMenuItem sCheatMenuItems[GZCheat_Max] = {
+#include "cheats.inl"
+};
+#undef DEFINE_CHEAT
+
+GZCheatManager gCheatManager;
+
+GZCheatManager::GZCheatManager() {
+    this->mMenu.title = "Cheats";
+    this->mMenu.parent = gMenuManager.GetMainMenu();
+    this->mMenu.entries = sCheatMenuItems;
+    this->mMenu.mCount = ARRAY_LEN(sCheatMenuItems);
+    this->mMenu.needSaveFile = true;
+    gCheatManager.SetCheatBitfieldPtr(gSettings.mProfiles[gSettings.mProfileHeader.curProfileIndex].mCheatBitfield);
+}
+
+void GZCheatManager::SetCheatBitfieldPtr(u32* pBitfield) { this->mpCheatBitfield = pBitfield; }
+
+bool GZCheatManager::Check(GZCheat eCheat) {
+    return this->mpCheatBitfield != NULL ? this->mpCheatBitfield[0] & (1 << eCheat) : false;
+}
+
+void GZCheatManager::Toggle(GZCheat eCheat) {
+    u32 value = 1 << eCheat;
+
+    if (this->mpCheatBitfield == NULL) {
+        return;
+    }
+
+    if (this->mpCheatBitfield[0] & value) {
+        this->mpCheatBitfield[0] &= ~value;
+    } else {
+        this->mpCheatBitfield[0] |= value;
+    }
+}
+
+void GZCheatManager::Update() {
+    if (data_027e0ce0 != NULL && data_027e0ce0->mUnk_28 != NULL) {
+        if (this->Check(GZCheat_Health)) {
+            //! TODO: find out what updates the hearts visually
+            data_027e0ce0->mHealth = data_027e0ce0->mHealthMax;
+        }
+
+        if (this->Check(GZCheat_Rupees)) {
+            data_027e0ce0->mUnk_28->mNumRupees = 9999;
+        }
+
+        if (this->Check(GZCheat_Arrows)) {
+            data_027e0ce0->mUnk_28->mArrowAmount = data_027e0ce0->mUnk_28->func_ov000_020a8728();
+        }
+
+        if (this->Check(GZCheat_Bombs)) {
+            data_027e0ce0->mUnk_28->mBombAmount = data_027e0ce0->mUnk_28->func_ov000_020a8748();
+        }
+    }
+
+    if (data_ov024_020d86b0 != NULL) {
+        if (this->Check(GZCheat_Postcards)) {
+            data_ov024_020d86b0->mNumPostcards = 127;
+        }
+    }
+}

src/gz_cheats.cpp

@@ -1,6 +1,7 @@
 #include "gz_menu.hpp"
 #include "build.hpp"
 #include "gz.hpp"
+#include "gz_cheats.hpp"
 #include "gz_commands.hpp"
 #include "gz_settings.hpp"
 
@@ -16,6 +17,12 @@
 /*
 Layout:
 - Main Menu
+    - Cheats
+        - Health
+        - Rupees
+        - Arrows
+        - Bombs
+        - Postcards
     - Inventory
         - Whirlwind
         - Boomerang
@@ -82,6 +89,7 @@ extern GZMenu sAboutMenu;
 // -- main menu items --
 
 static GZMenuItem sMainMenuItems[] = {
+    {"Cheats", GZMenuItemType_Default, NULL, NULL, 0, gCheatManager.GetMenu(), 0},
     {"Inventory", GZMenuItemType_Default, NULL, NULL, 0, &sInventoryMenu, 0},
     {"Collection", GZMenuItemType_Default, NULL, NULL, 0, &sCollectionMenu, 0},
     {"Commands", GZMenuItemType_Default, NULL, NULL, 0, &gCommandManager.mMenu, 0},
@@ -244,6 +252,8 @@ static void PrevProfile(u32 params) {
     } else {
         gSettings.mProfileHeader.curProfileIndex = 0;
     }
+
+    gCheatManager.SetCheatBitfieldPtr(gSettings.mProfiles[gSettings.mProfileHeader.curProfileIndex].mCheatBitfield);
 }
 
 static void NextProfile(u32 params) {
@@ -252,6 +262,8 @@ static void NextProfile(u32 params) {
     if (gSettings.mProfileHeader.curProfileIndex >= ARRAY_LEN(gSettings.mProfiles)) {
         gSettings.mProfileHeader.curProfileIndex = ARRAY_LEN(gSettings.mProfiles) - 1;
     }
+
+    gCheatManager.SetCheatBitfieldPtr(gSettings.mProfiles[gSettings.mProfileHeader.curProfileIndex].mCheatBitfield);
 }
 
 static void LoadDefaultProfile(u32 params) {