Added documentation on a lot of classes and functions (and removed some files I commited by mistake)
This commit is contained in:
@ -3,13 +3,22 @@ from typing import Optional
|
||||
|
||||
from dungeonbattle.settings import Settings
|
||||
|
||||
#This file contains a few useful enumeration classes used elsewhere in the code
|
||||
|
||||
|
||||
class DisplayActions(Enum):
|
||||
"""
|
||||
Display actions options for the callable displayaction Game uses
|
||||
(it just calls the same action on the display object displayaction refers to)
|
||||
"""
|
||||
REFRESH = auto()
|
||||
UPDATE = auto()
|
||||
|
||||
|
||||
class GameMode(Enum):
|
||||
"""
|
||||
Game mode options
|
||||
"""
|
||||
MAINMENU = auto()
|
||||
PLAY = auto()
|
||||
SETTINGS = auto()
|
||||
@ -17,6 +26,9 @@ class GameMode(Enum):
|
||||
|
||||
|
||||
class KeyValues(Enum):
|
||||
"""
|
||||
Key values options used in the game
|
||||
"""
|
||||
UP = auto()
|
||||
DOWN = auto()
|
||||
LEFT = auto()
|
||||
|
Reference in New Issue
Block a user