Add ability to stop sounds abruptly (#22)

Author: dillyo09

addons/sound_manager/SoundManager.cs

@@ -51,6 +51,12 @@ public static AudioStreamPlayer PlaySoundWithPitch(AudioStream resource, float p
 	}
 
 
+	public static void StopSound(AudioStream resource)
+	{
+	  Instance.Call("stop_sound", resource);
+	}
+
+
 	public static AudioStreamPlayer PlayUISound(AudioStream resource, string overrideBus = "")
 	{
 	  return (AudioStreamPlayer)Instance.Call("play_ui_sound", resource, overrideBus);
@@ -63,6 +69,12 @@ public static AudioStreamPlayer PlayUISoundWithPitch(AudioStream resource, float
 	}
 
 
+	public static void StopSound(AudioStream resource)
+	{
+	  Instance.Call("stop_ui_sound", resource);
+	}
+
+
 	public static void SetDefaultSoundBus(string bus)
 	{
 	  Instance.Call("set_default_sound_bus", bus);

addons/sound_manager/sound_effects.gd

@@ -5,3 +5,9 @@ func play(resource: AudioStream, override_bus: String = "") -> AudioStreamPlayer
 	var player = prepare(resource, override_bus)
 	player.call_deferred("play")
 	return player
+
+
+func stop(resource: AudioStream) -> void:
+	for player in busy_players:
+		if player.stream == resource:
+			player.call_deferred("stop")

addons/sound_manager/sound_manager.gd

@@ -63,6 +63,10 @@ func play_sound_with_pitch(resource: AudioStream, pitch: float = 1.0, override_b
 	return player
 
 
+func stop_sound(resource: AudioStream) -> void:
+	return sound_effects.stop(resource)
+
+
 func play_ui_sound(resource: AudioStream, override_bus: String = "") -> AudioStreamPlayer:
 	return ui_sound_effects.play(resource, override_bus)
 
@@ -73,6 +77,10 @@ func play_ui_sound_with_pitch(resource: AudioStream, pitch: float = 1.0, overrid
 	return player
 
 
+func stop_ui_sound(resource: AudioStream) -> void:
+	return ui_sound_effects.stop(resource)
+
+
 func set_default_sound_bus(bus: String) -> void:
 	sound_effects.bus = bus
 

docs/Sounds.md

@@ -24,6 +24,11 @@ Playing sound effects is broken up into playing general sounds (ie. in the game
 
   Play an audio stream with a specific pitch. Optionally specify which audio bus you want to use for this sound.
 
+- **`SoundManager.stop_sound(resource: AudioStream) -> void`**
+
+  Stop a specific audio stream.
+
+
 - **`SoundManager.play_ui_sound(resource: AudioStream, override_bus: String = "") -> AudioStreamPlayer`**
 
   Play an audio stream intended for the user interface. Optionally specify which audio bus you want to use for this sound.
@@ -34,6 +39,10 @@ Playing sound effects is broken up into playing general sounds (ie. in the game
 
   Play a UI audio stream with a specific pitch. Optionally specify which audio bus you want to use for this sound.
 
+- **`SoundManager.stop_ui_sound(resource: AudioStream) -> void`**
+
+  Stop a specific audio stream.
+
 - **`SoundManager.set_default_sound_bus(bus: String) -> void`**
 
   Sets the default audio bus used for playing sounds.