Address some linter issues; add doc strings

- Clean up some import ordering
- Write some Numpy style doc strings for classes and functions
This commit is contained in:
Eryn Wells 2022-05-07 08:55:10 -07:00
parent f3d5e273db
commit 7720bc525a
3 changed files with 56 additions and 10 deletions

View file

@ -205,6 +205,7 @@ class RoomsAndCorridorsGenerator(MapGenerator):
return tiles
def __rect_from_bsp_node(self, node: tcod.bsp.BSP) -> Rect:
'''Create a Rect from the given BSP node object'''
return Rect(Point(node.x, node.y), Size(node.width, node.height))
class Room:
@ -215,11 +216,21 @@ class Room:
raise NotImplementedError()
class RectangularRoom(Room):
'''A rectangular room defined by a Rect.
Attributes
----------
bounds : Rect
A rectangle that defines the room. This rectangle includes the tiles used for the walls, so the floor is 1 tile
inset from the bounds.
'''
def __init__(self, bounds: Rect):
self.bounds = bounds
@property
def center(self) -> Point:
'''The center of the room, truncated according to integer math rules'''
return self.bounds.midpoint
@property