bugfix(specialpower): Fix special power ready state during construction

Author: xezon

GeneralsMD/Code/GameEngine/Include/GameLogic/Module/SpecialPowerModule.h

@@ -52,7 +52,7 @@ class SpecialPowerModuleInterface
 
 	virtual Bool isModuleForPower( const SpecialPowerTemplate *specialPowerTemplate ) const = 0;
 	virtual Bool isReady( void ) const = 0;
-//  This is the althernate way to one-at-a-time BlackLotus' specials; we'll keep it commented her until Dustin decides, or until 12/10/02
+//  This is the alternate way to one-at-a-time BlackLotus' specials; we'll keep it commented her until Dustin decides, or until 12/10/02
 //	virtual Bool isBusy( void ) const = 0;
 	virtual Real getPercentReady( void ) const = 0;
 	virtual UnsignedInt getReadyFrame( void ) const = 0;
@@ -73,6 +73,7 @@ class SpecialPowerModuleInterface
 
 	//If the special power launches a construction site, we need to know the final product for placement purposes.
 	virtual const ThingTemplate* getReferenceThingTemplate() const = 0;
+	virtual void onConstructionCompleted() = 0;
 };
 
 //-------------------------------------------------------------------------------------------------
@@ -165,8 +166,12 @@ class SpecialPowerModule : public BehaviorModule,
 	//If the special power launches a construction site, we need to know the final product for placement purposes.
 	virtual const ThingTemplate* getReferenceThingTemplate() const { return NULL; }
 
+	virtual void onConstructionCompleted();
+
 protected:
 
+	void init();
+	void initCountdown();
 	Bool initiateIntentToDoSpecialPower( const Object *targetObj, const Coord3D *targetPos, const Waypoint *way, UnsignedInt commandOptions );
 	void triggerSpecialPower( const Coord3D *location );
 	void createViewObject( const Coord3D *location );

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

@@ -213,6 +213,8 @@ class Object : public Thing, public Snapshot
 	Bool isAirborneTarget() const { return m_status.test( OBJECT_STATUS_AIRBORNE_TARGET ); }	///< Our locomotor will control marking us as a valid target for anti air weapons or not
 	Bool isUsingAirborneLocomotor( void ) const;										///< returns true if the current locomotor is an airborne one
 
+	void onConstructionCompleted();
+
 	/// central place for us to put any additional capture logic
 	void onCapture( Player *oldOwner, Player *newOwner );
 

GeneralsMD/Code/GameEngine/Source/GameLogic/AI/AIPlayer.cpp

@@ -127,8 +127,8 @@ void AIPlayer::onStructureProduced( Object *factory, Object *bldg )
 
 		info->setUnderConstruction(false);
 		bldg->updateObjValuesFromMapProperties(&d);
-		// clear the under construction status
-		bldg->clearStatus( MAKE_OBJECT_STATUS_MASK2( OBJECT_STATUS_UNDER_CONSTRUCTION, OBJECT_STATUS_RECONSTRUCTING ) );
+
+		bldg->onConstructionCompleted();
 
 		// UnderConstruction just cleared, so update our upgrades
 		bldg->updateUpgradeModules();
@@ -470,8 +470,7 @@ Object *AIPlayer::buildStructureNow(const ThingTemplate *bldgPlan, BuildListInfo
 		info->setObjectID( bldg->getID() );
 		info->setObjectTimestamp( TheGameLogic->getFrame()+1 );	// has to be non-zero, so just add 1.
 
-		// clear the under construction status
-		bldg->clearStatus( MAKE_OBJECT_STATUS_MASK2( OBJECT_STATUS_UNDER_CONSTRUCTION, OBJECT_STATUS_RECONSTRUCTING ) );
+		bldg->onConstructionCompleted();
 
 		// UnderConstruction just cleared, so update our upgrades
 		bldg->updateUpgradeModules();

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

@@ -4505,6 +4505,35 @@ void Object::removeUpgrade( const UpgradeTemplate *upgradeT )
 	}
 }
 
+void Object::onConstructionCompleted()
+{
+	if (!testStatus(OBJECT_STATUS_UNDER_CONSTRUCTION))
+	{
+		// Was already signaled completed.
+		DEBUG_ASSERTCRASH(!testStatus(OBJECT_STATUS_RECONSTRUCTING), ("Unexpected status"));
+		return;
+	}
+
+	DEBUG_ASSERTCRASH(
+		getConstructionPercent() == (Real)CONSTRUCTION_COMPLETE ||
+		getConstructionPercent() >= 100.0f,
+		("Is the construction really completed yet?"));
+
+	// clear the under construction status
+	clearStatus(MAKE_OBJECT_STATUS_MASK2(
+		OBJECT_STATUS_UNDER_CONSTRUCTION,
+		OBJECT_STATUS_RECONSTRUCTING
+	));
+
+	// tell all special powers that the construction has completed
+	for(BehaviorModule** m = getBehaviorModules(); *m; ++m)
+	{
+		SpecialPowerModuleInterface* sp = (*m)->getSpecialPower();
+		if (sp)
+			sp->onConstructionCompleted();
+	}
+}
+
 //-------------------------------------------------------------------------------------------------
 /** Central point for onCapture logic */
 //-------------------------------------------------------------------------------------------------

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

@@ -96,11 +96,7 @@ SpecialPowerModule::SpecialPowerModule( Thing *thing, const ModuleData *moduleDa
 									: BehaviorModule( thing, moduleData )
 {
 
-#if RETAIL_COMPATIBLE_CRC
 	m_availableOnFrame = 0;
-#else
-	m_availableOnFrame = 0xFFFFFFFF;
-#endif
 	m_pausedCount = 0;
 	m_pausedOnFrame = 0;
 	m_pausedPercent = 0.0f;
@@ -110,16 +106,37 @@ SpecialPowerModule::SpecialPowerModule( Thing *thing, const ModuleData *moduleDa
 	// if we're pre-built, start counting down
 	if( !getObject()->getStatusBits().test( OBJECT_STATUS_UNDER_CONSTRUCTION ) )
 	{
-		//A sharedNSync special only startPowerRecharges when first scienced or when executed,
-		//Since a new modue with same SPTemplates may construct at any time.
-		if ( getSpecialPowerTemplate()->isSharedNSync() == FALSE )
-			startPowerRecharge();
+		init();
+	}
+	else
+	{
+#if RETAIL_COMPATIBLE_CRC
+		initCountdown();
+#else
+		// The Special Power will not be available until construction is done.
+		m_availableOnFrame = UINT_MAX;
+#endif
 	}
+
+}  // end SpecialPowerModule
+
+void SpecialPowerModule::init()
+{
+	//A sharedNSync special only startPowerRecharges when first scienced or when executed,
+	//Since a new module with same SPTemplates may construct at any time.
+	if ( getSpecialPowerTemplate()->isSharedNSync() == FALSE )
+		startPowerRecharge();
+
+	initCountdown();
+}
+
+void SpecialPowerModule::initCountdown()
+{
 	// WE USED TO DO THE POLL-EVERYBODY-AND-VOTE-ON-WHO-TO-SYNC-TO THING HERE,
 	// BUT NO MORE, NOW IT IS HANDLED IN PLAYER
 
 	// Some Special powers need to be activated by an Upgrade, so prevent the timer from going until then
-	const SpecialPowerModuleData *md = (const SpecialPowerModuleData *)moduleData;
+	const SpecialPowerModuleData *md = getSpecialPowerModuleData();
 	if( md->m_startsPaused )
 		pauseCountdown( TRUE );
 
@@ -140,9 +157,7 @@ SpecialPowerModule::SpecialPowerModule( Thing *thing, const ModuleData *moduleDa
 																 getObject()->getID(),
 																 getSpecialPowerModuleData()->m_specialPowerTemplate );
 	}
-
-
-}  // end SpecialPowerModule
+}
 
 //-------------------------------------------------------------------------------------------------
 const AudioEventRTS& SpecialPowerModule::getInitiateSound() const
@@ -380,6 +395,17 @@ Bool SpecialPowerModule::isScriptOnly() const
 	return modData->m_scriptedSpecialPowerOnly;
 }
 
+//-------------------------------------------------------------------------------------------------
+void SpecialPowerModule::onConstructionCompleted()
+{
+#if !RETAIL_COMPATIBLE_CRC
+	DEBUG_ASSERTCRASH(m_availableOnFrame == UINT_MAX,
+		("Unexpected state. Function must be called only after OBJECT_STATUS_UNDER_CONSTRUCTION was completed"));
+
+	m_availableOnFrame = 0;
+	init();
+#endif
+}
 
 //-------------------------------------------------------------------------------------------------
 /** A special power has been used ... start the recharge process by computing the frame

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AIUpdate/DozerAIUpdate.cpp

@@ -555,9 +555,7 @@ StateReturnType DozerActionDoActionState::update( void )
 				if( goalObject->getConstructionPercent() >= 100.0f )
 				{
 
-					// clear the under construction status
-					goalObject->clearStatus( MAKE_OBJECT_STATUS_MASK( OBJECT_STATUS_UNDER_CONSTRUCTION ) );
-					goalObject->clearStatus( MAKE_OBJECT_STATUS_MASK( OBJECT_STATUS_RECONSTRUCTING ) );
+					goalObject->onConstructionCompleted();
 
 					// stop playing the construction sound!
 					dozerAI->finishBuildingSound();