Add comments in UiText.py
This commit is contained in:
parent
b15382d9bc
commit
6832d41990
@ -1,14 +1,32 @@
|
|||||||
from typing import Tuple
|
from typing import Tuple, Union
|
||||||
|
|
||||||
import pygame
|
import pygame
|
||||||
|
from pygame.font import FontType
|
||||||
|
|
||||||
from src.ui.UiElement import UiElement
|
from src.ui.UiElement import UiElement
|
||||||
|
|
||||||
|
|
||||||
class UiText(UiElement):
|
class UiText(UiElement):
|
||||||
|
image: pygame.Surface
|
||||||
|
font: pygame.font.Font
|
||||||
|
text: str
|
||||||
|
antialias: bool
|
||||||
|
textColor: Tuple[int, int, int]
|
||||||
|
backgroundColor: Tuple[int, int, int]
|
||||||
|
|
||||||
def __init__(self, rect: pygame.Rect, text: str, font: pygame.font.Font = None,
|
def __init__(self, rect: pygame.Rect, text: str, font: pygame.font.Font = None,
|
||||||
textColor=(0, 0, 0), antialias: bool = False,
|
textColor: Tuple[int, int, int] = (0, 0, 0), antialias: bool = False,
|
||||||
backgroundColor=None):
|
backgroundColor: Union[Tuple[int, int, int], None] = None):
|
||||||
|
"""
|
||||||
|
Creates UiText object.
|
||||||
|
|
||||||
|
:param rect: Rectangle on which text view will be drawn.
|
||||||
|
:param text:
|
||||||
|
:param font: If no font is given then default pygame font will be used.
|
||||||
|
:param textColor:
|
||||||
|
:param antialias:
|
||||||
|
:param backgroundColor: Can be None.
|
||||||
|
"""
|
||||||
super().__init__(rect)
|
super().__init__(rect)
|
||||||
|
|
||||||
self.backgroundColor = backgroundColor
|
self.backgroundColor = backgroundColor
|
||||||
@ -25,7 +43,12 @@ class UiText(UiElement):
|
|||||||
wordImage = self.font.render(text, antialias, textColor)
|
wordImage = self.font.render(text, antialias, textColor)
|
||||||
self.image.blit(wordImage, (0, 0))
|
self.image.blit(wordImage, (0, 0))
|
||||||
|
|
||||||
def changeText(self, newText):
|
def changeText(self, newText: str):
|
||||||
|
"""
|
||||||
|
Changes text view's text.
|
||||||
|
|
||||||
|
:param newText:
|
||||||
|
"""
|
||||||
self.text = newText
|
self.text = newText
|
||||||
|
|
||||||
if self.backgroundColor is not None:
|
if self.backgroundColor is not None:
|
||||||
|
Loading…
Reference in New Issue
Block a user