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

Add doc string for Configuration attributes

Browse source
This commit is contained in:
Eryn Wells 2023-03-05 10:49:02 -08:00
parent e2553cca3b
commit c488ef9c2b
2 changed files with 20 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
erynrl/configuration.py
View file

@ -166,10 +166,23 @@ class TilesheetFontConfiguration(FontConfiguration):
@dataclass
class Configuration:
'''Configuration of the game engine'''
console_size: Size
console_font_config: FontConfiguration
'''
Configuration of the game engine
map_size: Size
### Attributes
console_font_configuration : FontConfiguration
A configuration object that defines the font to use for rendering the console
console_size : Size
The size of the console in tiles
map_size : Size
The size of the map in tiles
sandbox : bool
If this flag is toggled on, the map is rendered with no shroud
'''
console_font_configuration: FontConfiguration
console_size: Size = CONSOLE_SIZE
map_size: Size = MAP_SIZE
sandbox: bool = False