Add documentation for entities
This commit is contained in:
@ -7,4 +7,73 @@ Entités
|
||||
|
||||
player
|
||||
monsters
|
||||
items
|
||||
items
|
||||
|
||||
Entité
|
||||
------
|
||||
|
||||
Une entité est un élément placé sur la carte. Ce peut être le joueur, un monstre
|
||||
ou bien un objet sur la carte. Chaque entité dispose des attributs suivants :
|
||||
|
||||
* ``name: str``
|
||||
|
||||
Il s'agit du type de l'entité.
|
||||
|
||||
* ``y: int``
|
||||
* ``x: int``
|
||||
|
||||
Cela représente les coordonnées de l'entité sur la carte.
|
||||
|
||||
* ``map: Map``
|
||||
|
||||
Il s'agit de la carte sur laquelle est placée l'entité.
|
||||
|
||||
.. _objet: items.html
|
||||
|
||||
Il existe à l'heure actuelle deux types d'entité : une `entité attaquante`_ ou
|
||||
bien un objet_.
|
||||
|
||||
|
||||
Entité attaquante
|
||||
-----------------
|
||||
|
||||
.. _monstre: monsters.html
|
||||
.. _joueur: player.html
|
||||
|
||||
Une entité attaquante (``FightingEntity``) est un type d'entités représentant
|
||||
les personnages présents sur la carte, pouvant alors se battre. Ce peut être
|
||||
un monstre_ ou bien le joueur_.
|
||||
|
||||
Elles disposent toutes, en plus des paramètres d'entité, des attributs suivants :
|
||||
|
||||
* ``maxhealth: int``
|
||||
|
||||
Représente la vie maximale de l'entité, qui est aussi la vie de départ.
|
||||
|
||||
* ``health: int``
|
||||
|
||||
Représente la vie actuelle de l'entité.
|
||||
|
||||
* ``strength: int``
|
||||
|
||||
Représente la force de l'entité, le nombre de dégâts à faire à chaque coup.
|
||||
|
||||
* ``intelligence: int``
|
||||
* ``charisma: int``
|
||||
* ``dexterity: int``
|
||||
* ``constitution: int``
|
||||
|
||||
Tous ces paramètres sont des statistiques de l'entité, n'ayant pas de réelle
|
||||
influence pour le moment.
|
||||
|
||||
* ``level: int``
|
||||
|
||||
Niveau de l'entité.
|
||||
|
||||
Chaque type d'entité disposera de ses propres attributs de départ.
|
||||
|
||||
On considère une entité comme morte à partir du moment où sa vie descend
|
||||
en-dessous de 0 point de vie. À ce moment-là, l'entité est retirée de la carte.
|
||||
|
||||
Lorsqu'une entité en frappe une autre, celle-ci inflige autant de dégâts qu'elle
|
||||
n'a de force, et autant de points de vie sont perdus.
|
||||
|
Reference in New Issue
Block a user