Added animated focus outline, titles to option sections and improved btn navigation (#191)

* Button hover state theme is now unique

* Add focus outline manager (WIP)

* Stop relying on Godot built in theme / manual node

* Only show outline on keyboard or gamepad

* Do not initially show focus outline on scene change

* Manually try to fix options btn navigation

* Fix many btn nav errors through script

* Added scripted title to options

Author: valkyrienyanko

Framework/Autoloads/Autoloads.cs

@@ -22,14 +22,15 @@ public partial class Autoloads : Node
 
     public static Autoloads Instance { get; private set; }
 
-    public ComponentManager ComponentManager { get; private set; } // Cannot use [Export] here because Godot will bug out and unlink export path in editor after setup completes and restarts the editor
-    public GameConsole      GameConsole      { get; private set; } // Cannot use [Export] here because Godot will bug out and unlink export path in editor after setup completes and restarts the editor
-    public AudioManager     AudioManager     { get; private set; }
-    public OptionsManager   OptionsManager   { get; private set; }
-    public Services         Services         { get; private set; }
-    public MetricsOverlay   MetricsOverlay   { get; private set; }
-    public SceneManager     SceneManager     { get; private set; }
-    public Profiler         Profiler         { get; private set; }
+    public ComponentManager    ComponentManager { get; private set; } // Cannot use [Export] here because Godot will bug out and unlink export path in editor after setup completes and restarts the editor
+    public GameConsole         GameConsole      { get; private set; } // Cannot use [Export] here because Godot will bug out and unlink export path in editor after setup completes and restarts the editor
+    public AudioManager        AudioManager     { get; private set; }
+    public OptionsManager      OptionsManager   { get; private set; }
+    public Services            Services         { get; private set; }
+    public MetricsOverlay      MetricsOverlay   { get; private set; }
+    public SceneManager        SceneManager     { get; private set; }
+    public Profiler            Profiler         { get; private set; }
+    public FocusOutlineManager FocusOutline     { get; private set; }
 
 #if NETCODE_ENABLED
     public Logger Logger { get; private set; }
@@ -51,6 +52,7 @@ public override void _EnterTree()
         MetricsOverlay = new MetricsOverlay();
         Profiler = new Profiler();
         GameConsole = GetNode<GameConsole>("%Console");
+        FocusOutline = new FocusOutlineManager(this);
 
 #if NETCODE_ENABLED
         Logger = new Logger(GameConsole);

Framework/Autoloads/Autoloads.tscn

@@ -1,4 +1,4 @@
-[gd_scene load_steps=10 format=3 uid="uid://cj4fbh1a1lpq4"]
+[gd_scene load_steps=11 format=3 uid="uid://cj4fbh1a1lpq4"]
 
 [ext_resource type="Script" uid="uid://cdt2k6s3xm13g" path="res://Framework/Autoloads/Autoloads.cs" id="1_00yjk"]
 [ext_resource type="PackedScene" uid="uid://rbcqvr4snrvn" path="res://Framework/Scenes/MenuUI/Credits/Credits.tscn" id="2_xdmsn"]
@@ -8,6 +8,7 @@
 [ext_resource type="PackedScene" uid="uid://d1jo48n2hdkih" path="res://Framework/ModLoader/ModLoader.tscn" id="4_ems5f"]
 [ext_resource type="PackedScene" uid="uid://7tfets4irkba" path="res://Framework/Scenes/Options/Options.tscn" id="5_vm4c5"]
 [ext_resource type="Script" uid="uid://17yxgcswri77" path="res://Framework/Scenes/MenuScenes.cs" id="6_2fq88"]
+[ext_resource type="Texture2D" uid="uid://djggjhepn0bsf" path="res://Framework/Theme/CornerDashOutline.png" id="9_3cpyl"]
 
 [sub_resource type="Resource" id="Resource_xdmsn"]
 script = ExtResource("6_2fq88")
@@ -17,12 +18,10 @@ Options = ExtResource("5_vm4c5")
 Credits = ExtResource("2_xdmsn")
 metadata/_custom_type_script = "uid://17yxgcswri77"
 
-[node name="Autoloads" type="Node" node_paths=PackedStringArray("GameConsole", "ComponentManager")]
+[node name="Autoloads" type="Node"]
 process_mode = 3
 script = ExtResource("1_00yjk")
 _scenes = SubResource("Resource_xdmsn")
-GameConsole = NodePath("Debug/Console")
-ComponentManager = NodePath("ComponentManager")
 
 [node name="ComponentManager" type="Node" parent="."]
 process_mode = 1
@@ -33,3 +32,13 @@ layer = 128
 
 [node name="Console" parent="Debug" instance=ExtResource("4_8po21")]
 unique_name_in_owner = true
+
+[node name="CornerDashOutline" type="NinePatchRect" parent="."]
+z_index = 1
+offset_right = 40.0
+offset_bottom = 40.0
+texture = ExtResource("9_3cpyl")
+patch_margin_left = 8
+patch_margin_top = 8
+patch_margin_right = 8
+patch_margin_bottom = 8

Framework/Autoloads/SceneManager.cs

@@ -8,10 +8,8 @@ namespace __TEMPLATE__;
 // About Scene Switching: https://docs.godotengine.org/en/latest/tutorials/scripting/singletons_autoload.html
 public class SceneManager
 {
-    /// <summary>
-    /// The event is invoked right before the scene is changed
-    /// </summary>
     public event Action<string> PreSceneChanged;
+    public event Action<string> PostSceneChanged;
 
     public const int DefaultSceneFadeDuration = 2;
 
@@ -55,6 +53,8 @@ public void SwitchTo(PackedScene scene, TransType transType = TransType.None)
                 FadeTo(TransColor.Black, DefaultSceneFadeDuration, () => ChangeScene(path, transType));
                 break;
         }
+
+        PostSceneChanged?.Invoke(path);
     }
 
     /// <summary>
@@ -71,6 +71,8 @@ public void ResetCurrentScene()
 
         // Wait for engine to be ready before switching scenes
         _autoloads.CallDeferred(nameof(Autoloads.DeferredSwitchSceneProxy), sceneFilePath, Variant.From(TransType.None));
+
+        PostSceneChanged?.Invoke(sceneName);
     }
 
     public void DeferredSwitchScene(string rawName, Variant transTypeVariant)

Framework/Game.cs

@@ -34,6 +34,7 @@ private static T IsAutoloadsSetup<T>(Func<Autoloads, T> getPropertyFrom, string
         return getPropertyFrom(autoloads)!; // Assumes the field may be null, but we are not checking it here
     }
 
+    public static FocusOutlineManager FocusOutline => IsAutoloadsSetup(a => a.FocusOutline, nameof(FocusOutline));
     public static MetricsOverlay Metrics => IsAutoloadsSetup(a => a.MetricsOverlay, nameof(Metrics));
     public static OptionsManager Options => IsAutoloadsSetup(a => a.OptionsManager, nameof(Options));
     public static AudioManager Audio => IsAutoloadsSetup(a => a.AudioManager, nameof(Audio));
@@ -44,13 +45,14 @@ private static T IsAutoloadsSetup<T>(Func<Autoloads, T> getPropertyFrom, string
     public static Logger Logger => IsAutoloadsSetup(a => a.Logger, nameof(Logger));
 #else
     // The games release will not have the slow debugging checks
-    public static MetricsOverlay Metrics  => Autoloads.Instance.MetricsOverlay;
-    public static OptionsManager Options  => Autoloads.Instance.OptionsManager;
-    public static AudioManager   Audio    => Autoloads.Instance.AudioManager;
-    public static SceneManager   Scene    => Autoloads.Instance.SceneManager;
-    public static GameConsole    Console  => Autoloads.Instance.GameConsole;
-    public static Profiler       Profiler => Autoloads.Instance.Profiler;
-    public static Services       Services => Autoloads.Instance.Services;
-    public static Logger         Logger   => Autoloads.Instance.Logger;
+    public static FocusOutlineManager FocusOutline => Autoloads.Instance.FocusOutline;
+    public static MetricsOverlay      Metrics      => Autoloads.Instance.MetricsOverlay;
+    public static OptionsManager      Options      => Autoloads.Instance.OptionsManager;
+    public static AudioManager        Audio        => Autoloads.Instance.AudioManager;
+    public static SceneManager        Scene        => Autoloads.Instance.SceneManager;
+    public static GameConsole         Console      => Autoloads.Instance.GameConsole;
+    public static Profiler            Profiler     => Autoloads.Instance.Profiler;
+    public static Services            Services     => Autoloads.Instance.Services;
+    public static Logger              Logger       => Autoloads.Instance.Logger;
 #endif
-        }
+}

Framework/Scenes/MainMenuNav.cs

@@ -11,6 +11,7 @@ public partial class MainMenuNav : Node
     public override void _Ready()
     {
         _scene = Game.Scene;
+        Game.FocusOutline.IgnoreNextFocus();
         GetNode<Button>("Play").GrabFocus();
     }
 

Framework/Scenes/MenuUI/MainMenu/MainMenu.tscn

@@ -3,7 +3,6 @@
 [ext_resource type="PackedScene" uid="uid://djhd6uw7l1ok" path="res://Level.tscn" id="3_xo0to"]
 [ext_resource type="Script" uid="uid://bi551lrt82awu" path="res://Framework/Scenes/MainMenuNav.cs" id="5_sc4as"]
 
-
 [node name="Main Menu" type="PanelContainer"]
 anchors_preset = 15
 anchor_right = 1.0
@@ -43,6 +42,7 @@ text = "CREDITS"
 [node name="Quit" type="Button" parent="Nav"]
 custom_minimum_size = Vector2(175, 60)
 layout_mode = 2
+focus_neighbor_bottom = NodePath("../../Socials/HBox/Discord")
 text = "QUIT"
 
 [node name="Socials" type="MarginContainer" parent="."]

Framework/Scenes/Options/Options.cs

@@ -12,26 +12,15 @@ public partial class Options : PanelContainer
     private OptionsAudio _optionsAudio;
     private OptionsInput _optionsInput;
 
-    public override void _EnterTree()
-    {
-        _optionsNav = new OptionsNav(this);
-        _optionsGeneral = new OptionsGeneral(this);
-        _optionsGameplay = new OptionsGameplay(this);
-        _optionsDisplay = new OptionsDisplay(this);
-        _optionsGraphics = new OptionsGraphics(this);
-        _optionsAudio = new OptionsAudio(this);
-        _optionsInput = new OptionsInput(this);
-    }
-
     public override void _Ready()
     {
-        _optionsNav.Initialize();
-        _optionsGeneral.Initialize();
-        _optionsGameplay.Initialize();
-        _optionsDisplay.Initialize();
-        _optionsGraphics.Initialize();
-        _optionsAudio.Initialize();
-        _optionsInput.Initialize();
+        _optionsNav = new OptionsNav(this, GetNode<Label>("%Title"));
+        _optionsGeneral = new OptionsGeneral(this, _optionsNav.GeneralButton);
+        _optionsGameplay = new OptionsGameplay(this, _optionsNav.GameplayButton);
+        _optionsDisplay = new OptionsDisplay(this, _optionsNav.DisplayButton);
+        _optionsGraphics = new OptionsGraphics(this, _optionsNav.GraphicsButton);
+        _optionsAudio = new OptionsAudio(this);
+        _optionsInput = new OptionsInput(this, _optionsNav.InputButton);
     }
 
     public override void _Input(InputEvent @event)