Added the ability to pause the Art Attack timer

Author: Zephiles

USER_MANUAL.md

@@ -99,3 +99,4 @@ This menu allows you to warp to various places around the game. A description fo
 There are several other changes that have been made outside of the menu:
 1. The current Sequence value is displayed in the pause menu next to Mario's stats.
 2. The unused Mega badges can be used in battles without the need for a boot/hammer upgrade.
+3. Holding Y while using Art Attack will pause the timer that is used to check how long you are able to use it for.

ttyd-tools/rel/include/mod.h

@@ -18,6 +18,7 @@ class Mod
 	bool performPreBattleActions();
 	int32_t preventMenuSounds(int32_t, uint32_t, uint32_t, uint32_t);
 	const char *getCustomMessage(const char *);
+	uint32_t pauseArtAttackTimer();
 
 private:
 	void (*mPFN_makeKey_trampoline)() = nullptr;
@@ -28,6 +29,7 @@ class Mod
 	int32_t (*mPFN_SoundEfxPlayEx_trampoline)(int32_t, uint32_t, 
 		uint32_t, uint32_t) = nullptr;
 	const char *(*mPFN_msgSearch_trampoline)(const char *) = nullptr;
+	uint32_t (*mPFN_scissor_timer_main_trampoline)() = nullptr;
 };
 
 }

ttyd-tools/rel/include/ttyd.eu.lst

@@ -1406,6 +1406,35 @@
 // 801AB220:marioResetCamShiftRate
 // 801AB284:marioResetCamShift
 
+// sac_scissor.o
+// 80234D0C:wait_star_standby
+// 80234D44:star_stone_appear
+// 80234D70:scissor_end
+// 80234DE0:scissor_init
+// 80234E54:scissor_disp_region
+// 80235154:scissor_offscreen
+// 80235194:scissor_disp_control
+// 802353CC:scissor_capture
+// 80235434:scissor_ofscreen_ok
+// 80235498:scissor_damage_sub2
+// 802355B4:scissor_damage_sub
+// 8023581C:scissor_damage
+// 80235AA8:scissor_control
+80235EC4:scissor_timer_main
+// 8023602C:scissor_timer_get
+// 80236088:star_disp2D_sub
+// 80236230:star_disp2D
+// 802362A0:star_control
+// 8023673C:weaponGetPower_Scissor
+// 802367C8:tess
+// 80236A14:scissor_tess
+// 80236A84:scissor_cross
+// 80236EB0:scissor_intersection4
+// 80236F50:scissor_intersection3
+// 80236FEC:scissor_intersection2
+// 8023706C:scissor_intersection
+802376C4:GetScissorPtr
+
 // runtime.c
 8026849C:_savefpr_14
 802684A0:_savefpr_15

ttyd-tools/rel/include/ttyd.jp.lst

@@ -1398,6 +1398,35 @@
 // 801A3578:marioResetCamShiftRate
 // 801A35DC:marioResetCamShift
 
+// sac_scissor.o
+// 8022BBCC:wait_star_standby
+// 8022BC04:star_stone_appear
+// 8022BC30:scissor_end
+// 8022BCA0:scissor_init
+// 8022BD14:scissor_disp_region
+// 8022C014:scissor_offscreen
+// 8022C054:scissor_disp_control
+// 8022C28C:scissor_capture
+// 8022C2F4:scissor_ofscreen_ok
+// 8022C358:scissor_damage_sub2
+// 8022C474:scissor_damage_sub
+// 8022C6DC:scissor_damage
+// 8022C968:scissor_control
+8022CD84:scissor_timer_main
+// 8022CEEC:scissor_timer_get
+// 8022CF48:star_disp2D_sub
+// 8022D0F0:star_disp2D
+// 8022D160:star_control
+// 8022D5FC:weaponGetPower_Scissor
+// 8022D688:tess
+// 8022D8D4:scissor_tess
+// 8022D944:scissor_cross
+// 8022DD70:scissor_intersection4
+// 8022DE10:scissor_intersection3
+// 8022DEAC:scissor_intersection2
+// 8022DF2C:scissor_intersection
+8022E584:GetScissorPtr
+
 // runtime.c
 8025E90C:_savefpr_14
 8025E910:_savefpr_15

ttyd-tools/rel/include/ttyd.us.lst

@@ -1404,6 +1404,35 @@
 // 801A9544:marioResetCamShiftRate
 // 801A95A8:marioResetCamShift
 
+// sac_scissor.o
+// 8023127C:wait_star_standby
+// 802312B4:star_stone_appear
+// 802312E0:scissor_end
+// 80231350:scissor_init
+// 802313C4:scissor_disp_region
+// 802316C4:scissor_offscreen
+// 80231704:scissor_disp_control
+// 8023193C:scissor_capture
+// 802319A4:scissor_ofscreen_ok
+// 80231A08:scissor_damage_sub2
+// 80231B24:scissor_damage_sub
+// 80231D8C:scissor_damage
+// 80232018:scissor_control
+80232434:scissor_timer_main
+// 8023259C:scissor_timer_get
+// 802325F8:star_disp2D_sub
+// 802327A0:star_disp2D
+// 80232810:star_control
+// 80232CAC:weaponGetPower_Scissor
+// 80232D38:tess
+// 80232F84:scissor_tess
+// 80232FF4:scissor_cross
+// 80233420:scissor_intersection4
+// 802334C0:scissor_intersection3
+// 8023355C:scissor_intersection2
+// 802335DC:scissor_intersection
+80233C34:GetScissorPtr
+
 // runtime.c
 802648BC:_savefpr_14
 802648C0:_savefpr_15

ttyd-tools/rel/include/ttyd/sac_scissor.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <cstdint>
+
+namespace ttyd::sac_scissor {
+
+extern "C" {
+
+// wait_star_standby
+// star_stone_appear
+// scissor_end
+// scissor_init
+// scissor_disp_region
+// scissor_offscreen
+// scissor_disp_control
+// scissor_capture
+// scissor_ofscreen_ok
+// scissor_damage_sub2
+// scissor_damage_sub
+// scissor_damage
+// scissor_control
+uint32_t scissor_timer_main();
+// scissor_timer_get
+// star_disp2D_sub
+// star_disp2D
+// star_control
+// weaponGetPower_Scissor
+// tess
+// scissor_tess
+// scissor_cross
+// scissor_intersection4
+// scissor_intersection3
+// scissor_intersection2
+// scissor_intersection
+void *GetScissorPtr();
+
+}
+
+}

ttyd-tools/rel/source/main.cpp

@@ -12,6 +12,7 @@
 #include <ttyd/evt_sub.h>
 #include <ttyd/mario_pouch.h>
 #include <ttyd/OSCache.h>
+#include <ttyd/sac_scissor.h>
 
 #include <cstdio>
 
@@ -372,6 +373,27 @@ const char *Mod::getCustomMessage(const char *msgKey)
 	return mPFN_msgSearch_trampoline(msgKey);
 }
 
+uint32_t Mod::pauseArtAttackTimer()
+{
+	// Prevent the function from running if Y is being held
+	if (checkButtonComboEveryFrame(PAD_Y))
+	{
+		// Make sure the timer is not at 59 or lower, as pausing it then will cause issues
+		void *ArtAttackPointer = ttyd::sac_scissor::GetScissorPtr();
+		
+		int32_t ArtAttackTimer = *reinterpret_cast<int32_t *>(
+			reinterpret_cast<uint32_t>(ArtAttackPointer) + 0x104);
+		
+		if (ArtAttackTimer > 59)
+		{
+			return 0;
+		}
+	}
+	
+	// Call original function
+	return mPFN_scissor_timer_main_trampoline();
+}
+
 void writeStandardBranch(void *address, void functionStart(), void functionBranchBack())
 {
 	void *tempFunctionStart 		= reinterpret_cast<void *>(functionStart);

ttyd-tools/rel/source/mod.cpp

@@ -10,6 +10,7 @@
 #include <ttyd/seq_battle.h>
 #include <ttyd/sound.h>
 #include <ttyd/msgdrv.h>
+#include <ttyd/sac_scissor.h>
 #include <ttyd/fontmgr.h>
 #include <ttyd/windowdrv.h>
 #include <ttyd/seq_logo.h>
@@ -79,6 +80,12 @@ void Mod::init()
 	{
 		return gMod->getCustomMessage(msgKey);
 	});
+	
+	mPFN_scissor_timer_main_trampoline = patch::hookFunction(
+		ttyd::sac_scissor::scissor_timer_main, []()
+	{
+		return gMod->pauseArtAttackTimer();
+	});
 
 	// Initialize typesetting early
 	ttyd::fontmgr::fontmgrTexSetup();