s444409/DSZI_Survival
s444409/DSZI_Survival
2
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add comments to all methods in UiConsole class

Browse Source
This commit is contained in:
Michał Czekański 2020-05-10 18:03:29 +02:00 committed by Marcin Kostrzewski
parent 2cebcd3be6
commit 22355dc960
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/ui/UiConsole.py
View File

@ -40,7 +40,11 @@ class UiConsole(UiElement):
"""
self.addLinesToConsoleAndScrollToDisplayThem([inp])
def writeConsoleLines(self, startingLineInd=0):
def writeConsoleLines(self, startingLineInd: int = 0):
"""
Displays lines stored in console's list of lines, starting from line with given index.
:param startingLineInd: Line index, which will be written on top of the console.
"""
self.image.fill(self.bgColor)
if startingLineInd < 0:
startingLineInd = 0
@ -53,6 +57,13 @@ class UiConsole(UiElement):
writtenLines += 1
def addLinesToConsole(self, linesToAdd):
"""
Adds lines to console's list of lines. If one line is too long to display, then it is being cut to pieces,
so that it is appropriate size.
Warning: this method doesn't display given lines, just adds to list of lines.
:param linesToAdd:
"""
for line in linesToAdd:
self.consoleLines.append(line)
self.linesCount += 1
@ -81,6 +92,10 @@ class UiConsole(UiElement):
self.linesImagesCount += 1
def addLinesToConsoleAndScrollToDisplayThem(self, linesToAdd):
"""
Adds given lines to console's list of lines, writes them and scrolls console down to display them.
:param linesToAdd: Lines to add to console's list of lines and to display.
"""
self.addLinesToConsole(linesToAdd)
ind = 0
if self.linesImagesCount > self.maxLines: