feat(audio): Implement 'MoneyTransactionVolume' option to modify the volume of money deposit and withdraw audio events

Core/GameEngine/Include/Common/AudioSettings.h

@@ -35,8 +35,19 @@
 
 enum { MAX_HW_PROVIDERS = 4 };
 
+// TheSuperHackers @tweak xezon 23/07/2025 Adds setting to modify the volume of money deposit and withdraw sounds
+
 struct AudioSettings
 {
+	AudioSettings()
+#if RTS_GENERALS
+		: m_defaultMoneyTransactionVolume(1.0f)
+#elif RTS_ZEROHOUR
+		: m_defaultMoneyTransactionVolume(0.0f) // Uses zero volume by default because originally the money sounds did not work in Zero Hour
+#endif
+	{
+	}
+
 	AsciiString m_audioRoot;
 	AsciiString m_soundsFolder;
 	AsciiString m_musicFolder;
@@ -66,6 +77,7 @@ struct AudioSettings
 	Real m_default3DSoundVolume;
 	Real m_defaultSpeechVolume;
 	Real m_defaultMusicVolume;
+	Real m_defaultMoneyTransactionVolume;
 	UnsignedInt m_defaultSpeakerType2D;
 	UnsignedInt m_defaultSpeakerType3D;
 
@@ -74,6 +86,7 @@ struct AudioSettings
 	Real m_preferred3DSoundVolume;
 	Real m_preferredSpeechVolume;
 	Real m_preferredMusicVolume;
+	Real m_preferredMoneyTransactionVolume;
 
 	//The desired altitude of the microphone to improve panning relative to terrain.
 	Real m_microphoneDesiredHeightAboveTerrain;

Core/GameEngine/Source/Common/Audio/GameAudio.cpp

@@ -126,6 +126,7 @@ static const FieldParse audioSettingsFieldParseTable[] =
 	{ "Default3DSoundVolume",	INI::parsePercentToReal,						NULL,							offsetof( AudioSettings, m_default3DSoundVolume) },
 	{ "DefaultSpeechVolume",	INI::parsePercentToReal,						NULL,							offsetof( AudioSettings, m_defaultSpeechVolume) },
 	{ "DefaultMusicVolume",		INI::parsePercentToReal,						NULL,							offsetof( AudioSettings, m_defaultMusicVolume) },
+	{ "DefaultMoneyTransactionVolume", INI::parsePercentToReal,		NULL,							offsetof( AudioSettings, m_defaultMoneyTransactionVolume) },
 	{ "MicrophoneDesiredHeightAboveTerrain",	INI::parseReal,			NULL,							offsetof( AudioSettings, m_microphoneDesiredHeightAboveTerrain ) },
 	{ "MicrophoneMaxPercentageBetweenGroundAndCamera", INI::parsePercentToReal,	NULL,	offsetof( AudioSettings, m_microphoneMaxPercentageBetweenGroundAndCamera ) },
   { "ZoomMinDistance",		INI::parseReal,									NULL,							offsetof( AudioSettings, m_zoomMinDistance ) },
@@ -1150,6 +1151,7 @@ void INI::parseAudioSettingsDefinition( INI *ini )
 	TheAudio->friend_getAudioSettings()->m_preferred3DSoundVolume	= prefs.get3DSoundVolume() / 100.0f;
 	TheAudio->friend_getAudioSettings()->m_preferredSpeechVolume	= prefs.getSpeechVolume() / 100.0f;
 	TheAudio->friend_getAudioSettings()->m_preferredMusicVolume		= prefs.getMusicVolume() / 100.0f;
+	TheAudio->friend_getAudioSettings()->m_preferredMoneyTransactionVolume = prefs.getMoneyTransactionVolume() / 100.0f;
 }
 
 //-------------------------------------------------------------------------------------------------

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

@@ -51,6 +51,8 @@
 #include "Common/Debug.h"
 #include "Common/Snapshot.h"
 
+class AudioEventRTS;
+
 // ----------------------------------------------------------------------------------------------
 /**
 	How much "money" (Tiberium, Gems, Magic Resource Boxes, whatever) the Player has.
@@ -91,6 +93,9 @@ class Money : public Snapshot
   }
 
 protected:
+
+	void triggerAudioEvent(const AudioEventRTS& audioEvent);
+
 	// snapshot methods
 	virtual void crc( Xfer *xfer );
 	virtual void xfer( Xfer *xfer );

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

@@ -102,6 +102,7 @@ class OptionPreferences : public UserPreferences
 	Real get3DSoundVolume(void);							// convenience function
 	Real getSpeechVolume(void);								// convenience function
 	Real getMusicVolume(void);								// convenience function
+	Real getMoneyTransactionVolume(void) const;
 	Bool saveCameraInReplays(void);
 	Bool useCameraInReplays(void);
 	Int	 getStaticGameDetail(void);	// detail level selected by the user.

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

@@ -45,6 +45,7 @@
 #include "PreRTS.h"	// This must go first in EVERY cpp file int the GameEngine
 #include "Common/Money.h"
 
+#include "Common/AudioSettings.h"
 #include "Common/GameAudio.h"
 #include "Common/MiscAudio.h"
 #include "Common/Player.h"
@@ -66,13 +67,9 @@ UnsignedInt Money::withdraw(UnsignedInt amountToWithdraw, Bool playSound)
 	if (amountToWithdraw == 0)
 		return amountToWithdraw;
 
-	// Play a sound
 	if (playSound)
 	{
-		//@todo: Do we do this frequently enough that it is a performance hit?
-		AudioEventRTS event = TheAudio->getMiscAudio()->m_moneyWithdrawSound;
-		event.setPlayerIndex(m_playerIndex);
-		TheAudio->addAudioEvent(&event);
+		triggerAudioEvent(TheAudio->getMiscAudio()->m_moneyWithdrawSound);
 	}
 
 	m_money -= amountToWithdraw;
@@ -86,18 +83,28 @@ void Money::deposit(UnsignedInt amountToDeposit, Bool playSound)
 	if (amountToDeposit == 0)
 		return;
 
-	// Play a sound
 	if (playSound)
 	{
-		//@todo: Do we do this frequently enough that it is a performance hit?
-		AudioEventRTS event = TheAudio->getMiscAudio()->m_moneyDepositSound;
-		event.setPlayerIndex(m_playerIndex);
-		TheAudio->addAudioEvent(&event);
+		triggerAudioEvent(TheAudio->getMiscAudio()->m_moneyDepositSound);
 	}
 
 	m_money += amountToDeposit;
 }
 
+void Money::triggerAudioEvent(const AudioEventRTS& audioEvent)
+{
+	Real volume = TheAudio->getAudioSettings()->m_preferredMoneyTransactionVolume;
+	volume *= audioEvent.getVolume();
+	if (volume <= 0.0f)
+		return;
+
+	//@todo: Do we do this frequently enough that it is a performance hit?
+	AudioEventRTS event = audioEvent;
+	event.setPlayerIndex(m_playerIndex);
+	event.setVolume(volume);
+	TheAudio->addAudioEvent(&event);
+}
+
 // ------------------------------------------------------------------------------------------------
 /** CRC */
 // ------------------------------------------------------------------------------------------------

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp

@@ -725,6 +725,19 @@ Real OptionPreferences::getMusicVolume(void)
 	return volume;
 }
 
+Real OptionPreferences::getMoneyTransactionVolume(void) const
+{
+	OptionPreferences::const_iterator it = find("MoneyTransactionVolume");
+	if (it == end())
+		return TheAudio->getAudioSettings()->m_defaultMoneyTransactionVolume * 100.0f;
+
+	Real volume = (Real) atof(it->second.str());
+	if (volume < 0.0f)
+		volume = 0.0f;
+
+	return volume;
+}
+
 Int OptionPreferences::getSystemTimeFontSize(void)
 {
 	OptionPreferences::const_iterator it = find("SystemTimeFontSize");
@@ -1195,6 +1208,17 @@ static void saveOptions( void )
     TheAudio->setVolume(val / 100.0f, (AudioAffect) (AudioAffect_Speech | AudioAffect_SystemSetting));
 	}
 
+	//-------------------------------------------------------------------------------------------------
+	// Money tick volume
+	// TheSuperHackers @todo Add options slider ?
+	{
+		val = pref->getMoneyTransactionVolume();
+		AsciiString prefString;
+		prefString.format("%d", val);
+		(*pref)["MoneyTransactionVolume"] = prefString;
+		TheAudio->friend_getAudioSettings()->m_preferredMoneyTransactionVolume = val / 100.0f;
+	}
+
  	//-------------------------------------------------------------------------------------------------
  	// slider Gamma
  	val = GadgetSliderGetPosition(sliderGamma);

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

@@ -51,6 +51,8 @@
 #include "Common/Debug.h"
 #include "Common/Snapshot.h"
 
+class AudioEventRTS;
+
 // ----------------------------------------------------------------------------------------------
 /**
 	How much "money" (Tiberium, Gems, Magic Resource Boxes, whatever) the Player has.
@@ -91,6 +93,9 @@ class Money : public Snapshot
   }
 
 protected:
+
+	void triggerAudioEvent(const AudioEventRTS& audioEvent);
+
 	// snapshot methods
 	virtual void crc( Xfer *xfer );
 	virtual void xfer( Xfer *xfer );

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

@@ -106,6 +106,7 @@ class OptionPreferences : public UserPreferences
 	Real get3DSoundVolume(void);							// convenience function
 	Real getSpeechVolume(void);								// convenience function
 	Real getMusicVolume(void);								// convenience function
+	Real getMoneyTransactionVolume(void) const;
 	Bool saveCameraInReplays(void);
 	Bool useCameraInReplays(void);
 	Int	 getStaticGameDetail(void);	// detail level selected by the user.

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

@@ -45,6 +45,7 @@
 #include "PreRTS.h"	// This must go first in EVERY cpp file int the GameEngine
 #include "Common/Money.h"
 
+#include "Common/AudioSettings.h"
 #include "Common/GameAudio.h"
 #include "Common/MiscAudio.h"
 #include "Common/Player.h"
@@ -66,13 +67,9 @@ UnsignedInt Money::withdraw(UnsignedInt amountToWithdraw, Bool playSound)
 	if (amountToWithdraw == 0)
 		return amountToWithdraw;
 
-	// Play a sound
 	if (playSound)
 	{
-		//@todo: Do we do this frequently enough that it is a performance hit?
-		AudioEventRTS event = TheAudio->getMiscAudio()->m_moneyWithdrawSound;
-		event.setPlayerIndex(m_playerIndex);
-		TheAudio->addAudioEvent(&event);
+		triggerAudioEvent(TheAudio->getMiscAudio()->m_moneyWithdrawSound);
 	}
 
 	m_money -= amountToWithdraw;
@@ -86,13 +83,9 @@ void Money::deposit(UnsignedInt amountToDeposit, Bool playSound)
 	if (amountToDeposit == 0)
 		return;
 
-	// Play a sound
 	if (playSound)
 	{
-		//@todo: Do we do this frequently enough that it is a performance hit?
-		AudioEventRTS event = TheAudio->getMiscAudio()->m_moneyDepositSound;
-		event.setPlayerIndex(m_playerIndex);
-		TheAudio->addAudioEvent(&event);
+		triggerAudioEvent(TheAudio->getMiscAudio()->m_moneyDepositSound);
 	}
 
 	m_money += amountToDeposit;
@@ -107,6 +100,20 @@ void Money::deposit(UnsignedInt amountToDeposit, Bool playSound)
 	}
 }
 
+void Money::triggerAudioEvent(const AudioEventRTS& audioEvent)
+{
+	Real volume = TheAudio->getAudioSettings()->m_preferredMoneyTransactionVolume;
+	volume *= audioEvent.getVolume();
+	if (volume <= 0.0f)
+		return;
+
+	//@todo: Do we do this frequently enough that it is a performance hit?
+	AudioEventRTS event = audioEvent;
+	event.setPlayerIndex(m_playerIndex);
+	event.setVolume(volume);
+	TheAudio->addAudioEvent(&event);
+}
+
 // ------------------------------------------------------------------------------------------------
 /** CRC */
 // ------------------------------------------------------------------------------------------------

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp

@@ -769,6 +769,19 @@ Real OptionPreferences::getMusicVolume(void)
 	return volume;
 }
 
+Real OptionPreferences::getMoneyTransactionVolume(void) const
+{
+	OptionPreferences::const_iterator it = find("MoneyTransactionVolume");
+	if (it == end())
+		return TheAudio->getAudioSettings()->m_defaultMoneyTransactionVolume * 100.0f;
+
+	Real volume = (Real) atof(it->second.str());
+	if (volume < 0.0f)
+		volume = 0.0f;
+
+	return volume;
+}
+
 Int OptionPreferences::getSystemTimeFontSize(void)
 {
 	OptionPreferences::const_iterator it = find("SystemTimeFontSize");
@@ -1255,6 +1268,17 @@ static void saveOptions( void )
     TheAudio->setVolume(val / 100.0f, (AudioAffect) (AudioAffect_Speech | AudioAffect_SystemSetting));
 	}
 
+	//-------------------------------------------------------------------------------------------------
+	// Money tick volume
+	// TheSuperHackers @todo Add options slider ?
+	{
+		val = pref->getMoneyTransactionVolume();
+		AsciiString prefString;
+		prefString.format("%d", val);
+		(*pref)["MoneyTransactionVolume"] = prefString;
+		TheAudio->friend_getAudioSettings()->m_preferredMoneyTransactionVolume = val / 100.0f;
+	}
+
  	//-------------------------------------------------------------------------------------------------
  	// slider Gamma
  	val = GadgetSliderGetPosition(sliderGamma);