Added SoundSet RemoveSound method, for removing sounds from soundsets (and their sub soundsets)

Also cleaned up a few soundset-y places

Author: garethyr

CHANGELOG.md

@@ -625,9 +625,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	`soundSet.SubSoundSets` (Lua R) - An iterator over the sub `SoundSets` of this `SoundSet`, allowing you to manipulate them as you would any `SoundSet`.  
 	`soundSet:HasAnySounds(includeSubSoundSets)` (Lua) - Whether or not this `SoundSet` has any sounds, optionally including its sub `SoundSets`.  
 	`soundSet:SelectNextSounds()` (Lua) - Selects the next sounds for this `SoundSet`. Note that playing a `SoundContainer` will always also do this, so this is only really useful to allow you to skip sounds when `SoundSelectionCycleMode` is set to `FORWARDS`.  
-	`soundSet:AddSound("Path/to/sound")` (Lua) - Adds the sound at the given path with no offset, 0 minimum audible distance, and default attenuation start distance.  
-	`soundSet:AddSound("Path/to/sound", offset, minimumAudibleDistance, attenuationStartDistance)` (Lua) - Adds the sound at the given path with the given parameters.  
+	`soundSet:AddSound("Path/to/sound.flac")` (Lua) - Adds the sound at the given path with no offset, 0 minimum audible distance, and default attenuation start distance.  
+	`soundSet:AddSound("Path/to/sound.flac", offset, minimumAudibleDistance, attenuationStartDistance)` (Lua) - Adds the sound at the given path with the given parameters.  
 	`soundSet:AddSoundSet(soundSetToAdd)` (Lua) - Adds the given `SoundSet` as a sub `SoundSet` of this `SoundSet`.  
+	`soundSet:RemoveSound("Path/to/sound.flac")` (Lua) - Removes any sounds with the given filepath from the `SoundSet`, returning whether or not any where removed. Does not remove sounds from sub-`SoundSet`s.  
+	`soundSet:RemoveSound("Path/to/sound.flac", removeFromSubSoundSets)` (Lua) - Removes any sounds with the given filepath from the `SoundSet`, returning whether or not any where removed. Optionally removes matching sounds from any sub-`SoundSet`s and their sub-`SoundSet`s and so on.  
 
 	Additionally, `AddSound` and `AddSoundSet` INI properties work for `SoundSets`. They are exactly the same as they are for `SoundContainers`.
 

Entities/SoundSet.cpp

@@ -175,6 +175,18 @@ namespace RTE {
 		m_SoundData.push_back({soundFile, soundObject, offset, minimumAudibleDistance, attenuationStartDistance});
 	}
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	bool SoundSet::RemoveSound(const std::string &soundFilePath, bool removeFromSubSoundSets) {
+		auto soundsToRemove = std::remove_if(m_SoundData.begin(), m_SoundData.end(), [&soundFilePath](const SoundSet::SoundData &soundData) { return soundData.SoundFile.GetDataPath() == soundFilePath; });
+		bool anySoundsToRemove = soundsToRemove != m_SoundData.end();
+		if (anySoundsToRemove) { m_SoundData.erase(soundsToRemove, m_SoundData.end()); }
+		if (removeFromSubSoundSets) {
+			for (SoundSet subSoundSet : m_SubSoundSets) { anySoundsToRemove |= RemoveSound(soundFilePath, removeFromSubSoundSets); }
+		}
+		return anySoundsToRemove;
+	}
+
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	bool SoundSet::HasAnySounds(bool includeSubSoundSets) const {

Entities/SoundSet.h

@@ -120,11 +120,26 @@ namespace RTE {
 		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error.</param>
 		void AddSound(const std::string &soundFilePath, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance, bool abortGameForInvalidSound);
 
+		/// <summary>
+		/// Removes all instances of the sound with the given filepath from this SoundSet. Does not remove it from any sub-SoundSets.
+		/// </summary>
+		/// <param name="soundFilePath">The path to the sound to be removed from this SoundSet.</param>
+		/// <returns>Whether or not a sound with the given filepath was found in this SoundSet.</returns>
+		bool RemoveSound(const std::string &soundFilePath) { return RemoveSound(soundFilePath, false); }
+
+		/// <summary>
+		/// Removes all instances of the sound with the given filepath from this SoundSet, optionally removing it from all sub-SoundSets as well.
+		/// </summary>
+		/// <param name="soundFilePath">The path to the sound to be removed from this SoundSet.</param>
+		/// <param name="removeFromSubSoundSets">Whether or not to remove the sound from any sub-SoundSets as well as this SoundSet.</param>
+		/// <returns>Whether or not a sound with the given filepath was found in this SoundSet or, if set to remove from sub-SoundSets, any of its sub-SoundSets.</returns>
+		bool RemoveSound(const std::string &soundFilePath, bool removeFromSubSoundSets);
+
 		/// <summary>
 		/// Adds a copy of the given SoundData to this SoundSet.
 		/// </summary>
 		/// <param name="soundDataToAdd">The SoundData to copy to this SoundSet.</param>
-		void AddSoundData(SoundData soundDataToAdd) { m_SoundData.push_back(soundDataToAdd); }
+		void AddSoundData(const SoundData &soundDataToAdd) { m_SoundData.push_back(soundDataToAdd); }
 
 		/// <summary>
 		/// Adds a copy of the passed in SoundSet as a sub SoundSet of this SoundSet. Ownership IS transferred!

Lua/LuaBindingsEntities.cpp

@@ -1145,8 +1145,10 @@ namespace RTE {
 
 		.def("HasAnySounds", &SoundSet::HasAnySounds)
 		.def("SelectNextSounds", &SoundSet::SelectNextSounds)
-		.def("AddSound", (void (SoundSet:: *)(std::string const &soundFilePath)) &SoundSet::AddSound)
-		.def("AddSound", (void (SoundSet:: *)(std::string const &soundFilePath, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance)) &SoundSet::AddSound)
+		.def("AddSound", (void (SoundSet:: *)(const std::string &soundFilePath)) &SoundSet::AddSound)
+		.def("AddSound", (void (SoundSet:: *)(const std::string &soundFilePath, const Vector &offset, float minimumAudibleDistance, float attenuationStartDistance)) &SoundSet::AddSound)
+		.def("RemoveSound", (bool (SoundSet:: *)(const std::string &soundFilePath)) &SoundSet::RemoveSound)
+		.def("RemoveSound", (bool (SoundSet:: *)(const std::string &soundFilePath, bool removeFromSubSoundSets)) &SoundSet::RemoveSound)
 		.def("AddSoundSet", &SoundSet::AddSoundSet)
 
 		.enum_("SoundSelectionCycleMode")[