Merge pull request #4 from FreekDS/fix-issue2-issue3

Add shortcut methods + fix issue with multiple AudioEventPlayers having a single AudioStreamPlayer

Author: FreekDS

addons/AudioEvents/scripts/AudioStreamPlayerEvents.gd

@@ -16,19 +16,58 @@ signal soundEvent(soundName: String, id: int, playedAt: float)
 
 var lastId = -1
 
+#region Public API
+## Reset the AudioEventPlayer. Makes sure that all events will be played
+## when starting again.
+func reset():
+	lastId = -1
+
+
+func play():
+	if not _precondition("Cannot call play()"):
+		return
+	
+	# Resume if it was paused
+	if audioStreamPlayer.stream_paused:
+		audioStreamPlayer.stream_paused = false
+		return
+		
+	# Else reset and start again
+	reset()
+	audioStreamPlayer.stream = audioEventStream.audio
+	audioStreamPlayer.play()
+
+func pause():
+	if not _precondition("Cannot call pause()"):
+		return
+	
+	if audioStreamPlayer.playing:
+		audioStreamPlayer.stream_paused = true
+
+func stop():
+	if not _precondition("Cannot call stop()"):
+		return
+	reset()
+	audioStreamPlayer.stop()
+
+#endregion
+
+#region Godot callbacks
 func _ready():
-	var p = get_parent()
-	if p is AudioStreamPlayer:
-		audioStreamPlayer = p
+	if audioStreamPlayer == null:
+		var p = get_parent()
+		if p is AudioStreamPlayer:
+			audioStreamPlayer = p
 	if audioStreamPlayer == null:
 		push_error("Please assign AudioStreamPlayer, or make sure the parent is one!")
 		assert(false)
-		
+	
+	audioStreamPlayer.finished.connect(reset)
+	
 	if audioEventStream:
 		audioStreamPlayer.stream = audioEventStream.audio
-		if audioStreamPlayer.autoplay:
+		if audioStreamPlayer.autoplay and not audioStreamPlayer.playing:
 			audioStreamPlayer.play()
-	
 
 func _process(_delta):
 	if not audioStreamPlayer or not audioEventStream:
@@ -37,6 +76,12 @@ func _process(_delta):
 	if !audioStreamPlayer.playing:
 		return
 
+	# Make sure to only call events from this AudioEventPlayer
+	# in case multiple AudioEventStreams are using a single AudioStreamPlayer
+	# see issue #3
+	if audioStreamPlayer.stream != audioEventStream.audio:
+		return
+	
 	var pos = audioStreamPlayer.get_playback_position()
 	var index = -1
 	for t_i in range(len(audioEventStream.eventTimes)):
@@ -49,3 +94,18 @@ func _process(_delta):
 	if index != -1 and lastId != index:
 		soundEvent.emit(audioEventStream.name, index, pos)
 		lastId = index	# Avoid doubles
+		
+#endregion
+
+#region Private API
+func _precondition(err: String) -> bool:
+	if audioStreamPlayer == null:
+		push_error(err + ": ", "AudioStreamPlayer is not assigned")
+		return false
+	if audioEventStream == null:
+		push_error(err + ": ", "No AudioEventStream resource attached!")
+		return false
+	return true
+	
+#endregion
+

example/example.tscn

@@ -7,9 +7,9 @@
 
 [sub_resource type="Resource" id="Resource_2ro53"]
 script = ExtResource("3_rdl2a")
-audio = ExtResource("2_c08da")
-eventTimes = Array[float]([3.02, 6.96, 13.01])
 name = "Audio"
+audio = ExtResource("2_c08da")
+eventTimes = Array[float]([0.5, 6.96, 13.01])
 
 [node name="Example" type="Node"]