Refactor ScreenTransition to autoload, add a (fixed) roaming encounter

Author: food-please

assets/gui/screen_transitions/wipe_horizontal.png

@@ -2,17 +2,15 @@ extends Cutscene
 
 @export var timeline: DialogicTimeline
 
-@onready var _screen_transition: = $CanvasLayer/ScreenTransition as ScreenTransition
-
 
 func _execute() -> void:
-	_screen_transition.cover()
+	Transition.cover()
 
 	Dialogic.start_timeline(timeline)
 	await Dialogic.timeline_ended
 
 	Music.play(load("res://assets/music/Apple Cider.mp3"))
-	_screen_transition.reveal(2.0)
-	await _screen_transition.finished
+	Transition.clear(2.0)
+	await Transition.finished
 
 	queue_free.call_deferred()

assets/gui/screen_transitions/wipe_horizontal.png.import

@@ -22,6 +22,7 @@ CombatEvents="*res://src/common/combat_events.gd"
 Dialogic="*res://addons/dialogic/Other/DialogicGameHandler.gd"
 FieldEvents="*res://src/common/field_events.gd"
 Music="*res://src/common/music/music_player.tscn"
+Transition="*res://src/common/screen_transitions/ScreenTransition.tscn"
 
 [dialogic]
 

maps/opening_cutscene.gd

@@ -8,8 +8,6 @@ class_name CombatArena extends Control
 func _unhandled_input(event: InputEvent) -> void:
 	if event.is_action_released("back"):
 		CombatEvents.combat_lost.emit()
-		CombatEvents.combat_finished.emit()
 
 	elif event.is_action_released("interact"):
 		CombatEvents.combat_won.emit()
-		CombatEvents.combat_finished.emit()

project.godot

@@ -4,19 +4,16 @@ extends Node
 ## Emitted whenever a combat is triggered. Technically, this event occurs within the field state.
 signal combat_initiated(arena: PackedScene)
 
-## Emitted immediately after the player has won combat and all animations have finished.
-## This is used to transition to the combat results screen and notify the combat-starting-trigger
-## of the combat result.
+## Emitted immediately after the player has won combat and all animations have finished. Also, the
+## the battle results screen has been displayed and dismissed.
+## This is used to fade the screen post-combat and notify the combat-starting-trigger of the result.
 signal combat_won
 
 ## Emitted immediately after the player has lost combat and all animations have finished.
 ## This is used to fade the screen post-combat and notify the combat-starting-trigger of the result.
 signal combat_lost
 
 ## Emitted whenever the player has finished with the combat state regardless of whether or not the
-## combat was won by the player.
-## If the player won the combat, the battle results screen has been displayed and dismissed and the
-## screen has faded to black.
-## If the player lost combat, the screen has faded to black. In most places, the "gameover" screen
-## will be displayed next.
+## combat was won by the player. At this point the screen has faded to black and any events that
+## immediately follow the combat may occur.
 signal combat_finished

src/combat/combat_arena.gd

@@ -0,0 +1,14 @@
+[gd_scene load_steps=2 format=3 uid="uid://cmoqpuygxc5w8"]
+
+[ext_resource type="Script" path="res://src/common/screen_transitions/screen_transition.gd" id="1_vr13h"]
+
+[node name="ScreenTransition" type="CanvasLayer"]
+script = ExtResource("1_vr13h")
+
+[node name="ColorRect" type="ColorRect" parent="."]
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+color = Color(0, 0, 0, 1)

src/common/combat_events.gd

@@ -6,7 +6,7 @@
 ## animation before transitioning (see [method reveal]) to gameplay.
 ##
 ## [br][br]ScreenTransitions cover or reveal the screen uniformly as a fade animation.
-class_name ScreenTransition extends ColorRect
+class_name ScreenTransition extends CanvasLayer
 
 ## Emitted when the screen has finished the current animation, whether that is to [method cover] the
 ## screen or [method reveal] the screen.
@@ -23,47 +23,63 @@ const COVERED: = Color.WHITE
 
 var _tween: Tween
 
+@onready var _color_rect: = $ColorRect as ColorRect
+
 
 func _ready() -> void:
-	mouse_filter = Control.MOUSE_FILTER_IGNORE
+	# The screen transitions need to run over the gameplay, which is instantiated below all
+	# autoloads (including this class). Therefore, we want to move the ScreenTransition object to
+	# the very bottom of the SceneTree's child list.
+	# We cannot do so during ready, in which this node's parents are not yet ready. Therefore the
+	# call to move_child must be deferred a frame.
+	get_parent().move_child.call_deferred(self, get_parent().get_child_count()-1)
+	
+	# Allow the mouse through the transition GUI elements.
+	_color_rect.mouse_filter = Control.MOUSE_FILTER_IGNORE
 
 	# By default, do NOT have the ColorRect covering the screen.
 	show()
-	reveal()
+	clear()
 
 
 ## Hide the ColorRect instantly, unless the duration argument is non-zero.
-func reveal(duration: = 0.0) -> void:
+## This method is a coroutine that will finish once the screen has been cleared.
+func clear(duration: = 0.0) -> void:
 	if _tween:
 		_tween.kill()
 		_tween = null
 		finished.emit()
 
-	if is_equal_approx(duration, 0.0):
-		modulate = CLEAR
+	if is_equal_approx(duration, 0.0) or _color_rect.modulate.is_equal_approx(CLEAR):
+		_color_rect.modulate = CLEAR
 		call_deferred("emit_signal", "finished")
 
 	else:
 		_tween_transition(duration, CLEAR)
+	
+	await finished
 
 
 ## Cover the screen instantly, unless the duration argument is non-zero.
+## This method is a coroutine that will finish once the screen has been covered.
 func cover(duration: = 0.0) -> void:
 	if _tween:
 		_tween.kill()
 		_tween = null
 		finished.emit()
 
-	if is_equal_approx(duration, 0.0):
-		modulate = COVERED
+	if is_equal_approx(duration, 0.0) or _color_rect.modulate.is_equal_approx(COVERED):
+		_color_rect.modulate = COVERED
 		call_deferred("emit_signal", "finished")
 
 	else:
 		_tween_transition(duration, COVERED)
+	
+	await finished
 
 
 # Relegate the tween creation to a method so that derived classes can easily change transition type.
 func _tween_transition(duration: float, target_colour: Color) -> void:
 	_tween = create_tween()
-	_tween.tween_property(self, "modulate", target_colour, duration)
+	_tween.tween_property(_color_rect, "modulate", target_colour, duration)
 	_tween.tween_callback(func(): finished.emit())