Cherry picking commit for PitchVariation so development runs with replacing-pawnis-sounds data branch

Author: garethyr

Entities/SoundContainer.cpp

@@ -30,6 +30,7 @@ namespace RTE {
 		m_Pos = Vector();
 		m_Volume = 1.0F;
 		m_Pitch = 1.0F;
+		m_PitchVariation = 0;
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -52,6 +53,7 @@ namespace RTE {
 		m_Pos = reference.m_Pos;
 		m_Volume = reference.m_Volume;
 		m_Pitch = reference.m_Pitch;
+		m_PitchVariation = reference.m_PitchVariation;
 
 		return 0;
 	}
@@ -95,6 +97,8 @@ namespace RTE {
 			reader >> m_Volume;
 		} else if (propName == "Pitch") {
 			reader >> m_Pitch;
+		} else if (propName == "PitchVariation") {
+			reader >> m_PitchVariation;
 		} else {
 			return Entity::ReadProperty(propName, reader);
 		}
@@ -138,6 +142,8 @@ namespace RTE {
 		writer << m_Volume;
 		writer.NewProperty("Pitch");
 		writer << m_Pitch;
+		writer.NewProperty("PitchVariation");
+		writer << m_PitchVariation;
 
 		return 0;
 	}

Entities/SoundContainer.h

@@ -248,6 +248,12 @@ namespace RTE {
 		/// </summary>
 		/// <param name="newPitch">The new pitch sounds in this SoundContainer should be played at. Limited between 0.125 and 8 (8 octaves up or down).</param>
 		void SetPitch(float newPitch) { m_Pitch = std::clamp(newPitch, 0.125F, 8.0F); if (IsBeingPlayed()) { g_AudioMan.ChangeSoundContainerPlayingChannelsPitch(this); } }
+
+		/// <summary>
+		/// Gets the pitch variation the sounds in this SoundContainer are played at.
+		/// </summary>
+		/// <returns>The pitch variation the sounds in this SoundContainer are played at.</returns>
+		float GetPitchVariation() const { return m_PitchVariation; }
 #pragma endregion
 
 #pragma region Playback Controls
@@ -341,6 +347,7 @@ namespace RTE {
 
 		Vector m_Pos; //!< The current position of this SoundContainer's sounds.
 		float m_Pitch; //!< The current natural pitch of this SoundContainer's sounds.
+		float m_PitchVariation; //!< The randomized pitch variation of this SoundContainer's sounds. 1 means the sound will vary a full octave both ways.
 		float m_Volume; //!< The current natural volume of this SoundContainer's sounds.
 
 		/// <summary>

Managers/AudioMan.cpp

@@ -523,14 +523,16 @@ namespace RTE {
 		int channelIndex;
 		std::vector<const SoundSet::SoundData *> selectedSoundData;
 		soundContainer->GetTopLevelSoundSet().GetFlattenedSoundData(selectedSoundData, true);
+		float pitchVariationFactor = 1.0F + std::abs(soundContainer->GetPitchVariation());
 		for (const SoundSet::SoundData *soundData : selectedSoundData) {
 			result = (result == FMOD_OK) ? m_AudioSystem->playSound(soundData->SoundObject, channelGroupToPlayIn, true, &channel) : result;
 			result = (result == FMOD_OK) ? channel->getIndex(&channelIndex) : result;
 
 			result = (result == FMOD_OK) ? channel->setUserData(soundContainer) : result;
 			result = (result == FMOD_OK) ? channel->setCallback(SoundChannelEndedCallback) : result;
 			result = (result == FMOD_OK) ? channel->setPriority(soundContainer->GetPriority()) : result;
-			result = (result == FMOD_OK) ? channel->setPitch(soundContainer->GetPitch()) : result;
+			float pitchVariationMultiplier = pitchVariationFactor == 1.0F ? 1.0F : RandomNum(1.0F / pitchVariationFactor, 1.0F * pitchVariationFactor);
+			result = (result == FMOD_OK) ? channel->setPitch(soundContainer->GetPitch() * pitchVariationMultiplier) : result;
 			if (soundContainer->IsImmobile()) {
 				result = (result == FMOD_OK) ? channel->set3DLevel(0.0F) : result;
 				result = (result == FMOD_OK) ? channel->setVolume(soundContainer->GetVolume()) : result;