fix(draw): Recover tread debris effects for W3DTankTruckDraw (TheSuperHackers#2251)

Tread debris can be enabled in W3DTankTruckDraw INI modules by setting

TreadDebrisLeft=TrackDebrisDirtLeft
TreadDebrisRight=TrackDebrisDirtRight

Author: xezon

Core/GameEngineDevice/Include/W3DDevice/GameClient/Module/W3DTankTruckDraw.h

@@ -38,6 +38,8 @@
 #include "WW3D2/rendobj.h"
 #include "WW3D2/part_emt.h"
 
+//-------------------------------------------------------------------------------------------------
+// TheSuperHackers @fix xezon 01/02/2026 The Tread Effects are now usable in W3DTankTruckDraw.
 //-------------------------------------------------------------------------------------------------
 class W3DTankTruckDrawModuleData : public W3DModelDrawModuleData
 {
@@ -139,6 +141,9 @@ class W3DTankTruckDraw : public W3DModelDraw
 
 	RenderObjClass *m_prevRenderObj;
 
+	void createTreadEmitters( void ); ///< Create particle effects for treads.
+	void tossTreadEmitters( void ); ///< Destroy particle effects for treads.
+
 	void createWheelEmitters( void ); ///< Create particle effects for wheels.
 	void tossWheelEmitters( void ); ///< Destroy particle effects for wheels.
 	void enableWheelEmitters( Bool enable ); ///< Start or stop creating effects from the wheels.

Core/GameEngineDevice/Source/W3DDevice/GameClient/Drawable/Draw/W3DTankDraw.cpp

@@ -51,14 +51,20 @@
 
 class Matrix3D;
 
+// TheSuperHackers @info Is enabled by default and therefore compatible with the Retail INI setups.
+#define SHOW_DEFAULT_TANK_DEBRIS (1)
+
 //-------------------------------------------------------------------------------------------------
-W3DTankDrawModuleData::W3DTankDrawModuleData() :
-	m_treadDebrisNameLeft("TrackDebrisDirtLeft"),
-	m_treadDebrisNameRight("TrackDebrisDirtRight"),
-	m_treadAnimationRate(0.0f),
-	m_treadPivotSpeedFraction(0.6f),
-	m_treadDriveSpeedFraction(0.3f)
+W3DTankDrawModuleData::W3DTankDrawModuleData()
+	: m_treadAnimationRate(0.0f)
+	, m_treadPivotSpeedFraction(0.6f)
+	, m_treadDriveSpeedFraction(0.3f)
 {
+	if constexpr (SHOW_DEFAULT_TANK_DEBRIS)
+	{
+		m_treadDebrisNameLeft = "TrackDebrisDirtLeft"; // TheSuperHackers @todo Remove data particle names from code
+		m_treadDebrisNameRight = "TrackDebrisDirtRight";
+	}
 }
 
 //-------------------------------------------------------------------------------------------------

Core/GameEngineDevice/Source/W3DDevice/GameClient/Drawable/Draw/W3DTankTruckDraw.cpp

@@ -47,15 +47,20 @@
 #include "W3DDevice/GameClient/Module/W3DTankTruckDraw.h"
 #include "WW3D2/matinfo.h"
 
-//#define SHOW_TANK_DEBRIS
+// TheSuperHackers @info Is disabled by default and therefore compatible with the Retail INI setups.
+#define SHOW_DEFAULT_TANK_DEBRIS (0)
+
 //-------------------------------------------------------------------------------------------------
-W3DTankTruckDrawModuleData::W3DTankTruckDrawModuleData():
-	m_treadDebrisNameLeft("TrackDebrisDirtLeft"),
-	m_treadDebrisNameRight("TrackDebrisDirtRight"),
-	m_treadAnimationRate(0.0f),
-	m_treadPivotSpeedFraction(0.6f),
-	m_treadDriveSpeedFraction(0.3f)
+W3DTankTruckDrawModuleData::W3DTankTruckDrawModuleData()
+	: m_treadAnimationRate(0.0f)
+	, m_treadPivotSpeedFraction(0.6f)
+	, m_treadDriveSpeedFraction(0.3f)
 {
+	if constexpr (SHOW_DEFAULT_TANK_DEBRIS)
+	{
+		m_treadDebrisNameLeft = "TrackDebrisDirtLeft"; // TheSuperHackers @todo Remove data particle names from code
+		m_treadDebrisNameRight = "TrackDebrisDirtRight";
+	}
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -114,40 +119,15 @@ m_prevRenderObj(nullptr)
 
 	m_treadCount=0;
 
-#ifdef SHOW_TANK_DEBRIS
-	if (getW3DTankTruckDrawModuleData())
-	{
-		const AsciiString *treadDebrisNames[2];
-		static_assert(ARRAY_SIZE(treadDebrisNames) == ARRAY_SIZE(m_treadDebrisIDs), "Array size must match");
-		treadDebrisNames[0] = &getW3DTankTruckDrawModuleData()->m_treadDebrisNameLeft;
-		treadDebrisNames[1] = &getW3DTankTruckDrawModuleData()->m_treadDebrisNameRight;
-
-		for (size_t i = 0; i < ARRAY_SIZE(m_treadDebrisIDs); ++i)
-		{
-			if (m_treadDebrisIDs[i] == INVALID_PARTICLE_SYSTEM_ID)
-			{
-				if (const ParticleSystemTemplate *sysTemplate = TheParticleSystemManager->findTemplate(*treadDebrisNames[i]))
-				{
-					ParticleSystem *particleSys = TheParticleSystemManager->createParticleSystem( sysTemplate );
-					particleSys->attachToDrawable(getDrawable());
-					DEBUG_CRASH(("test me, may not work (srj)"));
-					// important: mark it as do-not-save, since we'll just re-create it when we reload.
-					particleSys->setSaveable(FALSE);
-					// they come into being stopped.
-					//particleSys->stop();
-					m_treadDebrisIDs[i] = particleSys->getSystemID();
-				}
-			}
-		}
-	}
-#endif
+	createTreadEmitters();
 }
 
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
 W3DTankTruckDraw::~W3DTankTruckDraw()
 {
 	tossWheelEmitters();
+	tossTreadEmitters();
 
 	for (Int i=0; i<MAX_TREADS_PER_TANK; i++)
 		if (m_treads[i].m_robj)
@@ -188,13 +168,63 @@ void W3DTankTruckDraw::setFullyObscuredByShroud(Bool fullyObscured)
 	if (fullyObscured != getFullyObscuredByShroud())
 	{
 		if (fullyObscured)
+		{
 			tossWheelEmitters();
+			stopMoveDebris();
+		}
 		else
+		{
 			createWheelEmitters();
+		}
 	}
 	W3DModelDraw::setFullyObscuredByShroud(fullyObscured);
 }
 
+//-------------------------------------------------------------------------------------------------
+//-------------------------------------------------------------------------------------------------
+void W3DTankTruckDraw::createTreadEmitters( void )
+{
+	if (getW3DTankTruckDrawModuleData())
+	{
+		const AsciiString *treadDebrisNames[2];
+		static_assert(ARRAY_SIZE(treadDebrisNames) == ARRAY_SIZE(m_treadDebrisIDs), "Array size must match");
+		treadDebrisNames[0] = &getW3DTankTruckDrawModuleData()->m_treadDebrisNameLeft;
+		treadDebrisNames[1] = &getW3DTankTruckDrawModuleData()->m_treadDebrisNameRight;
+
+		for (size_t i = 0; i < ARRAY_SIZE(m_treadDebrisIDs); ++i)
+		{
+			if (m_treadDebrisIDs[i] == INVALID_PARTICLE_SYSTEM_ID)
+			{
+				if (const ParticleSystemTemplate *sysTemplate = TheParticleSystemManager->findTemplate(*treadDebrisNames[i]))
+				{
+					ParticleSystem *particleSys = TheParticleSystemManager->createParticleSystem( sysTemplate );
+					particleSys->attachToDrawable(getDrawable());
+					// important: mark it as do-not-save, since we'll just re-create it when we reload.
+					particleSys->setSaveable(FALSE);
+					// they come into being stopped.
+					particleSys->stop();
+					m_treadDebrisIDs[i] = particleSys->getSystemID();
+				}
+			}
+		}
+	}
+}
+
+//-------------------------------------------------------------------------------------------------
+//-------------------------------------------------------------------------------------------------
+void W3DTankTruckDraw::tossTreadEmitters( void )
+{
+	for (size_t i = 0; i < ARRAY_SIZE(m_treadDebrisIDs); ++i)
+	{
+		if (ParticleSystem *particleSys = TheParticleSystemManager->findParticleSystem(m_treadDebrisIDs[i]))
+		{
+			particleSys->attachToObject(nullptr);
+			particleSys->destroy();
+		}
+		m_treadDebrisIDs[i] = INVALID_PARTICLE_SYSTEM_ID;
+	}
+}
+
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
 void W3DTankTruckDraw::createWheelEmitters( void )
@@ -341,9 +371,7 @@ void W3DTankTruckDraw::setHidden(Bool h)
 	if (h)
 	{
 		enableWheelEmitters(false);
-#ifdef SHOW_TANK_DEBRIS
 		stopMoveDebris();
-#endif
 	}
 }
 
@@ -619,7 +647,6 @@ void W3DTankTruckDraw::doDrawModule(const Matrix3D* transformMtx)
 	}
 
 	//Tank update
-#ifdef SHOW_TANK_DEBRIS
 	const Real DEBRIS_THRESHOLD = 0.00001f;
 
 		// if tank is moving, kick up dust and debris
@@ -654,7 +681,7 @@ void W3DTankTruckDraw::doDrawModule(const Matrix3D* transformMtx)
 			particleSys->setBurstCountMultiplier( velMult.z );
 		}
 	}
-#endif
+
 	//Update movement of treads
 	if (m_treadCount)
 	{
@@ -734,4 +761,8 @@ void W3DTankTruckDraw::loadPostProcess( void )
 	// toss any existing wheel emitters (no need to re-create; we'll do that on demand)
 	tossWheelEmitters();
 
+	// toss any existing tread emitters and re-create 'em (since this module expects 'em to always be around)
+	tossTreadEmitters();
+	createTreadEmitters();
+
 }