Documentation fixes
This commit is contained in:
parent
31811782fb
commit
3924023a92
@ -1,5 +1,13 @@
|
|||||||
class AStarNode:
|
class AStarNode:
|
||||||
def __init__(self, parent, action, state):
|
def __init__(self, parent, action, state):
|
||||||
|
"""
|
||||||
|
Create a node used in A*.
|
||||||
|
|
||||||
|
:type action: Rotations
|
||||||
|
:param parent: Parent node
|
||||||
|
:param action: Action (Rotation)
|
||||||
|
:param state: A tuple of coords as (x,y,rotation)
|
||||||
|
"""
|
||||||
self.state = state
|
self.state = state
|
||||||
self.parent = parent
|
self.parent = parent
|
||||||
self.action = action
|
self.action = action
|
@ -122,7 +122,7 @@ class Entity(pygame.sprite.Sprite):
|
|||||||
|
|
||||||
def getFacingCoord(self, screenRelative=True):
|
def getFacingCoord(self, screenRelative=True):
|
||||||
"""
|
"""
|
||||||
Gets coordinates forward to the player.
|
Gets coordinates forward to this entity.
|
||||||
|
|
||||||
:param screenRelative: If true, the method returns absolute coords
|
:param screenRelative: If true, the method returns absolute coords
|
||||||
:return: Position tuple of (x,y) coords
|
:return: Position tuple of (x,y) coords
|
||||||
|
@ -2,6 +2,7 @@ class Statistics:
|
|||||||
def __init__(self, hp, hunger, thirst, stamina):
|
def __init__(self, hp, hunger, thirst, stamina):
|
||||||
"""
|
"""
|
||||||
Create a statistic object. Used to determine some object state (usually player's).
|
Create a statistic object. Used to determine some object state (usually player's).
|
||||||
|
|
||||||
:param hp: Health points
|
:param hp: Health points
|
||||||
:param hunger: Hunger (it rises)
|
:param hunger: Hunger (it rises)
|
||||||
:param thirst: Thirst (also rises)
|
:param thirst: Thirst (also rises)
|
||||||
|
Loading…
Reference in New Issue
Block a user