bugfix(ghostobject): Properly refresh real and ghost objects when changing the local player in the Ghost Object Manager (#1569)

Author: xezon

Core/Libraries/Source/WWVegas/WW3D2/rendobj.cpp

@@ -807,24 +807,27 @@ void RenderObjClass::Add(SceneClass * scene)
  *   11/04/1997 GH  : Created.                                                                 *
  *   2/25/99    GTH : moved to the base RenderObjClass                                         *
  *=============================================================================================*/
-void RenderObjClass::Remove(void)
+bool RenderObjClass::Remove(void)
 {
 	// All render objects have their scene pointers set.  To check if this is a "top level"
 	// object, (i.e. directly in the scene) you see if its Container pointer is NULL.
 #if 1
 	if (Container == NULL) {
 		if (Scene != NULL) {
 			Scene->Remove_Render_Object(this);
-			return;
+			return true;
 		}
+		return false;
 	} else {
 		Container->Remove_Sub_Object(this);
-		return;
+		return true;
 	}
 #else
-	if (!Scene) return;
+	if (!Scene)
+		return false;
 	Scene->Remove_Render_Object(this);
 	Scene = NULL;
+	return true;
 #endif
 }
 

Core/Libraries/Source/WWVegas/WW3D2/rendobj.h

@@ -265,7 +265,7 @@ class RenderObjClass : public RefCountClass , public PersistClass, public MultiL
 	// as small as possible
 	///////////////////////////////////////////////////////////////////////////////////////////////////////////////
 	virtual void					Add(SceneClass * scene);
-	virtual void					Remove(void);
+	virtual bool					Remove(void);
 	virtual SceneClass *			Get_Scene(void);
 	virtual SceneClass *			Peek_Scene(void)																{ return Scene; }
 	virtual void					Set_Container(RenderObjClass * con);

Generals/Code/GameEngine/Include/GameLogic/Object.h

@@ -391,6 +391,7 @@ class Object : public Thing, public Snapshot
 	void friend_setPartitionData(PartitionData *pd) { m_partitionData = pd; }
 	PartitionData *friend_getPartitionData() const { return m_partitionData; }
 	const PartitionData *friend_getConstPartitionData() const { return m_partitionData; }
+	Bool hasGhostObject() const; ///< This object has a ghost object. This does not imply that a ghost snapshot is taken or active.
 
 	void onPartitionCellChange();///< We have moved a 'significant' amount, so do maintenence that can be considered 'cell-based'
 	void handlePartitionCellMaintenance();					///< Undo and redo all shroud actions.  Call when something has changed, like position or ownership or Death

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

@@ -655,11 +655,16 @@ void GameClient::update( void )
 				{
 					if (TheGhostObjectManager->trackAllPlayers())
 					{
-						Int *playerIndex = nonLocalPlayerIndices;
-						Int *const playerIndexEnd = nonLocalPlayerIndices + numNonLocalPlayers;
-						for (; playerIndex < playerIndexEnd; ++playerIndex)
+						// TheSuperHackers @info Update the shrouded status for all objects
+						// that own a ghost object for all non local players. This is costly.
+						if (object->hasGhostObject())
 						{
-							object->getShroudedStatus(*playerIndex);
+							Int *playerIndex = nonLocalPlayerIndices;
+							Int *const playerIndexEnd = nonLocalPlayerIndices + numNonLocalPlayers;
+							for (; playerIndex < playerIndexEnd; ++playerIndex)
+							{
+								object->getShroudedStatus(*playerIndex);
+							}
 						}
 					}
 

Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp

@@ -4198,6 +4198,15 @@ void Object::adjustModelConditionForWeaponStatus()
 	}
 }
 
+//-------------------------------------------------------------------------------------------------
+Bool Object::hasGhostObject() const
+{
+	if (m_partitionData == NULL)
+		return false;
+
+	return m_partitionData->getGhostObject() != NULL;
+}
+
 //-------------------------------------------------------------------------------------------------
 /// We have moved a 'significant' amount, so do maintenence that can be considered 'cell-based'
 void Object::onPartitionCellChange()

Generals/Code/GameEngineDevice/Include/W3DDevice/GameLogic/W3DGhostObject.h

@@ -59,8 +59,8 @@ class W3DGhostObject: public GhostObject
 	virtual void loadPostProcess( void );
 	void removeParentObject(void);
 	void restoreParentObject(void);	///< restore the original non-ghosted object to scene.
-	void addToScene(int playerIndex);
-	void removeFromScene(int playerIndex);
+	Bool addToScene(int playerIndex);
+	Bool removeFromScene(int playerIndex);
 	ObjectShroudStatus getShroudStatus(int playerIndex);	///< used to get the partition manager to update ghost objects without parent objects.
 	void freeAllSnapShots(void);				///< used to free all snapshots from all players.
 

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

@@ -63,8 +63,8 @@ class W3DRenderObjectSnapshot : public Snapshot
 	~W3DRenderObjectSnapshot() {REF_PTR_RELEASE(m_robj);}
 
 	inline void update(RenderObjClass *robj, DrawableInfo *drawInfo, Bool cloneParentRobj = TRUE);	///<refresh the current snapshot with latest state
-	inline void addToScene(void); ///< add this fogged render object to the scene.
-	inline void removeFromScene(); ///< remove this fogged render object from the scene.
+	inline Bool addToScene(void); ///< add this fogged render object to the scene.
+	inline Bool removeFromScene(); ///< remove this fogged render object from the scene.
 
 protected:
 
@@ -151,17 +151,21 @@ void W3DRenderObjectSnapshot::update(RenderObjClass *robj, DrawableInfo *drawInf
 
 // ------------------------------------------------------------------------------------------------
 // ------------------------------------------------------------------------------------------------
-void W3DRenderObjectSnapshot::addToScene(void)
+Bool W3DRenderObjectSnapshot::addToScene(void)
 {
 	if (!m_robj->Is_In_Scene())
+	{
 		W3DDisplay::m_3DScene->Add_Render_Object(m_robj);
+		return true;
+	}
+	return false;
 }
 
 // ------------------------------------------------------------------------------------------------
 // ------------------------------------------------------------------------------------------------
-void W3DRenderObjectSnapshot::removeFromScene()
+Bool W3DRenderObjectSnapshot::removeFromScene()
 {
-	m_robj->Remove();
+	return m_robj->Remove();
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -531,29 +535,37 @@ void W3DGhostObject::updateParentObject(Object *object, PartitionData *mod)
 // ------------------------------------------------------------------------------------------------
 /**Remove the dummy render objects from scene that belong to given player*/
 // ------------------------------------------------------------------------------------------------
-void W3DGhostObject::removeFromScene(int playerIndex)
+Bool W3DGhostObject::removeFromScene(int playerIndex)
 {
 	W3DRenderObjectSnapshot *snap = m_parentSnapshots[playerIndex];
 
+	Bool removed = false;
+
 	while (snap)
 	{
-		snap->removeFromScene();
+		removed |= snap->removeFromScene();
 		snap = snap->m_next;
 	}
+
+	return removed;
 }
 
 // ------------------------------------------------------------------------------------------------
 /**Add the dummy render objects to scene so player sees the correct version within the fog*/
 // ------------------------------------------------------------------------------------------------
-void W3DGhostObject::addToScene(int playerIndex)
+Bool W3DGhostObject::addToScene(int playerIndex)
 {
 	W3DRenderObjectSnapshot *snap = m_parentSnapshots[playerIndex];
 
+	Bool added = false;
+
 	while (snap)
 	{
-		snap->addToScene();
+		added |= snap->addToScene();
 		snap = snap->m_next;
 	}
+
+	return added;
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -923,38 +935,57 @@ GhostObject *W3DGhostObjectManager::addGhostObject(Object *object, PartitionData
 // ------------------------------------------------------------------------------------------------
 void W3DGhostObjectManager::setLocalPlayerIndex(int playerIndex)
 {
+	const int oldPlayerIndex = getLocalPlayerIndex();
+
+	if (playerIndex == oldPlayerIndex)
+		return;
+
+	GhostObjectManager::setLocalPlayerIndex(playerIndex);
+
 	//Whenever we switch local players, we need to remove all ghost objects belonging
 	//to another player from the map.  We then insert the current local player's
 	//ghost objects into the map.
+	// TheSuperHackers @bugfix xezon 06/09/2025 This function now properly
+	// updates ghost objects and real objects when changing players.
 
 	W3DGhostObject *mod = m_usedModules;
 
 	while (mod)
 	{
-		mod->removeFromScene(m_localPlayer);
+		const Bool oldGhostRemoved = mod->removeFromScene(oldPlayerIndex);
+		const ObjectShroudStatus newShroudStatus = mod->getShroudStatus(playerIndex);
+		Bool newGhostAdded = false;
 
-		if (mod->m_parentSnapshots[playerIndex])
+		if (newShroudStatus >= OBJECTSHROUD_FOGGED)
 		{
-			//new player has his own snapshot
-			if (!mod->m_parentSnapshots[m_localPlayer])
-			{
-				//previous player didn't have a snapshot so real object must
-				//have been in the scene.  Replace it with our snapshot.
-				mod->removeParentObject();
-			}
-			mod->addToScene(playerIndex);
+			newGhostAdded = mod->addToScene(playerIndex);
 		}
-		else if (mod->m_parentSnapshots[m_localPlayer])
+
+		if (oldGhostRemoved && !newGhostAdded)
 		{
-			//new player doesn't have a snapshot which means restore original object
-			//if it was replaced by a snapshot by the previous player.
 			mod->restoreParentObject();
 		}
+		else if (!oldGhostRemoved && newGhostAdded)
+		{
+			mod->removeParentObject();
+		}
 
 		mod = mod->m_nextSystem;
 	}
 
-	GhostObjectManager::setLocalPlayerIndex(playerIndex);
+	// TheSuperHackers @bugfix xezon 06/09/2025 This function now properly updates
+	// all real objects when changing players without waiting for another logic step.
+	// This is particularly noticeable when changing the player while the game is paused.
+	for (Drawable* draw = TheGameClient->firstDrawable(); draw != NULL; draw = draw->getNextDrawable())
+	{
+		Object* obj = draw->getObject();
+		if (obj == NULL)
+			continue;
+
+		const ObjectShroudStatus shroudStatus = obj->getShroudedStatus(playerIndex);
+		const Bool shrouded = shroudStatus >= OBJECTSHROUD_FOGGED;
+		draw->setFullyObscuredByShroud(shrouded);
+	}
 }
 
 // ------------------------------------------------------------------------------------------------

GeneralsMD/Code/GameEngine/Include/GameLogic/Object.h

@@ -416,6 +416,7 @@ class Object : public Thing, public Snapshot
 	void friend_setPartitionData(PartitionData *pd) { m_partitionData = pd; }
 	PartitionData *friend_getPartitionData() const { return m_partitionData; }
 	const PartitionData *friend_getConstPartitionData() const { return m_partitionData; }
+	Bool hasGhostObject() const; ///< This object has a ghost object. This does not imply that a ghost snapshot is taken or active.
 
 	void onPartitionCellChange();///< We have moved a 'significant' amount, so do maintenence that can be considered 'cell-based'
 	void handlePartitionCellMaintenance();					///< Undo and redo all shroud actions.  Call when something has changed, like position or ownership or Death

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

@@ -693,11 +693,16 @@ void GameClient::update( void )
 				{
 					if (TheGhostObjectManager->trackAllPlayers())
 					{
-						Int *playerIndex = nonLocalPlayerIndices;
-						Int *const playerIndexEnd = nonLocalPlayerIndices + numNonLocalPlayers;
-						for (; playerIndex < playerIndexEnd; ++playerIndex)
+						// TheSuperHackers @info Update the shrouded status for all objects
+						// that own a ghost object for all non local players. This is costly.
+						if (object->hasGhostObject())
 						{
-							object->getShroudedStatus(*playerIndex);
+							Int *playerIndex = nonLocalPlayerIndices;
+							Int *const playerIndexEnd = nonLocalPlayerIndices + numNonLocalPlayers;
+							for (; playerIndex < playerIndexEnd; ++playerIndex)
+							{
+								object->getShroudedStatus(*playerIndex);
+							}
 						}
 					}
 

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp

@@ -4763,6 +4763,15 @@ void Object::adjustModelConditionForWeaponStatus()
 	}
 }
 
+//-------------------------------------------------------------------------------------------------
+Bool Object::hasGhostObject() const
+{
+	if (m_partitionData == NULL)
+		return false;
+
+	return m_partitionData->getGhostObject() != NULL;
+}
+
 //-------------------------------------------------------------------------------------------------
 /// We have moved a 'significant' amount, so do maintenence that can be considered 'cell-based'
 void Object::onPartitionCellChange()