Added a quests GUI. (#188)

Author: robbrit

assets/game-spec.json

@@ -241,6 +241,10 @@
                 {
                     "name": "exit-button-selected",
                     "path": "assets/gui/exit-button-selected.png"
+                },
+                {
+                    "name": "quests-button",
+                    "path": "assets/gui/quests-button.png"
                 }
             ],
             "buttons": [
@@ -250,17 +254,27 @@
                     "name": "resume-button",
                     "center": [
                         400,
-                        290
+                        370
                     ],
                     "action": "engine.builtin.resume_game"
                 },
+                {
+                    "selected_image_asset": "quests-button",
+                    "unselected_image_asset": "quests-button",
+                    "name": "quests-button",
+                    "center": [
+                        400,
+                        260
+                    ],
+                    "action": "game.gui.quests.show_quests_gui"
+                },
                 {
                     "selected_image_asset": "exit-button-selected",
                     "unselected_image_asset": "exit-button",
                     "name": "exit-button",
                     "center": [
                         400,
-                        180
+                        150
                     ],
                     "action": "engine.builtin.exit_game"
                 }

assets/gui/quests-button.png

@@ -35,8 +35,9 @@ def resume_game(api: scripts.GameAPI) -> None:
     api.start_game()
 
 
-def exit_game() -> None:
+def exit_game(api: scripts.GameAPI) -> None:
     """Exits the game."""
+    # pylint: disable=unused-argument
     sys.exit(0)
 
 

engine/builtin.py

@@ -0,0 +1,35 @@
+from typing import (
+    Optional,
+)
+
+from arcade import gui
+
+from engine import scripts
+
+
+class GUI:
+    """A base GUI that implements the GUI protocol."""
+
+    api: Optional[scripts.GameAPI]
+    manager: Optional[gui.UIManager]
+
+    def __init__(self):
+        self.api = None
+        self.manager = None
+
+    def set_api(self, api: scripts.GameAPI) -> None:
+        """Sets the game API for this GUI."""
+        self.api = api
+
+    def set_manager(self, manager: gui.UIManager) -> None:
+        """Sets the UI manager for this GUI."""
+        self.manager = manager
+
+        self.manager.clear()
+        self._reset_widgets()
+
+    def draw(self) -> None:
+        """Renders the GUI."""
+
+    def _reset_widgets(self) -> None:
+        """Override to handle widget creation."""

engine/gui/base.py

@@ -1,4 +1,5 @@
 import dataclasses
+import functools
 from typing import (
     List,
     Optional,
@@ -8,6 +9,7 @@
 from arcade import gui
 
 from engine import scripts
+from engine.gui import base
 
 CONVERSATION_PADDING = 10
 CONVERSATION_Y = 200
@@ -63,48 +65,21 @@ def title(self) -> Optional[str]:
         """Gets the title to display at the top of the conversation GUI."""
 
 
-class _ChoiceButton(gui.UIFlatButton):
-    """Class to allow us to attach data to a UI Button."""
-
-    index: int
-
-    def __init__(self, index, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.index = index
-
-
-class GUI:
+class GUI(base.GUI):
     """A GUI that navigates a conversation in the game."""
 
     root: Conversation
     current: Conversation
 
-    api: Optional[scripts.GameAPI]
-    manager: Optional[gui.UIManager]
-
     def __init__(self, root_conversation: Conversation):
+        super().__init__()
         self.root = root_conversation
         self.current = self.root
         self.api = None
         self.manager = None
 
-    def set_api(self, api: scripts.GameAPI) -> None:
-        """Sets the game API for this GUI."""
-        self.api = api
-
-    def set_manager(self, manager: gui.UIManager) -> None:
-        """Sets the UI manager for this GUI."""
-        self.manager = manager
-
-        self.manager.clear()
-        self._reset_widgets()
-
-    def draw(self) -> None:
-        """Renders the conversation."""
-
-    def _choice_picked(self, event: gui.UIOnClickEvent):
-        index = event.source.index
-        choice = self.current.choices[index]
+    def _choice_picked(self, choice: Choice, _event: gui.UIOnClickEvent):
+        assert self.api is not None
 
         if choice.link is not None:
             self.current = choice.link
@@ -137,8 +112,7 @@ def _reset_widgets(self) -> None:
         )
 
         for i, choice in enumerate(self.current.choices):
-            button = _ChoiceButton(
-                index=i,
+            button = gui.UIFlatButton(
                 x=CHOICES_OFFSET,
                 y=(
                     (len(self.current.choices) - i) * CHOICE_HEIGHT
@@ -147,7 +121,10 @@ def _reset_widgets(self) -> None:
                 height=CHOICE_HEIGHT,
                 text=choice.text,
             )
-            button.on_click = self._choice_picked  # type: ignore
+            button.set_handler(
+                "on_click",
+                functools.partial(self._choice_picked, choice),
+            )
             self.manager.add(button, index=0)
 
         exit_button = gui.UIFlatButton(

engine/gui/conversation.py

@@ -0,0 +1,142 @@
+import functools
+from typing import (
+    List,
+    Optional,
+    Tuple,
+)
+
+from arcade import (
+    csscolor,
+    gui,
+)
+
+from engine import (
+    core,
+    scripts,
+)
+from engine.gui import base
+from game.quests import (
+    base as quests,
+    db as quest_db,
+)
+
+GUI_PADDING = 5
+
+
+class GUI(base.GUI):
+    """A GUI that shows all the quests for the player."""
+
+    _quest_title: Optional[gui.UILabel]
+    _quest_description: Optional[gui.UITextArea]
+
+    def __init__(self):
+        super().__init__()
+        self._quest_title = None
+        self._quest_description = None
+
+    def _select_quest(
+        self,
+        quest: quests.Quest,
+        quest_state: quests.QuestState,
+        _event: gui.UIEvent,
+    ) -> None:
+        assert self._quest_title is not None
+        assert self._quest_description is not None
+
+        self._quest_title.text = quest.title
+        self._quest_title.fit_content()
+        self._quest_description.text = quest.steps[quest_state.current_step].description
+
+    def _reset_widgets(self) -> None:
+        assert self.api is not None
+        assert self.manager is not None
+
+        self.manager.clear()
+        # Dirty hack to get the UI manager to reset correctly.
+        self.manager.children[0] = []
+
+        quest_states: List[Tuple[quests.Quest, quests.QuestState]] = [
+            (quest_db.get(quest_id), quest_state)
+            for quest_id, quest_state in self.api.player_data["quests"].items()
+        ]
+
+        self._quest_title = gui.UILabel(size_hint=(1.0, 0.1), text="")
+        self._quest_description = gui.UITextArea(size_hint=(1.0, 0.9), text="")
+
+        quest_details_pane = gui.UIBoxLayout(
+            vertical=True,
+            size_hint=(0.5, 1.0),
+            children=(self._quest_title, self._quest_description),
+            space_between=GUI_PADDING,
+        )
+        resume_button = gui.UIFlatButton(text="Resume")
+
+        @resume_button.event("on_click")
+        def _on_resume_button(_event: gui.UIEvent) -> None:
+            assert self.api is not None
+            self.api.start_game()
+
+        quest_buttons: List[gui.UIWidget] = []
+
+        for quest, quest_state in quest_states:
+            button = gui.UIFlatButton(
+                size_hint=(1.0, None),
+                height=30,
+                text=quest.title,
+            )
+            button.set_handler(
+                "on_click",
+                functools.partial(
+                    self._select_quest,
+                    quest=quest,
+                    quest_state=quest_state,
+                ),
+            )
+            quest_buttons.append(button)
+
+        if not quest_buttons:
+            quest_buttons.append(gui.UILabel(italic=True, text="No quests yet"))
+
+        main_layout = gui.UIBoxLayout(
+            vertical=True,
+            space_between=GUI_PADDING,
+            children=(
+                gui.UIBoxLayout(
+                    vertical=False,
+                    size_hint=(1.0, 0.8),
+                    space_between=GUI_PADDING,
+                    children=(
+                        gui.UIBoxLayout(
+                            vertical=True,
+                            children=[
+                                gui.UILabel(text="Quests"),
+                            ]
+                            + quest_buttons,
+                            space_between=GUI_PADDING,
+                            size_hint=(0.5, 1.0),
+                        )
+                        .with_space_around(
+                            GUI_PADDING, GUI_PADDING, GUI_PADDING, GUI_PADDING
+                        )
+                        .with_border(color=csscolor.WHITE),
+                        quest_details_pane.with_space_around(
+                            GUI_PADDING, GUI_PADDING, GUI_PADDING, GUI_PADDING
+                        ).with_border(color=csscolor.WHITE),
+                    ),
+                ),
+                gui.UIBoxLayout(size_hint=(1.0, 0.2), children=(resume_button,)),
+            ),
+        )
+
+        anchor = gui.UIAnchorWidget(
+            width=core.SCREEN_WIDTH,
+            height=core.SCREEN_HEIGHT,
+            child=gui.UIWrapper(child=main_layout, size_hint=(1.0, 1.0)),
+        )
+
+        self.manager.add(anchor, index=0)
+
+
+def show_quests_gui(api: scripts.GameAPI) -> None:
+    """Shows the quests GUI."""
+    api.show_gui(GUI())

game/gui/quests.py

@@ -0,0 +1,14 @@
+"""This module tracks a set of all the quests in the game."""
+
+from typing import (
+    Dict,
+)
+
+from game.quests import base
+
+_quests: Dict[str, base.Quest] = {}
+
+
+def get(name: str) -> base.Quest:
+    """Gets a quest by name."""
+    return _quests[name]