refactor: Implement cleaner solution

Stubbjax · Stubbjax · commit 7f06777de3e0 · 2025-11-20T00:03:05.000+11:00
diff --git a/Generals/Code/GameEngine/Include/GameLogic/Object.h b/Generals/Code/GameEngine/Include/GameLogic/Object.h
@@ -418,7 +418,7 @@ class Object : public Thing, public Snapshot
 	Int getTransportSlotCount() const;
 	void friend_setContainedBy( Object *containedBy ) { m_containedBy = containedBy; }
 	const Object* getEnclosingContainedBy() const; ///< Find the first enclosing container in the containment chain.
-	Bool isSelfOrEnclosingContainedByVisible() const; ///< Is this object or its top-level container visible?
+	const Object* getOuterObject() const; ///< Get the top-level object
 
 	// Special Powers -------------------------------------------------------------------------------
 	SpecialPowerModuleInterface *getSpecialPowerModule( const SpecialPowerTemplate *specialPowerTemplate ) const;
diff --git a/Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp b/Generals/Code/GameEngine/Source/GameLogic/Object/Object.cpp
@@ -679,13 +679,12 @@ const Object* Object::getEnclosingContainedBy() const
 	return NULL;
 }
 
-Bool Object::isSelfOrEnclosingContainedByVisible() const
+const Object* Object::getOuterObject() const
 {
-	if (getDrawable() && getDrawable()->isVisible())
-		return TRUE;
+	if (const Object* enclosing = getEnclosingContainedBy())
+		return enclosing;
 
-	const Object* container = getEnclosingContainedBy();
-	return container && container->getDrawable() && container->getDrawable()->isVisible();
+	return this;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -2833,7 +2832,8 @@ void Object::onVeterancyLevelChanged( VeterancyLevel oldLevel, VeterancyLevel ne
 	Bool doAnimation = provideFeedback
 		&& newLevel > oldLevel
 		&& !isKindOf(KINDOF_IGNORED_IN_GUI)
-		&& isSelfOrEnclosingContainedByVisible();
+		&& getOuterObject()->getDrawable()
+		&& getOuterObject()->getDrawable()->isVisible();
 
 	if( doAnimation && TheGameLogic->getDrawIconUI() )
 	{
diff --git a/Generals/Code/GameEngine/Source/GameLogic/Object/Weapon.cpp b/Generals/Code/GameEngine/Source/GameLogic/Object/Weapon.cpp
@@ -886,7 +886,8 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 
 		// TheSuperHackers @todo: Remove hardcoded KINDOF_MINE check and apply PlayFXWhenStealthed = Yes to the mine weapons instead.
 
-		if(!sourceObj->isSelfOrEnclosingContainedByVisible()	// if user watching cannot see us
+		Drawable* outerDrawable = sourceObj->getOuterObject()->getDrawable();
+		if ((!outerDrawable || !outerDrawable->isVisible())		// if user watching cannot see us
 			&& !sourceObj->isKindOf(KINDOF_MINE)								// and not a mine (which always do the FX, even if hidden)...
 			&& !isPlayFXWhenStealthed()													// and not a weapon marked to playwhenstealthed
 			)
diff --git a/GeneralsMD/Code/GameEngine/Include/GameLogic/Object.h b/GeneralsMD/Code/GameEngine/Include/GameLogic/Object.h
@@ -443,7 +443,7 @@ class Object : public Thing, public Snapshot
 	Int getTransportSlotCount() const;
 	void friend_setContainedBy( Object *containedBy ) { m_containedBy = containedBy; }
 	const Object* getEnclosingContainedBy() const; ///< Find the first enclosing container in the containment chain.
-	Bool isSelfOrEnclosingContainedByVisible() const; ///< Is this object or its top-level container visible?
+	const Object* getOuterObject() const; ///< Get the top-level object
 
 	// Special Powers -------------------------------------------------------------------------------
 	SpecialPowerModuleInterface *getSpecialPowerModule( const SpecialPowerTemplate *specialPowerTemplate ) const;
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp
@@ -743,13 +743,12 @@ const Object* Object::getEnclosingContainedBy() const
 	return NULL;
 }
 
-Bool Object::isSelfOrEnclosingContainedByVisible() const
+const Object* Object::getOuterObject() const
 {
-	if (getDrawable() && getDrawable()->isVisible())
-		return TRUE;
+	if (const Object* enclosing = getEnclosingContainedBy())
+		return enclosing;
 
-	const Object* container = getEnclosingContainedBy();
-	return container && container->getDrawable() && container->getDrawable()->isVisible();
+	return this;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -3148,7 +3147,8 @@ void Object::onVeterancyLevelChanged( VeterancyLevel oldLevel, VeterancyLevel ne
 	Bool doAnimation = provideFeedback
 		&& newLevel > oldLevel
 		&& !isKindOf(KINDOF_IGNORED_IN_GUI)
-		&& isSelfOrEnclosingContainedByVisible();
+		&& getOuterObject()->getDrawable()
+		&& getOuterObject()->getDrawable()->isVisible();
 
 	if( doAnimation && TheGameLogic->getDrawIconUI() )
 	{
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AIUpdate/HackInternetAIUpdate.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AIUpdate/HackInternetAIUpdate.cpp
@@ -543,7 +543,8 @@ StateReturnType HackInternetState::update()
 				//Grant the unit some experience for a successful hack.
 				xp->addExperiencePoints( ai->getXpPerCashUpdate() );
 
-				if (owner->isSelfOrEnclosingContainedByVisible())
+				Drawable* outerDrawable = owner->getOuterObject()->getDrawable();
+				if (outerDrawable && outerDrawable->isVisible())
 				{
 					// OY LOOK!  I AM USING LOCAL PLAYER.  Do not put anything other than TheInGameUI->addFloatingText in the block this controls!!!
 					//Display cash income floating over the hacker.
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AutoDepositUpdate.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AutoDepositUpdate.cpp
@@ -63,6 +63,7 @@
 #include "GameLogic/Module/AutoDepositUpdate.h"
 #include "GameLogic/Module/AIUpdate.h"
 #include "GameLogic/Object.h"
+#include "GameClient/Drawable.h"
 #include "GameClient/InGameUI.h"
 #include "GameClient/Color.h"
 #include "GameClient/GameText.h"
@@ -172,7 +173,8 @@ UpdateSleepTime AutoDepositUpdate::update( void )
 			getObject()->getControllingPlayer()->getScoreKeeper()->addMoneyEarned( modData->m_depositAmount);
 		}
 
-		if (moneyAmount > 0 && getObject()->isSelfOrEnclosingContainedByVisible())
+		Drawable* outerDrawable = getObject()->getOuterObject()->getDrawable();
+		if (moneyAmount > 0 && outerDrawable && outerDrawable->isVisible())
 		{
 
       const Object *owner = getObject();
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/DockUpdate/SupplyCenterDockUpdate.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/DockUpdate/SupplyCenterDockUpdate.cpp
@@ -34,6 +34,7 @@
 #include "GameLogic/Module/SupplyCenterDockUpdate.h"
 #include "GameLogic/Module/SupplyTruckAIUpdate.h"
 #include "GameClient/Color.h"
+#include "GameClient/Drawable.h"
 #include "GameClient/InGameUI.h"
 #include "GameClient/GameText.h"
 
@@ -128,7 +129,8 @@ Bool SupplyCenterDockUpdate::action( Object* docker, Object *drone )
 		}
 	}
 
-	if (value > 0 && getObject()->isSelfOrEnclosingContainedByVisible())
+	Drawable* outerDrawable = getObject()->getOuterObject()->getDrawable();
+	if (value > 0 && outerDrawable && outerDrawable->isVisible())
 	{
 		// OY LOOK!  I AM USING LOCAL PLAYER.  Do not put anything other than TheInGameUI->addFloatingText in the block this controls!!!
 		// Setup info for adding a floating text
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Weapon.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Weapon.cpp
@@ -917,7 +917,8 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 
 		// TheSuperHackers @todo: Remove hardcoded KINDOF_MINE check and apply PlayFXWhenStealthed = Yes to the mine weapons instead.
 
-		if(!sourceObj->isSelfOrEnclosingContainedByVisible()	// if user watching cannot see us
+		Drawable* outerDrawable = sourceObj->getOuterObject()->getDrawable();
+		if ((!outerDrawable || !outerDrawable->isVisible())		// if user watching cannot see us
 			&& !sourceObj->isKindOf(KINDOF_MINE)								// and not a mine (which always do the FX, even if hidden)...
 			&& !isPlayFXWhenStealthed()													// and not a weapon marked to playwhenstealthed
 			)

Original file line number	Diff line number	Diff line change
`@@ -679,13 +679,12 @@ const Object* Object::getEnclosingContainedBy() const`
`679`	`679`	`return NULL;`
`680`	`680`	`}`
`681`	`681`
`682`		`-Bool Object::isSelfOrEnclosingContainedByVisible() const`
	`682`	`+const Object* Object::getOuterObject() const`
`683`	`683`	`{`
`684`		`- if (getDrawable() && getDrawable()->isVisible())`
`685`		`- return TRUE;`
	`684`	`+ if (const Object* enclosing = getEnclosingContainedBy())`
	`685`	`+ return enclosing;`
`686`	`686`
`687`		`- const Object* container = getEnclosingContainedBy();`
`688`		`- return container && container->getDrawable() && container->getDrawable()->isVisible();`
	`687`	`+ return this;`
`689`	`688`	`}`
`690`	`689`
`691`	`690`	`//-------------------------------------------------------------------------------------------------`
`@@ -2833,7 +2832,8 @@ void Object::onVeterancyLevelChanged( VeterancyLevel oldLevel, VeterancyLevel ne`
`2833`	`2832`	`Bool doAnimation = provideFeedback`
`2834`	`2833`	`&& newLevel > oldLevel`
`2835`	`2834`	`&& !isKindOf(KINDOF_IGNORED_IN_GUI)`
`2836`		`- && isSelfOrEnclosingContainedByVisible();`
	`2835`	`+ && getOuterObject()->getDrawable()`
	`2836`	`+ && getOuterObject()->getDrawable()->isVisible();`
`2837`	`2837`
`2838`	`2838`	`if( doAnimation && TheGameLogic->getDrawIconUI() )`
`2839`	`2839`	`{`
Original file line number	Diff line number	Diff line change
`@@ -886,7 +886,8 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate`
`886`	`886`
`887`	`887`	`// TheSuperHackers @todo: Remove hardcoded KINDOF_MINE check and apply PlayFXWhenStealthed = Yes to the mine weapons instead.`
`888`	`888`
`889`		`- if(!sourceObj->isSelfOrEnclosingContainedByVisible() // if user watching cannot see us`
	`889`	`+ Drawable* outerDrawable = sourceObj->getOuterObject()->getDrawable();`
	`890`	`+ if ((!outerDrawable \|\| !outerDrawable->isVisible()) // if user watching cannot see us`
`890`	`891`	`&& !sourceObj->isKindOf(KINDOF_MINE) // and not a mine (which always do the FX, even if hidden)...`
`891`	`892`	`&& !isPlayFXWhenStealthed() // and not a weapon marked to playwhenstealthed`
`892`	`893`	`)`
Original file line number	Diff line number	Diff line change
`@@ -743,13 +743,12 @@ const Object* Object::getEnclosingContainedBy() const`
`743`	`743`	`return NULL;`
`744`	`744`	`}`
`745`	`745`
`746`		`-Bool Object::isSelfOrEnclosingContainedByVisible() const`
	`746`	`+const Object* Object::getOuterObject() const`
`747`	`747`	`{`
`748`		`- if (getDrawable() && getDrawable()->isVisible())`
`749`		`- return TRUE;`
	`748`	`+ if (const Object* enclosing = getEnclosingContainedBy())`
	`749`	`+ return enclosing;`
`750`	`750`
`751`		`- const Object* container = getEnclosingContainedBy();`
`752`		`- return container && container->getDrawable() && container->getDrawable()->isVisible();`
	`751`	`+ return this;`
`753`	`752`	`}`
`754`	`753`
`755`	`754`	`//-------------------------------------------------------------------------------------------------`
`@@ -3148,7 +3147,8 @@ void Object::onVeterancyLevelChanged( VeterancyLevel oldLevel, VeterancyLevel ne`
`3148`	`3147`	`Bool doAnimation = provideFeedback`
`3149`	`3148`	`&& newLevel > oldLevel`
`3150`	`3149`	`&& !isKindOf(KINDOF_IGNORED_IN_GUI)`
`3151`		`- && isSelfOrEnclosingContainedByVisible();`
	`3150`	`+ && getOuterObject()->getDrawable()`
	`3151`	`+ && getOuterObject()->getDrawable()->isVisible();`
`3152`	`3152`
`3153`	`3153`	`if( doAnimation && TheGameLogic->getDrawIconUI() )`
`3154`	`3154`	`{`
Original file line number	Diff line number	Diff line change
`@@ -543,7 +543,8 @@ StateReturnType HackInternetState::update()`
`543`	`543`	`//Grant the unit some experience for a successful hack.`
`544`	`544`	`xp->addExperiencePoints( ai->getXpPerCashUpdate() );`
`545`	`545`
`546`		`- if (owner->isSelfOrEnclosingContainedByVisible())`
	`546`	`+ Drawable* outerDrawable = owner->getOuterObject()->getDrawable();`
	`547`	`+ if (outerDrawable && outerDrawable->isVisible())`
`547`	`548`	`{`
`548`	`549`	`// OY LOOK! I AM USING LOCAL PLAYER. Do not put anything other than TheInGameUI->addFloatingText in the block this controls!!!`
`549`	`550`	`//Display cash income floating over the hacker.`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@`
`34`	`34`	`#include "GameLogic/Module/SupplyCenterDockUpdate.h"`
`35`	`35`	`#include "GameLogic/Module/SupplyTruckAIUpdate.h"`
`36`	`36`	`#include "GameClient/Color.h"`
	`37`	`+#include "GameClient/Drawable.h"`
`37`	`38`	`#include "GameClient/InGameUI.h"`
`38`	`39`	`#include "GameClient/GameText.h"`
`39`	`40`
`@@ -128,7 +129,8 @@ Bool SupplyCenterDockUpdate::action( Object* docker, Object *drone )`
`128`	`129`	`}`
`129`	`130`	`}`
`130`	`131`
`131`		`- if (value > 0 && getObject()->isSelfOrEnclosingContainedByVisible())`
	`132`	`+ Drawable* outerDrawable = getObject()->getOuterObject()->getDrawable();`
	`133`	`+ if (value > 0 && outerDrawable && outerDrawable->isVisible())`
`132`	`134`	`{`
`133`	`135`	`// OY LOOK! I AM USING LOCAL PLAYER. Do not put anything other than TheInGameUI->addFloatingText in the block this controls!!!`
`134`	`136`	`// Setup info for adding a floating text`
Original file line number	Diff line number	Diff line change
`@@ -917,7 +917,8 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate`
`917`	`917`
`918`	`918`	`// TheSuperHackers @todo: Remove hardcoded KINDOF_MINE check and apply PlayFXWhenStealthed = Yes to the mine weapons instead.`
`919`	`919`
`920`		`- if(!sourceObj->isSelfOrEnclosingContainedByVisible() // if user watching cannot see us`
	`920`	`+ Drawable* outerDrawable = sourceObj->getOuterObject()->getDrawable();`
	`921`	`+ if ((!outerDrawable \|\| !outerDrawable->isVisible()) // if user watching cannot see us`
`921`	`922`	`&& !sourceObj->isKindOf(KINDOF_MINE) // and not a mine (which always do the FX, even if hidden)...`
`922`	`923`	`&& !isPlayFXWhenStealthed() // and not a weapon marked to playwhenstealthed`
`923`	`924`	`)`