refactor(module): Improve and simplify the implementation of HordeUpdate and related code (#1582)

Author: xezon

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

@@ -309,8 +309,8 @@ class Player : public Snapshot
 	/// return t iff the player has all sciences that are prereqs for knowing the given science
 	Bool hasPrereqsForScience(ScienceType t) const;
 
-	Bool hasUpgradeComplete( const UpgradeTemplate *upgradeTemplate );		///< does player have totally done and produced upgrade
-	Bool hasUpgradeComplete( UpgradeMaskType testMask );		///< does player have totally done and produced upgrade
+	Bool hasUpgradeComplete( const UpgradeTemplate *upgradeTemplate ) const;		///< does player have totally done and produced upgrade
+	Bool hasUpgradeComplete( UpgradeMaskType testMask ) const;		///< does player have totally done and produced upgrade
 	UpgradeMaskType getCompletedUpgradeMask() const { return m_upgradesCompleted; }	///< get list of upgrades that are completed
 	Bool hasUpgradeInProduction( const UpgradeTemplate *upgradeTemplate );		///< does player have this upgrade in progress right now
 	Upgrade *addUpgrade( const UpgradeTemplate *upgradeTemplate,

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

@@ -57,6 +57,7 @@ class AssaultTransportAIInterface;
 class JetAIUpdate;
 
 enum AIStateType CPP_11(: Int);
+enum HordeActionType CPP_11(: Int);
 enum ObjectID CPP_11(: Int);
 
 
@@ -560,7 +561,10 @@ class AIUpdateInterface : public UpdateModule, public AICommandInterface
 	void setAttitude( AttitudeType tude );	///< set the behavior modifier for this agent
 
 	// Common AI "status" effects -------------------------------------------------------------------
-	void evaluateMoraleBonus( void );
+	Bool hasNationalism() const;
+	Bool hasFanaticism() const;
+	void evaluateMoraleBonus( Bool inHorde, Bool allowNationalism, HordeActionType type );
+	void evaluateNationalismBonusClassic( Bool inHorde, Bool allowNationalism );
 
 #ifdef ALLOW_DEMORALIZE
 	// demoralization ... what a nifty word to write.

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

@@ -62,15 +62,15 @@ class HordeUpdateModuleData : public ModuleData
 {
 public:
   UnsignedInt								m_updateRate;   ///< how often to recheck our horde status
-	KindOfMaskType						m_kindof;				///< the kind(s) of units that count towards horde-ness
+	KindOfMaskType						m_kindof;				///< the kind(s) of units that count towards hordeness
 	Int												m_minCount;		  ///< min count to get "horde" status
-  Real											m_minDist;      ///< min dist to contribute to horde-ness
+  Real											m_minDist;      ///< min dist to contribute to hordeness
 	Bool											m_alliesOnly;		///< if true, only allied units count towards hordeness
 	Bool											m_exactMatch;		///< if true, only exact same type of units count towards hordeness
 	Real											m_rubOffRadius;///< If I am this close to another guy who is a true hordesman, it'll rub off on me
-	HordeActionType						m_action;				///< what to do if we get horde-ness
-	Bool											m_allowedNationalism; ///< Nationalism is hard ocded.  Yeah!  Add to the goodness with this flag instead of rewriting after Alpha.
-	std::vector<AsciiString>	m_flagSubObjNames;		///< name(s) of the flag subobj
+	HordeActionType						m_action;				///< what to do if we get hordeness
+	Bool											m_allowedNationalism; ///< Nationalism is hard coded.  Yeah!  Add to the goodness with this flag instead of rewriting after Alpha.
+	std::vector<AsciiString>	m_flagSubObjNames;		///< name(s) of the flag sub obj
 
 	HordeUpdateModuleData();
 	static void buildFieldParse(MultiIniFieldParse& p);
@@ -87,7 +87,7 @@ class HordeUpdateInterface
 	virtual Bool hasFlag() const = 0;
 	virtual Bool isTrueHordeMember() const = 0;
 	virtual Bool isAllowedNationalism() const = 0;
-
+	virtual HordeActionType getHordeActionType() const = 0;
 };
 
 //-------------------------------------------------------------------------------------------------
@@ -104,11 +104,13 @@ class HordeUpdate : public UpdateModule, public HordeUpdateInterface
 	HordeUpdateInterface *getHordeUpdateInterface() { return this; }
 
 	virtual void onDrawableBoundToObject();
+	virtual UpdateSleepTime update();	///< update this object's AI
+
 	virtual Bool isInHorde() const { return m_inHorde; }
+	virtual Bool hasFlag() const { return m_hasFlag; }
 	virtual Bool isTrueHordeMember() const { return m_trueHordeMember && m_inHorde; }
 	virtual Bool isAllowedNationalism() const;
-	virtual Bool hasFlag() const { return m_hasFlag; }
-	virtual UpdateSleepTime update();	///< update this object's AI
+	virtual HordeActionType getHordeActionType() const { return getHordeUpdateModuleData()->m_action; };
 
 protected:
 
@@ -117,8 +119,8 @@ class HordeUpdate : public UpdateModule, public HordeUpdateInterface
 
 private:
 	UnsignedInt m_lastHordeRefreshFrame; //Just like it sounds
-	Bool				m_inHorde;				 //I amy be a trueMember, or I may merely inherit hordehood from a neighbor who is
-	Bool				m_trueHordeMember; //meaning, I have enough hordesman near me to qualify
+	Bool				m_inHorde;				 //I may be a true member, or I may merely inherit hordehood from a neighbor who is
+	Bool				m_trueHordeMember; //meaning, I have enough hordesmen near me to qualify
 	Bool				m_hasFlag;
 
 };

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

@@ -2990,7 +2990,7 @@ Upgrade *Player::findUpgrade( const UpgradeTemplate *upgradeTemplate )
 //=================================================================================================
 /** Does the player have this completed upgrade */
 //=================================================================================================
-Bool Player::hasUpgradeComplete( const UpgradeTemplate *upgradeTemplate )
+Bool Player::hasUpgradeComplete( const UpgradeTemplate *upgradeTemplate ) const
 {
 	UpgradeMaskType testMask = upgradeTemplate->getUpgradeMask();
 	return hasUpgradeComplete( testMask );
@@ -3001,7 +3001,7 @@ Bool Player::hasUpgradeComplete( const UpgradeTemplate *upgradeTemplate )
 	Does the player have this completed upgrade.  This form is exposed so Objects can do quick lookups.
 */
 //=================================================================================================
-Bool Player::hasUpgradeComplete( UpgradeMaskType testMask )
+Bool Player::hasUpgradeComplete( UpgradeMaskType testMask ) const
 {
 	return m_upgradesCompleted.testForAll( testMask );
 }

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

@@ -4678,121 +4678,114 @@ setTmpValue(now);
 
 // ------------------------------------------------------------------------------------------------
 // ------------------------------------------------------------------------------------------------
-void AIUpdateInterface::evaluateMoraleBonus( void )
+Bool AIUpdateInterface::hasNationalism() const
 {
-	Object *us = getObject();
-#ifdef ALLOW_DEMORALIZE
-	Bool demoralized = isDemoralized();
-#endif
-	Bool horde = FALSE;
-	Bool nationalism = FALSE;
-	Bool fanaticism = FALSE;
-
-	// do we have nationalism
-	///@todo Find a better way to represent nationalism without hardcoding here (CBD)
-	static const UpgradeTemplate *nationalismTemplate = TheUpgradeCenter->findUpgrade( "Upgrade_Nationalism" );
-	DEBUG_ASSERTCRASH( nationalismTemplate != NULL, ("AIUpdateInterface::evaluateMoraleBonus - Nationalism upgrade not found") );
-	Player *player = us->getControllingPlayer();
-	if( player && player->hasUpgradeComplete( nationalismTemplate ) )
-		nationalism = TRUE;
-
-	// do we have fanaticism
-	///@todo Find a better way to represent fanaticism without hardcoding here (MAL)
-	static const UpgradeTemplate *fanaticismTemplate = TheUpgradeCenter->findUpgrade( "Upgrade_Fanaticism" );
-	DEBUG_ASSERTCRASH( fanaticismTemplate != NULL, ("AIUpdateInterface::evaluateMoraleBonus - Fanaticism upgrade not found") );
-	if( player && player->hasUpgradeComplete( fanaticismTemplate ) )
-		fanaticism = TRUE;
-
-	// are we in a horde
-	HordeUpdateInterface *hui;
-	for( BehaviorModule** u = us->getBehaviorModules(); *u; ++u )
-	{
-
-		hui = (*u)->getHordeUpdateInterface();
-		if( hui && hui->isInHorde() )
-		{
-			horde = TRUE;
-
-			if( !hui->isAllowedNationalism() )
-			{
-				// Sorry CBD and MAL, but the cancer has spread to the lymph nodes.  After Alpha, just pump full of painkillers.
-				nationalism = FALSE;
-				fanaticism = FALSE;
-			}
-		}
+	if (const Player *player = getObject()->getControllingPlayer())
+	{
+		///@todo Find a better way to represent nationalism without hard coding here (CBD)
+		static const UpgradeTemplate *nationalismTemplate = TheUpgradeCenter->findUpgrade( "Upgrade_Nationalism" );
+		DEBUG_ASSERTCRASH( nationalismTemplate != NULL, ("AIUpdateInterface::evaluateMoraleBonusImpl - Nationalism upgrade not found") );
+		return player->hasUpgradeComplete( nationalismTemplate );
+	}
+	return false;
+}
 
+// ------------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------------
+Bool AIUpdateInterface::hasFanaticism() const
+{
+	if (const Player *player = getObject()->getControllingPlayer())
+	{
+		///@todo Find a better way to represent fanaticism without hard coding here (MAL)
+		static const UpgradeTemplate *fanaticismTemplate = TheUpgradeCenter->findUpgrade( "Upgrade_Fanaticism" );
+		DEBUG_ASSERTCRASH( fanaticismTemplate != NULL, ("AIUpdateInterface::evaluateMoraleBonusImpl - Fanaticism upgrade not found") );
+		return player->hasUpgradeComplete( fanaticismTemplate );
 	}
+	return false;
+}
 
+// ------------------------------------------------------------------------------------------------
+// TheSuperHackers @refactor The implementation has been improved and simplified.
+// ------------------------------------------------------------------------------------------------
+void AIUpdateInterface::evaluateMoraleBonus( Bool inHorde, Bool allowNationalism, HordeActionType type )
+{
 #ifdef ALLOW_DEMORALIZE
-	// if we are are not demoralized we can have horde and nationalism effects
-	if( demoralized == FALSE )
-#endif
+
+	// if we are demoralized, then we can not have horde and nationalism effects
+	if( isDemoralized() )
 	{
+		Object *us = getObject();
 
-#ifdef ALLOW_DEMORALIZE
 		// demoralized
-		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_DEMORALIZED );
-#endif
+		us->setWeaponBonusCondition( WEAPONBONUSCONDITION_DEMORALIZED );
 
-		//Lorenzen temporarily disabled, since it fights with the horde buff
-		//Drawable *draw = us->getDrawable();
-		//if ( draw && !us->isKindOf( KINDOF_PORTABLE_STRUCTURE ) )
-		//	draw->setTerrainDecal(TERRAIN_DECAL_NONE);
+		// we cannot have horde bonuses
+		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
+		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
 
-		// horde
-		if( horde )
+		Drawable *draw = us->getDrawable();
+		if( draw && !us->isKindOf( KINDOF_PORTABLE_STRUCTURE ) )
 		{
-			us->setWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
-
+			draw->setTerrainDecal(TERRAIN_DECAL_DEMORALIZED);
 		}
-		else
-			us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
-
-		// nationalism
-		if( nationalism )
-    {
-			us->setWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
-      // fanaticism
-      if ( fanaticism )
-        us->setWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );// FOR THE NEW GC INFANTRY GENERAL
-      else
-        us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
-    }
-		else
-			us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
 
+		return;
+	}
+
+	// demoralized
+	us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_DEMORALIZED );
+
+#endif // ALLOW_DEMORALIZE
+
+	//Lorenzen temporarily disabled, since it fights with the horde buff
+	//Object *us = getObject();
+	//Drawable *draw = us->getDrawable();
+	//if ( draw && !us->isKindOf( KINDOF_PORTABLE_STRUCTURE ) )
+	//	draw->setTerrainDecal(TERRAIN_DECAL_NONE);
 
+	switch (type)
+	{
+	case HORDEACTION_HORDE:
+		evaluateNationalismBonusClassic(inHorde, allowNationalism);
+		break;
+	}
+}
+
+// ------------------------------------------------------------------------------------------------
+// TheSuperHackers @info The classic Nationalism Bonus implementation.
+// Is not great, because Nationalism and Fanaticism bonuses are not disabled when leaving the horde.
+// ------------------------------------------------------------------------------------------------
+void AIUpdateInterface::evaluateNationalismBonusClassic( Bool inHorde, Bool allowNationalism )
+{
+	Object *us = getObject();
 
+	if( inHorde )
+	{
+		us->setWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
 	}
-#ifdef ALLOW_DEMORALIZE
 	else
 	{
+		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+	}
 
-		// demoralized
-		us->setWeaponBonusCondition( WEAPONBONUSCONDITION_DEMORALIZED );
+	if( allowNationalism && hasNationalism() )
+	{
+		us->setWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
 
-		// we cannot have horde bonus condition
-		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
-		Drawable *draw = us->getDrawable();
-		if( draw && !us->isKindOf( KINDOF_PORTABLE_STRUCTURE ) )
+		if ( hasFanaticism() )
 		{
-			draw->setTerrainDecal(TERRAIN_DECAL_DEMORALIZED);
+			us->setWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
 		}
-
-		// we cannot have nationalism bonus condition
+		else
+		{
+			us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
+		}
+	}
+	else
+	{
 		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
-    us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
-
 	}
-#endif
-
-/*
-	UnicodeString msg;
-	msg.format( L"'%S' Horde=%d,Nationalism=%d,Demoralized=%d",
-							us->getTemplate()->getName().str(), horde, nationalism, demoralized );
-	TheInGameUI->message( msg );
-*/
-
 }
 
 #ifdef ALLOW_DEMORALIZE
@@ -4809,12 +4802,16 @@ void AIUpdateInterface::setDemoralized( UnsignedInt durationInFrames )
 	if( (prevDemoralizedFrames == 0 && m_demoralizedFramesLeft > 0) ||
 			(prevDemoralizedFrames > 0 && m_demoralizedFramesLeft == 0) )
 	{
-
 		// evaluate demoralization, nationalism, and horde effect as they are all intertwined
-		evaluateMoraleBonus();
-
+		Object *us = getObject();
+		for( BehaviorModule** u = us->getBehaviorModules(); *u; ++u )
+		{
+			if ( HordeUpdateInterface *hui = (*u)->getHordeUpdateInterface() )
+			{
+				evaluateMoraleBonus( hui->isInHorde(), hui->isAllowedNationalism(), hui->getHordeActionType() );
+			}
+		}
 	}
-
 }
 #endif