From 3b9e86f74092e5e997c4e061ee16fca9842744b6 Mon Sep 17 00:00:00 2001
From: fheinrich <fheinrich@techfak.uni-bielefeld.de>
Date: Wed, 14 Feb 2024 14:26:25 +0100
Subject: [PATCH] Doc and renaming for clarity

---
 .../gui_2d_vis/overcooked_gui.py              | 55 +++++++++----------
 1 file changed, 25 insertions(+), 30 deletions(-)

diff --git a/overcooked_simulator/gui_2d_vis/overcooked_gui.py b/overcooked_simulator/gui_2d_vis/overcooked_gui.py
index 63d02a2e..f73f8213 100644
--- a/overcooked_simulator/gui_2d_vis/overcooked_gui.py
+++ b/overcooked_simulator/gui_2d_vis/overcooked_gui.py
@@ -59,8 +59,11 @@ class PlayerKeySet:
         Movement keys in the following order: Down, Up, Left, Right
 
         Args:
-            player_name: The name of the player to control.
-            keys: The keys which control this player in the following order: Down, Up, Left, Right, Interact, Pickup.
+            move_keys: The keys which control this players movement in the following order: Down, Up, Left, Right.
+            interact_key: The key to interact with objects in the game.
+            pickup_key: The key to pick items up or put them down.
+            switch_key: The key for switching through controllable players.
+            players: The player indices which this keyset can control.
         """
         self.move_vectors: list[list[int]] = [[-1, 0], [1, 0], [0, -1], [0, 1]]
         self.key_to_movement: dict[pygame.key, list[int]] = {
@@ -123,24 +126,11 @@ class PyGameGUI:
         self.screen_margin = self.visualization_config["GameWindow"]["screen_margin"]
         self.min_width = self.visualization_config["GameWindow"]["min_width"]
         self.min_height = self.visualization_config["GameWindow"]["min_height"]
-
         self.buttons_width = self.visualization_config["GameWindow"]["buttons_width"]
         self.buttons_height = self.visualization_config["GameWindow"]["buttons_height"]
-
         self.order_bar_height = self.visualization_config["GameWindow"][
             "order_bar_height"
         ]
-
-        self.images_path = ROOT_DIR / "pygame_gui" / "images"
-
-        self.menu_state = MenuStates.Start
-        self.manager: pygame_gui.UIManager
-
-        self.vis = Visualizer(self.visualization_config)
-
-        self.sub_processes = []
-
-        self.fullscreen = False
         (
             self.window_width_fullscreen,
             self.window_height_fullscreen,
@@ -150,10 +140,17 @@ class PyGameGUI:
         self.kitchen_width = 1
         self.kitchen_height = 1
         self.kitchen_aspect_ratio = 1
+        self.images_path = ROOT_DIR / "pygame_gui" / "images"
+        self.vis = Visualizer(self.visualization_config)
 
-        self.two_windows = False
+        self.fullscreen = False
 
-    def get_window_sizes(self, state: dict):
+        self.menu_state = MenuStates.Start
+        self.manager: pygame_gui.UIManager
+
+        self.sub_processes = []
+
+    def get_window_sizes_from_state(self, state: dict):
         self.kitchen_width = state["kitchen"]["width"]
         self.kitchen_height = state["kitchen"]["height"]
         self.kitchen_aspect_ratio = self.kitchen_height / self.kitchen_width
@@ -192,9 +189,9 @@ class PyGameGUI:
         self.game_height = max(self.game_height, 100)
         self.grid_size = max(self.grid_size, 1)
 
-        redisual_x = self.game_width - (self.kitchen_width * self.grid_size)
+        residual_x = self.game_width - (self.kitchen_width * self.grid_size)
         residual_y = self.game_height - (self.kitchen_height * self.grid_size)
-        self.game_width -= redisual_x
+        self.game_width -= residual_x
         self.game_height -= residual_y
 
     def setup_player_keys(self, n=1, disjunct=False):
@@ -829,7 +826,7 @@ class PyGameGUI:
             )
             state = json.loads(websocket.recv())
 
-        self.get_window_sizes(state)
+        self.get_window_sizes_from_state(state)
 
     def start_button_press(self):
         self.menu_state = MenuStates.Game
@@ -1011,16 +1008,14 @@ class PyGameGUI:
                     if event.type == pygame.QUIT:
                         self.running = False
 
-                        # UI Buttons:
-                    elif event.type == pygame.VIDEORESIZE:
-                        # scrsize = event.size
-                        self.window_width_windowed = event.w
-                        self.window_height_windowed = event.h
-                        self.recalc_game_size()
-                        self.set_window_size()
-
-                        self.init_ui_elements()
-                        self.manage_button_visibility()
+                    # elif event.type == pygame.VIDEORESIZE:
+                    #     # scrsize = event.size
+                    #     self.window_width_windowed = event.w
+                    #     self.window_height_windowed = event.h
+                    #     self.recalc_game_size()
+                    #     self.set_window_size()
+                    #     self.init_ui_elements()
+                    #     self.manage_button_visibility()
 
                     if event.type == pygame_gui.UI_BUTTON_PRESSED:
                         match event.ui_element:
-- 
GitLab