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
  9
 10MINICRAFT_NAME = "DoorKey"
 11__doc__ = MiniCraftEnv.description(MINICRAFT_NAME, for_module_header=True)
 12
 13
 14class MiniHCraftDoorKey(MiniCraftEnv):
 15    MINICRAFT_NAME = MINICRAFT_NAME
 16    __doc__ = MiniCraftEnv.description(MINICRAFT_NAME)
 17
 18    START = Zone("start_room")
 19    """Start room."""
 20    LOCKED_ROOM = Zone("locked_room")
 21    """Room behind a locked door."""
 22
 23    KEY = Item("key")
 24    """Key used to unlock the door."""
 25    GOAL = Item("goal")
 26    """Goal to reach."""
 27
 28    OPEN_DOOR = Item("open_door")
 29    """Open door between the two rooms."""
 30    LOCKED_DOOR = Item("locked_door")
 31    """Locked door between the two rooms, can be unlocked with a key."""
 32
 33    def __init__(self, **kwargs) -> None:
 34        self.task = GetItemTask(self.GOAL)
 35        super().__init__(
 36            self.MINICRAFT_NAME,
 37            purpose=self.task,
 38            start_zone=self.START,
 39            **kwargs,
 40        )
 41
 42    def build_transformations(self) -> List[Transformation]:
 43        transformations = []
 44
 45        # Ensure key cannot be created if anywhere else
 46        search_for_key = Transformation(
 47            "search_for_key",
 48            inventory_changes=[
 49                Yield(CURRENT_ZONE, self.KEY, create=1, max=0),
 50                Yield(PLAYER, self.KEY, create=0, max=0),
 51                Yield(self.START, self.KEY, create=0, max=0),
 52                Yield(self.LOCKED_ROOM, self.KEY, create=0, max=0),
 53            ],
 54            zone=self.START,
 55        )
 56        transformations.append(search_for_key)
 57
 58        pickup = Transformation(
 59            "pickup_key",
 60            inventory_changes=[
 61                Use(CURRENT_ZONE, self.KEY, consume=1),
 62                Yield(PLAYER, self.KEY, create=1),
 63            ],
 64        )
 65        put_down = Transformation(
 66            "put_down_key",
 67            inventory_changes=[
 68                Use(PLAYER, self.KEY, consume=1),
 69                Yield(CURRENT_ZONE, self.KEY, create=1),
 70            ],
 71        )
 72        transformations += [pickup, put_down]
 73
 74        search_for_door = Transformation(
 75            "search_for_door",
 76            inventory_changes=[
 77                Yield(CURRENT_ZONE, self.LOCKED_DOOR, max=0),
 78                Yield(CURRENT_ZONE, self.OPEN_DOOR, create=0, max=0),
 79            ],
 80            zone=self.START,
 81        )
 82        transformations.append(search_for_door)
 83
 84        unlock_door = Transformation(
 85            "unlock_door",
 86            inventory_changes=[
 87                Use(PLAYER, self.KEY),
 88                Use(CURRENT_ZONE, self.LOCKED_DOOR, consume=1),
 89                Yield(CURRENT_ZONE, self.OPEN_DOOR, create=1),
 90            ],
 91        )
 92        transformations.append(unlock_door)
 93
 94        move_to_locked_room = Transformation(
 95            "move_to_locked_room",
 96            destination=self.LOCKED_ROOM,
 97            inventory_changes=[Use(CURRENT_ZONE, self.OPEN_DOOR)],
 98            zone=self.START,
 99        )
100        transformations.append(move_to_locked_room)
101
102        move_to_start_room = Transformation(
103            destination=self.START,
104            zone=self.LOCKED_ROOM,
105        )
106        transformations.append(move_to_start_room)
107
108        find_goal = Transformation(
109            "find_goal",
110            inventory_changes=[Yield(CURRENT_ZONE, self.GOAL, max=0)],
111            zone=self.LOCKED_ROOM,
112        )
113        transformations.append(find_goal)
114
115        reach_goal = Transformation(
116            "reach_goal",
117            inventory_changes=[
118                Use(CURRENT_ZONE, self.GOAL, consume=1),
119                Yield(PLAYER, self.GOAL),
120            ],
121        )
122        transformations.append(reach_goal)
123
124        return transformations