bugfix(logic): Decouple scripted audio events from CRC computation (TheSuperHackers#2075)

Author: Caball009

Core/GameEngine/Include/GameLogic/LogicRandomValue.h

@@ -33,11 +33,15 @@
 
 // do NOT use these functions directly, rather use the macros below
 extern Int GetGameLogicRandomValue( int lo, int hi, const char *file, int line );
+extern Int GetGameLogicRandomValueUnchanged(int lo, int hi, const char* file, int line);
 extern Real GetGameLogicRandomValueReal( Real lo, Real hi, const char *file, int line );
+extern Real GetGameLogicRandomValueRealUnchanged(Real lo, Real hi, const char* file, int line);
 
 // use these macros to access the random value functions
 #define GameLogicRandomValue( lo, hi ) GetGameLogicRandomValue( lo, hi, __FILE__, __LINE__ )
+#define GameLogicRandomValueUnchanged( lo, hi ) GetGameLogicRandomValueUnchanged( lo, hi, __FILE__, __LINE__ )
 #define GameLogicRandomValueReal( lo, hi ) GetGameLogicRandomValueReal( lo, hi, __FILE__, __LINE__ )
+#define GameLogicRandomValueRealUnchanged( lo, hi ) GetGameLogicRandomValueRealUnchanged( lo, hi, __FILE__, __LINE__ )
 
 //--------------------------------------------------------------------------------------------------------------
 class CColorAlphaDialog;

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

@@ -340,7 +340,7 @@ void AudioEventRTS::generateFilename( void )
 		{
 			if (m_isLogicalAudio)
 			{
-				which = GameLogicRandomValue(0, m_eventInfo->m_sounds.size() - 1);
+				which = GameLogicRandomValueUnchanged(0, m_eventInfo->m_sounds.size() - 1);
 			}
 			else
 			{
@@ -388,7 +388,7 @@ void AudioEventRTS::generatePlayInfo( void )
 		// needs to be logic because it needs to be the same on all systems.
 		Int attackToPlay;
 		if (m_isLogicalAudio) {
-			attackToPlay = GameLogicRandomValue(0, attackSize - 1);
+			attackToPlay = GameLogicRandomValueUnchanged(0, attackSize - 1);
 		} else {
 			attackToPlay = GameAudioRandomValue(0, attackSize - 1);
 		}
@@ -406,7 +406,7 @@ void AudioEventRTS::generatePlayInfo( void )
 		// needs to be logic because it needs to be the same on all systems.
 		Int decayToPlay;
 		if (m_isLogicalAudio) {
-			decayToPlay = GameLogicRandomValue(0, decaySize - 1);
+			decayToPlay = GameLogicRandomValueUnchanged(0, decaySize - 1);
 		} else {
 			decayToPlay = GameAudioRandomValue(0, decaySize - 1);
 		}

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

@@ -444,8 +444,13 @@ AudioHandle AudioManager::addAudioEvent(const AudioEventRTS *eventToAdd)
 	}
 
 	// TheSuperHackers @info Scripted audio events are logical, i.e. synchronized across clients.
-	// This early return cannot be taken for such audio events as it skips code that changes the logical game seed values.
+	// In retail mode this early return cannot be taken for such audio events as it skips code that changes the logical game seed values.
+	// In non-retail mode logical audio events are decoupled from the CRC computation, so this early return is allowed.
+#if RETAIL_COMPATIBLE_CRC
 	const Bool logicalAudio = eventToAdd->getIsLogicalAudio();
+#else
+	const Bool logicalAudio = FALSE;
+#endif
 	const Bool notForLocal = !eventToAdd->getUninterruptable() && !shouldPlayLocally(eventToAdd);
 
 	if (!logicalAudio && notForLocal)
@@ -467,11 +472,13 @@ AudioHandle AudioManager::addAudioEvent(const AudioEventRTS *eventToAdd)
 		}
 	}
 
+#if RETAIL_COMPATIBLE_CRC
 	if (notForLocal)
 	{
 		releaseAudioEventRTS(audioEvent);
 		return AHSV_NotForLocal;
 	}
+#endif
 
 	// cull muted audio
 	if (audioEvent->getVolume() < m_audioSettings->m_minVolume) {

Core/GameEngine/Source/Common/RandomValue.cpp

@@ -228,6 +228,37 @@ DEBUG_LOG(( "%d: GetGameLogicRandomValue = %d (%d - %d), %s line %d",
 	return rval;
 }
 
+//
+// TheSuperHackers @info This function does not change the seed values with retail compatibility disabled.
+// Consecutive calls always return the same value for the same combination of min / max values, assuming the seed values haven't changed in between.
+// The intended use case for this function are randomized values that are desirable to be synchronized across clients,
+// but should not result in a mismatch if they aren't synchronized; e.g. for scripted audio events.
+//
+Int GetGameLogicRandomValueUnchanged( int lo, int hi, const char *file, int line )
+{
+#if RETAIL_COMPATIBLE_CRC
+	return GetGameLogicRandomValue(lo, hi, file, line);
+#endif
+
+	const UnsignedInt delta = hi - lo + 1;
+	if (delta == 0)
+		return hi;
+
+	UnsignedInt seed[ARRAY_SIZE(theGameLogicSeed)];
+	memcpy(&seed[0], &theGameLogicSeed[0], sizeof(seed));
+
+	const Int rval = ((Int)(randomValue(seed) % delta)) + lo;
+
+	DEBUG_ASSERTCRASH(rval >= lo && rval <= hi, ("Bad random val"));
+
+#ifdef DEBUG_RANDOM_LOGIC
+	DEBUG_LOG(( "%d: GetGameLogicRandomValueUnchanged = %d (%d - %d), %s line %d",
+		TheGameLogic->getFrame(), rval, lo, hi, file, line ));
+#endif
+
+	return rval;
+}
+
 //
 // Integer random value
 //
@@ -298,6 +329,37 @@ DEBUG_LOG(( "%d: GetGameLogicRandomValueReal = %f, %s line %d",
 	return rval;
 }
 
+//
+// TheSuperHackers @info This function does not change the seed values with retail compatibility disabled.
+// Consecutive calls always return the same value for the same combination of min / max values, assuming the seed values haven't changed in between.
+// The intended use case for this function are randomized values that are desirable to be synchronized across clients,
+// but should not result in a mismatch if they aren't synchronized; e.g. for scripted audio events.
+//
+Real GetGameLogicRandomValueRealUnchanged( Real lo, Real hi, const char *file, int line )
+{
+#if RETAIL_COMPATIBLE_CRC
+	return GetGameLogicRandomValueReal(lo, hi, file, line);
+#endif
+
+	const Real delta = hi - lo;
+	if (delta <= 0.0f)
+		return hi;
+
+	UnsignedInt seed[ARRAY_SIZE(theGameLogicSeed)];
+	memcpy(&seed[0], &theGameLogicSeed[0], sizeof(seed));
+
+	const Real rval = ((Real)(randomValue(seed)) * theMultFactor) * delta + lo;
+
+	DEBUG_ASSERTCRASH(rval >= lo && rval <= hi, ("Bad random val"));
+
+#ifdef DEBUG_RANDOM_LOGIC
+	DEBUG_LOG(( "%d: GetGameLogicRandomValueRealUnchanged = %f, %s line %d",
+		TheGameLogic->getFrame(), rval, file, line ));
+#endif
+
+	return rval;
+}
+
 //
 // Real valued random value
 //