Feature Implementation for Pressure Plates

[rynky]

Introduction

This PR introduces the new pressure plates feature in our Overcooked environment.

Features

Currently, pressure plates have the same action capabilities as buttons. There is support for both moving wall and barrier interactions.

See the ButtonAction() class in jaxmarl/environments/overcooked_v3/common.py for more information. You can find an action type cheat sheet at the bottom of this PR.

Currently, due to a bug, only toggling barriers is working. This has been put on low priority because there seem to be no good ideas for levels with pressure plates and moving walls.

Initializing your Pressure Plates

Example Initialization: Pressure Plate Demo Level

pressure_plate_demo = """
WWWWWWW
0 #_AWW <----- Pressure Plate 0
WWWW WW
P #_  X <----- Pressure Plate 1
WWWW WW
1 #_AWW <----- Pressure Plate 2
WWWWWWW
"""

Note:

• Pressure Plates are denoted with the underscore "_"
• Barriers are denoted with the hashtag "#"
• All layouts must be defined in the dictionary overcooked_v3_layouts from jaxmarl/environments/overcooked_v3/layouts.py

To enable pressure plate functionality, you must append the following parameters to your layout configurations:

"map_name": Layout.from_string(
        ...
        pressure_plate_config=[ ... ],
        barrier_config=[ ... ],
    ),

pressure_plate_config = [ (target_index: int, action_type: int), ... ]

barrier_config = [ initial_barrier_state: bool, ... ]

Here's how it looks for the pressure_plate_demo layout:

"pressure_plate_demo": Layout.from_string(
        ...
        pressure_plate_config=[
            (1, ButtonAction.TOGGLE_BARRIER), # Plate 0 (Top) triggers Barrier 1
            (2, ButtonAction.TOGGLE_BARRIER), # Plate 1 (Middle) triggers Barrier 2
            (0, ButtonAction.TOGGLE_BARRIER), # Plate 2 (Bottom) triggers Barrier 0
        ],
        barrier_config=[
            True,  # Barrier 0 (Top) - initially active
            True,  # Barrier 1 (Middle) - initially active
            True,  # Barrier 2 (Bottom) - initially active
        ],
    ),

Note: JAX implicitly numbers static objects of the same type from left to right, top to bottom.

Action Type Cheat Sheet

For toggling barriers, use ButtonAction.TOGGLE_BARRIER.

The other (not working) action types are:

• ButtonAction.TOGGLE_PAUSE
• ButtonAction.TOGGLE_DIRECTION
• ButtonAction.TOGGLE_BOUNCE
• ButtonAction.TRIGGER_MOVE

[SeanYeSchool]

I tried using Copilot to change the graphics of the barriers when they are deactivated by the pressure plates but it seems that it is quite troublesome and instead has the behaviour of removing the barrier completely. Might come back to this if its still desired.