Update coinflip.py

coinflip.py

@@ -7,48 +7,52 @@
 
 # Set up pygame
 pygame.init()
-screen_width, screen_height = 600, 500 # Set the screen dimensions
+screen_width, screen_height = 600, 500                          # Set the screen dimensions to create a smaller window for the coin toss screen to run in
 screen = pygame.display.set_mode((screen_width, screen_height)) # Create the screen
-pygame.display.set_caption("Coin Toss") # Set the window title
+pygame.display.set_caption("Coin Toss")                         # Set the window title
 
 clock = pygame.time.Clock() # Create the clock
 ui_manager = pygame_gui.UIManager((screen_width, screen_height)) # Create the UI manager for pygame_gui
 
 # Fonts
-font = pygame.font.Font("fonts/PublicSans-Bold.ttf", 24)
+font = pygame.font.Font("fonts/PublicSans-Bold.ttf", 24) # Sets the font to the same one used throughout the system — Public Sans Bold size of 24
 
 # Team colours (set elsewhere) and read by this file from the shared.py file
 home_team_colour = shared.home_team_colour
 away_team_colour = shared.away_team_colour
 
 
-def draw_text(text, font, colour, surface, x, y): # Function to render text on the screen
-    textobj = font.render(text, True, colour) # Render the text with the specified font and colour
-    textrect = textobj.get_rect() # Get the rectangle of the rendered text
-    textrect.topleft = (x, y) # Set the position of the text rectangle
-    surface.blit(textobj, textrect) # Draw the text on the surface at the specified position
+def draw_text(text, font, colour, surface, x, y):               # Function to render text on the screen
+    textobj = font.render(text, True, colour)                   # Render the text with the specified font and colour
+    textrect = textobj.get_rect()                               # Get the rectangle of the rendered text
+    textrect.topleft = (x, y)                                   # Set the position of the text rectangle
+    surface.blit(textobj, textrect)                             # Draw the text on the surface at the specified position
+
 # ---------------------------------------------------------------------------------------------------------------------
 # Basic button class
 # ---------------------------------------------------------------------------------------------------------------------
 
 class Button:
-    def __init__(self, text, x, y, w, h, colour, action=None): # Initialize the button with text, position, size, colour, and an optional action
-        self.text = text # The text to display on the button
-        self.rect = pygame.Rect(x, y, w, h) # The rectangle that defines the button's position and size
-        self.colour = colour # The colour of the button
-        self.action = action # The action to perform when the button is clicked
-
-    def draw(self, screen): # Draw the button on the screen
-        pygame.draw.rect(screen, self.colour, self.rect) # Draw the button rectangle with the specified colour
-        draw_text(self.text, font, pygame.Color("azure"), screen, self.rect.x + 10, self.rect.y + 10) # Draw the text on the button with the defult colour 'azure'
+    HOVER_COLOUR = (180, 180, 180) # Defines the colour that the buttons are when the mouse is hovered over them, this is treated as an attribute and can be reffered to with Button.HOVER_COLOUR
+    def __init__(self, text, x, y, w, h, colour, action=None):          # Initialize the button with text, position, size, colour, and an optional action
+        self.text = text                                                # The text to display on the button
+        self.rect = pygame.Rect(x, y, w, h)                             # The rectangle that defines the button's position and size
+        self.colour = colour                                            # The colour of the button
+        self.action = action                                            # The action to perform when the button is clicked
+
+    def draw(self, screen): # Function to draw all of the buttons including the hover over colour
+        mouse_pos = pygame.mouse.get_pos() # Checks the position of the mouse
+        draw_colour = Button.HOVER_COLOUR if self.rect.collidepoint(mouse_pos) else self.colour
+        pygame.draw.rect(screen, draw_colour, self.rect) # Draws the button with the colour based on the mouse position
+        draw_text(self.text, font, pygame.Color("azure"), screen, self.rect.x + 10, self.rect.y + 10) # Draws the text on the button, offset by 10 pixels in both x and y directions for better visibility
 
     def is_clicked(self, pos): # Check if the button is clicked by checking if the mouse position is within the button's rectangle
         return self.rect.collidepoint(pos) 
 
-    def handle_event(self, event): # Handle events for the button
-        if event.type == pygame.MOUSEBUTTONDOWN and self.is_clicked(event.pos): # Check if the mouse button is pressed and if the button is clicked
-            if self.action: # If an action is defined, call it when the button is clicked this depends on the function tht is entered in the action seciton of the button
-                self.action() # If an action is defined, call it when the button is clicked
+    def handle_event(self, event):                                                      # Defines how to hndle events for the button
+        if event.type == pygame.MOUSEBUTTONDOWN and self.is_clicked(event.pos):         # Check if the mouse button is pressed and if the button is clicked
+            if self.action:                                                             # Call the action when the button is clicked this depends on the function tht is entered in the action seciton of the button
+                self.action()                                                           # If an action is defined (i.e. entered when defining the button), call it when the button is clicked
 
 # Coin toss logic
 def cointossoutcome(): 
@@ -80,13 +84,12 @@ def cointossoutcome():
 while running:
     time_delta = clock.tick(60) / 1000.0 # Error handling for the clock tick to ensure a consistent frame rate
 
-    for event in pygame.event.get(): # Process events
-        if event.type == pygame.QUIT: # If the quit event is triggered, exit the loop
-            running = False # Exit the main loop
-
-        heads.handle_event(event) # Handle events for the Heads button
-        tails.handle_event(event) # Handle events for the Tails button
-        ui_manager.process_events(event) # Process events for the UI manager
+    for event in pygame.event.get():        # Informs the system of how to process events
+        if event.type == pygame.QUIT:       # If the quit event is triggered, exit the loop and quit the game
+            running = False                 # Set running to false and thereby exit the main loop
+        heads.handle_event(event)           # Handle events for the Heads button
+        tails.handle_event(event)           # Handle events for the Tails button
+        ui_manager.process_events(event)    # Process events for the UI manager
 
     ui_manager.update(time_delta) # Update the UI manager with the time delta to ensure smooth animations and transitions