Added an error display for when npcNameToPtr fails to find a correct NPC

Author: Zephiles

ttyd-tools/rel/include/draw.h

@@ -123,6 +123,7 @@ void drawActionCommandsTiming();
 void drawSettingsCurrentWork();
 
 void drawHeapArrayErrors();
+void drawNpcNameToPtrError();
 void drawTitleScreenInfo();
 void drawFileSelectScreenInfo();
 

ttyd-tools/rel/include/global.h

@@ -809,6 +809,12 @@ struct ErrorHandlerStrings
 	char InstructionAndAddress[128];
 };
 
+struct NpcNameToPtrErrorStruct
+{
+	uint32_t Timer;
+	char Buffer[32];
+};
+
 extern MenuVars MenuVar;
 extern Menus Menu[30];
 extern Cheats Cheat[24];
@@ -840,6 +846,7 @@ extern MemoryCardStruct MenuSettings;
 extern WarpByEventStruct WarpByEvent;
 extern WarpByIndexStruct WarpByIndex;
 extern MenuPrevMenuAndOption PrevMenuAndOption;
+extern NpcNameToPtrErrorStruct NpcNameToPtrError;
 
 extern uint8_t CheatsOrder[];
 extern uint16_t StatsMarioIcons[];

ttyd-tools/rel/include/mod.h

@@ -33,6 +33,7 @@ class Mod
 	void drawArtAttackHitboxes(ttyd::dispdrv::CameraId);
 	int32_t displayActionCommandsTimingHook(void *, ttyd::battle_unit::AttackParams *);
 	void errorHandler(uint16_t, gc::OSContext::OSContext *, uint32_t, uint32_t);
+	ttyd::npcdrv::NpcEntry *npcNameToPtr_New(const char *);
 
 private:
 	void (*mPFN_marioStMain_trampoline)() = nullptr;
@@ -57,6 +58,8 @@ class Mod
 
 	void (*mPFN_systemErrorHandler_trampoline)(uint16_t, 
 		gc::OSContext::OSContext *, uint32_t, uint32_t) = nullptr;
+	
+	ttyd::npcdrv::NpcEntry *(*mPFN_npcNameToPtr_New_trampoline)(const char *) = nullptr;
 };
 
 }

ttyd-tools/rel/source/draw.cpp

@@ -4474,7 +4474,7 @@ void drawHeapArrayErrors()
 	uint32_t TextColor 		= 0xFFFFFFFF;
 	uint8_t Alpha 			= 0xFF;
 	int32_t PosX 			= -232;
-	int32_t PosY 			= 120;
+	int32_t PosY 			= 100;
 	float Scale 			= 0.6;
 
 	// Draw the text
@@ -4485,6 +4485,25 @@ void drawHeapArrayErrors()
 	clearMemory(tempHeapBuffer, sizeof(HeapBuffer));
 }
 
+void drawNpcNameToPtrError()
+{
+	uint32_t TextColor 		= 0xFFFFFFFF;
+	uint8_t Alpha 			= 0xFF;
+	int32_t PosX 			= -232;
+	int32_t PosY 			= 120;
+	float Scale 			= 0.6;
+	
+	// Draw the text
+	char *tempBuffer = NpcNameToPtrError.Buffer;
+	drawText(tempBuffer, PosX, PosY, Alpha, TextColor, Scale);
+	
+	// Clear the buffer if the timer is at 0
+	if (NpcNameToPtrError.Timer == 0)
+	{
+		clearMemory(tempBuffer, sizeof(NpcNameToPtrError.Buffer));
+	}
+}
+
 void drawTitleScreenInfo()
 {
 	// Draw the window for the text

ttyd-tools/rel/source/global.cpp

@@ -1851,6 +1851,7 @@ struct MemoryCardStruct MenuSettings;
 struct WarpByEventStruct WarpByEvent;
 struct WarpByIndexStruct WarpByIndex;
 struct MenuPrevMenuAndOption PrevMenuAndOption;
+struct NpcNameToPtrErrorStruct NpcNameToPtrError;
 
 void initMenuVars()
 {

ttyd-tools/rel/source/main.cpp

@@ -476,18 +476,18 @@ bool Mod::performRelPatches(gc::OSModule::OSModuleInfo *newModule, void *bss)
 	}
 }
 
-void addTextToHeapArray(char *text)
+void addTextToHeapBuffer(char *text)
 {
 	char *tempHeapBuffer = HeapBuffer;
 
 	// Make sure adding the new text will not result in an overflow
 	uint32_t NewTextSize = strlen(text);
-	uint32_t CurrentHeapSize = strlen(tempHeapBuffer);
+	uint32_t CurrentHeapBufferSize = strlen(tempHeapBuffer);
 
-	uint32_t NewHeapSize = CurrentHeapSize + NewTextSize + 1;
-	uint32_t MaxHeapSize = sizeof(HeapBuffer);
+	uint32_t NewHeapBufferSize = CurrentHeapBufferSize + NewTextSize + 1;
+	uint32_t MaxHeapBufferSize = sizeof(HeapBuffer);
 
-	if (NewHeapSize > MaxHeapSize)
+	if (NewHeapBufferSize > MaxHeapBufferSize)
 	{
 		// Adding the new text will result in an overflow, so don't add it
 		return;
@@ -582,7 +582,7 @@ void checkHeaps()
 				currentChunk);
 
 			// Add the text to the heap buffer
-			addTextToHeapArray(tempDisplayBuffer);
+			addTextToHeapBuffer(tempDisplayBuffer);
 		}
 
 		// Check the free entries
@@ -595,7 +595,7 @@ void checkHeaps()
 				currentChunk);
 
 			// Add the text to the heap buffer
-			addTextToHeapArray(tempDisplayBuffer);
+			addTextToHeapBuffer(tempDisplayBuffer);
 		}
 	}
 
@@ -611,7 +611,7 @@ void checkHeaps()
 			currentChunk);
 
 		// Add the text to the heap buffer
-		addTextToHeapArray(tempDisplayBuffer);
+		addTextToHeapBuffer(tempDisplayBuffer);
 	}
 
 	// Check the free entries
@@ -623,7 +623,7 @@ void checkHeaps()
 			currentChunk);
 
 		// Add the text to the heap buffer
-		addTextToHeapArray(tempDisplayBuffer);
+		addTextToHeapBuffer(tempDisplayBuffer);
 	}
 
 	// Draw any errors that occured
@@ -633,6 +633,55 @@ void checkHeaps()
 	}
 }
 
+ttyd::npcdrv::NpcEntry *Mod::npcNameToPtr_New(const char *name)
+{
+	// Get the work pointer
+	ttyd::npcdrv::NpcWork *NpcWorkPointer = ttyd::npcdrv::npcGetWorkPtr();
+	
+	// Loop through the NPCs to find the correct one
+	ttyd::npcdrv::NpcEntry *NPC = nullptr;
+	uint32_t MaxNpcCount = NpcWorkPointer->npcMaxCount;
+	
+	for (uint32_t i = 0; i < MaxNpcCount; i++)
+	{
+		NPC = &NpcWorkPointer->entries[i];
+		if (NPC->flags & (1 << 0)) // Check if 0 bit is active
+		{
+			if (compareStrings(NPC->wUnkAnimation, name))
+			{
+				return NPC;
+			}
+		}
+	}
+	
+	// Didn't find the correct NPC, so return the last one and print error text
+	// Only print the error text if currently not printing any previous error text
+	if (NpcNameToPtrError.Timer == 0)
+	{
+		const char *Text = "npcNameToPtr error occured";
+		strcpy(NpcNameToPtrError.Buffer, Text);
+		NpcNameToPtrError.Timer = secondsToFrames(5);
+	}
+	
+	return NPC;
+}
+
+void displayNpcNameToPtrError()
+{
+	uint32_t Timer = NpcNameToPtrError.Timer;
+	if (Timer > 0)
+	{
+		Timer--;
+		NpcNameToPtrError.Timer = Timer;
+	}
+	
+	// Call the drawing function regardless of the current time, as the drawing function is what clears the buffer
+	if (NpcNameToPtrError.Buffer[0] != '\0')
+	{
+		drawFunctionOnDebugLayerWithOrder(drawNpcNameToPtrError, 100.f);
+	}
+}
+
 void initAddressOverwrites()
 {
 	#ifdef TTYD_US
@@ -818,6 +867,7 @@ void Mod::run()
 			displayMarioSpeedXZ();
 			displayStickAngle();
 			displayMemoryWatches();
+			displayNpcNameToPtrError();
 		}
 
 		// Only run button-based displays if currently not changing button combos

ttyd-tools/rel/source/mod.cpp

@@ -139,7 +139,13 @@ void Mod::init()
 		StartErrorHandlerEnableFPU();
 		gMod->errorHandler(error, context, dsisr, dar);
 	});
-
+	
+	mPFN_npcNameToPtr_New_trampoline = patch::hookFunction(
+		ttyd::npcdrv::npcNameToPtr, [](const char *name)
+	{
+		return gMod->npcNameToPtr_New(name);
+	});
+	
 	// Initialize typesettings early
 	// Only run if an ACE loader was not used
 	uint32_t LoaderValue = *reinterpret_cast<uint32_t *>(0x80004148);