eryn/going-rogue
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc strings in Messages module

Browse source
This commit is contained in:
Eryn Wells 2022-05-15 16:18:42 -07:00
parent 8239b22157
commit ccd2e04d0e
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
erynrl/messages.py
View file

@ -8,6 +8,18 @@ import tcod
from .geometry import Rect from .geometry import Rect
class Message: class Message:
'''A message in the message log
Attributes
----------
text : str
The text of the message
foreground : Tuple[int, int, int]
The foreground color to render the message with
count : int
The number of times this message has stacked
'''
def __init__(self, text: str, fg: Optional[Tuple[int, int, int]] = None): def __init__(self, text: str, fg: Optional[Tuple[int, int, int]] = None):
self.text = text self.text = text
self.foreground = fg self.foreground = fg
@ -53,10 +65,12 @@ class MessageLog:
self.messages.append(Message(text, fg)) self.messages.append(Message(text, fg))
def render_to_console(self, console: tcod.console.Console, rect: Rect): def render_to_console(self, console: tcod.console.Console, rect: Rect):
'''Render this message log to the given console in the given rect'''
self.render_messages(console, rect, self.messages) self.render_messages(console, rect, self.messages)
@staticmethod @staticmethod
def render_messages(console: tcod.console.Console, rect: Rect, messages: Reversible[Message]): def render_messages(console: tcod.console.Console, rect: Rect, messages: Reversible[Message]):
'''Render a list of messages to the console in the given rect'''
y_offset = min(rect.size.height, len(messages)) y_offset = min(rect.size.height, len(messages))
for message in reversed(messages): for message in reversed(messages):