Add universal game pausing system

Author: popcar2

Scenes/Taskbar/start_menu_option.gd

@@ -5,6 +5,7 @@ extends Panel
 @export var game_scene: String
 @export var title_text: String
 @export var description_text: String
+@export var use_generic_pause_menu: bool
 
 var is_mouse_over: bool
 
@@ -39,6 +40,9 @@ func spawn_window() -> void:
 	window = load("res://Scenes/Window/Game Window/game_window.tscn").instantiate()
 	window.get_node("%Game Window").add_child(load(game_scene).instantiate())
 
+	if use_generic_pause_menu:
+		window.get_node("%GamePauseManager").process_mode = Node.PROCESS_MODE_INHERIT
+	
 	window.title_text = %"Menu Title".text
 	get_tree().current_scene.add_child(window)
 

Scenes/Taskbar/start_menu_option.tscn

@@ -16,6 +16,7 @@ clip_contents = true
 custom_minimum_size = Vector2(0, 50)
 script = ExtResource("1_2fneu")
 game_scene = "res://Games/Cube Scene/cube_scene.tscn"
+use_generic_pause_menu = true
 
 [node name="Background Panel" type="Panel" parent="."]
 visible = false
@@ -68,7 +69,7 @@ grow_horizontal = 2
 size_flags_horizontal = 3
 mouse_filter = 2
 bbcode_enabled = true
-text = "[center]GodotOS"
+text = "[center]Game Title"
 
 [node name="Menu Description" type="RichTextLabel" parent="HBoxContainer/Control"]
 unique_name_in_owner = true
@@ -85,7 +86,7 @@ size_flags_horizontal = 3
 mouse_filter = 2
 theme_override_font_sizes/normal_font_size = 14
 bbcode_enabled = true
-text = "[center]GodotOS in GodotOS in GodotOS in"
+text = "[center]Your very cool game description"
 
 [connection signal="mouse_entered" from="." to="." method="_on_mouse_entered"]
 [connection signal="mouse_exited" from="." to="." method="_on_mouse_exited"]

Scenes/Window/Game Window/game_pause_manager.gd

@@ -0,0 +1,43 @@
+extends Node
+class_name GamePauseManager
+
+## A generic pause manager for games in GodotOS.
+## When you press ui_cancel, it pauses or unpauses.
+
+## NOTE: This node disabled by default but gets enabled by start menu option
+## if the generic pause menu bool is enabled there.
+
+@export var pause_packed_scene: PackedScene
+
+@onready var window: FakeWindow = $".."
+
+var is_paused: bool
+var current_pause_screen: CanvasLayer
+
+func _input(event: InputEvent) -> void:
+	if !window.is_selected:
+		return
+	
+	if event.is_action_pressed("ui_cancel"):
+		toggle_pause()
+
+## Pauses and adds the pause screen as a child to the game scene.
+## The reason for this is so the pause screen scales with the viewport.
+func toggle_pause() -> void:
+	if %"Game Window".get_child_count() == 0:
+		NotificationManager.spawn_notification("Error: No game scene to pause???")
+		return
+	
+	var game_scene: Node = %"Game Window".get_child(0)
+	
+	if is_paused:
+		game_scene.process_mode = Node.PROCESS_MODE_INHERIT
+		if current_pause_screen != null:
+			current_pause_screen.queue_free()
+	else:
+		game_scene.process_mode = Node.PROCESS_MODE_DISABLED
+		var pause_screen: CanvasLayer = pause_packed_scene.instantiate()
+		game_scene.add_child(pause_screen)
+		current_pause_screen = pause_screen
+	
+	is_paused = !is_paused

Scenes/Window/Game Window/game_window.gd

@@ -3,6 +3,7 @@ extends SubViewport
 ## The game window, used to show games.
 
 @onready var window: FakeWindow = $"../../.."
+@onready var game_pause_manager: GamePauseManager = %"GamePauseManager"
 
 func _ready() -> void:
 	window.minimized.connect(_handle_window_minimized)
@@ -14,6 +15,9 @@ func _ready() -> void:
 	#$"../..".size *= get_window().content_scale_factor
 
 func _handle_window_minimized(is_minimized: bool) -> void:
+	if game_pause_manager.is_paused:
+		return
+	
 	if is_minimized:
 		get_child(0).process_mode = Node.PROCESS_MODE_DISABLED
 	else:

Scenes/Window/Game Window/game_window.tscn

@@ -1,7 +1,9 @@
-[gd_scene load_steps=4 format=3 uid="uid://c73tsgfxmn37a"]
+[gd_scene load_steps=6 format=3 uid="uid://c73tsgfxmn37a"]
 
 [ext_resource type="PackedScene" uid="uid://cojrqff5vocjv" path="res://Scenes/Window/Window.tscn" id="1_r6cfa"]
 [ext_resource type="Script" path="res://Scenes/Window/Game Window/game_window.gd" id="2_83d0v"]
+[ext_resource type="Script" path="res://Scenes/Window/Game Window/game_pause_manager.gd" id="2_sh1be"]
+[ext_resource type="PackedScene" uid="uid://eprwl55n45fe" path="res://Scenes/Window/Game Window/pause_screen.tscn" id="3_uu1vi"]
 
 [sub_resource type="StyleBoxFlat" id="StyleBoxFlat_5cq01"]
 bg_color = Color(0.188235, 0.105882, 0.243137, 0.6)
@@ -19,7 +21,14 @@ theme_override_styles/panel = SubResource("StyleBoxFlat_5cq01")
 [node name="Title Text" parent="Top Bar" index="0"]
 texture_filter = 2
 
-[node name="AspectRatioContainer" type="AspectRatioContainer" parent="." index="1"]
+[node name="GamePauseManager" type="Node" parent="." index="1"]
+unique_name_in_owner = true
+process_mode = 4
+editor_description = "Disabled by default, gets enabled by start_menu_option at runtime."
+script = ExtResource("2_sh1be")
+pause_packed_scene = ExtResource("3_uu1vi")
+
+[node name="AspectRatioContainer" type="AspectRatioContainer" parent="." index="2"]
 layout_mode = 1
 anchors_preset = 15
 anchor_right = 1.0

Scenes/Window/Game Window/pause_screen.tscn

@@ -0,0 +1,30 @@
+[gd_scene format=3 uid="uid://eprwl55n45fe"]
+
+[node name="CanvasLayer" type="CanvasLayer"]
+
+[node name="ColorRect" type="ColorRect" parent="."]
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+mouse_filter = 1
+color = Color(0, 0, 0, 0.784314)
+
+[node name="RichTextLabel" type="RichTextLabel" parent="ColorRect"]
+layout_mode = 1
+anchors_preset = 8
+anchor_left = 0.5
+anchor_top = 0.5
+anchor_right = 0.5
+anchor_bottom = 0.5
+offset_left = -200.0
+offset_top = -45.0
+offset_right = 200.0
+offset_bottom = 45.0
+grow_horizontal = 2
+grow_vertical = 2
+mouse_filter = 2
+theme_override_font_sizes/normal_font_size = 64
+bbcode_enabled = true
+text = "[center]- PAUSED -"