bugfix(module): Fix missing horde condition of Nationalism and Fanaticism weapon bonuses

This fix is opt-in by setting Action=HORDE_FIXED in HordeUpdate behavior modules

Author: xezon

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

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

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

@@ -44,17 +44,33 @@ class UpgradeTemplate;
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
 
+// TheSuperHackers @bugfix Adds the new HORDEACTION_HORDE_FIXED type.
+// 
+// TheSuperHackers @todo If we want more control over the horde setup, then we need to implement
+// filters for separate weapon bonuses and required upgrades. But adding more behavior modules will
+// be a performance concern. Example INI setup:
+//
+// Behavior = HordeUpdate ModuleTag
+//   Action = NATIONALISM
+//   ;ApplyWeaponBonus = NATIONALISM
+//   UpgradeRequired = Upgrade_Nationalism
+// End
+//
 enum HordeActionType CPP_11(: Int)
 {
-	HORDEACTION_HORDE = 0,
+	HORDEACTION_HORDE, ///< Classic action, applies the Horde bonus correctly, but Nationalism and Fanaticism bonuses are not removed after leaving horde.
+	HORDEACTION_HORDE_FIXED, ///< Applies the Horde, Nationalism and Fanaticism bonuses correctly.
 
-	HORDEACTION_COUNT
+	HORDEACTION_COUNT,
+	HORDEACTION_DEFAULT = HORDEACTION_HORDE_FIXED, ///< Uses the fixed horde action by default. This is retail compatible, because all modules explicitly set Action = HORDE.
 };
 
 #ifdef DEFINE_HORDEACTION_NAMES
 static const char *TheHordeActionTypeNames[] =
 {
 	"HORDE",
+	"HORDE_FIXED",
+
 	NULL
 };
 #endif
@@ -89,7 +105,7 @@ class HordeUpdateInterface
 	virtual Bool hasFlag() const = 0;
 	virtual Bool isTrueHordeMember() const = 0;
 	virtual Bool isAllowedNationalism() const = 0;
-
+	virtual HordeActionType getHordeActionType() const = 0;
 };
 
 //-------------------------------------------------------------------------------------------------
@@ -107,9 +123,10 @@ class HordeUpdate : public UpdateModule, public HordeUpdateInterface
 
 	virtual void onDrawableBoundToObject();
 	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 HordeActionType getHordeActionType() const { return getHordeUpdateModuleData()->m_action; };
 	virtual UpdateSleepTime update();	///< update this object's AI
 
 protected:
@@ -119,8 +136,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/GameLogic/Object/Update/AIUpdate.cpp

@@ -4678,56 +4678,39 @@ setTmpValue(now);
 
 // ------------------------------------------------------------------------------------------------
 // ------------------------------------------------------------------------------------------------
-void AIUpdateInterface::evaluateMoraleBonus( void )
+void AIUpdateInterface::evaluateMoraleBonusImpl( Bool inHorde, Bool allowNationalism, Bool classicImplementation )
 {
 	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;
-			}
-		}
-
-	}
 
 #ifdef ALLOW_DEMORALIZE
 	// if we are are not demoralized we can have horde and nationalism effects
-	if( demoralized == FALSE )
+	if( !isDemoralized() )
 #endif
 	{
+		Player *player = us->getControllingPlayer();
+
+		Bool nationalism;
+		Bool fanaticism;
+
+		if (player && allowNationalism)
+		{
+			// do we have nationalism
+			///@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") );
+			nationalism = player->hasUpgradeComplete( nationalismTemplate );
+
+			// do we have fanaticism
+			///@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") );
+			fanaticism = player->hasUpgradeComplete( fanaticismTemplate );
+		}
+		else
+		{
+			nationalism = FALSE;
+			fanaticism = FALSE;
+		}
 
 #ifdef ALLOW_DEMORALIZE
 		// demoralized
@@ -4739,29 +4722,61 @@ void AIUpdateInterface::evaluateMoraleBonus( void )
 		//if ( draw && !us->isKindOf( KINDOF_PORTABLE_STRUCTURE ) )
 		//	draw->setTerrainDecal(TERRAIN_DECAL_NONE);
 
-		// horde
-		if( horde )
+		if (classicImplementation)
 		{
-			us->setWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+			// TheSuperHackers @info The classic implementation.
+			// Is not great, because Nationalism and Fanaticism bonuses are not disabled when leaving the horde.
 
+			if( inHorde )
+			{
+				us->setWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+			}
+			else
+			{
+				us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+			}
+
+			if( nationalism )
+			{
+				us->setWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
+
+				if ( fanaticism )
+					us->setWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
+				else
+					us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
+			}
+			else
+			{
+				us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
+			}
 		}
 		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 );
+		{
+			// TheSuperHackers @bugfix The fixed implementation.
+			// Nationalism and Fanaticism are now tied to the horde status.
+			// And Fanaticism is no longer dependent on Nationalism.
 
+			if( inHorde )
+			{
+				us->setWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+
+				if( nationalism )
+				{
+					us->setWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
+				}
 
+				if( fanaticism )
+				{
+					us->setWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
+				}
+			}
+			else
+			{
+				us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+				us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
+				us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
+			}
+		}
 
 	}
 #ifdef ALLOW_DEMORALIZE
@@ -4771,28 +4786,37 @@ void AIUpdateInterface::evaluateMoraleBonus( void )
 		// demoralized
 		us->setWeaponBonusCondition( WEAPONBONUSCONDITION_DEMORALIZED );
 
-		// we cannot have horde bonus condition
+		// we cannot have horde bonuses
 		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_HORDE );
+		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_NATIONALISM );
+		us->clearWeaponBonusCondition( WEAPONBONUSCONDITION_FANATICISM );
+
 		Drawable *draw = us->getDrawable();
 		if( draw && !us->isKindOf( KINDOF_PORTABLE_STRUCTURE ) )
 		{
 			draw->setTerrainDecal(TERRAIN_DECAL_DEMORALIZED);
 		}
 
-		// we cannot have nationalism bonus condition
-		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 );
-*/
+}
+
+// ------------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------------
+void AIUpdateInterface::evaluateMoraleBonus( Bool inHorde, Bool allowNationalism, HordeActionType type )
+{
+	switch (type)
+	{
+	case HORDEACTION_HORDE:
+		evaluateMoraleBonusImpl(inHorde, allowNationalism, TRUE);
+		break;
 
+	default:
+	case HORDEACTION_HORDE_FIXED:
+		evaluateMoraleBonusImpl(inHorde, allowNationalism, FALSE);
+		break;
+	}
 }
 
 #ifdef ALLOW_DEMORALIZE
@@ -4809,12 +4833,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