refactor: Rename RETAIL_COMPATIBLE_BUG macro to PRESERVE_RETAIL_BEHAVIOR (#1877)

Author: Stubbjax

Core/GameEngine/Include/Common/GameDefines.h

@@ -23,8 +23,8 @@
 // Note: Retail compatibility must not be broken before this project officially does.
 // Use RETAIL_COMPATIBLE_CRC and RETAIL_COMPATIBLE_XFER_SAVE to guard breaking changes.
 
-#ifndef RETAIL_COMPATIBLE_BUG
-#define RETAIL_COMPATIBLE_BUG (1) // Retain bugs present in retail Generals 1.08 and Zero Hour 1.04
+#ifndef PRESERVE_RETAIL_BEHAVIOR
+#define PRESERVE_RETAIL_BEHAVIOR (1) // Retain behavior present in retail Generals 1.08 and Zero Hour 1.04
 #endif
 
 #ifndef RETAIL_COMPATIBLE_CRC

Generals/Code/GameEngine/Include/Common/TunnelTracker.h

@@ -59,7 +59,7 @@ class TunnelTracker : public MemoryPoolObject,
 	static void destroyObject( Object *obj, void *userData ); ///< Callback for Iterate Contained system
 	static void healObject( Object *obj, void *frames ); ///< Callback for Iterate Contained system
 
-#if RETAIL_COMPATIBLE_BUG || RETAIL_COMPATIBLE_CRC
+#if PRESERVE_RETAIL_BEHAVIOR || RETAIL_COMPATIBLE_CRC
 	void healObjects(Real frames);	///< heal all objects within the tunnel
 #else
 	void healObjects();	///< heal all objects within the tunnel

Generals/Code/GameEngine/Source/Common/RTS/Player.cpp

@@ -677,7 +677,7 @@ void Player::update()
 		}
 	}
 
-#if !RETAIL_COMPATIBLE_BUG && !RETAIL_COMPATIBLE_CRC
+#if !PRESERVE_RETAIL_BEHAVIOR && !RETAIL_COMPATIBLE_CRC
 	// TheSuperHackers @bugfix Stubbjax 26/09/2025 The Tunnel System now heals
 	// all units once per frame instead of once per frame per Tunnel Network.
 	TunnelTracker* tunnelSystem = getTunnelSystem();

Generals/Code/GameEngine/Source/Common/RTS/TunnelTracker.cpp

@@ -256,7 +256,7 @@ void TunnelTracker::destroyObject( Object *obj, void * )
 
 // ------------------------------------------------------------------------
 	// heal all the objects within the tunnel system using the iterateContained function
-#if RETAIL_COMPATIBLE_BUG || RETAIL_COMPATIBLE_CRC
+#if PRESERVE_RETAIL_BEHAVIOR || RETAIL_COMPATIBLE_CRC
 void TunnelTracker::healObjects(Real frames)
 {
 	iterateContained(healObject, &frames, FALSE);
@@ -280,7 +280,7 @@ void TunnelTracker::healObject( Object *obj, void *frames)
 {
 
 	//get the number of frames to heal
-#if RETAIL_COMPATIBLE_BUG || RETAIL_COMPATIBLE_CRC
+#if PRESERVE_RETAIL_BEHAVIOR || RETAIL_COMPATIBLE_CRC
 	Real *framesForFullHeal = (Real*)frames;
 #else
 	UnsignedInt* framesForFullHeal = (UnsignedInt*)frames;

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

@@ -347,7 +347,7 @@ Bool addDrawableToList( Drawable *draw, void *userData )
 	if (!pds->drawableListToFill)
 		return FALSE;
 
-#if !RTS_GENERALS || !RETAIL_COMPATIBLE_BUG
+#if !RTS_GENERALS || !PRESERVE_RETAIL_BEHAVIOR
 	// TheSuperHackers @info
 	// In retail, drag-selecting allows the player to select stealthed objects and objects through the
 	// fog. Some players exploit this bug to determine where an opponent's units are and consider this

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

@@ -593,7 +593,7 @@ void ActiveBody::attemptHealing( DamageInfo *damageInfo )
 		//(object pointer loses scope as soon as atteptdamage's caller ends)
 		m_lastDamageInfo = *damageInfo;
 		m_lastDamageCleared = false;
-#if RETAIL_COMPATIBLE_BUG
+#if PRESERVE_RETAIL_BEHAVIOR
 		m_lastDamageTimestamp = TheGameLogic->getFrame();
 #endif
 		m_lastHealingTimestamp = TheGameLogic->getFrame();

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

@@ -403,7 +403,7 @@ UpdateSleepTime TunnelContain::update( void )
 	if (controllingPlayer)
 	{
 		TunnelTracker *tunnelSystem = controllingPlayer->getTunnelSystem();
-#if RETAIL_COMPATIBLE_BUG || RETAIL_COMPATIBLE_CRC
+#if PRESERVE_RETAIL_BEHAVIOR || RETAIL_COMPATIBLE_CRC
 		if (tunnelSystem)
 		{
 			const TunnelContainModuleData* modData = getTunnelContainModuleData();

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

@@ -1333,7 +1333,7 @@ class GenericObjectCreationNugget : public ObjectCreationNugget
 			}
 		}
 
-#if !RETAIL_COMPATIBLE_CRC && !RETAIL_COMPATIBLE_BUG
+#if !RETAIL_COMPATIBLE_CRC && !PRESERVE_RETAIL_BEHAVIOR
 		ObjectID sinkID = sourceObj->getExperienceTracker()->getExperienceSink();
 		firstObject->getExperienceTracker()->setExperienceSink(sinkID != INVALID_ID ? sinkID : sourceObj->getID());
 #endif

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

@@ -1341,7 +1341,7 @@ void SpecialAbilityUpdate::triggerAbilityEffect()
 			if( targetMoney && objectMoney )
 			{
 				UnsignedInt cash = targetMoney->countMoney();
-#if RETAIL_COMPATIBLE_CRC || RETAIL_COMPATIBLE_BUG
+#if RETAIL_COMPATIBLE_CRC || PRESERVE_RETAIL_BEHAVIOR
 				UnsignedInt desiredAmount = 1000;
 #else
 				UnsignedInt desiredAmount = data->m_effectValue;

GeneralsMD/Code/GameEngine/Include/Common/TunnelTracker.h

@@ -59,7 +59,7 @@ class TunnelTracker : public MemoryPoolObject,
 	static void destroyObject( Object *obj, void *userData ); ///< Callback for Iterate Contained system
 	static void healObject( Object *obj, void *frames ); ///< Callback for Iterate Contained system
 
-#if RETAIL_COMPATIBLE_BUG || RETAIL_COMPATIBLE_CRC
+#if PRESERVE_RETAIL_BEHAVIOR || RETAIL_COMPATIBLE_CRC
 	void healObjects(Real frames);	///< heal all objects within the tunnel
 #else
 	void healObjects();	///< heal all objects within the tunnel