Finished documenting world and player

This commit is contained in:
mibi88 2023-01-07 11:27:45 +01:00
parent 96d6177674
commit 4e766bf06b
1 changed files with 46 additions and 1 deletions

View File

@ -34,6 +34,19 @@ world, player, on_npc_collision, scii_keys = None, get_input_text = None, no_col
### Un exemple de `world`
```python
map0 = """
########################################################
# ________ \|/ #
# | ) | _|_ #
# |_)____| \_/ ______ #
# ^ [==-==-] _ #
# <=> [-===-=] // #
# / \ [==-==-] <=// #
# | || #
########################################################
"""
world = {
"dmode": STICKY,
"map_num": 0,
@ -83,6 +96,7 @@ world = {
```
### Description
* `dmode` : La méthode d'affichage de la carte :
* `STICKY` : Le joueur est au milieu à part si il est trop proche du bord de la carte, il va donc se décentrer.
* `CENTERED` : Le joueur est toujours au centre (comme dans Asci).
@ -98,4 +112,35 @@ world = {
* `to_x` et `to_y` : La position de d'arrivée.
* `to_map` : La map de l'arrivée.
* `isactive` : Bolléen : est ce que ce jump peut téléporter le joueur ?
* `npc` : Liste des pnj qui sont des dictionnaires constituée de :
* `npc` : Liste des pnj qui sont des dictionnaires constituée de :
* `x` et `y` : Leur position sur la map.
* `isvisible` : est ce qu'ils sont visibles.
* `collision_check` : Bolléen : est ce qu'on peut entrer en collision avec eux.
* `layer` : Au dessus de quel layer ils s'affichent.
* `map` : Sur quelle map ils sont.
* `char` : Quel caractère est utilisé pour les afficher.
* `name` : Le nom du pnj, ce qui permet de l'identifier.
## `player`, le joueur
### Un exemple de `player`
```python
player = {
"x": 3,
"y": 4,
"isvisible": 1,
"collision_check": 1,
"layer": 0,
"playerc": '@'
}
```
### Description
* `x` et `y` : Sa position sur la map.
* `isvisible` : est ce qu'il est visible.
* `collision_check` : Bolléen : est ce qu'il est stoppé par les objets durs et les pnj.
* `layer` : Au dessus de quel layer ils s'affiche.
La map sur laquelle il est est déjà définie dans `map_num` de `world`.