feat(gui): Implement money per minute display for local player (#1481)

Is disabled by default and can be enabled by setting ShowMoneyPerMinute=yes in Options.ini

Author: L3-M

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

@@ -408,6 +408,9 @@ class GlobalData : public SubsystemInterface
 	Int m_systemTimeFontSize;
 	Int m_gameTimeFontSize;
 
+	// TheSuperHackers @feature L3-M 21/08/2025 toggle the money per minute display, false shows only the original current money
+	Bool m_showMoneyPerMinute;
+
 	Real m_shakeSubtleIntensity;			///< Intensity for shaking a camera with SHAKE_SUBTLE
 	Real m_shakeNormalIntensity;			///< Intensity for shaking a camera with SHAKE_NORMAL
 	Real m_shakeStrongIntensity;			///< Intensity for shaking a camera with SHAKE_STRONG

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

@@ -61,13 +61,14 @@ class Money : public Snapshot
 
 public:
 
-	inline Money() : m_money(0), m_playerIndex(0)
+	inline Money() : m_playerIndex(0)
 	{
+		init();
 	}
 
 	void init()
 	{
-		m_money = 0;
+		setStartingCash(0);
 	}
 
 	inline UnsignedInt countMoney() const
@@ -77,7 +78,11 @@ class Money : public Snapshot
 
 	/// returns the actual amount withdrawn, which may be less than you want. (sorry, can't go into debt...)
 	UnsignedInt withdraw(UnsignedInt amountToWithdraw, Bool playSound = TRUE);
-	void deposit(UnsignedInt amountToDeposit, Bool playSound = TRUE);
+	void deposit(UnsignedInt amountToDeposit, Bool playSound = TRUE, Bool trackIncome = TRUE);
+
+	void setStartingCash(UnsignedInt amount);
+	void updateIncomeBucket();
+	UnsignedInt getCashPerMinute() const;
 
 	void setPlayerIndex(Int ndx) { m_playerIndex = ndx; }
 
@@ -102,4 +107,7 @@ class Money : public Snapshot
 
 	UnsignedInt m_money;	///< amount of money
 	Int m_playerIndex;	///< what is my player index?
+	UnsignedInt m_incomeBuckets[60];	///< circular buffer of 60 seconds for income tracking
+	UnsignedInt m_currentBucket;
+	UnsignedInt m_cashPerMinute;
 };

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

@@ -70,6 +70,7 @@ enum DrawableID CPP_11(: Int);
 #include <Utility/hash_map_adapter.h>
 #include <list>
 #include <map>
+#include <numeric>
 #include <queue>
 #include <set>
 #include <stack>

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

@@ -145,6 +145,8 @@ class OptionPreferences : public UserPreferences
 	Int getGameTimeFontSize(void);
 
 	Real getResolutionFontAdjustment(void);
+
+	Bool getShowMoneyPerMinute(void) const;
 };
 
 //-----------------------------------------------------------------------------

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -939,6 +939,8 @@ GlobalData::GlobalData()
 	m_systemTimeFontSize = 8;
 	m_gameTimeFontSize = 8;
 
+	m_showMoneyPerMinute = FALSE;
+
 	m_debugShowGraphicalFramerate = FALSE;
 
 	// By default, show all asserts.
@@ -1192,6 +1194,7 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 	TheWritableGlobalData->m_renderFpsFontSize = optionPref.getRenderFpsFontSize();
 	TheWritableGlobalData->m_systemTimeFontSize = optionPref.getSystemTimeFontSize();
 	TheWritableGlobalData->m_gameTimeFontSize = optionPref.getGameTimeFontSize();
+	TheWritableGlobalData->m_showMoneyPerMinute = optionPref.getShowMoneyPerMinute();
 
 	Int val=optionPref.getGammaValue();
 	//generate a value between 0.6 and 2.0.

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

@@ -51,6 +51,7 @@
 #include "Common/Player.h"
 #include "Common/PlayerList.h"
 #include "Common/Xfer.h"
+#include "GameLogic/GameLogic.h"
 
 // ------------------------------------------------------------------------------------------------
 UnsignedInt Money::withdraw(UnsignedInt amountToWithdraw, Bool playSound)
@@ -78,7 +79,7 @@ UnsignedInt Money::withdraw(UnsignedInt amountToWithdraw, Bool playSound)
 }
 
 // ------------------------------------------------------------------------------------------------
-void Money::deposit(UnsignedInt amountToDeposit, Bool playSound)
+void Money::deposit(UnsignedInt amountToDeposit, Bool playSound, Bool trackIncome)
 {
 	if (amountToDeposit == 0)
 		return;
@@ -88,9 +89,43 @@ void Money::deposit(UnsignedInt amountToDeposit, Bool playSound)
 		triggerAudioEvent(TheAudio->getMiscAudio()->m_moneyDepositSound);
 	}
 
+	if (trackIncome)
+	{
+		m_incomeBuckets[m_currentBucket] += amountToDeposit;
+		m_cashPerMinute += amountToDeposit;
+	}
+
 	m_money += amountToDeposit;
 }
 
+// ------------------------------------------------------------------------------------------------
+void Money::setStartingCash(UnsignedInt amount)
+{
+	m_money = amount;
+	std::fill(m_incomeBuckets, m_incomeBuckets + ARRAY_SIZE(m_incomeBuckets), 0u);
+	m_currentBucket = 0u;
+	m_cashPerMinute = 0u;
+}
+
+// ------------------------------------------------------------------------------------------------
+void Money::updateIncomeBucket()
+{
+	UnsignedInt frame = TheGameLogic->getFrame();
+	UnsignedInt nextBucket = (frame / LOGICFRAMES_PER_SECOND) % ARRAY_SIZE(m_incomeBuckets);
+	if (nextBucket != m_currentBucket)
+	{
+		m_cashPerMinute -= m_incomeBuckets[nextBucket];
+		m_currentBucket = nextBucket;
+		m_incomeBuckets[m_currentBucket] = 0u;
+	}
+}
+
+// ------------------------------------------------------------------------------------------------
+UnsignedInt Money::getCashPerMinute() const
+{
+	return m_cashPerMinute;
+}
+
 void Money::triggerAudioEvent(const AudioEventRTS& audioEvent)
 {
 	Real volume = TheAudio->getAudioSettings()->m_preferredMoneyTransactionVolume;
@@ -116,19 +151,35 @@ void Money::crc( Xfer *xfer )
 // ------------------------------------------------------------------------------------------------
 /** Xfer method
 	* Version Info:
-	* 1: Initial version */
+	* 1: Initial version
+	* 2: Add saveload support for the cash per minute income tracking */
 // ------------------------------------------------------------------------------------------------
 void Money::xfer( Xfer *xfer )
 {
 
 	// version
+#if RETAIL_COMPATIBLE_XFER_SAVE
 	XferVersion currentVersion = 1;
+#else
+	XferVersion currentVersion = 2;
+#endif
 	XferVersion version = currentVersion;
 	xfer->xferVersion( &version, currentVersion );
 
 	// money value
 	xfer->xferUnsignedInt( &m_money );
 
+	if (version <= 1)
+	{
+		setStartingCash(m_money);
+	}
+	else
+	{
+		xfer->xferUser(m_incomeBuckets, sizeof(m_incomeBuckets));
+		xfer->xferUnsignedInt(&m_currentBucket);
+
+		m_cashPerMinute = std::accumulate(m_incomeBuckets, m_incomeBuckets + ARRAY_SIZE(m_incomeBuckets), 0u);
+	}
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -147,5 +198,7 @@ void Money::parseMoneyAmount( INI *ini, void *instance, void *store, const void*
 {
   // Someday, maybe, have mulitple fields like Gold:10000 Wood:1000 Tiberian:10
   Money * money = (Money *)store;
-  INI::parseUnsignedInt( ini, instance, &money->m_money, userData );
+	UnsignedInt moneyAmount;
+	INI::parseUnsignedInt( ini, instance, &moneyAmount, userData );
+	money->setStartingCash(moneyAmount);
 }

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

@@ -434,11 +434,11 @@ void Player::init(const PlayerTemplate* pt)
 			// Note that copying the entire Money class instead would also copy the player index inside of it.
 			if ( TheGameInfo )
 			{
-				m_money.deposit( TheGameInfo->getStartingCash().countMoney(), FALSE );
+				m_money.deposit( TheGameInfo->getStartingCash().countMoney(), FALSE, FALSE );
 			}
 			else
 			{
-				m_money.deposit( TheGlobalData->m_defaultStartingCash.countMoney(), FALSE );
+				m_money.deposit( TheGlobalData->m_defaultStartingCash.countMoney(), FALSE, FALSE );
 			}
 		}
 
@@ -1771,7 +1771,7 @@ void Player::transferAssetsFromThat(Player *that)
 	// transfer all his money
 	UnsignedInt allMoney = that->getMoney()->countMoney();
 	that->getMoney()->withdraw(allMoney);
-	getMoney()->deposit(allMoney);
+	getMoney()->deposit(allMoney, TRUE, FALSE);
 }
 
 //=============================================================================

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

@@ -171,7 +171,7 @@ AsciiString PlayerTemplate::getStartingUnit( Int i ) const
 	// assign the money into the 'Money' (m_money) pointed to at 'store'
 	Money *theMoney = (Money *)store;
 	theMoney->init();
-	theMoney->deposit( money );
+	theMoney->setStartingCash(money);
 
 }
 

Generals/Code/GameEngine/Source/Common/System/BuildAssistant.cpp

@@ -250,7 +250,7 @@ void BuildAssistant::update( void )
 					sellValue = REAL_TO_UNSIGNEDINT( obj->getTemplate()->calcCostToBuild( player ) *
 																										 TheGlobalData->m_sellPercentage );
 
-				player->getMoney()->deposit( sellValue );
+				player->getMoney()->deposit( sellValue, TRUE, FALSE );
 				// this money shouldn't be scored since it wasn't really "earned."
 //				player->getScoreKeeper()->addMoneyEarned( sellValue );
 

Generals/Code/GameEngine/Source/Common/UserPreferences.cpp

@@ -700,7 +700,7 @@ Money CustomMatchPreferences::getStartingCash(void) const
   }
 
   Money money;
-  money.deposit( strtoul( it->second.str(), NULL, 10 ), FALSE  );
+  money.deposit( strtoul( it->second.str(), NULL, 10 ), FALSE, FALSE );
 
   return money;
 }