Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xezon wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce0c737
refactor(draw): Rename emitters functions in W3DTankDraw, W3DTankTruc…
xezon Feb 3, 2026
aa8ffdb
fix(draw): Recover tread debris effects for W3DTankTruckDraw (#2251)
xezon Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Core/GameEngineDevice/Include/W3DDevice/GameClient/Module/W3DTankDraw.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,10 @@ class W3DTankDraw : public W3DModelDraw
Int m_treadCount;
Coord3D m_lastDirection; ///< orientation of tank last time it was drawn.

void createEmitters( void ); ///< Create particle effects.
void tossEmitters( void ); ///< Create particle effects.
void createTreadEmitters( void ); ///< Create particle effects for treads.
void tossTreadEmitters( void ); ///< Destroy particle effects for treads.

void stopMoveDebris( void ); ///< stop creating debris from the tank treads
void updateTreadObjects(void); ///< update pointers to sub-objects like treads.
void updateTreadPositions(Real uvDelta); ///< update uv coordinates on each tread
void stopMoveDebris( void ); ///< Stop creating debris from the tank treads.
void updateTreadObjects(void); ///< Update pointers to sub-objects like treads.
void updateTreadPositions(Real uvDelta); ///< Update uv coordinates on each tread.
};
17 changes: 11 additions & 6 deletions Core/GameEngineDevice/Include/W3DDevice/GameClient/Module/W3DTankTruckDraw.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -139,12 +141,15 @@ class W3DTankTruckDraw : public W3DModelDraw

RenderObjClass *m_prevRenderObj;

void createEmitters( void ); ///< Create particle effects.
void tossEmitters( void ); ///< Create particle effects.
void enableEmitters( Bool enable ); ///< stop creating debris from the tank treads
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.
void updateBones( void );

void stopMoveDebris( void ); ///< stop creating debris from the tank treads
void updateTreadObjects(void); ///< update pointers to sub-objects like treads.
void updateTreadPositions(Real uvDelta); ///< update uv coordinates on each tread
void stopMoveDebris( void ); ///< Stop creating debris from the tank treads.
void updateTreadObjects(void); ///< Update pointers to sub-objects like treads.
void updateTreadPositions(Real uvDelta); ///< Update uv coordinates on each tread.
};
6 changes: 3 additions & 3 deletions Core/GameEngineDevice/Include/W3DDevice/GameClient/Module/W3DTruckDraw.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ class W3DTruckDraw : public W3DModelDraw

RenderObjClass *m_prevRenderObj;

void createEmitters( void ); ///< Create particle effects.
void tossEmitters( void ); ///< Create particle effects.
void enableEmitters( Bool enable ); ///< stop creating debris from the tank 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.
void updateBones( void );
};
35 changes: 19 additions & 16 deletions Core/GameEngineDevice/Source/W3DDevice/GameClient/Drawable/Draw/W3DTankDraw.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
}
}

//-------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -100,12 +106,12 @@ W3DTankDraw::W3DTankDraw( Thing *thing, const ModuleData* moduleData )
m_lastDirection.y=0.0f;
m_lastDirection.z=0.0f;

createEmitters();
createTreadEmitters();
}

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
void W3DTankDraw::tossEmitters( void )
void W3DTankDraw::tossTreadEmitters( void )
{
for (size_t i = 0; i < ARRAY_SIZE(m_treadDebrisIDs); ++i)
{
Expand All @@ -120,7 +126,7 @@ void W3DTankDraw::tossEmitters( void )

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
void W3DTankDraw::createEmitters( void )
void W3DTankDraw::createTreadEmitters( void )
{
const AsciiString *treadDebrisNames[2];
static_assert(ARRAY_SIZE(treadDebrisNames) == ARRAY_SIZE(m_treadDebrisIDs), "Array size must match");
Expand Down Expand Up @@ -150,7 +156,7 @@ void W3DTankDraw::createEmitters( void )
W3DTankDraw::~W3DTankDraw()
{
// TheSuperHackers @fix Mauller 16/04/2025 Delete particle systems
tossEmitters();
tossTreadEmitters();

for (Int i=0; i<MAX_TREADS_PER_TANK; i++)
if (m_treads[i].m_robj)
Expand All @@ -159,9 +165,6 @@ W3DTankDraw::~W3DTankDraw()

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
/**
* Stop creating debris from the tank treads
*/
void W3DTankDraw::stopMoveDebris( void )
{
for (size_t i = 0; i < ARRAY_SIZE(m_treadDebrisIDs); ++i)
Expand Down Expand Up @@ -432,8 +435,8 @@ void W3DTankDraw::loadPostProcess( void )
// extend base class
W3DModelDraw::loadPostProcess();

// toss any existing ones and re-create 'em (since this module expects 'em to always be around)
tossEmitters();
createEmitters();
// toss any existing tread emitters and re-create 'em (since this module expects 'em to always be around)
tossTreadEmitters();
createTreadEmitters();

}
140 changes: 81 additions & 59 deletions Core/GameEngineDevice/Source/W3DDevice/GameClient/Drawable/Draw/W3DTankTruckDraw.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
}
}

//-------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -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()
{
tossEmitters();
tossWheelEmitters();
tossTreadEmitters();

for (Int i=0; i<MAX_TREADS_PER_TANK; i++)
if (m_treads[i].m_robj)
Expand All @@ -156,9 +136,6 @@ W3DTankTruckDraw::~W3DTankTruckDraw()

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
/**
* Stop creating debris from the tank treads
*/
void W3DTankTruckDraw::stopMoveDebris( void )
{
for (size_t i = 0; i < ARRAY_SIZE(m_treadDebrisIDs); ++i)
Expand All @@ -172,7 +149,7 @@ void W3DTankTruckDraw::stopMoveDebris( void )

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
void W3DTankTruckDraw::tossEmitters()
void W3DTankTruckDraw::tossWheelEmitters()
{
for (size_t i = 0; i < ARRAY_SIZE(m_truckEffectIDs); ++i)
{
Expand All @@ -191,19 +168,66 @@ void W3DTankTruckDraw::setFullyObscuredByShroud(Bool fullyObscured)
if (fullyObscured != getFullyObscuredByShroud())
{
if (fullyObscured)
tossEmitters();
{
tossWheelEmitters();
stopMoveDebris();
}
else
createEmitters();
{
createWheelEmitters();
}
}
W3DModelDraw::setFullyObscuredByShroud(fullyObscured);
}

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
/**
* Start creating debris from the tank treads
*/
void W3DTankTruckDraw::createEmitters( void )
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 )
{
if (getDrawable()->isDrawableEffectivelyHidden())
return;
Expand Down Expand Up @@ -241,16 +265,13 @@ void W3DTankTruckDraw::createEmitters( void )

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
/**
* Stop creating debris from the tank treads
*/
void W3DTankTruckDraw::enableEmitters( Bool enable )
void W3DTankTruckDraw::enableWheelEmitters( Bool enable )
{
// don't check... if we are hidden the first time thru, then we'll never create the emitters.
// eg, if we are loading a game and the unit is in a tunnel, he'll never get emitteres even when he exits.
//if (!m_effectsInitialized)
{
createEmitters();
createWheelEmitters();
m_effectsInitialized=true;
}

Expand Down Expand Up @@ -349,10 +370,8 @@ void W3DTankTruckDraw::setHidden(Bool h)
W3DModelDraw::setHidden(h);
if (h)
{
enableEmitters(false);
#ifdef SHOW_TANK_DEBRIS
enableWheelEmitters(false);
stopMoveDebris();
#endif
}
}

Expand Down Expand Up @@ -573,7 +592,7 @@ void W3DTankTruckDraw::doDrawModule(const Matrix3D* transformMtx)
Bool wasPowersliding = m_isPowersliding;
m_isPowersliding = false;
if (physics->isMotive() && !obj->isSignificantlyAboveTerrain()) {
enableEmitters(true);
enableWheelEmitters(true);
Coord3D accel = *physics->getAcceleration();
accel.z = 0; // ignore gravitational force.
Bool accelerating = accel.length()>ACCEL_THRESHOLD;
Expand Down Expand Up @@ -615,7 +634,7 @@ void W3DTankTruckDraw::doDrawModule(const Matrix3D* transformMtx)
}
}
else
enableEmitters(false);
enableWheelEmitters(false);

m_wasAirborne = obj->isSignificantlyAboveTerrain();

Expand All @@ -628,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
Expand Down Expand Up @@ -663,7 +681,7 @@ void W3DTankTruckDraw::doDrawModule(const Matrix3D* transformMtx)
particleSys->setBurstCountMultiplier( velMult.z );
}
}
#endif

//Update movement of treads
if (m_treadCount)
{
Expand Down Expand Up @@ -740,7 +758,11 @@ void W3DTankTruckDraw::loadPostProcess( void )
// extend base class
W3DModelDraw::loadPostProcess();

// toss any existing ones (no need to re-create; we'll do that on demand)
tossEmitters();
// 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();

}
Loading
Loading