Added comments to everything

This commit is contained in:
djkellerman
2025-04-18 15:54:50 -04:00
parent a0305ea0e9
commit 213bb2d14b
39 changed files with 3166 additions and 1796 deletions

View File

@@ -1,50 +1,76 @@
using System.Collections.Generic;
using TMPro;
using UnityEngine; using Game; using Music; using Player;
using UnityEngine;
using Game;
using Music;
using Player;
namespace Game
{
public class WinScreen : MonoBehaviour
{
public static WinScreen Instance;
public List<TextMeshProUGUI> playerTexts;
private void Awake() // Ensures only one instance of WinScreen exists
/// <summary>
/// Manages the win screen display for the game.
/// Displays the winning player's information and triggers the win screen animation.
/// </summary>
public class WinScreen : MonoBehaviour
{
if (Instance == null)
{
Instance = this;
}
else
{
Destroy(this.gameObject);
}
}
public void ShowWinScreen(int player)
{
if (player - 1 < 0 || player - 1 >= GameManager.playerColors.Count)
{
return;
}
/// <summary>
/// A singleton instance of the <see cref="WinScreen"/> class.
/// Ensures only one instance of the WinScreen exists at a time.
/// </summary>
public static WinScreen Instance;
foreach (TextMeshProUGUI playerText in playerTexts)
/// <summary>
/// A list of text elements used to display player information on the win screen.
/// </summary>
public List<TextMeshProUGUI> playerTexts;
/// <summary>
/// Ensures only one instance of the WinScreen exists.
/// Destroys duplicate instances if they are created.
/// </summary>
private void Awake()
{
playerText.text = "Player " + player;
if (playerText.color != Color.black)
if (Instance == null)
{
playerText.color = GameManager.playerColors[player - 1];
Instance = this;
}
else
{
Destroy(this.gameObject);
}
}
Animator animator = GetComponent<Animator>();
if (animator == null)
/// <summary>
/// Displays the win screen for the specified player.
/// Updates the text and color of the win screen to reflect the winning player.
/// </summary>
/// <param name="player">The number of the winning player (1-based index).</param>
public void ShowWinScreen(int player)
{
return;
// Validate the player index
if (player - 1 < 0 || player - 1 >= GameManager.playerColors.Count)
{
return;
}
// Update the text and color for each player text element
foreach (TextMeshProUGUI playerText in playerTexts)
{
playerText.text = "Player " + player;
if (playerText.color != Color.black)
{
playerText.color = GameManager.playerColors[player - 1];
}
}
// Trigger the win screen animation
Animator animator = GetComponent<Animator>();
if (animator == null)
{
return;
}
animator.SetTrigger("win");
}
animator.SetTrigger("win");
}
}
}