Added a display for Mario's XZ speed

Author: Zephiles

USER_MANUAL.md

@@ -83,17 +83,18 @@ This menu allows you to change the HP, Max HP, FP, Max FP, held items, and statu
 ### Displays
 1. **On-Screen Timer** displays a timer at the bottom-right of the screen. This timer is set to run at the current FPS, and therefore will count from 0 to 59 (0 to 49 for EU at 50hz) before reaching one second.
 2. **Mario's Coordinates** displays Mario's coordinates at the bottom-left of the screen. If the On-Screen Timer is active, then the position of Mario's Coordinates will be shifted upwards.
-3. **Jump Storage** displays a value that determines whether you have Jump Storage or not. The value will be 0 when you don't have it, and 1 when you have it. While this display is active, you can press Y three times in succession to manually give yourself Jump Storage.
-4. **Button Input Display** displays which buttons are pressed at the bottom-left of the screen. When this display is active, the other displays that are placed at the bottom-left of the screen are shifted upwards.
-5. **Stick Angle** displays the current angle held with the left stick. The four main directions are 0 for up, 90 for right, 180 for down, and 270 for left. If no angle is held, then it will simply print **Neutral**.
-6. **Guard/Superguard Timings** displays the following:
+3. **Mario's Speed XZ** displays Mario's speed, based on both the X axis and the Z axis.
+4. **Jump Storage** displays a value that determines whether you have Jump Storage or not. The value will be 0 when you don't have it, and 1 when you have it. While this display is active, you can press Y three times in succession to manually give yourself Jump Storage.
+5. **Button Input Display** displays which buttons are pressed at the bottom-left of the screen. When this display is active, the other displays that are placed at the bottom-left of the screen are shifted upwards.
+6. **Stick Angle** displays the current angle held with the left stick. The four main directions are 0 for up, 90 for right, 180 for down, and 270 for left. If no angle is held, then it will simply print **Neutral**.
+7. **Guard/Superguard Timings** displays the following:
    * The frame that you guarded/superguarded an attack out of the total amount of possible frames.
    * How many frames early you pressed A or B. It should be noted that nothing will be displayed if the button was pressed very early (more than 6 or so frames for guards, and more than 12 or so frames for superguards).
    * Whether you pressed too many buttons in a short period of time for the guard/superguard to be accepted.
    * Whether the attack can be superguarded or not (will only be displayed if you tried to superguard it).
-7. **Art Attack Hitboxes** displays boxes around enemies in battles when using Art Attack.
-8. **Yoshi Skip** displays various information about performing this skip. The main timer (labeled YST) is set to reset and start running once you leave a battle, and pauses once you press A. You can also manually reset this timer by holding Y for two seconds.
-9. **Palace Skip** displays various information about performing this skip. The main timer (labeled PST) is set to reset and start once you leave the pause menu, and pauses once you press X. You can also manually reset this timer by holding Y for two seconds. **PhaEmy** keeps track of the Y coordinate for the phantom ember, **ItemTimer** keeps track of the timer for the current item in the field, and **ParY** keeps track of your partner's Y coordinate.
+8. **Art Attack Hitboxes** displays boxes around enemies in battles when using Art Attack.
+9. **Yoshi Skip** displays various information about performing this skip. The main timer (labeled YST) is set to reset and start running once you leave a battle, and pauses once you press A. You can also manually reset this timer by holding Y for two seconds.
+10. **Palace Skip** displays various information about performing this skip. The main timer (labeled PST) is set to reset and start once you leave the pause menu, and pauses once you press X. You can also manually reset this timer by holding Y for two seconds. **PhaEmy** keeps track of the Y coordinate for the phantom ember, **ItemTimer** keeps track of the timer for the current item in the field, and **ParY** keeps track of your partner's Y coordinate.
 
 ### Warps
 This menu allows you to warp to various places around the game. The menu allows you to either choose a map from a list, or to choose a map and entrance manually. When choosing from the list, a description for each option is displayed when the cursor is over one.

ttyd-tools/rel/include/codes.h

@@ -24,6 +24,7 @@ void getStickAngleString(char *stringOut);
 void displaySequenceInPauseMenu();
 void displayOnScreenTimer();
 void displayMarioCoordinatesBoolCheck();
+void displayMarioSpeedXZ();
 void displayJumpStorageDetails();
 void displayButtonInputs();
 void displayStickAngle();

ttyd-tools/rel/include/draw.h

@@ -106,6 +106,7 @@ void drawOnScreenTimerButtonCombos();
 void drawOnScreenTimer();
 void drawSequenceInPauseMenu();
 void drawMarioCoordinates();
+void drawMarioSpeedXZ();
 void drawJumpStorageDetails();
 void drawButtonInputs();
 void drawStickAngle();

ttyd-tools/rel/include/global.h

@@ -319,6 +319,7 @@ enum DISPLAYS_OPTIONS
 {
 	ONSCREEN_TIMER = 0,
 	MARIO_COORDINATES,
+	MARIO_SPEED_XZ,
 	JUMP_STORAGE,
 	BUTTON_INPUT_DISPLAY,
 	STICK_ANGLE,
@@ -634,7 +635,7 @@ struct WarpByIndexStruct
 
 extern Menus Menu[27];
 extern Cheats Cheat[22];
-extern bool Displays[9];
+extern bool Displays[10];
 extern char DisplayBuffer[256];
 extern char HeapBuffer[1024];
 extern MemoryWatchStruct MemoryWatch[60];

ttyd-tools/rel/source/codes.cpp

@@ -846,6 +846,16 @@ void displayMarioCoordinatesBoolCheck()
 	drawFunctionOnDebugLayer(drawMarioCoordinates);
 }
 
+void displayMarioSpeedXZ()
+{
+	if (!Displays[MARIO_SPEED_XZ])
+	{
+		return;
+	}
+	
+	drawFunctionOnDebugLayer(drawMarioSpeedXZ);
+}
+
 void displayJumpStorageDetails()
 {
 	if (!Displays[JUMP_STORAGE])
@@ -898,12 +908,6 @@ void displayStickAngle()
 		return;
 	}
 
-	// Don't display if the Guard/Superguard timings display is active
-	if (DisplayActionCommands.DisplayTimer > 0)
-	{
-		return;
-	}
-	
 	drawFunctionOnDebugLayer(drawStickAngle);
 }
 
@@ -940,12 +944,6 @@ void displayYoshiSkipDetails()
 		return;
 	}
 
-	// Don't display if the Guard/Superguard timings display is active
-	if (DisplayActionCommands.DisplayTimer > 0)
-	{
-		return;
-	}
-	
 	if (checkForSpecificSeq(ttyd::seqdrv::SeqIndex::kBattle)) // In battle
 	{
 		// Pause in battle
@@ -1000,12 +998,6 @@ void displayPalaceSkipDetails()
 		return;
 	}
 
-	// Don't display if the Guard/Superguard timings display is active
-	if (DisplayActionCommands.DisplayTimer > 0)
-	{
-		return;
-	}
-	
 	uint32_t SystemLevel = getSystemLevel();
 	if (SystemLevel == 15)
 	{

ttyd-tools/rel/source/draw.cpp

@@ -3335,7 +3335,6 @@ void drawOnScreenTimer()
 			Displays[PALACE_SKIP] || 
 			Displays[YOSHI_SKIP])
 		{
-			
 			PosY += 20;
 		}
 	}
@@ -3378,6 +3377,38 @@ void drawMarioCoordinates()
 	drawText(tempDisplayBuffer, PosX, PosY, Alpha, TextColor, Scale);
 }
 
+void drawMarioSpeedXZ()
+{
+	uint32_t TextColor 		= 0xFFFFFFFF;
+	uint8_t Alpha 			= 0xFF;
+	int32_t PosX 			= -232;
+	int32_t PosY 			= -162;
+	float Scale 			= 0.75;
+	
+	// Move the text up if the input display is active
+	if (Displays[BUTTON_INPUT_DISPLAY])
+	{
+		PosY += 20;
+	}
+	
+	// Move the text up if the Mario coordinates display is active
+	if (Displays[MARIO_COORDINATES] || 
+		Displays[PALACE_SKIP] || 
+		Displays[YOSHI_SKIP])
+	{
+		PosY += 20;
+	}
+	
+	ttyd::mario::Player *player = ttyd::mario::marioGetPtr();
+	char *tempDisplayBuffer = DisplayBuffer;
+	
+	sprintf(tempDisplayBuffer,
+		"MarSpeedXZ: %.6f",
+		player->wPlayerEffectiveSpeed);
+	
+	drawText(tempDisplayBuffer, PosX, PosY, Alpha, TextColor, Scale);
+}
+
 void drawJumpStorageDetails()
 {
 	uint32_t TextColor 	= 0xFFFFFFFF;
@@ -3451,6 +3482,12 @@ void drawStickAngle()
 		PosY += 20;
 	}
 
+	// Move the text up if the Mario Speed XZ display is active
+	if (Displays[MARIO_SPEED_XZ])
+	{
+		PosY += 20;
+	}
+	
 	// Move the text up if Mario's Coordinates are displayed, or if the Palace Skip display is active
 	if (Displays[MARIO_COORDINATES] || Displays[PALACE_SKIP])
 	{
@@ -3513,6 +3550,12 @@ void drawYoshiSkipDetails()
 		PosY += 20;
 	}
 
+	// Move the text up if the Mario Speed XZ display is active
+	if (Displays[MARIO_SPEED_XZ])
+	{
+		PosY += 20;
+	}
+	
 	// Draw the text
 	char StickAngleString[12];
 	getStickAngleString(StickAngleString);
@@ -3657,6 +3700,12 @@ void drawPalaceSkipDetails()
 		PosY += 20;
 	}
 
+	// Move the text up if the Mario Speed XZ display is active
+	if (Displays[MARIO_SPEED_XZ])
+	{
+		PosY += 20;
+	}
+	
 	// Draw the text
 	char *tempDisplayBuffer = DisplayBuffer;
 	sprintf(tempDisplayBuffer,

ttyd-tools/rel/source/global.cpp

@@ -6,7 +6,7 @@
 
 namespace mod {
 
-const char *VersionNumber = "v3.0.26";
+const char *VersionNumber = "v3.0.27";
 
 const char *RootLines[] = 
 {
@@ -1166,13 +1166,15 @@ uint8_t DisplaysOrder[] =
 	YOSHI_SKIP,
 	PALACE_SKIP,
 	STICK_ANGLE,
+	MARIO_SPEED_XZ,
 };
 
 const char *DisplaysLines[] = 
 {
 	"Return",
 	"On-Screen Timer",
 	"Mario's Coordinates",
+	"Mario's Speed XZ",
 	"Jump Storage",
 	"Button Input Display",
 	"Stick Angle",
@@ -1321,7 +1323,7 @@ const char ButtonInputDisplay[] =
 
 struct Menus Menu[27];
 struct Cheats Cheat[22];
-bool Displays[9];
+bool Displays[10];
 char DisplayBuffer[256];
 char HeapBuffer[1024];
 struct MemoryWatchStruct MemoryWatch[60];

ttyd-tools/rel/source/main.cpp

@@ -735,23 +735,35 @@ void Mod::run()
 	// Run if currently repositioning watches
 	if (!MenuIsDisplayed || HideMenu)
 	{
+		// Don't display some displays if the Guard/Superguard timings display is active
+		if (DisplayActionCommands.DisplayTimer == 0)
+		{
+			// Only run button-based codes if currently not changing button combos
+			if (!tempChangingCheatButtonCombo)
+			{
+				displayYoshiSkipDetails();
+				displayPalaceSkipDetails();
+			}
+			
+			// Run each display function that isn't button-based
+			displayMarioCoordinatesBoolCheck();
+			displayMarioSpeedXZ();
+			displayStickAngle();
+			displayMemoryWatches();
+		}
+		
 		// Only run button-based codes if currently not changing button combos
 		if (!tempChangingCheatButtonCombo)
 		{
 			displayOnScreenTimer();
 			displayJumpStorageDetails();
 			displayButtonInputs();
-			displayYoshiSkipDetails();
-			displayPalaceSkipDetails();
 		}
 
 		// Run each display function that isn't button-based
 		spawnItem(); // Needs to always run due to the adjustable value menu sometimes being displayed
 		displaySequenceInPauseMenu();
-		displayMarioCoordinatesBoolCheck();
 		displayActionCommandsTiming();
-		displayStickAngle();
-		displayMemoryWatches();
 
 		// Perform any necessaery REL patches
 		performRELPatches();