1from typing import List
  2
  3from hcraft.elements import Item, Zone
  4from hcraft.task import GetItemTask
  5from hcraft.transformation import Transformation, Use, Yield, PLAYER, CURRENT_ZONE
  6
  7from hcraft.examples.minicraft.minicraft import MiniCraftEnv
  8
  9MINICRAFT_NAME = "KeyCorridor"
 10__doc__ = MiniCraftEnv.description(MINICRAFT_NAME, for_module_header=True)
 11
 12
 13class MiniHCraftKeyCorridor(MiniCraftEnv):
 14    MINICRAFT_NAME = MINICRAFT_NAME
 15    __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 16
 17    START = Zone("start_room")
 18    """Start room."""
 19    KEY_ROOM = Zone("key_room")
 20    """Room containing a key."""
 21    LOCKED_ROOM = Zone("locked_room")
 22    """Room behind a locked door."""
 23
 24    KEY = Item("key")
 25    """Key used to unlock locked door."""
 26    BALL = Item("ball")
 27    """Ball to pickup."""
 28    WEIGHT = Item("weight")
 29    """Weight of carried items."""
 30
 31    OPEN_DOOR = Item("open_door")
 32    """Opened lockedroom door."""
 33    OPEN_KEY_DOOR = Item("blue_open_door")
 34    """Opened keyroom door."""
 35    CLOSED_KEY_DOOR = Item("blue_closed_door")
 36    """Closed keyroom door."""
 37    LOCKED_DOOR = Item("locked_door")
 38    """Locked door, can be unlocked with a key."""
 39
 40    def __init__(self, **kwargs) -> None:
 41        self.task = GetItemTask(self.BALL)
 42        super().__init__(
 43            self.MINICRAFT_NAME,
 44            start_zone=self.START,
 45            start_zones_items={
 46                self.START: [self.CLOSED_KEY_DOOR, self.LOCKED_DOOR],
 47                self.LOCKED_ROOM: [self.BALL],
 48            },
 49            purpose=self.task,
 50            **kwargs,
 51        )
 52
 53    def build_transformations(self) -> List[Transformation]:
 54        transformations = []
 55
 56        # Ensure key cannot be created if anywhere else
 57        search_for_key = Transformation(
 58            "search_for_key",
 59            inventory_changes=[
 60                Yield(CURRENT_ZONE, self.KEY, create=1, max=0),
 61                Yield(PLAYER, self.KEY, create=0, max=0),
 62                Yield(self.START, self.KEY, create=0, max=0),
 63                Yield(self.KEY_ROOM, self.KEY, create=0, max=0),
 64                Yield(self.LOCKED_ROOM, self.KEY, create=0, max=0),
 65            ],
 66            zone=self.KEY_ROOM,
 67        )
 68        transformations.append(search_for_key)
 69
 70        pickup = Transformation(
 71            "pickup_key",
 72            inventory_changes=[
 73                Use(CURRENT_ZONE, self.KEY, consume=1),
 74                Yield(PLAYER, self.KEY),
 75                Yield(PLAYER, self.WEIGHT, max=0),
 76            ],
 77        )
 78        put_down = Transformation(
 79            "put_down_key",
 80            inventory_changes=[
 81                Use(PLAYER, self.KEY, consume=1),
 82                Use(PLAYER, self.WEIGHT, consume=1),
 83                Yield(CURRENT_ZONE, self.KEY, create=1),
 84            ],
 85        )
 86        transformations += [pickup, put_down]
 87
 88        open_door = Transformation(
 89            "open_door",
 90            inventory_changes=[
 91                Use(CURRENT_ZONE, self.CLOSED_KEY_DOOR, consume=1),
 92                Yield(CURRENT_ZONE, self.OPEN_KEY_DOOR, create=1),
 93            ],
 94        )
 95        transformations.append(open_door)
 96
 97        move_to_key_room = Transformation(
 98            "move_to_key_room",
 99            destination=self.KEY_ROOM,
100            inventory_changes=[Use(CURRENT_ZONE, self.OPEN_KEY_DOOR)],
101            zone=self.START,
102        )
103        transformations.append(move_to_key_room)
104
105        for from_zone in [self.KEY_ROOM, self.LOCKED_ROOM]:
106            move_to_start_room = Transformation(
107                f"move_to_start_room_from_{from_zone.name}",
108                destination=self.START,
109                zone=from_zone,
110            )
111            transformations.append(move_to_start_room)
112
113        unlock_door = Transformation(
114            "unlock_door",
115            inventory_changes=[
116                Use(PLAYER, self.KEY),
117                Use(CURRENT_ZONE, self.LOCKED_DOOR, consume=1),
118                Yield(CURRENT_ZONE, self.OPEN_DOOR, create=1),
119            ],
120        )
121        transformations.append(unlock_door)
122
123        move_to_locked_room = Transformation(
124            "move_to_locked_room",
125            destination=self.LOCKED_ROOM,
126            inventory_changes=[Use(CURRENT_ZONE, self.OPEN_DOOR)],
127            zone=self.START,
128        )
129        transformations.append(move_to_locked_room)
130
131        pickup_ball = Transformation(
132            "pickup_ball",
133            inventory_changes=[
134                Use(CURRENT_ZONE, self.BALL, consume=1),
135                Yield(PLAYER, self.BALL),
136                Yield(PLAYER, self.WEIGHT, max=0),
137            ],
138        )
139        transformations.append(pickup_ball)
140
141        return transformations