Merge pull request #269 from Daniel-Cortez/music-controller

Implement MusicController

Author: DimensionWarped

Entities/Misc/HUD.tscn

@@ -1,4 +1,4 @@
-[gd_scene load_steps=32 format=3 uid="uid://c30uceea18q1w"]
+[gd_scene load_steps=31 format=3 uid="uid://c30uceea18q1w"]
 
 [ext_resource type="Material" uid="uid://bveqi5m5ihsgj" path="res://Shaders/PlayerPalette.tres" id="2_xy7bp"]
 [ext_resource type="FontFile" uid="uid://cj70hn8i05uo5" path="res://Graphics/HUD/hud_lives_numerals.png" id="3_eauoj"]
@@ -16,7 +16,6 @@
 [ext_resource type="PackedScene" uid="uid://bass3w6af55vw" path="res://Tools/Timing/ProcessTimer.tscn" id="13_g84gd"]
 [ext_resource type="Texture2D" uid="uid://60ak1q0xrn1s" path="res://Graphics/HUD/hud_gametimeover.png" id="15_oja0m"]
 [ext_resource type="AudioStream" uid="uid://dh4rsaka62ph4" path="res://Audio/SFX/Gimmicks/Switch.wav" id="16"]
-[ext_resource type="AudioStream" uid="uid://dnyw7remih6op" path="res://Audio/Soundtrack/8. SWD_GameOver.ogg" id="16_vq3lx"]
 [ext_resource type="AudioStream" uid="uid://clgobastngtvy" path="res://Audio/SFX/Misc/Score.wav" id="17"]
 
 [sub_resource type="Animation" id="5"]
@@ -1001,10 +1000,6 @@ libraries = {
 "": SubResource("AnimationLibrary_dmnhc")
 }
 
-[node name="GameOverMusic" type="AudioStreamPlayer" parent="GameOver"]
-stream = ExtResource("16_vq3lx")
-bus = &"Music"
-
 [node name="Water" type="CanvasLayer" parent="."]
 
 [node name="WaterOverlay" type="ColorRect" parent="Water"]

Scene/Main.tscn

@@ -1,13 +1,9 @@
-[gd_scene load_steps=16 format=3 uid="uid://byje3iiukvt4p"]
+[gd_scene load_steps=12 format=3 uid="uid://byje3iiukvt4p"]
 
-[ext_resource type="AudioStream" uid="uid://dec4ik84l88go" path="res://Audio/Soundtrack/2. SWD_SpeedUp.ogg" id="1"]
 [ext_resource type="Script" path="res://Scripts/Global/Main.gd" id="2"]
-[ext_resource type="AudioStream" uid="uid://b30ai1lqlh32u" path="res://Audio/Soundtrack/3. SWD_1Up.ogg" id="3"]
 [ext_resource type="PackedScene" uid="uid://c58ontqoxjuti" path="res://Scene/Presentation/PoweredByWorlds.tscn" id="4"]
-[ext_resource type="AudioStream" uid="uid://o4f15hnb5thp" path="res://Audio/Soundtrack/7. SWD_Drowning.ogg" id="5"]
 [ext_resource type="PackedScene" uid="uid://b2xskcomtpo2x" path="res://Entities/Misc/ControllerMenu.tscn" id="6"]
 [ext_resource type="PackedScene" uid="uid://c1xhc4uh26inb" path="res://Entities/Misc/PauseMenu.tscn" id="7"]
-[ext_resource type="AudioStream" uid="uid://25oy5g80wsxu" path="res://Audio/Soundtrack/5. SWD_Boss.ogg" id="8"]
 
 [sub_resource type="CanvasItemMaterial" id="1"]
 
@@ -141,29 +137,6 @@ process_mode = 1
 
 [node name="PoweredByWorlds" parent="SceneLoader" instance=ExtResource("4")]
 
-[node name="Music" type="Node" parent="."]
-process_mode = 1
-
-[node name="Music" type="AudioStreamPlayer" parent="Music"]
-autoplay = true
-bus = &"Music"
-
-[node name="BossTheme" type="AudioStreamPlayer" parent="Music"]
-stream = ExtResource("8")
-bus = &"Music"
-
-[node name="EffectTheme" type="AudioStreamPlayer" parent="Music"]
-stream = ExtResource("1")
-bus = &"Music"
-
-[node name="Drowning" type="AudioStreamPlayer" parent="Music"]
-stream = ExtResource("5")
-bus = &"Music"
-
-[node name="Life" type="AudioStreamPlayer" parent="Music"]
-stream = ExtResource("3")
-bus = &"Music"
-
 [node name="GUI" type="CanvasLayer" parent="."]
 process_mode = 3
 layer = 128
@@ -186,5 +159,3 @@ autoplay = "RESET"
 [node name="ControllerMenu" parent="GUI" instance=ExtResource("6")]
 
 [node name="Pause" parent="GUI" instance=ExtResource("7")]
-
-[connection signal="finished" from="Music/Life" to="." method="_on_Life_finished"]

Scripts/Boss/BossBoundrySetter.gd

@@ -46,19 +46,15 @@ func _on_BoundrySetter_body_entered(body):
 						if lockBottom:
 							i.limitBottom = min(global_position.y+screenSize.y/2,Global.hardBorderBottom)
 
-					Global.main.set_volume(-50)
-					await Global.main.volume_set
-					Global.main.set_volume(0,100)
 
-					Global.bossMusic.play()
+					MusicController.play_music_theme(MusicController.MusicTheme.BOSS_THEME)
 					boss.active = true
 
 					if boss.has_signal("boss_over"):
 						boss.connect("boss_over",Callable(self,"boss_completed"))
 
 func boss_completed():
-	Global.bossMusic.stop()
-	Global.music.play()
+	MusicController.stop_music_theme(MusicController.MusicTheme.BOSS_THEME)
 	# set boundries for players
 	for i in Global.players:
 		if is_instance_valid(i):

Scripts/Global/Global.gd

@@ -46,17 +46,6 @@ func is_in_any_stage_clear_phase() -> bool:
 func reset_stage_clear_phase() -> void:
 	set_stage_clear_phase(Global.STAGE_CLEAR_PHASES.NOT_STARTED)
 
-# Music
-var musicParent = null
-var music = null
-var bossMusic = null
-var effectTheme = null
-var drowning = null
-var life = null
-# song themes to play for things like invincibility and speed shoes
-var themes = [preload("res://Audio/Soundtrack/1. SWD_Invincible.ogg"),preload("res://Audio/Soundtrack/2. SWD_SpeedUp.ogg"),preload("res://Audio/Soundtrack/4. SWD_StageClear.ogg")]
-# index for current theme
-var currentTheme = 0
 
 # Sound, used for play_sound (used for a global sound, use this if multiple nodes use the same sound)
 var soundChannel = AudioStreamPlayer.new()
@@ -229,21 +218,15 @@ func play_sound(sound = null) -> void:
 ## use a check function to see if a score increase would go above 50,000
 func check_score_life(score_add: int = 0) -> void:
 	if score / 50000 < (score + score_add) / 50000:
-		life.play()
+		MusicController.play_music_theme(MusicController.MusicTheme._1UP)
 		lives += 1
-		effectTheme.volume_db = -100
-		music.volume_db = -100
-		bossMusic.volume_db = -100
 
 
 ## use this to set the stage clear theme, only runs if stage clear phase is NONE
 func stage_clear() -> void:
 	if !is_in_any_stage_clear_phase():
-		currentTheme = 2
-		music.stream = themes[currentTheme]
-		music.play()
-		effectTheme.stop()
-		bossMusic.stop()
+		MusicController.stop_music_theme(MusicController.MusicTheme.LEVEL_THEME)
+		MusicController.play_music_theme(MusicController.MusicTheme.STAGE_CLEAR)
 
 
 ## Emit the stage started signal

Scripts/Global/Main.gd

@@ -6,14 +6,6 @@ var lastScene = null
 
 # this gets emited when the scene fades, used to load in level details and data to hide it from the player
 signal scene_faded
-# signal that emits when volume fades
-signal volume_set
-
-# note: volumes can be set with set_volume(), these variables are just for volume control reference
-var startVolumeLevel = 0 # used as reference for when a volume change started
-var setVolumeLevel = 0 # where to fade the volume to
-var volumeLerp = 0 # current stage between start and set for volume level
-var volumeFadeSpeed = 1 # speed for volume changing
 
 # was paused enables menu control when the player pauses manually so they don't get stuck (get_tree().paused may want to be used by other intances)
 var wasPaused = false
@@ -23,38 +15,9 @@ var sceneCanPause = false
 func _ready():
 	# global object references
 	Global.main = self
-	Global.musicParent = get_node_or_null("Music")
-	Global.music = get_node_or_null("Music/Music")
-	Global.bossMusic = get_node_or_null("Music/BossTheme")
-	Global.effectTheme = get_node_or_null("Music/EffectTheme")
-	Global.drowning = get_node_or_null("Music/Drowning")
-	Global.life = get_node_or_null("Music/Life")
 	# initialize game data using global reset (it's better then assigning variables twice)
 	Global.reset_values()
 
-func _process(delta):
-	# verify scene isn't paused
-	if !get_tree().paused and Global.music != null:
-		# pause main music if effect theme, boss music or drowning songs are playing
-		Global.music.stream_paused = Global.effectTheme.playing or Global.drowning.playing or Global.bossMusic.playing
-		# pause boss music if drowning
-		Global.bossMusic.stream_paused = Global.drowning.playing
-		# pause effect music if drowning
-		Global.effectTheme.stream_paused = Global.drowning.playing or Global.bossMusic.playing
-		
-		# check that volume lerp isn't transitioned yet
-		if volumeLerp < 1:
-			# move volume lerp to 1
-			volumeLerp = move_toward(volumeLerp,1,delta*volumeFadeSpeed)
-			# use volume lerp to set the effect volume
-			Global.music.volume_db = lerp(float(startVolumeLevel),float(setVolumeLevel),float(volumeLerp))
-			# copy the volume to other songs (you'll want to add yours here if you add more)
-			Global.effectTheme.volume_db = Global.music.volume_db
-			Global.drowning.volume_db = Global.music.volume_db
-			Global.bossMusic.volume_db = Global.music.volume_db
-			if volumeLerp >= 1:
-				volume_set.emit()
-
 func _input(event):
 	# Pausing
 	if event.is_action_pressed("gm_pause") and sceneCanPause:
@@ -174,30 +137,3 @@ func change_scene_to_file(scene = null, fadeOut = "", fadeIn = "", length = 1, s
 	# if fadeOut wasn't set either then just reset the fader
 	elif fadeOut != "":
 		$GUI/Fader.play("RESET")
-	
-	# stop life sound (if it's still playing)
-	if Global.life.is_playing():
-		Global.life.stop()
-		# set volume level to default
-		Global.music.volume_db = 0
-		# copy the volume to other songs (you'll want to add yours here if you add more)
-		Global.bossMusic.volume_db = Global.bossMusic.volume_db
-		Global.effectTheme.volume_db = Global.music.volume_db
-		Global.drowning.volume_db = Global.music.volume_db
-
-# executed when life sound has finished
-func _on_Life_finished():
-	# set volume level to default
-	set_volume()
-
-# set the volume level
-func set_volume(volume = 0, fadeSpeed = 1):
-	# set the start volume level to the curren volume
-	startVolumeLevel = Global.music.volume_db
-	# set the volume level to go to
-	setVolumeLevel = volume
-	# set volume transition
-	volumeLerp = 0
-	# set the speed for the transition
-	volumeFadeSpeed = fadeSpeed
-	# this is continued in _process() as it needs to run during gameplay