Game Event Handler Module
This module defines the GameEventHandler class, responsible for capturing and processing all user inputs (keyboard, mouse clicks, mouse movement) during the main game loop. It acts as a central dispatcher, interpreting events based on the current game state and delegating actions to other game components like GameActions, GameLogic, DevelopmentManager, and the main Game object.
High-Level Design
Dependency Diagram
Visualizes the primary dependencies of the GameEventHandler.
![@startuml
package "GameEventHandler Module" {
[GameEventHandler]
}
package "Game Core" {
[Game]
[GameActions]
[GameLogic]
[DevelopmentManager]
[Board]
[Renderer]
[Player]
[AIEmotionUI]
}
package "Data Structures" {
[Cards]
}
package "Utilities" {
[Sound_Manager]
}
package "External Libraries" {
[pygame]
[sys]
}
[GameEventHandler] --> [Game]
[GameEventHandler] --> [GameActions]
[GameEventHandler] --> [Cards]
[GameEventHandler] --> [Sound_Manager]
[GameEventHandler] --> [pygame]
[GameEventHandler] --> [sys]
[GameEventHandler] --> [GameLogic]
[GameEventHandler] --> [DevelopmentManager]
[GameEventHandler] --> [Board]
[GameEventHandler] --> [Renderer]
[GameEventHandler] --> [Player]
[GameEventHandler] --> [AIEmotionUI]
@enduml](../_images/plantuml-56062bcdc3aba8c6b2d28fbbfb02a38afe32ad84.png)
GameEventHandler Dependencies
Simplified State Handling
Shows the main game states the GameEventHandler explicitly checks and how input handling differs.
![@startuml
[*] --> IDLE : Game Start
state "Input Handling" as Handling {
IDLE : Awaiting Input
ROLL : Handle Roll/Quit/Develop/Pause Click/Key
BUY : Handle Yes/No Click/Key
AUCTION : Handle Bid/Pass Click/Key, Numeric Input
DEVELOPMENT : Handle DevManager Click/Key, Complete Button
POPUP_SHOWN : Handle Click/Key to dismiss
CARD_SHOWN : Handle Click/Key to dismiss
GAME_OVER : Input Ignored
}
IDLE --> Handling : Event Occurs
Handling --> Handling : Process Event (State may change via GameActions/GameLogic)
Handling --> GAME_OVER : Game Over Condition Met
note right of Handling
The handler reacts differently
based on `self.game.state`,
`self.game.development_mode`,
`self.game.show_popup`, etc.
State transitions are often
triggered by calls to
`self.game_actions`.
end note
@enduml](../_images/plantuml-ea11e6cb290a4ca186789edd7467d36e30d9b9b5.png)
Simplified State Handling in GameEventHandler
Detailed Design
Class Diagram
GameEventHandler Class Diagram
Activity Diagrams
Overall Click Handling Flow (`handle_click`)
Provides a high-level view of the decision-making process within handle_click.
Activity Diagram: handle_click Logic Flow
Sequence Diagrams
Main Input Loop Dispatch
Sequence Diagram: Input Handling Dispatch
Click Handling (ROLL State)
Sequence Diagram - Handle Click (Normal Turn)
Click Handling (BUY State)
Sequence Diagram: Click Handling (BUY State)
Auction Click Handling
Sequence Diagram: Auction Click Handling
Key Handling (ROLL State)
Illustrates the primary key presses handled when the game state is ROLL.
Sequence Diagram: Key Handling (ROLL State)
Key Handling (AUCTION State)
Sequence Diagram - Handle Auction Input
Key Methods Overview
handle_input(): The main event loop processor. Iterates through Pygame events and calls specific handlers (handle_click, handle_motion, handle_key) or handles QUIT events directly. Returns game over status if detected.
handle_click(pos): Processes left mouse clicks. Behavior depends heavily on game.state (ROLL, BUY, AUCTION), game.development_mode, game.show_popup, game.show_card, and which UI element (buttons, AI mood UI) is clicked. Delegates actions to GameActions, DevelopmentManager, or handle_auction_click.
handle_motion(pos): Processes mouse movement, primarily to update hover states for buttons and AI mood UI elements.
handle_key(event): Processes keyboard presses. Behavior depends on game.state, active popups/cards, and development mode. Handles rolling dice, buying/passing, auction input, quitting, pausing, camera movement, and development actions. Delegates actions to GameActions, DevelopmentManager, or handle_auction_input.
handle_auction_input(event): Specifically handles keyboard input during an auction (numeric keys for bid amount, Enter to submit, Esc to pass, Backspace). Calls _process_auction_bid.
_process_auction_bid(current_bidder): Validates and submits the entered bid amount to GameLogic.
handle_auction_click(pos): Specifically handles mouse clicks during an auction (Bid button, Pass button). Calls _process_auction_bid or GameLogic.process_auction_pass. Checks for auction completion.