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

Clean up the doc comment on Entity

Browse source
This commit is contained in:
Eryn Wells 2023-03-04 11:07:32 -08:00
parent a83b85b7a0
commit b9c45f44b2
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
erynrl/object.py
View file

@ -29,10 +29,11 @@ class RenderOrder(Enum):
class Entity: class Entity:
'''A single-tile drawable entity with a symbol and position '''A single-tile drawable entity with a symbol and position
Attributes ### Attributes
----------
identifier : int identifier : int
A numerical value that uniquely identifies this entity across the entire game A numerical value that uniquely identifies this entity across the entire
game
position : Point position : Point
The Entity's location on the map The Entity's location on the map
foreground : Tuple[int, int, int] foreground : Tuple[int, int, int]
@ -42,13 +43,16 @@ class Entity:
symbol : str symbol : str
A single character string that represents this character on the map A single character string that represents this character on the map
blocks_movement : bool blocks_movement : bool
True if this Entity blocks other Entities from moving through its position True if this Entity blocks other Entities from moving through its
position
render_order : RenderOrder render_order : RenderOrder
One of the RenderOrder values that specifies a layer at which this entity will be rendered. Higher values are One of the RenderOrder values that specifies a layer at which this
rendered on top of lower values. entity will be rendered. Higher values are rendered on top of lower
values.
''' '''
# A monotonically increasing identifier to help differentiate between entities that otherwise look identical # A monotonically increasing identifier to help differentiate between
# entities that otherwise look identical
__next_identifier = 1 __next_identifier = 1
def __init__( def __init__(