bugfix(ghostobject): Properly keep ghosted and shrouded objects hidden when taking a ghost snapshot or changing the local player (#1569)

Author: xezon

Generals/Code/GameEngine/Include/GameClient/Drawable.h

@@ -270,6 +270,8 @@ enum TerrainDecalType CPP_11(: Int)
 
 //-----------------------------------------------------------------------------
 
+constexpr const UnsignedInt InvalidShroudClearFrame = ~0u;
+
 const Int DRAWABLE_FRAMES_PER_FLASH = LOGICFRAMES_PER_SECOND / 2;
 
 //-----------------------------------------------------------------------------

Generals/Code/GameEngine/Source/GameClient/Drawable.cpp

@@ -362,7 +362,7 @@ Drawable::Drawable( const ThingTemplate *thingTemplate, DrawableStatusBits statu
 	m_timeElapsedFade = 0;
 	m_timeToFade = 0;
 
-	m_shroudClearFrame = 0;
+	m_shroudClearFrame = InvalidShroudClearFrame;
 
 	for (i = 0; i < NUM_DRAWABLE_MODULE_TYPES; ++i)
 		m_modules[i] = NULL;

Generals/Code/GameEngine/Source/GameClient/GameClient.cpp

@@ -669,7 +669,7 @@ void GameClient::update( void )
 					}
 
 					ObjectShroudStatus ss=object->getShroudedStatus(localPlayerIndex);
-					if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame()!=0) {
+					if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame() != InvalidShroudClearFrame) {
 						UnsignedInt limit = 2*LOGICFRAMES_PER_SECOND;
 						if (object->isEffectivelyDead()) {
 							// extend the time, so we can see the dead plane blow up & crash.

Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DScene.cpp

@@ -595,7 +595,7 @@ void RTS3DScene::renderOneObject(RenderInfoClass &rinfo, RenderObjClass *robj, I
 			// so the player can see them and missiles chasing them.  jba.
 			if (ss == OBJECTSHROUD_CLEAR) {
 				draw->setShroudClearFrame(TheGameLogic->getFrame());
-			}	else if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame()!=0) {
+			}	else if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame() != InvalidShroudClearFrame) {
 				UnsignedInt limit = 2*LOGICFRAMES_PER_SECOND;
 				if (obj->isEffectivelyDead()) {
 					limit += 3*LOGICFRAMES_PER_SECOND;

Generals/Code/GameEngineDevice/Source/W3DDevice/GameLogic/W3DGhostObject.cpp

@@ -339,6 +339,13 @@ void W3DGhostObject::snapShot(int playerIndex)
 	if (draw->isDrawableEffectivelyHidden())
 		return;	//don't bother to snapshot things which nobody can see.
 
+	//After we remove the unfogged object, we also disable
+	//anything that should be hidden inside fog - shadow, particles, etc.
+	draw->setFullyObscuredByShroud(true);
+
+	// TheSuperHackers @bugfix Definitely keep this shrouded from here on until the shroud becomes clear again.
+	draw->setShroudClearFrame(InvalidShroudClearFrame);
+
 	W3DRenderObjectSnapshot *snap = m_parentSnapshots[playerIndex];
 	W3DRenderObjectSnapshot *prevSnap = NULL;
 
@@ -417,6 +424,9 @@ void W3DGhostObject::removeParentObject(void)
 	//anything that should be hidden inside fog - shadow, particles, etc.
 	draw->setFullyObscuredByShroud(true);
 
+	// TheSuperHackers @bugfix Definitely keep this shrouded from here on until the shroud becomes clear again.
+	draw->setShroudClearFrame(InvalidShroudClearFrame);
+
 	//walk through all W3D render objects used by this object
 	for (DrawModule ** dm = draw->getDrawModules(); *dm; ++dm)
 	{
@@ -985,6 +995,12 @@ void W3DGhostObjectManager::setLocalPlayerIndex(int playerIndex)
 		const ObjectShroudStatus shroudStatus = obj->getShroudedStatus(playerIndex);
 		const Bool shrouded = shroudStatus >= OBJECTSHROUD_FOGGED;
 		draw->setFullyObscuredByShroud(shrouded);
+
+		if (shrouded)
+		{
+			// TheSuperHackers @bugfix Definitely keep this shrouded from here on until the shroud becomes clear again.
+			draw->setShroudClearFrame(InvalidShroudClearFrame);
+		}
 	}
 }
 

GeneralsMD/Code/GameEngine/Include/GameClient/Drawable.h

@@ -278,6 +278,8 @@ enum TerrainDecalType CPP_11(: Int)
 
 //-----------------------------------------------------------------------------
 
+constexpr const UnsignedInt InvalidShroudClearFrame = ~0u;
+
 const Int DRAWABLE_FRAMES_PER_FLASH = LOGICFRAMES_PER_SECOND / 2;
 
 //-----------------------------------------------------------------------------

GeneralsMD/Code/GameEngine/Source/GameClient/Drawable.cpp

@@ -399,7 +399,7 @@ Drawable::Drawable( const ThingTemplate *thingTemplate, DrawableStatusBits statu
 	m_timeElapsedFade = 0;
 	m_timeToFade = 0;
 
-	m_shroudClearFrame = 0;
+	m_shroudClearFrame = InvalidShroudClearFrame;
 
 	for (i = 0; i < NUM_DRAWABLE_MODULE_TYPES; ++i)
 		m_modules[i] = NULL;

GeneralsMD/Code/GameEngine/Source/GameClient/GameClient.cpp

@@ -707,7 +707,7 @@ void GameClient::update( void )
 					}
 
 					ObjectShroudStatus ss=object->getShroudedStatus(localPlayerIndex);
-					if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame()!=0) {
+					if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame() != InvalidShroudClearFrame) {
 						UnsignedInt limit = 2*LOGICFRAMES_PER_SECOND;
 						if (object->isEffectivelyDead()) {
 							// extend the time, so we can see the dead plane blow up & crash.

GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DScene.cpp

@@ -621,7 +621,7 @@ void RTS3DScene::renderOneObject(RenderInfoClass &rinfo, RenderObjClass *robj, I
 			// so the player can see them and missiles chasing them.  jba.
 			if (ss == OBJECTSHROUD_CLEAR) {
 				draw->setShroudClearFrame(TheGameLogic->getFrame());
-			}	else if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame()!=0) {
+			}	else if (ss >= OBJECTSHROUD_FOGGED && draw->getShroudClearFrame() != InvalidShroudClearFrame) {
 				UnsignedInt limit = 2*LOGICFRAMES_PER_SECOND;
 				if (obj->isEffectivelyDead()) {
 					limit += 3*LOGICFRAMES_PER_SECOND;

GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameLogic/W3DGhostObject.cpp

@@ -343,6 +343,13 @@ void W3DGhostObject::snapShot(int playerIndex)
 	if (draw->isDrawableEffectivelyHidden())
 		return;	//don't bother to snapshot things which nobody can see.
 
+	//After we remove the unfogged object, we also disable
+	//anything that should be hidden inside fog - shadow, particles, etc.
+	draw->setFullyObscuredByShroud(true);
+
+	// TheSuperHackers @bugfix Definitely keep this shrouded from here on until the shroud becomes clear again.
+	draw->setShroudClearFrame(InvalidShroudClearFrame);
+
 	W3DRenderObjectSnapshot *snap = m_parentSnapshots[playerIndex];
 	W3DRenderObjectSnapshot *prevSnap = NULL;
 
@@ -421,6 +428,9 @@ void W3DGhostObject::removeParentObject(void)
 	//anything that should be hidden inside fog - shadow, particles, etc.
 	draw->setFullyObscuredByShroud(true);
 
+	// TheSuperHackers @bugfix Definitely keep this shrouded from here on until the shroud becomes clear again.
+	draw->setShroudClearFrame(InvalidShroudClearFrame);
+
 	//walk through all W3D render objects used by this object
 	for (DrawModule ** dm = draw->getDrawModules(); *dm; ++dm)
 	{
@@ -989,6 +999,12 @@ void W3DGhostObjectManager::setLocalPlayerIndex(int playerIndex)
 		const ObjectShroudStatus shroudStatus = obj->getShroudedStatus(playerIndex);
 		const Bool shrouded = shroudStatus >= OBJECTSHROUD_FOGGED;
 		draw->setFullyObscuredByShroud(shrouded);
+
+		if (shrouded)
+		{
+			// TheSuperHackers @bugfix Definitely keep this shrouded from here on until the shroud becomes clear again.
+			draw->setShroudClearFrame(InvalidShroudClearFrame);
+		}
 	}
 }