Improve GlobalUI

* Rename overlayRect to tintRect, pauseOverlayRect to pauseTintRect, & related
* Add "Now Playing" music label UI & showMusicLabel()
* Reorganize code

Author: ShinryakuTako

AutoLoad/GlobalUI.gd

@@ -41,9 +41,13 @@ const pauseOverlayScene := preload("res://UI/PauseOverlay.tscn")
 @onready var foregroundOverlay:		CanvasLayer				= %ForegroundOverlay
 @onready var labelsList:			TemporaryLabelList		= %LabelsList
 @onready var navigationContainer:	UINavigationContainer	= %NavigationContainer ## For top-level UI
-@onready var overlayRect:			ColorRect				= %GlobalOverlayRect
-@onready var pauseOverlayRect:		ColorRect				= %PauseOverlayRect
+@onready var tintRect:				ColorRect				= %GlobalTintRect
+
+@onready var pauseTintRect:			ColorRect				= %PauseTintRect
 @onready var pauseOverlayContainer:	UINavigationContainer	= %PauseOverlayContainer
+
+@onready var musicLabelContainer:	Container				= %MusicLabelContainer
+@onready var musicLabel:			Label					= %MusicLabel
 #endregion
 
 
@@ -59,6 +63,9 @@ func _ready() -> void:
 		if windowMode != DisplayServer.WINDOW_MODE_FULLSCREEN and windowMode != DisplayServer.WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
 			GlobalUI.setWindowSize(Settings.windowWidth, Settings.windowHeight, false) # !showLabel to avoid clutter
 
+	musicLabelContainer.position.y = musicLabel.get_viewport_rect().end.y
+	Tools.connectSignal(GlobalSonic.musicPlayerDidPlay, self.onGlobalSonic_musicPlayerDidPlay)
+
 
 func setWindowSize(width: int, height: int, showLabel: bool = true) -> void:
 	var viewport:	Viewport = self.get_viewport()
@@ -100,7 +107,7 @@ func showPauseVisuals(isPaused: bool) -> void:
 		# Ensure visibility just in case
 		pauseOverlay.pauseButton.visible = true
 		pauseOverlay.visible = true
-		Animations.fadeIn(pauseOverlayRect)
+		Animations.fadeIn(pauseTintRect)
 		if pauseOverlayTween: pauseOverlayTween.kill()
 		pauseOverlayTween = Animations.fadeIn(pauseOverlayContainer, 0.2)
 		didShowPauseOverlay.emit(pauseOverlay)
@@ -109,7 +116,7 @@ func showPauseVisuals(isPaused: bool) -> void:
 
 		if pauseOverlay: pauseOverlay.pauseButton.visible = false
 
-		Animations.fadeOut(pauseOverlayRect)
+		Animations.fadeOut(pauseTintRect)
 		if pauseOverlayTween: pauseOverlayTween.kill()
 		pauseOverlayTween = Animations.fadeOut(pauseOverlayContainer, 0.2)
 		await pauseOverlayTween.finished
@@ -125,23 +132,55 @@ func showPauseVisuals(isPaused: bool) -> void:
 	navigationContainer.visible = not pauseOverlayContainer.visible
 
 
-func createTemporaryLabel(text: String) -> Label:
-	return labelsList.createTemporaryLabel(text)
-
+func onGlobalSonic_musicPlayerDidPlay(fileName: String) -> void:
+	showMusicLabel(fileName.get_basename().get_file())
 
 #region Animations
 
 ## Fades in the global overlay, which may be a solid black rectangle, effectively fading OUT the actual game content.
-func fadeInOverlayRect() -> Tween:
+func fadeInTintRect() -> Tween:
 	if rectFadeTween: rectFadeTween.kill()
-	rectFadeTween = Animations.fadeIn(overlayRect)
+	rectFadeTween = Animations.fadeIn(tintRect)
 	return rectFadeTween
 
 
 ## Fades out the global overlay, which may be a solid black rectangle, effectively fading IN the actual game content.
-func fadeOutOverlayRect() -> Tween:
+func fadeOutTintRect() -> Tween:
 	if rectFadeTween: rectFadeTween.kill()
-	rectFadeTween = Animations.fadeOut(overlayRect)
+	rectFadeTween = Animations.fadeOut(tintRect)
 	return rectFadeTween
 
+
+## @experimental
+func showMusicLabel(title: String) -> void:
+	# TODO: Fix interrupted animations
+
+	const margin:		float = 4.0
+	const showTime:		float = 0.5
+	const hideTime:		float = 0.5
+	const waitTIme:		float = 2.0
+
+	# musicLabel.text				= "" # Let any existing title be animated into the new one ^^
+	musicLabelContainer.position.y	= musicLabelContainer.get_viewport_rect().end.y
+	musicLabelContainer.modulate	= Color(Color.CYAN, 0)
+	musicLabelContainer.visible		= true
+
+	Animations.tweenProperty(musicLabel, ^"text", title, showTime)
+
+	var slideAnimation: Tween = Animations.tweenProperty(musicLabelContainer, ^"position:y", musicLabelContainer.get_viewport_rect().end.y - 16 - margin, showTime) \
+		.set_ease(Tween.EASE_OUT)
+	Animations.fadeIn(musicLabelContainer, showTime)
+
+	await slideAnimation.finished
+	await SceneManager.sceneTree.create_timer(waitTIme).timeout
+
+	Animations.tweenProperty(musicLabel, ^"text", "", hideTime)
+	Animations.tweenProperty(musicLabelContainer, ^"position:y", musicLabelContainer.get_viewport_rect().end.y, hideTime) \
+		.set_ease(Tween.EASE_OUT)
+	Animations.fadeOut(musicLabelContainer, hideTime)
+
+
+func createTemporaryLabel(text: String) -> Label:
+	return labelsList.createTemporaryLabel(text)
+
 #endregion

AutoLoad/GlobalUI.tscn

@@ -1,9 +1,15 @@
-[gd_scene load_steps=5 format=3 uid="uid://bqsh8lrdxmljt"]
+[gd_scene load_steps=8 format=3 uid="uid://bqsh8lrdxmljt"]
 
 [ext_resource type="Script" uid="uid://152oaj1p6c27" path="res://AutoLoad/GlobalUI.gd" id="1_6ujyj"]
 [ext_resource type="Script" uid="uid://dlj44gyo6xh11" path="res://UI/UINavigationContainer.gd" id="2_vibvi"]
 [ext_resource type="Script" uid="uid://cyqog03afsper" path="res://UI/Lists/TemporaryLabelList.gd" id="3_vibvi"]
+[ext_resource type="Material" uid="uid://b3pgi66bf5g2e" path="res://Assets/Materials/AddUnshaded.tres" id="4_c88uu"]
 [ext_resource type="Shortcut" uid="uid://c4er757mljhl4" path="res://Resources/Shortcuts/BackShortcut.tres" id="4_u63o5"]
+[ext_resource type="Texture2D" uid="uid://clox863hbl6dx" path="res://Assets/Tiles/Kenney1Bit-Monochrome-Transparent.png" id="4_vibvi"]
+
+[sub_resource type="AtlasTexture" id="AtlasTexture_c88uu"]
+atlas = ExtResource("4_vibvi")
+region = Rect2(624, 256, 16, 16)
 
 [node name="GlobalUI" type="Node"]
 process_mode = 3
@@ -38,7 +44,7 @@ size_flags_vertical = 4
 shortcut = ExtResource("4_u63o5")
 text = "<"
 
-[node name="GlobalOverlayRect" type="ColorRect" parent="ForegroundOverlay"]
+[node name="GlobalTintRect" type="ColorRect" parent="ForegroundOverlay"]
 unique_name_in_owner = true
 visible = false
 modulate = Color(1, 1, 1, 0)
@@ -50,7 +56,35 @@ grow_vertical = 2
 mouse_filter = 2
 color = Color(0.15, 0, 0.3, 1)
 
-[node name="PauseOverlayRect" type="ColorRect" parent="ForegroundOverlay"]
+[node name="MusicLabelContainer" type="HBoxContainer" parent="ForegroundOverlay"]
+unique_name_in_owner = true
+modulate = Color(0, 1, 1, 1)
+material = ExtResource("4_c88uu")
+custom_minimum_size = Vector2(64, 16)
+anchors_preset = 2
+anchor_top = 1.0
+anchor_bottom = 1.0
+offset_left = 4.0
+offset_top = -16.0
+offset_right = 96.0
+grow_vertical = 0
+size_flags_horizontal = 3
+size_flags_vertical = 8
+
+[node name="MusicIcon" type="TextureRect" parent="ForegroundOverlay/MusicLabelContainer"]
+layout_mode = 2
+size_flags_horizontal = 0
+size_flags_vertical = 4
+texture = SubResource("AtlasTexture_c88uu")
+stretch_mode = 2
+
+[node name="MusicLabel" type="Label" parent="ForegroundOverlay/MusicLabelContainer"]
+unique_name_in_owner = true
+custom_minimum_size = Vector2(0, 8)
+layout_mode = 2
+text = "Now Playing"
+
+[node name="PauseTintRect" type="ColorRect" parent="ForegroundOverlay"]
 unique_name_in_owner = true
 visible = false
 modulate = Color(1, 1, 1, 0)

AutoLoad/SceneManager.gd

@@ -77,7 +77,7 @@ func transitionToScene(nextScene: PackedScene, pauseSceneTree: bool = true, anim
 
 	# Pause
 	sceneTree.paused = pauseSceneTree
-	if animate: await GlobalUI.fadeInOverlayRect().finished # Fade the overlay in, fade the game out.
+	if animate: await GlobalUI.fadeInTintRect().finished # Fade the overlay in, fade the game out.
 
 	# Transition
 	sceneTree.change_scene_to_packed(nextScene)
@@ -86,7 +86,7 @@ func transitionToScene(nextScene: PackedScene, pauseSceneTree: bool = true, anim
 	# Unpause
 	await sceneTree.create_timer(0.1).timeout # A little breath before showing the next scene
 	sceneTree.paused = false # Unpause to begin the gameplay motion before the overlay fades-out for a smoother feel, instead of an abrupt movement.
-	if animate: await GlobalUI.fadeOutOverlayRect().finished # Fade the overlay out, fade the game in.
+	if animate: await GlobalUI.fadeOutTintRect().finished # Fade the overlay out, fade the game in.
 
 	ongoingTransitionScene = null # Clear the transition tracker
 	if Debug.shouldPrintDebugLogs: Debug.printDebug(str("SceneTree.current_scene: ", sceneTree.current_scene), logName)