From 237af7e3dc8abeb72e558a5e4cdc1e53749926f2 Mon Sep 17 00:00:00 2001
From: Felix Kirchner <felix.kirchner.fk@gmail.com>
Date: Wed, 23 Jul 2025 11:33:57 +0200
Subject: [PATCH] Added constant and updated docs

---
 lib/presentation/views/active_game_view.dart | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/lib/presentation/views/active_game_view.dart b/lib/presentation/views/active_game_view.dart
index d428f1c..b05daba 100644
--- a/lib/presentation/views/active_game_view.dart
+++ b/lib/presentation/views/active_game_view.dart
@@ -24,11 +24,19 @@ class ActiveGameView extends StatefulWidget {
 }
 
 class _ActiveGameViewState extends State<ActiveGameView> {
+  /// Constant value to represent a press on the cancel button in round view.
+  static const int kRoundCancelled = -1;
+
   final confettiController = ConfettiController(
     duration: const Duration(seconds: 10),
   );
+
   late final GameSession gameSession;
+
+  /// A list of the ranks for each player corresponding to their index in sortedPlayerIndices
   late List<int> denseRanks;
+
+  /// A list of player indices sorted by their scores in ascending order.
   late List<int> sortedPlayerIndices;
 
   @override
@@ -453,7 +461,8 @@ class _ActiveGameViewState extends State<ActiveGameView> {
       ),
     );
 
-    if (round == -1) return;
+    // If the user presses the cancel button
+    if (round == kRoundCancelled) return;
 
     if (widget.gameSession.isGameFinished && context.mounted) {
       _playFinishAnimation(context);