Added a cheat to remove the D-Pad Options display

Author: Zephiles

USER_MANUAL.md

@@ -53,11 +53,12 @@ This menu allows you to modify your entire inventory, including standard items,
 14. **Levitate** allows you to levitate in the air. The button combination must be held for this code to work.
 15. **Lock Mario's HP To Max** locks Mario's current HP to the max.
 16. **Allow Running From Any Battle** allows you to run from any battle, even if the battle would normally not allow this.
-17. **Disable Pause Menu/Z Menu Sounds** disables the sound effects that play when the pause menu and the Z menu are opened/closed.
-18. **Bobbery Early** clears some values, which allows you to perform Bobbery Early more than once on a save file without the need to reload.
-19. **Force NPC Item Drop** forces any defeared enemy to drop a specified item. The item can be changed at will.
-20. **Manage Flags** allows you to manually change a lot of the important flags in the game.
-21. **Clear Area Flags** allows you to clear most of the flags for a specified area. A confirmation message is displayed when trying to do so, to prevent accidently clearing flags. The flags will be cleared on the next screen transition.
+17. **Disable D-Pad Options Display** prevents the D-Pad options display at the bottom-left of the screen from appearing. More specifically, this is the display that shows which D-Pad button opens which menu in the pause menu. These buttons can still be used, regardless of whether the display is disabled or not.
+18. **Disable Pause Menu/Z Menu Sounds** disables the sound effects that play when the pause menu and the Z menu are opened/closed.
+19. **Bobbery Early** clears some values, which allows you to perform Bobbery Early more than once on a save file without the need to reload.
+20. **Force NPC Item Drop** forces any defeared enemy to drop a specified item. The item can be changed at will.
+21. **Manage Flags** allows you to manually change a lot of the important flags in the game.
+22. **Clear Area Flags** allows you to clear most of the flags for a specified area. A confirmation message is displayed when trying to do so, to prevent accidently clearing flags. The flags will be cleared on the next screen transition.
 
 ### Stats
 This menu allows you to modify Mario's stats, all of your partner's stats, whether or not partners are enabled or not, whether a partner is out or not, and whether or not a follower is out or not.

ttyd-tools/rel/include/global.h

@@ -79,6 +79,7 @@ enum CHEATS_OPTIONS
 	LEVITATE,
 	LOCK_MARIO_HP_TO_MAX,
 	RUN_FROM_BATTLES,
+	DISABLE_DPAD_OPTIONS_DISPLAY,
 	DISABLE_MENU_SOUNDS,
 	BOBBERY_EARLY,
 	FORCE_ITEM_DROP,
@@ -632,7 +633,7 @@ struct WarpByIndexStruct
 };
 
 extern Menus Menu[27];
-extern Cheats Cheat[20];
+extern Cheats Cheat[22];
 extern bool Displays[9];
 extern char DisplayBuffer[256];
 extern char HeapBuffer[1024];

ttyd-tools/rel/source/assembly/DisableDPadOptionsDisplay.s

@@ -0,0 +1,22 @@
+.global StartDisableDPadOptionsDisplay
+.global BranchBackDisableDPadOptionsDisplay
+
+StartDisableDPadOptionsDisplay:
+stwu %sp,-0x10(%sp)
+stmw %r30,0x8(%sp)
+mr %r30,%r3
+mr %r31,%r4
+
+mr %r3,%r0 # unkVar
+bl disableDPadOptionsDisplay
+
+# Check the returned bool
+cmpwi %r3,0 # False
+
+mr %r3,%r30
+mr %r4,%r31
+lmw %r30,0x8(%sp)
+addi %sp,%sp,0x10
+
+BranchBackDisableDPadOptionsDisplay:
+b 0

ttyd-tools/rel/source/codes.cpp

@@ -69,6 +69,16 @@ int32_t forceNPCItemDrop(void *ptr)
 	return *reinterpret_cast<int32_t *>(
 		reinterpret_cast<uint32_t>(ptr) + 0x23C);
 }
+
+bool disableDPadOptionsDisplay(uint16_t unkVar)
+{
+	if (Cheat[DISABLE_DPAD_OPTIONS_DISPLAY].Active)
+	{
+		return false;
+	}
+	
+	return (unkVar & (1 << 8)); // Check the 8 bit
+}
 }
 
 void Mod::performBattleChecks()

ttyd-tools/rel/source/global.cpp

@@ -64,6 +64,7 @@ uint8_t CheatsOrder[] =
 	FORCE_ITEM_DROP,
 	CLEAR_AREA_FLAGS,
 	MANAGE_FLAGS,
+	DISABLE_DPAD_OPTIONS_DISPLAY,
 };
 
 const char *CheatsLines[] = 
@@ -85,6 +86,7 @@ const char *CheatsLines[] =
 	"Levitate",
 	"Lock Mario's HP To Its Max",
 	"Allow Running From Any Battle",
+	"Disable D-Pad Options Display",
 	"Disable Pause Menu/Z Menu Sounds",
 	"Bobbery Early",
 	"Force NPC Item Drop",
@@ -1318,7 +1320,7 @@ const char ButtonInputDisplay[] =
 #endif
 
 struct Menus Menu[27];
-struct Cheats Cheat[20];
+struct Cheats Cheat[22];
 bool Displays[9];
 char DisplayBuffer[256];
 char HeapBuffer[1024];
@@ -1599,6 +1601,7 @@ void initMenuVars()
 		Cheat[LOCK_MARIO_HP_TO_MAX].Active 					= false;
 		Cheat[RUN_FROM_BATTLES].Active 						= false;
 		Cheat[SPAWN_ITEM].Active 							= false;
+		// Cheat[DISABLE_DPAD_OPTIONS_DISPLAY].Active 		= false;
 		// Cheat[DISABLE_MENU_SOUNDS].Active 				= false;
 		// Cheat[BOBBERY_EARLY].Active 						= false;
 		Cheat[FORCE_ITEM_DROP].Active 						= false;

ttyd-tools/rel/source/main.cpp

@@ -54,6 +54,8 @@ extern "C"
 	void BranchBackPreventJumpAndHammer();
 	void StartFixRoomProblems();
 	void BranchBackFixRoomProblems();
+	void StartDisableDPadOptionsDisplay();
+	void BranchBackDisableDPadOptionsDisplay();
 }
 
 // Functions accessed by assembly overwrites
@@ -515,7 +517,7 @@ void initAddressOverwrites()
 	#ifdef TTYD_US
 	void *PreventPreBattleSoftlockAddress 		= reinterpret_cast<void *>(0x80046600);
 	void *DisableBattlesAddress 				= reinterpret_cast<void *>(0x800448CC);
-	void *AllowRunningFromBattles 				= reinterpret_cast<void *>(0x80123CA4);
+	void *AllowRunningFromBattlesAddress 		= reinterpret_cast<void *>(0x80123CA4);
 	void *ForceNPCItemDropAddress 				= reinterpret_cast<void *>(0x8004EC10);
 	void *DebugModeInitialzeAddress 			= reinterpret_cast<void *>(0x80009B2C);
 	void *DebugModeShowBuildDateAddress 		= reinterpret_cast<void *>(0x80008FE8);
@@ -535,10 +537,11 @@ void initAddressOverwrites()
 	void *BacktraceScreenEndBranchAddress 		= reinterpret_cast<void *>(0x8025E4A8);
 	void *FixRoomProblemsAddress 				= reinterpret_cast<void *>(0x800087C8);
 	void *ArtAttackHitboxesAddress 				= reinterpret_cast<void *>(0x80231938);
+	void *DisableDPadOptionsDisplayAddress 		= reinterpret_cast<void *>(0x8013D148);
 	#elif defined TTYD_JP
 	void *PreventPreBattleSoftlockAddress 		= reinterpret_cast<void *>(0x80045F5C);
 	void *DisableBattlesAddress 				= reinterpret_cast<void *>(0x80044228);
-	void *AllowRunningFromBattles 				= reinterpret_cast<void *>(0x8011E7DC);
+	void *AllowRunningFromBattlesAddress 		= reinterpret_cast<void *>(0x8011E7DC);
 	void *ForceNPCItemDropAddress 				= reinterpret_cast<void *>(0x8004DFB0);
 	void *DebugModeInitialzeAddress 			= reinterpret_cast<void *>(0x8000999C);
 	void *DebugModeShowBuildDateAddress 		= reinterpret_cast<void *>(0x80008EB8);
@@ -556,10 +559,11 @@ void initAddressOverwrites()
 	void *BacktraceScreenFontSizeAddress 		= reinterpret_cast<void *>(0x80422618);
 	void *FixRoomProblemsAddress 				= reinterpret_cast<void *>(0x800086F0);
 	void *ArtAttackHitboxesAddress 				= reinterpret_cast<void *>(0x8022C288);
+	void *DisableDPadOptionsDisplayAddress 		= reinterpret_cast<void *>(0x80137C1C);
 	#elif defined TTYD_EU
 	void *PreventPreBattleSoftlockAddress 		= reinterpret_cast<void *>(0x800466E8);
 	void *DisableBattlesAddress 				= reinterpret_cast<void *>(0x800449B4);
-	void *AllowRunningFromBattles 				= reinterpret_cast<void *>(0x80124BE4);
+	void *AllowRunningFromBattlesAddress 		= reinterpret_cast<void *>(0x80124BE4);
 	void *ForceNPCItemDropAddress 				= reinterpret_cast<void *>(0x8004ECDC);
 	void *DebugModeInitialzeAddress 			= reinterpret_cast<void *>(0x80009CF0);
 	void *DebugModeShowBuildDateAddress 		= reinterpret_cast<void *>(0x800091B4);
@@ -579,12 +583,13 @@ void initAddressOverwrites()
 	void *BacktraceScreenEndBranchAddress 		= reinterpret_cast<void *>(0x80262080);
 	void *FixRoomProblemsAddress 				= reinterpret_cast<void *>(0x80008994);
 	void *ArtAttackHitboxesAddress 				= reinterpret_cast<void *>(0x802353C8);
+	void *DisableDPadOptionsDisplayAddress 		= reinterpret_cast<void *>(0x8013EC30);
 	#endif
 
 	writeStandardBranch(DisableBattlesAddress, 
 		StartDisableBattles, BranchBackDisableBattles);
 
-	writeStandardBranch(AllowRunningFromBattles, 
+	writeStandardBranch(AllowRunningFromBattlesAddress, 
 		StartAllowRunningFromBattles, BranchBackAllowRunningFromBattles);
 
 	writeStandardBranch(ForceNPCItemDropAddress, 
@@ -614,6 +619,9 @@ void initAddressOverwrites()
 	writeStandardBranch(FixRoomProblemsAddress, 
 		StartFixRoomProblems, BranchBackFixRoomProblems);
 
+	writeStandardBranch(DisableDPadOptionsDisplayAddress, 
+		StartDisableDPadOptionsDisplay, BranchBackDisableDPadOptionsDisplay);
+	
 	patch::writeBranch(PreventPreBattleSoftlockAddress, reinterpret_cast<void *>(preventPreBattleSoftlock));
 
 	patch::writeBranch(ArtAttackHitboxesAddress, reinterpret_cast<void *>(displayArtAttackHitboxes));

ttyd-tools/rel/source/menu.cpp

@@ -575,6 +575,7 @@ void menuCheckButton()
 								}
 								case LOCK_MARIO_HP_TO_MAX:
 								case RUN_FROM_BATTLES:
+								case DISABLE_DPAD_OPTIONS_DISPLAY:
 								case DISABLE_MENU_SOUNDS:
 								case BOBBERY_EARLY:
 								{