From b600b39e7f28f0a27ef7aad09acc3cad3ccc31aa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
<fschroeder@techfak.uni-bielefeld.de>
Date: Sat, 27 Jan 2024 02:54:07 +0100
Subject: [PATCH] Add penalty for trashing items in Overcooked simulator
This update introduces a penalty computation for items that the player puts into the trash in the Overcooked simulator. A new function has been added onto the Order class to calculate this penalty, and the Trashcan class has been updated to use this new function whenever an item is dropped off. This change helps to further emulate real gameplay mechanics.
---
overcooked_simulator/counter_factory.py | 2 ++
overcooked_simulator/counters.py | 9 +++++++++
.../game_content/environment_config.yaml | 2 ++
overcooked_simulator/order.py | 17 +++++++++++++++++
4 files changed, 30 insertions(+)
diff --git a/overcooked_simulator/counter_factory.py b/overcooked_simulator/counter_factory.py
index 46a96a17..f1d02672 100644
--- a/overcooked_simulator/counter_factory.py
+++ b/overcooked_simulator/counter_factory.py
@@ -15,6 +15,7 @@ from overcooked_simulator.counters import (
Sink,
PlateConfig,
SinkAddon,
+ Trashcan,
)
from overcooked_simulator.game_items import ItemInfo, ItemType, CookingEquipment, Plate
from overcooked_simulator.order import OrderAndScoreManager
@@ -175,6 +176,7 @@ class CounterFactory:
)
elif issubclass(counter_class, ServingWindow):
kwargs.update(self.serving_window_additional_kwargs)
+ if issubclass(counter_class, (ServingWindow, Trashcan)):
kwargs[
"order_and_score"
] = self.order_and_score # individual because for the later trash scorer
diff --git a/overcooked_simulator/counters.py b/overcooked_simulator/counters.py
index 8fd1e658..c3e33392 100644
--- a/overcooked_simulator/counters.py
+++ b/overcooked_simulator/counters.py
@@ -470,13 +470,22 @@ class Trashcan(Counter):
The character `X` in the `layout` file represents the Trashcan.
"""
+ def __init__(
+ self, order_and_score: OrderAndScoreManager, pos: npt.NDArray[float], **kwargs
+ ):
+ super().__init__(pos, **kwargs)
+ self.order_and_score = order_and_score
+
def pick_up(self, on_hands: bool = True) -> Item | None:
pass
def drop_off(self, item: Item) -> Item | None:
if isinstance(item, CookingEquipment):
+ self.order_and_score.apply_penalty_for_using_trash(item.content_list)
item.reset_content()
return item
+ else:
+ self.order_and_score.apply_penalty_for_using_trash(item)
return None
def can_drop_off(self, item: Item) -> bool:
diff --git a/overcooked_simulator/game_content/environment_config.yaml b/overcooked_simulator/game_content/environment_config.yaml
index d8d2d5f6..89a3ceb4 100644
--- a/overcooked_simulator/game_content/environment_config.yaml
+++ b/overcooked_simulator/game_content/environment_config.yaml
@@ -78,6 +78,8 @@ orders:
default: -5
serving_not_ordered_meals: !!python/name:overcooked_simulator.order.serving_not_ordered_meals_with_zero_score ''
# a func that calcs a store for not ordered but served meals. Input: meal
+ penalty_for_trash: !!python/name:overcooked_simulator.order.penalty_for_each_item ''
+ # a func that calcs the penalty for items that the player puts into the trashcan.
player_config:
radius: 0.4
diff --git a/overcooked_simulator/order.py b/overcooked_simulator/order.py
index 68e5d311..b44d014d 100644
--- a/overcooked_simulator/order.py
+++ b/overcooked_simulator/order.py
@@ -146,6 +146,14 @@ class OrderAndScoreManager:
[Item], Tuple[bool, float]
] = order_config["serving_not_ordered_meals"]
"""Function that decides if not ordered meals can be served and what score it gives"""
+
+ self.penalty_for_trash: Callable[[Item | list[Item]], float] = (
+ order_config["penalty_for_trash"]
+ if "penalty_for_trash" in order_config
+ else zero
+ )
+ """Function that calculates the penalty for items which were put into the trashcan."""
+
self.available_meals = available_meals
"""The meals for that orders can be sampled from."""
self.open_orders: Deque[Order] = deque()
@@ -285,6 +293,9 @@ class OrderAndScoreManager:
for order in self.open_orders
]
+ def apply_penalty_for_using_trash(self, remove: Item | list[Item]):
+ self.increment_score(self.penalty_for_trash(remove))
+
class ScoreCalcFuncType(Protocol):
"""Typed kwargs of the expected `Order.score_calc` function. Which is also returned by the
@@ -592,3 +603,9 @@ def simple_expired_penalty(item: ItemInfo, default: float, **kwargs) -> float:
def serving_not_ordered_meals_with_zero_score(meal: Item) -> Tuple[bool, float | int]:
"""Not ordered meals are accepted but do not affect the score."""
return True, 0
+
+
+def penalty_for_each_item(remove: Item | list[Item]) -> float:
+ if isinstance(remove, list):
+ return -len(remove) * 5
+ return -5
--
GitLab