From a96a9cbbea33d990be73d038657dbb72a7fb6cf1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
 <fschroeder@techfak.uni-bielefeld.de>
Date: Tue, 5 Mar 2024 13:07:13 +0100
Subject: [PATCH] Update .gitignore, .gitlab-ci.yml, player.py

Added 'generated' to .gitignore, updated pdoc footer text in .gitlab-ci.yml, and included interaction state for player in player.py. The player interaction with the counter is now being tracked and a new comment was added for the progress method. This will enhance player's tracking and usage in the game environment.
---
 .gitignore                    |  1 +
 .gitlab-ci.yml                |  2 +-
 cooperative_cuisine/player.py | 10 ++++++++++
 3 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index eb6bba84..7d7fad54 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@
 # Edit at https://www.toptal.com/developers/gitignore?templates=python,intellij,visualstudiocode,pycharm,git,flask,django,docusaurus,ros,ros2,linux,macos,windows
 
 playground
+generated
 
 ### Django ###
 *.log
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 4e55859a..759e2513 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -18,7 +18,7 @@ pages:
     - apt-get install -y python3-dev python3-pip graphviz graphviz-dev
     - pip install pdoc
     - pip install ".[rl]"
-    - pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico --footer-text "Developed@<a href="https://scs.techfak.uni-bielefeld.de/">SCS</a>
+    - pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico --footer-text "Developed@SCS"
   artifacts:
     paths:
       - public
diff --git a/cooperative_cuisine/player.py b/cooperative_cuisine/player.py
index f4e69c3a..a92f12f3 100644
--- a/cooperative_cuisine/player.py
+++ b/cooperative_cuisine/player.py
@@ -85,6 +85,7 @@ class Player:
         """The env time until the player wants to move."""
 
         self.interacting: bool = False
+        """Is the player currently interacting with a counter."""
 
     def set_movement(self, move_vector, move_until):
         """Called by the `perform_action` method. Movements will be performed (pos will be updated) in the `step`
@@ -182,6 +183,15 @@ class Player:
         self.last_interacted_counter = None
 
     def progress(self, passed_time: timedelta, now: datetime):
+        """Iterative progress call on the player.
+
+        Similar to the `Counter.progress` method.
+        How often it is called depends on the `env_step_frequency` or how often `step` is called.
+
+        Args:
+            passed_time: The amount of time that has passed since the last call of the method.
+            now: The current env time.
+        """
         if self.interacting and self.last_interacted_counter:
             # TODO only interact on counter (Sink/CuttingBoard) if hands are free configure in config?
             if self.holding:
-- 
GitLab