From 92aa45646c91c17b8b008b870d2bf2b74ff6c371 Mon Sep 17 00:00:00 2001
From: Mark Joshwel <mark@joshwel.co>
Date: Sun, 11 Aug 2024 07:20:58 +0800
Subject: [PATCH] game(ui): interim overlay uxmls and skeleton scripts

---
 .../Scripts/OverlayCompleteUnderTimeMenu.cs   | 22 +++++
 .../OverlayCompleteUnderTimeMenu.cs.meta      |  3 +
 .../Scripts/OverlayFailedOverTimeMenu.cs      | 22 +++++
 .../Scripts/OverlayFailedOverTimeMenu.cs.meta |  3 +
 .../Assets/Scripts/OverlayPauseMenu.cs        | 22 +++++
 .../Assets/Scripts/OverlayPauseMenu.cs.meta   |  3 +
 .../Assets/Scripts/ScreenMainMenu.cs          | 86 ++++++++++++++++++
 .../Assets/Scripts/ScreenMainMenu.cs.meta     |  3 +
 .../Assets/Scripts/ScreenOptionsMenu.cs       | 90 +++++++++++++++++++
 .../Assets/Scripts/ScreenOptionsMenu.cs.meta  |  3 +
 .../Assets/UI Toolkit/Interfaces.meta         |  8 ++
 .../UI Toolkit/Interfaces/OverlayHUD.uxml     |  8 ++
 .../Interfaces/OverlayHUD.uxml.meta           | 10 +++
 .../Interfaces/OverlayInteractionPrompt.uxml  |  7 ++
 .../OverlayInteractionPrompt.uxml.meta        | 10 +++
 15 files changed, 300 insertions(+)
 create mode 100644 RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs
 create mode 100644 RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs.meta
 create mode 100644 RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs
 create mode 100644 RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs.meta
 create mode 100644 RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs
 create mode 100644 RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs.meta
 create mode 100644 RunningLateGame/Assets/Scripts/ScreenMainMenu.cs
 create mode 100644 RunningLateGame/Assets/Scripts/ScreenMainMenu.cs.meta
 create mode 100644 RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs
 create mode 100644 RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs.meta
 create mode 100644 RunningLateGame/Assets/UI Toolkit/Interfaces.meta
 create mode 100644 RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml
 create mode 100644 RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml.meta
 create mode 100644 RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml
 create mode 100644 RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml.meta

diff --git a/RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs b/RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs
new file mode 100644
index 0000000..d499e36
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs
@@ -0,0 +1,22 @@
+/*
+ * author: mark joshwel
+ * date: 11/8/2024
+ * description: TODO
+ */
+
+/// <summary>
+///     TODO
+/// </summary>
+public class OverlayCompleteUnderTimeMenu : CommonMenu
+{
+    /// <summary>
+    ///     function to associate a display state with the menu,
+    ///     and subscribe button events to their respective functions
+    /// </summary>
+    public override void OnEnable()
+    {
+        // set the associated state and call the base OnEnable
+        associatedState = GameManager.DisplayState.OverlayCompleteUnderTimeMenu;
+        base.OnEnable();
+    }
+}
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs.meta b/RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs.meta
new file mode 100644
index 0000000..7d1eb25
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/OverlayCompleteUnderTimeMenu.cs.meta
@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: d90104adf847428596a24cd16d00676e
+timeCreated: 1723322846
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs b/RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs
new file mode 100644
index 0000000..c453ca2
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs
@@ -0,0 +1,22 @@
+/*
+ * author: mark joshwel
+ * date: 11/8/2024
+ * description: TODO
+ */
+
+/// <summary>
+///     TODO
+/// </summary>
+public class OverlayFailedOverTimeMenu : CommonMenu
+{
+    /// <summary>
+    ///     function to associate a display state with the menu,
+    ///     and subscribe button events to their respective functions
+    /// </summary>
+    public override void OnEnable()
+    {
+        // set the associated state and call the base OnEnable
+        associatedState = GameManager.DisplayState.OverlayFailedOverTimeMenu;
+        base.OnEnable();
+    }
+}
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs.meta b/RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs.meta
new file mode 100644
index 0000000..91ca3c4
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/OverlayFailedOverTimeMenu.cs.meta
@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 9dda88a82bad4822922db26f7f9f4266
+timeCreated: 1723322994
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs b/RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs
new file mode 100644
index 0000000..b7e4eeb
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs
@@ -0,0 +1,22 @@
+/*
+ * author: mark joshwel
+ * date: 11/8/2024
+ * description: TODO
+ */
+
+/// <summary>
+///     TODO
+/// </summary>
+public class OverlayPauseMenu : CommonMenu
+{
+    /// <summary>
+    ///     function to associate a display state with the menu,
+    ///     and subscribe button events to their respective functions
+    /// </summary>
+    public override void OnEnable()
+    {
+        // set the associated state and call the base OnEnable
+        associatedState = GameManager.DisplayState.OverlayPauseMenu;
+        base.OnEnable();
+    }
+}
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs.meta b/RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs.meta
new file mode 100644
index 0000000..85f2a76
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/OverlayPauseMenu.cs.meta
@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 06af012c6fb2403484f6b955d96c91db
+timeCreated: 1723323029
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/ScreenMainMenu.cs b/RunningLateGame/Assets/Scripts/ScreenMainMenu.cs
new file mode 100644
index 0000000..51e8c14
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/ScreenMainMenu.cs
@@ -0,0 +1,86 @@
+/*
+ * author: mark joshwel
+ * date: 11/8/2024
+ * description: script for handling main menu button functions
+ */
+
+using UnityEngine;
+using UnityEngine.UIElements;
+
+/// <summary>
+///     class managing the main menu and button function invocations
+/// </summary>
+public class ScreenMainMenu : CommonMenu
+{
+    /// <summary>
+    ///     button to quit game
+    /// </summary>
+    public Button ButtonExit;
+
+    /// <summary>
+    ///     button to show the options menu
+    /// </summary>
+    public Button ButtonOptions;
+
+    /// <summary>
+    ///     button to play game
+    /// </summary>
+    public Button ButtonPlay;
+
+    /// <summary>
+    ///     function to associate a display state with the menu,
+    ///     and subscribe button events to their respective functions
+    /// </summary>
+    public override void OnEnable()
+    {
+        // set the associated state and call the base OnEnable
+        associatedState = GameManager.DisplayState.ScreenMainMenu;
+        base.OnEnable();
+
+        // get the start button from the ui root and subscribe appropriate functions
+        ButtonPlay = UI.Q<Button>("ButtonPlay");
+        ButtonPlay.clicked += PlayClick;
+        ButtonPlay.clicked += OptionStartGame;
+
+        // get the options button from the ui root and subscribe appropriate functions
+        ButtonOptions = UI.Q<Button>("ButtonOptions");
+        ButtonOptions.clicked += PlayClick;
+        ButtonOptions.clicked += OptionShowOptions;
+
+        // get the quit button from the ui root and subscribe appropriate functions
+        ButtonExit = UI.Q<Button>("ButtonExit");
+        ButtonExit.clicked += PlayClick;
+        ButtonExit.clicked += OptionQuitGame;
+    }
+
+    /// <summary>
+    ///     handles start button press,
+    ///     signals the game manager appropriately
+    /// </summary>
+    private void OptionStartGame()
+    {
+        // start game
+        Game.NewGame();
+    }
+
+    /// <summary>
+    ///     handles options button press,
+    ///     signals the game manager appropriately
+    /// </summary>
+    private void OptionShowOptions()
+    {
+        // show the option menu
+        Game.SetDisplayState(GameManager.DisplayState.ScreenOptionsMenu);
+    }
+
+    /// <summary>
+    ///     handles quit button press,
+    ///     signals the game manager appropriately
+    /// </summary>
+    private void OptionQuitGame()
+    {
+        // quit game
+        Debug.Log("MainMenu.OptionQuitGame: exiting");
+        Game.Quit();
+    }
+}
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/ScreenMainMenu.cs.meta b/RunningLateGame/Assets/Scripts/ScreenMainMenu.cs.meta
new file mode 100644
index 0000000..a18750f
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/ScreenMainMenu.cs.meta
@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: f7d3d52857e7418c805c0237b4c86485
+timeCreated: 1723321636
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs b/RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs
new file mode 100644
index 0000000..0912fb6
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs
@@ -0,0 +1,90 @@
+/*
+ * author: mark joshwel
+ * date: 11/8/2024
+ * description: option menu script for handling credits menu button functions
+ */
+
+using UnityEngine.UIElements;
+
+/// <summary>
+///     class managing the credits menu and button function invocations
+/// </summary>
+public class ScreenOptionsMenu : CommonMenu
+{
+    /// <summary>
+    ///     button to return to the main menu
+    /// </summary>
+    public Button ButtonReturn;
+
+    /// <summary>
+    ///     slider for music volume
+    /// </summary>
+    public Slider SliderAudioMusic;
+
+    /// <summary>
+    ///     slider for sfx volume
+    /// </summary>
+    public Slider SliderAudioSfx;
+
+    /// <summary>
+    ///     function to associate a display state with the menu,
+    ///     and subscribe button events to their respective functions
+    /// </summary>
+    public override void OnEnable()
+    {
+        // set the associated state and call the base OnEnable
+        associatedState = GameManager.DisplayState.ScreenOptionsMenu;
+        base.OnEnable();
+
+        // get the start button from the ui root and subscribe appropriate functions
+        ButtonReturn = UI.Q<Button>("ButtonReturn");
+        ButtonReturn.clicked += PlayClick;
+        ButtonReturn.clicked += OptionReturnToMainMenu;
+
+        // get the music slider from the ui root
+        SliderAudioMusic = UI.Q<Slider>("Music");
+        // TODO: and set the initial value to the current music volume
+        // SliderAudioMusic.value = Audio.GetMusicVolume() * 100;
+        // and subscribe appropriate functions
+        SliderAudioMusic.RegisterCallback<ChangeEvent<float>>(OptionSetMusicVolume);
+
+        // get the sfx slider from the ui root
+        SliderAudioSfx = UI.Q<Slider>("SFX");
+        // TODO: and set the initial value to the current sfx volume
+        // SliderAudioSfx.value = Audio.GetSfxVolume() * 100;
+        // and subscribe appropriate functions
+        SliderAudioSfx.RegisterCallback<ChangeEvent<float>>(OptionSetSfxVolume);
+    }
+
+    /// <summary>
+    ///     handles return to the main menu button press,
+    ///     signals the game manager appropriately
+    /// </summary>
+    private void OptionReturnToMainMenu()
+    {
+        // return to the main menu
+        Game.SetDisplayState(GameManager.DisplayState.ScreenMainMenu);
+    }
+
+    /// <summary>
+    ///     handle music volume slider change,
+    ///     sets the music channel volume in the audio manager appropriately
+    /// </summary>
+    /// <param name="evt"></param>
+    private void OptionSetMusicVolume(ChangeEvent<float> evt)
+    {
+        // TODO: slider is from 0 to 100, convert to 0 to 1, and set
+        // Audio.SetMusicVolume(evt.newValue / 100);
+    }
+
+    /// <summary>
+    ///     handle sfx volume slider change,
+    ///     sets the sfx channel volume in the audio manager appropriately
+    /// </summary>
+    /// <param name="evt"></param>
+    private void OptionSetSfxVolume(ChangeEvent<float> evt)
+    {
+        // TODO: slider is from 0 to 100, convert to 0 to 1, and set
+        // Audio.SetSfxVolume(evt.newValue / 100);
+    }
+}
\ No newline at end of file
diff --git a/RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs.meta b/RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs.meta
new file mode 100644
index 0000000..c099591
--- /dev/null
+++ b/RunningLateGame/Assets/Scripts/ScreenOptionsMenu.cs.meta
@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 81b14085a75c30f4fb71c2f8c4429547
+timeCreated: 1723321636
\ No newline at end of file
diff --git a/RunningLateGame/Assets/UI Toolkit/Interfaces.meta b/RunningLateGame/Assets/UI Toolkit/Interfaces.meta
new file mode 100644
index 0000000..850724d
--- /dev/null
+++ b/RunningLateGame/Assets/UI Toolkit/Interfaces.meta	
@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 83ed4fb68c1cfd744b89eff5a83a6c2b
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml
new file mode 100644
index 0000000..e91ec59
--- /dev/null
+++ b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml	
@@ -0,0 +1,8 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" editor-extension-mode="False">
+    <ui:VisualElement name="Root" style="flex-grow: 1; justify-content: space-around; align-items: center;">
+        <ui:VisualElement name="VertHolder" style="flex-grow: 1; justify-content: flex-start; align-items: center; align-self: auto; margin-top: 2%;">
+            <ui:Label tabindex="-1" parse-escape-sequences="true" display-tooltip-when-elided="true" text="00:53.47" name="Stopwatch" style="color: rgb(255, 255, 255); -unity-text-align: upper-center; white-space: normal; -unity-font: url(&quot;project://database/Assets/UI%20Toolkit/RLFonts/Fervojo/Fervojo-Bold.otf?fileID=12800000&amp;guid=505dfbc18d2d4604db47ff55755f9dc8&amp;type=3#Fervojo-Bold&quot;); -unity-font-definition: url(&quot;project://database/Assets/UI%20Toolkit/RLFonts/Fervojo/Fervojo-Bold%20SDF.asset?fileID=11400000&amp;guid=1abb65c0bf74b1649863fc75b2b83ac1&amp;type=2#Fervojo-Bold SDF&quot;); font-size: 32px; margin-bottom: 0; padding-bottom: 0;" />
+            <ui:Label tabindex="-1" parse-escape-sequences="true" display-tooltip-when-elided="true" text="00:53.47" name="Score" style="color: rgb(255, 255, 255); -unity-text-align: upper-center; white-space: normal; -unity-font: url(&quot;project://database/Assets/UI%20Toolkit/RLFonts/Fervojo/Fervojo-Bold.otf?fileID=12800000&amp;guid=505dfbc18d2d4604db47ff55755f9dc8&amp;type=3#Fervojo-Bold&quot;); -unity-font-definition: url(&quot;project://database/Assets/UI%20Toolkit/RLFonts/Fervojo/Fervojo-Bold%20SDF.asset?fileID=11400000&amp;guid=1abb65c0bf74b1649863fc75b2b83ac1&amp;type=2#Fervojo-Bold SDF&quot;); font-size: 14px; margin-top: 0; padding-top: 0;" />
+        </ui:VisualElement>
+    </ui:VisualElement>
+</ui:UXML>
diff --git a/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml.meta b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml.meta
new file mode 100644
index 0000000..6dc8799
--- /dev/null
+++ b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayHUD.uxml.meta	
@@ -0,0 +1,10 @@
+fileFormatVersion: 2
+guid: 61a631e3bab018249a7b4e91108bfde2
+ScriptedImporter:
+  internalIDToNameTable: []
+  externalObjects: {}
+  serializedVersion: 2
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+  script: {fileID: 13804, guid: 0000000000000000e000000000000000, type: 0}
diff --git a/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml
new file mode 100644
index 0000000..d828dd3
--- /dev/null
+++ b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml	
@@ -0,0 +1,7 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" editor-extension-mode="False">
+    <ui:VisualElement name="Root" style="flex-grow: 1; justify-content: space-around; align-items: center;">
+        <ui:VisualElement name="VertHolder" style="flex-grow: 1; justify-content: center; margin-top: 25%;">
+            <ui:Label tabindex="-1" parse-escape-sequences="true" display-tooltip-when-elided="true" text="Press E to Interact" name="PromptLabel" style="background-color: rgba(0, 0, 0, 0.33); color: rgb(255, 255, 255); -unity-text-align: upper-center; padding-right: 8px; padding-left: 8px; padding-top: 8px; padding-bottom: 8px; border-top-left-radius: 5px; border-top-right-radius: 5px; border-bottom-right-radius: 5px; border-bottom-left-radius: 5px; white-space: normal; -unity-font: url(&quot;project://database/Assets/UI%20Toolkit/RLFonts/Fervojo/Fervojo-Medium.otf?fileID=12800000&amp;guid=9439a6fdc5392c6479cda7dd72a8f3f7&amp;type=3#Fervojo-Medium&quot;); -unity-font-definition: url(&quot;project://database/Assets/UI%20Toolkit/RLFonts/Fervojo/Fervojo-Medium%20SDF.asset?fileID=11400000&amp;guid=45943718062c86e448361bd7f6506932&amp;type=2#Fervojo-Medium SDF&quot;);" />
+        </ui:VisualElement>
+    </ui:VisualElement>
+</ui:UXML>
diff --git a/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml.meta b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml.meta
new file mode 100644
index 0000000..df35a03
--- /dev/null
+++ b/RunningLateGame/Assets/UI Toolkit/Interfaces/OverlayInteractionPrompt.uxml.meta	
@@ -0,0 +1,10 @@
+fileFormatVersion: 2
+guid: 5ecae982f651ff6438bbaa95ba0362e1
+ScriptedImporter:
+  internalIDToNameTable: []
+  externalObjects: {}
+  serializedVersion: 2
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+  script: {fileID: 13804, guid: 0000000000000000e000000000000000, type: 0}