make containers functional (fixes #12)

Author: creaturekatze

data/worlds/chaosdorf/areas/hackcenter.toml

@@ -24,9 +24,13 @@ description = "a large couch. It seems quite comfortable..."
 obvious = true
 
 [[contents]]
+kind = "container"
 name = "fridge"
 description = "a fridge full of magic potions"
 obvious = true
+[[contents.contents]]
+name = "mate"
+kind = "item"
 
 [[contents]]
 name = "printer"

src/fantasy_forge/area.py

@@ -9,7 +9,7 @@
 import toml
 
 from fantasy_forge.entity import Entity
-from fantasy_forge.utils import UniqueDict
+from fantasy_forge.utils import UniqueDict, inflate_contents
 
 logger = logging.getLogger(__name__)
 
@@ -59,39 +59,8 @@ def to_dict(self: Self) -> dict:
 
     @staticmethod
     def from_dict(messages: Messages, area_dict: dict) -> Area:
-        contents_list: list[Entity] = []
-        for entity_dict in area_dict.get("contents", []):
-            match entity_dict.get("kind", "entity"):
-                case "item":
-                    from fantasy_forge.item import Item
-
-                    contents_list.append(Item(messages, entity_dict))
-                case "gateway":
-                    from fantasy_forge.gateway import Gateway
-
-                    contents_list.append(Gateway(messages, entity_dict))
-                case "key":
-                    from fantasy_forge.key import Key
-
-                    contents_list.append(Key(messages, entity_dict))
-                case "enemy":
-                    from fantasy_forge.enemy import Enemy
-
-                    contents_list.append(Enemy(messages, entity_dict))
-                case "weapon":
-                    from fantasy_forge.weapon import Weapon
-
-                    contents_list.append(Weapon(messages, entity_dict))
-                case "armour":
-                    from fantasy_forge.armour import Armour
-
-                    contents_list.append(Armour(messages, entity_dict))
-
-                case default:
-                    contents_list.append(Entity(messages, entity_dict))
         area = Area(messages, area_dict)
-        for entity in contents_list:
-            area.contents[entity.name] = entity
+        inflate_contents(messages, area_dict.get("contents", []), area)
         return area
 
     @staticmethod

src/fantasy_forge/container.py

@@ -1,27 +1,31 @@
+from __future__ import annotations
+
 """Container class
 
 A container is an item in the world which holds an inventory.
 """
 
-from typing import Any, Self
+from typing import TYPE_CHECKING, Any, Iterator, Self
 
-from fantasy_forge.inventory import Inventory
 from fantasy_forge.item import Item
+from fantasy_forge.localization import highlight_interactive
+from fantasy_forge.messages import Messages
+from fantasy_forge.utils import UniqueDict, inflate_contents
 
 
-class Container(Inventory, Item):
+class Container(Item):
     """Container object."""
 
+    contents: UniqueDict[str, Item]
+    capacity: int
     __important_attributes__ = (*Item.__important_attributes__, "capacity")
-    __attributes__ = {**Inventory.__attributes__, **Item.__attributes__}
+    __attributes__ = {**Item.__attributes__, "capacity": int}
 
-    def __init__(
-        self: Self, config_dict: dict[str, Any], l10n: FluentLocalization
-    ) -> None:
+    def __init__(self: Self, messages: Messages, config_dict: dict[str, Any]) -> None:
         """
         config_dict contents
-        inherited from Inventory
-        'capacity' (int): maximum capacity of the inventory
+        'capacity' (int): maximum capacity of the container
+        'contents' (list): contents of the container
 
         inherited from Item
         'moveable' (bool): can the item be moved by the player (default: True)
@@ -32,9 +36,43 @@ def __init__(
         'description' (str): description of the entity (default: "")
         'obvious'(bool): whether the entity will be spotted immediately (default: False)
         """
-        Inventory.__init__(self, config_dict, l10n)
-        Item.__init__(self, config_dict, l10n)
+        super().__init__(messages, config_dict)
+        self.capacity = config_dict.get("capacity", 10)
+        self.contents = UniqueDict()
+        inflate_contents(messages, config_dict.get("contents", []), self)
+
+    def __len__(self: Self) -> int:
+        """Returns current capacity."""
+        return len(self.contents)
+
+    def __iter__(self: Self) -> Iterator[Item]:
+        """Iterates over items in container."""
+        yield from self.contents.values()
+
+    def __contains__(self: Self, other: str) -> bool:
+        """Returns if entity is in container."""
+        return other in self.contents
+
+    def on_look(self: Self, player: Player):
+        super().on_look(player)
+        if not self.contents:
+            self.messages.to(
+                [player], "container-look-empty-message", container=self.name
+            )
+        else:
+            self.messages.to(
+                [player],
+                "container-look-message",
+                container=self.name,
+                contents=", ".join(
+                    [
+                        highlight_interactive(str(item)).format(None)
+                        + f" (weight: {item.weight})"
+                        for item in self
+                    ]
+                ),
+            )
 
 
 if TYPE_CHECKING:
-    from fluent.runtime import FluentLocalization
+    from fantasy_forge.player import Player

src/fantasy_forge/inventory.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Iterator, Self
+from typing import TYPE_CHECKING, Self
 
+from fantasy_forge.container import Container
 from fantasy_forge.entity import Entity
 from fantasy_forge.item import Item
+from fantasy_forge.localization import highlight_interactive
 from fantasy_forge.utils import UniqueDict
 
 
@@ -15,36 +17,14 @@ class InventoryTooSmall(Exception):
     pass
 
 
-class Inventory(Entity):
+class Inventory(Container):
     """An Inventory contains multiple entities."""
 
-    messages: Messages
-    capacity: int
-    contents: UniqueDict[str, Item]
-
-    __important_attributes__ = ("name", "capacity")
-    __attributes__ = {**Entity.__attributes__, "capacity": int}
-
     def __init__(self: Self, messages: Messages, capacity: int):
         self.messages = messages
         self.capacity = capacity
         self.contents = UniqueDict()
 
-    def __len__(self: Self) -> int:
-        """Returns current capacity."""
-        return len(self.contents)
-
-    def __iter__(self: Self) -> Iterator[Item]:
-        """Iterates over items in inventory."""
-        yield from self.contents.values()
-
-    def __len__(self: Self) -> int:
-        return len(self.contents)
-
-    def __contains__(self: Self, other: str) -> bool:
-        """Returns if entity is in inventory."""
-        return other in self.contents
-
     def calculate_weight(self: Self) -> int:
         weight = 0
         for item in self.contents.values():

src/fantasy_forge/l10n/en/main.ftl

@@ -52,6 +52,8 @@ dropped = You dropped { INTER($item) }.
 enter-area-message = You are now in { $area }. You see:
 inventory-look-message = In the inventory you find { $items }.
 inventory-look-empty-message = Your inventory is empty.
+container-look-message = In the { $container } you find { $contents }.
+container-look-empty-message = The { $container } is empty.
 inventory-capacity-message = Maximum capacity ({ NUM($capacity) }) reached.
 inventory-too-small-message = Inventory isn't big enough to fit this item. (Capacity: ({ NUM($capacity) }), Item weight: ({ NUM($weight) })).
 inventory-item-not-found-message = Item { $item } couldn't be found.

src/fantasy_forge/utils.py

@@ -1,13 +1,20 @@
+from __future__ import annotations
+
 import ctypes
 from pathlib import Path
 from string import whitespace
+from typing import TYPE_CHECKING, Any
+
+from fantasy_forge.entity import Entity
+from fantasy_forge.messages import Messages
 
 SOURCE_FOLDER: Path = Path(__file__).parent.resolve()  # fantasy_forge/src/fantasy_forge
 ROOT_FOLDER: Path = SOURCE_FOLDER.parent.parent.resolve()  # fantasy_forge
 
 DATA_FOLDER: Path = ROOT_FOLDER / "data"  # fantasy_forge/data
 WORLDS_FOLDER: Path = DATA_FOLDER / "worlds"  # fantasy_forge/data/worlds
 
+
 # taken from https://stackoverflow.com/a/5948050/2192464
 class UniqueDict[K, V](dict[K, V]):
     def __setitem__(self, key: K, value: V):
@@ -17,6 +24,48 @@ def __setitem__(self, key: K, value: V):
             raise KeyError("Key already exists")
 
 
+def inflate_contents(
+    messages: Messages, contents: list[dict[str, Any]], target: Area | Container
+):
+    contents_list: list[Entity] = []
+    for entity_dict in contents:
+        match entity_dict.get("kind", "entity"):
+            case "item":
+                from fantasy_forge.item import Item
+
+                contents_list.append(Item(messages, entity_dict))
+            case "gateway":
+                from fantasy_forge.gateway import Gateway
+
+                contents_list.append(Gateway(messages, entity_dict))
+            case "key":
+                from fantasy_forge.key import Key
+
+                contents_list.append(Key(messages, entity_dict))
+            case "enemy":
+                from fantasy_forge.enemy import Enemy
+
+                contents_list.append(Enemy(messages, entity_dict))
+            case "weapon":
+                from fantasy_forge.weapon import Weapon
+
+                contents_list.append(Weapon(messages, entity_dict))
+            case "armour":
+                from fantasy_forge.armour import Armour
+
+                contents_list.append(Armour(messages, entity_dict))
+
+            case "container":
+                from fantasy_forge.container import Container
+
+                contents_list.append(Container(messages, entity_dict))
+
+            case _:
+                contents_list.append(Entity(messages, entity_dict))
+    for entity in contents_list:
+        target.contents[entity.name] = entity
+
+
 # taken from https://stackoverflow.com/a/15274929/2192464
 def terminate_thread(thread):
     """Terminates a python thread from another thread.
@@ -36,6 +85,7 @@ def terminate_thread(thread):
         ctypes.pythonapi.PyThreadState_SetAsyncExc(thread.ident, None)
         raise SystemError("PyThreadState_SetAsyncExc failed")
 
+
 def clean_filename(filename: str) -> str:
     result = []
     for char in filename.casefold():
@@ -46,3 +96,8 @@ def clean_filename(filename: str) -> str:
         else:
             continue
     return "".join(result)
+
+
+if TYPE_CHECKING:
+    from fantasy_forge.area import Area
+    from fantasy_forge.container import Container