Add a MessageLog that keeps a record of in-game events

erynrl/messages.py

@@ -0,0 +1,72 @@
+# Eryn Wells <eryn@erynwells.me>
+
+import textwrap
+from typing import List, Optional, Reversible, Tuple
+
+import tcod
+
+from .geometry import Rect
+
+class Message:
+    def __init__(self, text: str, fg: Optional[Tuple[int, int, int]] = None):
+        self.text = text
+        self.foreground = fg
+        self.count = 1
+
+    @property
+    def full_text(self) -> str:
+        '''The full text of the message, including a count of repeats, if present'''
+        if self.count == 1:
+            return self.text
+        else:
+            return f'{self.text} (x{self.count})'
+
+    def __str__(self) -> str:
+        return self.text
+
+    def __repr__(self) -> str:
+        return f'{self.__class__.__name__}({repr(self.text)}, fg={self.foreground})'
+
+class MessageLog:
+    '''A buffer of messages sent to the player by the game'''
+
+    def __init__(self):
+        self.messages: List[Message] = []
+
+    def add_message(self, text: str, fg: Optional[Tuple[int, int, int]] = None, stack: bool = True):
+        '''
+        Add a message to the buffer
+
+        Parameters
+        ----------
+        text : str
+            The text of the message
+        fg : Tuple[int, int, int], optional
+            A foreground color to render the text
+        stack : bool
+            If True and the previous message in the buffer is the same as the text given, increment the count of that
+            message rather than adding a new message to the buffer
+        '''
+        if stack and self.messages and self.messages[-1].text == text:
+            self.messages[-1].count += 1
+        else:
+            self.messages.append(Message(text, fg))
+
+    def render_to_console(self, console: tcod.console.Console, rect: Rect):
+        self.render_messages(console, rect, self.messages)
+
+    @staticmethod
+    def render_messages(console: tcod.console.Console, rect: Rect, messages: Reversible[Message]):
+        y_offset = min(rect.size.height, len(messages))
+
+        for message in reversed(messages):
+            wrapped_text = textwrap.wrap(message.full_text, rect.size.width)
+            for line in wrapped_text:
+                console.print(x=rect.min_x, y=rect.min_y + y_offset - 1, string=line, fg=message.foreground)
+                y_offset -= 1
+
+                if y_offset < 0:
+                    break
+
+            if y_offset < 0:
+                break