game: stdise whats done in Awake, OnEnable and Start

- Awake -> singleton stuff or anything that needs to start really early
- OnEnable -> init + register callbacks
- Start -> do anything that might call a callback

ColourMeOKGame/Assets/Scripts/AccountUI.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Net.Mail;
-using Firebase.Auth;
 using UnityEngine;
 using UnityEngine.Assertions;
 using UnityEngine.UIElements;
@@ -110,7 +109,7 @@ private void OnEnable()
         _secondaryActionButton.clicked += OnSecondaryActionButtonClick;
 
         TransitionStateTo(State.NotSignedIn);
-        
+
         if (state == State.UnassociatedState) throw new Exception("unreachable state");
         GameManager.Instance.Backend.RegisterOnSignInCallback(_ =>
         {
@@ -376,6 +375,8 @@ private void OnUsernameUpdateButtonClick()
                     _ => "An error occurred updating the username. Please try again."
                 };
             });
+
+        // TODO: update lpdata
     }
 
     /// <summary>
@@ -408,6 +409,8 @@ private void OnEmailUpdateButtonClick()
                     _ => "An error occurred updating the email. Please try again."
                 };
             });
+
+        // TODO: update lpdata
     }
 
     /// <summary>
@@ -608,7 +611,7 @@ private void OnSecondaryActionButtonClick()
                 throw new ArgumentOutOfRangeException();
         }
     }
-    
+
     /// <summary>
     ///     populate the fields with the given username and email,
     ///     used as a callback to when local player data is changed

ColourMeOKGame/Assets/Scripts/Backend.cs

@@ -57,6 +57,12 @@ public enum UserAccountDetailTargetEnum
         Password
     }
 
+    /// <summary>
+    ///     callback functions to be invoked when the user signs in
+    /// </summary>
+    /// <returns></returns>
+    private readonly List<Action<FirebaseConnectionStatus>> _onConnectionStatusChangedCallbacks = new();
+
     /// <summary>
     ///     callback functions to be invoked when the user signs in
     /// </summary>
@@ -66,12 +72,6 @@ public enum UserAccountDetailTargetEnum
     ///     callback functions to be invoked when the user signs out
     /// </summary>
     private readonly List<Action> _onSignOutCallbacks = new();
-    
-    /// <summary>
-    ///     callback functions to be invoked when the user signs in
-    /// </summary>
-    /// <returns></returns>
-    private readonly List<Action<FirebaseConnectionStatus>> _onConnectionStatusChangedCallbacks = new ();
 
     /// <summary>
     ///     the firebase authentication object
@@ -87,17 +87,17 @@ public enum UserAccountDetailTargetEnum
     ///     the current user object, if authenticated
     /// </summary>
     private FirebaseUser _user;
-    
-    /// <summary>
-    ///     whether the user is signed in
-    /// </summary>
-    public bool IsSignedIn;
 
     /// <summary>
     ///     the current user's username, if authenticated
     /// </summary>
     private string _username;
 
+    /// <summary>
+    ///     whether the user is signed in
+    /// </summary>
+    public bool IsSignedIn;
+
     /// <summary>
     ///     whether the backend is connected to the firebase backend
     /// </summary>
@@ -151,7 +151,7 @@ public void Initialise(Action<FirebaseConnectionStatus> callback)
             Debug.Log("firebase status is" + Status);
         });
     }
-    
+
     /// <summary>
     ///     function to fire all on sign in callbacks
     /// </summary>
@@ -159,7 +159,6 @@ private void FireOnSignInCallbacks()
     {
         Debug.Log($"firing OnSignInCallbacks ({_onSignInCallbacks.Count})");
         foreach (var callback in _onSignInCallbacks)
-        {
             try
             {
                 callback.Invoke(_user);
@@ -168,9 +167,8 @@ private void FireOnSignInCallbacks()
             {
                 Debug.LogError($"error invoking OnSignInCallback: {e.Message}");
             }
-        }
     }
-    
+
     /// <summary>
     ///     function to fire all on sign-out callbacks
     /// </summary>
@@ -178,7 +176,6 @@ private void FireOnSignOutCallbacks()
     {
         Debug.Log($"firing OnSignOutCallbacks ({_onSignOutCallbacks.Count})");
         foreach (var callback in _onSignOutCallbacks)
-        {
             try
             {
                 callback.Invoke();
@@ -187,7 +184,6 @@ private void FireOnSignOutCallbacks()
             {
                 Debug.LogError($"error invoking OnSignOutCallback: {e.Message}");
             }
-        }
     }
 
     /// <summary>
@@ -234,10 +230,7 @@ private void AuthStateChanged(object sender, EventArgs eventArgs)
         if (!IsSignedIn) return;
 
         Debug.Log($"signed in successfully as {_user?.UserId}");
-        RetrieveUsernameWithCallback((_, _) =>
+        RetrieveUsernameWithCallback((_, _) => { FireOnSignInCallbacks(); });
-        {
-            FireOnSignInCallbacks();
-        });
     }
 
     /// <summary>
@@ -482,11 +475,12 @@ public void ForgotPassword(string email, Action<bool> callback)
     ///     abstraction function to get the user's recent scores from the database
     /// </summary>
     /// <param name="callback">
-    ///     callback function that takes in a <c>DatabaseTransactionResult</c> enum and a <c>List&lt;LocalPlayerData.Score&gt;</c>
+    ///     callback function that takes in a <c>DatabaseTransactionResult</c> enum and a
+    ///     <c>List&lt;LocalPlayerData.Score&gt;</c>
     /// </param>
     public void GetRecentScores(Action<DatabaseTransactionResult, List<LocalPlayerData.Score>> callback)
     {
-        // TODO
+        // TODO: implement this
         callback(DatabaseTransactionResult.Error, new List<LocalPlayerData.Score>(0));
     }
 
@@ -506,7 +500,10 @@ public void GetRecentScores(Action<DatabaseTransactionResult, List<LocalPlayerDa
     ///     abstraction function to get and calculate the user's rating from the database
     ///     calculation is done locally, call UpdateUserRating to update the user's rating in the database
     /// </summary>
-    /// <param name="callback">callback function that takes in a <c>DatabaseTransactionResult</c> enum and a user rating <c>float</c></param>
+    /// <param name="callback">
+    ///     callback function that takes in a <c>DatabaseTransactionResult</c> enum and a user rating
+    ///     <c>float</c>
+    /// </param>
     public void CalculateUserRating(
         Action<DatabaseTransactionResult, float> callback)
     {

ColourMeOKGame/Assets/Scripts/GameManager.cs

@@ -18,26 +18,26 @@ public class GameManager : MonoBehaviour
     /// </summary>
     public UIManager ui;
 
+    /// <summary>
+    ///     list of callbacks to call when the local player data changes
+    /// </summary>
+    private readonly List<Action<LocalPlayerData>> _onLocalPlayerDataChangeCallbacks = new();
+
     /// <summary>
     ///     the local player data object for storing player data
     /// </summary>
     private LocalPlayerData _data;
 
-    /// <summary>
-    ///     read-only property for accessing the local player data outside of this class
-    /// </summary>
-    public LocalPlayerData Data => _data;
-
-    /// <summary>
-    ///     list of callbacks to call when the local player data changes
-    /// </summary>
-    private readonly List<Action<LocalPlayerData>> _onLocalPlayerDataChangeCallbacks = new List<Action<LocalPlayerData>>();
-
     /// <summary>
     ///     backend object for handling communication with the firebase backend
     /// </summary>
     public Backend Backend;
 
+    /// <summary>
+    ///     read-only property for accessing the local player data outside of this class
+    /// </summary>
+    public LocalPlayerData Data => _data;
+
     /// <summary>
     ///     enforces singleton behaviour; sets doesn't destroy on load and checks for multiple instances
     /// </summary>
@@ -59,12 +59,21 @@ private void Awake()
     }
 
     /// <summary>
-    ///     called when the game object is enabled, initialises variables
+    ///     start modifying state
+    /// </summary>
+    private void Start()
+    {
+        Debug.Log("GameManager starts here");
+        _data.LoadFromTheWorld(FireLocalPlayerDataChangeCallbacks);
+    }
+
+    /// <summary>
+    ///     initialise variables and ui elements
     /// </summary>
     private void OnEnable()
     {
         ui = UIManager.Instance;
-        
+
         // load the local player data and refresh the ui
         _data = new LocalPlayerData();
 
@@ -91,7 +100,7 @@ private void OnEnable()
             ui.UI.Q<Button>("LeaderboardButton").style.display = DisplayStyle.None;
             ui.UI.Q<Button>("AccountButton").style.display = DisplayStyle.None;
         });
-        
+
         // register a callback to refresh the ui when the player signs in
         Backend.RegisterOnSignInCallback(_ =>
         {
@@ -99,15 +108,6 @@ private void OnEnable()
             _data.LoadFromTheWorld(FireLocalPlayerDataChangeCallbacks);
         });
     }
-    
-    /// <summary>
-    ///     load in stuff
-    /// </summary>
-    private void Start()
-    {
-        Debug.Log("GameManager starts here");
-        _data.LoadFromTheWorld(FireLocalPlayerDataChangeCallbacks);
-    }
 
     /// <summary>
     ///     called when the application is quitting, saves the local player data
@@ -118,7 +118,7 @@ private void OnApplicationQuit()
         Backend.Cleanup();
         _data.SaveToTheWorld();
     }
-    
+
     /// <summary>
     ///     function to register a callback to be called when the local player data changes
     /// </summary>
@@ -136,7 +136,6 @@ private void FireLocalPlayerDataChangeCallbacks(LocalPlayerData data)
     {
         Debug.Log($"firing LocalPlayerDataChangeCallbacks ({_onLocalPlayerDataChangeCallbacks.Count})");
         foreach (var callback in _onLocalPlayerDataChangeCallbacks)
-        {
             try
             {
                 callback.Invoke(data);
@@ -145,6 +144,5 @@ private void FireLocalPlayerDataChangeCallbacks(LocalPlayerData data)
             {
                 Debug.LogError($"error invoking LocalPlayerDataChangeCallback: {e.Message}");
             }
-        }
     }
 }

ColourMeOKGame/Assets/Scripts/OklchColourPickerUI.cs

@@ -43,7 +43,7 @@ public class OklchColourPickerUI : MonoBehaviour
     private VisualElement _responseColour;
 
     /// <summary>
-    ///     function to set the initial values of the sliders
+    ///     modify state of initialised variables
     /// </summary>
     private void Start()
     {
@@ -53,7 +53,7 @@ private void Start()
     }
 
     /// <summary>
-    ///     function to subscribe slider events to their respective functions
+    ///     initialise the ui elements and register change event callbacks functions
     /// </summary>
     public void OnEnable()
     {

ColourMeOKGame/Assets/Scripts/Playground.cs

@@ -1,18 +0,0 @@
-using UnityEngine;
-
-public class Playground
-{
-    private float _score;
-
-    private void SomethingSomethingScore()
-    {
-        var score = 0.0f;
-
-        _score = score;
-    }
-
-    private void ShowTheScore()
-    {
-        Debug.Log(_score);
-    }
-}

ColourMeOKGame/Assets/Scripts/Playground.cs.meta

@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: 662d126b54a54d9ebe6a1dc716d199e3
-timeCreated: 1731830473

ColourMeOKGame/Assets/Scripts/SideViewUI.cs

@@ -1,4 +1,3 @@
-using System;
 using UnityEngine;
 using UnityEngine.UIElements;
 
@@ -12,48 +11,48 @@ public class SideViewUI : MonoBehaviour
     /// </summary>
     private Button _accountButton;
 
+    /// <summary>
+    ///     text label for showing the player's stable-ish chroma accuracy
+    /// </summary>
+    private Label _chromaAccuracyText;
+
+    /// <summary>
+    ///     connection status label for showing the connection status
+    /// </summary>
+    private Label _connectionStatusLabel;
+
+    /// <summary>
+    ///     text label for showing the player's stable-ish hue accuracy
+    /// </summary>
+    private Label _hueAccuracyText;
+
     /// <summary>
     ///     leaderboard button for showing the leaderboard
     /// </summary>
     private Button _leaderboardButton;
 
+    /// <summary>
+    ///     text label for showing the player's stable-ish lightness accuracy
+    /// </summary>
+    private Label _lightnessAccuracyText;
+
     /// <summary>
     ///     play button for starting the game
     /// </summary>
     private Button _playButton;
 
-    /// <summary>
-    ///     connection status label for showing the connection status
-    /// </summary>
-    private Label _connectionStatusLabel;
-    
     /// <summary>
     ///     text label for showing the player's known name
     /// </summary>
     private Label _playerText;
-    
+
     /// <summary>
     ///     text label for showing the player's rating
     /// </summary>
     private Label _ratingText;
-    
-    /// <summary>
-    ///     text label for showing the player's stable-ish lightness accuracy
-    /// </summary>
-    private Label _lightnessAccuracyText;
-    
-    /// <summary>
-    ///     text label for showing the player's stable-ish chroma accuracy
-    /// </summary>
-    private Label _chromaAccuracyText;
-    
-    /// <summary>
-    ///     text label for showing the player's stable-ish hue accuracy
-    /// </summary>
-    private Label _hueAccuracyText;
 
     /// <summary>
-    ///     function to subscribe button events to their respective functions
+    ///     initialise the ui elements and register the button click event functions
     /// </summary>
     private void OnEnable()
     {
@@ -67,12 +66,12 @@ private void OnEnable()
 
         _accountButton = ui.Q<Button>("AccountButton");
         _accountButton.clicked += OnAccountButtonClicked;
-        
+
         _connectionStatusLabel = ui.Q<Label>("ConnectionStatusLabel");
-        
+
         _playerText = ui.Q<Label>("PlayerText");
         _ratingText = ui.Q<Label>("RatingText");
- 
+
         _lightnessAccuracyText = ui.Q<Label>("LightnessAccuracyText");
         _chromaAccuracyText = ui.Q<Label>("ChromaAccuracyText");
         _hueAccuracyText = ui.Q<Label>("HueAccuracyText");

ColourMeOKGame/Assets/Scripts/UIManager.cs

@@ -51,10 +51,20 @@ private void Awake()
         }
     }
 
+    /// <summary>
+    ///     modify state of initial variables
+    /// </summary>
+    private void Start()
+    {
+        SetDisplayState(DisplayState.Nothing);
+    }
+
+    /// <summary>
+    ///     initialise variables
+    /// </summary>
     private void OnEnable()
     {
         UI = GetComponent<UIDocument>().rootVisualElement;
-        SetDisplayState(DisplayState.Nothing);
     }
 
     /// <summary>