add pause menu

Author: dually8

KirbVania/Levels/main.tscn

@@ -1,10 +1,11 @@
-[gd_scene load_steps=12 format=3 uid="uid://bxpyucm48u158"]
+[gd_scene load_steps=13 format=3 uid="uid://bxpyucm48u158"]
 
 [ext_resource type="PackedScene" uid="uid://ewtdtlls7g4l" path="res://Prefabs/hud.tscn" id="1_45dd7"]
 [ext_resource type="Script" path="res://Scripts/GameManager.cs" id="1_mavl2"]
 [ext_resource type="Texture2D" uid="uid://c6vahw4halja1" path="res://Assets/Castlevania_Level1.png" id="1_y2iyb"]
 [ext_resource type="Texture2D" uid="uid://b7laf5rrynmj7" path="res://Assets/Castlevania_Tileset.png" id="2_8j0dx"]
 [ext_resource type="PackedScene" uid="uid://br7qwturgnoix" path="res://Prefabs/player.tscn" id="3_hev6s"]
+[ext_resource type="PackedScene" uid="uid://d1000cpwd36l0" path="res://Prefabs/pause_menu.tscn" id="3_ipq38"]
 [ext_resource type="PackedScene" uid="uid://o55thht06h1l" path="res://Prefabs/light.tscn" id="5_fb8rp"]
 [ext_resource type="PackedScene" uid="uid://csav025q8eiw1" path="res://Prefabs/boundary.tscn" id="8_opuld"]
 [ext_resource type="PackedScene" uid="uid://b2wo84efmnnq" path="res://Prefabs/enemy_spawner.tscn" id="9_ofw52"]
@@ -281,15 +282,19 @@ physics_layer_0/collision_layer = 1
 physics_layer_0/collision_mask = 62
 sources/1 = SubResource("TileSetAtlasSource_r0vr1")
 
-[node name="Main" type="Node2D" node_paths=PackedStringArray("_player", "_hud")]
+[node name="Main" type="Node2D" node_paths=PackedStringArray("_player", "_hud", "_pauseMenu")]
 script = ExtResource("1_mavl2")
 _player = NodePath("Player")
 _hud = NodePath("UI/HUD")
+_pauseMenu = NodePath("UI/PauseMenu")
 
 [node name="UI" type="CanvasLayer" parent="."]
 
 [node name="HUD" parent="UI" instance=ExtResource("1_45dd7")]
 
+[node name="PauseMenu" parent="UI" instance=ExtResource("3_ipq38")]
+visible = false
+
 [node name="CastlevaniaLevel1" type="Sprite2D" parent="."]
 visible = false
 modulate = Color(1, 0.701961, 0.701961, 0.501961)

KirbVania/Prefabs/main_menu.tscn

@@ -36,6 +36,8 @@ theme_override_constants/separation = 16
 layout_mode = 2
 text = "KirbVania"
 label_settings = SubResource("LabelSettings_d8sct")
+horizontal_alignment = 1
+vertical_alignment = 1
 
 [node name="PlayBtn" type="Button" parent="MarginContainer/VBoxContainer"]
 unique_name_in_owner = true

KirbVania/Prefabs/options_menu.tscn

@@ -36,6 +36,8 @@ theme_override_constants/separation = 16
 layout_mode = 2
 text = "Options"
 label_settings = SubResource("LabelSettings_d8sct")
+horizontal_alignment = 1
+vertical_alignment = 1
 
 [node name="BackButton" type="Button" parent="MarginContainer/VBoxContainer"]
 unique_name_in_owner = true

KirbVania/Prefabs/pause_menu.tscn

@@ -0,0 +1,57 @@
+[gd_scene load_steps=3 format=3 uid="uid://d1000cpwd36l0"]
+
+[ext_resource type="Script" path="res://Scripts/PauseMenu.cs" id="1_607jt"]
+
+[sub_resource type="LabelSettings" id="LabelSettings_d8sct"]
+font_size = 36
+
+[node name="PauseMenu" type="Control"]
+process_mode = 2
+layout_mode = 3
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+script = ExtResource("1_607jt")
+
+[node name="MarginContainer" type="MarginContainer" parent="."]
+layout_mode = 1
+anchors_preset = 8
+anchor_left = 0.5
+anchor_top = 0.5
+anchor_right = 0.5
+anchor_bottom = 0.5
+offset_left = -68.5
+offset_top = -48.5
+offset_right = 68.5
+offset_bottom = 48.5
+grow_horizontal = 2
+grow_vertical = 2
+
+[node name="VBoxContainer" type="VBoxContainer" parent="MarginContainer"]
+layout_mode = 2
+theme_override_constants/separation = 16
+
+[node name="Title" type="Label" parent="MarginContainer/VBoxContainer"]
+layout_mode = 2
+text = "Pause"
+label_settings = SubResource("LabelSettings_d8sct")
+horizontal_alignment = 1
+vertical_alignment = 1
+
+[node name="ResumeBtn" type="Button" parent="MarginContainer/VBoxContainer"]
+layout_mode = 2
+focus_neighbor_bottom = NodePath("../OptionsBtn")
+text = "Resume"
+
+[node name="OptionsBtn" type="Button" parent="MarginContainer/VBoxContainer"]
+layout_mode = 2
+focus_neighbor_top = NodePath("../ResumeBtn")
+focus_neighbor_bottom = NodePath("../ExitBtn")
+text = "Options"
+
+[node name="ExitBtn" type="Button" parent="MarginContainer/VBoxContainer"]
+layout_mode = 2
+focus_neighbor_top = NodePath("../OptionsBtn")
+text = "Exit"

KirbVania/Scripts/GameManager.cs

@@ -1,11 +1,15 @@
 using Godot;
 using System;
+using KirbVania.Scripts;
 
 public partial class GameManager : Node2D
 {
 	[Export] private Player _player { get; set; }
 	[Export] private HUD _hud { get; set; }
+	[Export] private PauseMenu _pauseMenu { get; set; }
+
 	private int _score = 0;
+	private bool _isPaused = false;
 	private AudioStreamPlayer2D _levelMusic;
 
 	public override void _Ready()
@@ -16,6 +20,14 @@ public override void _Ready()
 		InitializeUI();
 	}
 
+	public override void _Input(InputEvent @event)
+	{
+		if (@event.IsActionPressed(InputActions.TogglePause))
+		{
+			PauseGame();
+		}
+	}
+
 	private void OnPlayerScoreIncrease(int amount)
 	{
 		_score += amount;
@@ -37,4 +49,21 @@ private void InitializeUI()
 		_hud.SetScore(0);
 		_hud.SetHealth(6);
 	}
+
+	private void PauseGame()
+	{
+		if (_isPaused) return;
+		_isPaused = true;
+		_pauseMenu.Show();
+		_levelMusic.StreamPaused = true;
+		GetTree().Paused = true;
+	}
+
+	public void UnpauseGame()
+	{
+		if (!_isPaused) return;
+		_isPaused = false;
+		_levelMusic.StreamPaused = false;
+		GetTree().Paused = false;
+	}
 }

KirbVania/Scripts/InputActions.cs

@@ -0,0 +1,15 @@
+namespace KirbVania.Scripts;
+
+/// <summary>
+/// Constants for input actions.
+/// Be sure to update the Input Map in Project Settings
+/// such that the actions match the constants below.
+/// </summary>
+public static class InputActions
+{
+	public static string MoveLeft => "move_left";
+	public static string MoveRight => "move_right";
+	public static string Jump => "jump";
+	public static string Attack => "attack";
+	public static string TogglePause => "toggle_pause";
+}

KirbVania/Scripts/PauseMenu.cs

@@ -0,0 +1,55 @@
+using Godot;
+using System;
+
+public partial class PauseMenu : Control
+{
+	private Button _resumeButton;
+	private Button _optionsButton;
+	private Button _exitButton;
+	private GameManager _gameManager;
+
+	public override void _Ready()
+	{
+		_resumeButton = GetNode<Button>("MarginContainer/VBoxContainer/ResumeBtn");
+		_resumeButton.Pressed += OnResumePressed;
+		_resumeButton.GrabFocus();
+		_optionsButton = GetNode<Button>("MarginContainer/VBoxContainer/OptionsBtn");
+		_optionsButton.Pressed += OnOptionsPressed;
+		_exitButton = GetNode<Button>("MarginContainer/VBoxContainer/ExitBtn");
+		_exitButton.Pressed += OnExitPressed;
+		_gameManager = GetNode<GameManager>("/root/Main");
+		VisibilityChanged += OnVisibilityChanged;
+	}
+
+	private void OnVisibilityChanged()
+	{
+		if (Visible)
+		{
+			_resumeButton.GrabFocus();
+		}
+		else
+		{
+			_resumeButton.ReleaseFocus();
+		}
+	}
+
+	private void OnResumePressed()
+	{
+		// Unpause the game
+		_gameManager.UnpauseGame();
+	}
+
+	private void OnOptionsPressed()
+	{
+		// Go to options menu
+		// GetTree().ChangeSceneToFile("res://Prefabs/options_menu.tscn");
+		GD.Print("TODO: Implement options menu that can come back to this thing");
+	}
+
+	private void OnExitPressed()
+	{
+		// Exit to main menu
+		GetTree().Paused = false;
+		GetTree().ChangeSceneToFile("res://Prefabs/main_menu.tscn");
+	}
+}

KirbVania/Scripts/Player.cs

@@ -101,14 +101,12 @@ public override void _Process(double delta)
 
 	public override void _PhysicsProcess(double delta)
 	{
-		if (Input.IsActionJustPressed("quit"))
-			GetTree().Quit();
 		HandleMovement((float)delta);
 	}
 
 	public override void _Input(InputEvent @event)
 	{
-		if (@event.IsActionPressed("attack"))
+		if (@event.IsActionPressed(InputActions.Attack))
 		{
 			_isAttacking = true;
 			TryAttack();
@@ -156,7 +154,7 @@ public void Heal(int amount)
 	private void Die()
 	{
 		// TODO: Display game over screen
-		GetTree().ReloadCurrentScene();
+		GetTree().ChangeSceneToFile("res://Prefabs/main_menu.tscn");
 	}
 
 	#endregion
@@ -205,7 +203,7 @@ private void HandleMovement(float delta)
 		}
 
 		// Handle Jump.
-		if (Input.IsActionJustPressed("jump") && IsOnFloor())
+		if (Input.IsActionJustPressed(InputActions.Jump) && IsOnFloor())
 		{
 			velocity.Y = JumpVelocity;
 			// Play jump sound
@@ -228,7 +226,7 @@ private void HandleMovement(float delta)
 		else
 		{
 			// Handle horizontal movement
-			var direction = Input.GetAxis("move_left", "move_right");
+			var direction = Input.GetAxis(InputActions.MoveLeft, InputActions.MoveRight);
 			velocity.X = _isAttacking && IsOnFloor() ? 0 : direction * Speed;
 		}
 

KirbVania/project.godot

@@ -69,11 +69,12 @@ attack={
 , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":2,"pressure":0.0,"pressed":true,"script":null)
 ]
 }
-quit={
+toggle_pause={
 "deadzone": 0.5,
-"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":81,"key_label":0,"unicode":113,"echo":false,"script":null)
+"events": [Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":true,"script":null)
+, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194306,"key_label":0,"unicode":0,"echo":false,"script":null)
 , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194305,"key_label":0,"unicode":0,"echo":false,"script":null)
-, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":4,"pressure":0.0,"pressed":true,"script":null)
+, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":80,"key_label":0,"unicode":112,"echo":false,"script":null)
 ]
 }