Finished docss

This commit is contained in:
mibi88 2023-01-07 12:45:10 +01:00
parent e1ebed2497
commit 0a0f87f543
1 changed files with 22 additions and 2 deletions

View File

@ -105,7 +105,7 @@ world = {
* `map_num` : Le numéro de la carte sur laquelle on va démarrer le jeu.
* `maps` : Une liste de plusieurs cartes, chacune constituée de :
* `layers` : les différentes couches qui contituent les maps. Ces layers sont dessinés du premier au dernier.
* `data` : Une string qui a l'apparence du layer.
* `data` : Une string qui contient le layer (`map0` dans l'exemple).
* `transp_char` : Le caractère qui ne sera pas affiché : permet de voir le layer d'en dessous. Si il est à `None`, aucun caractère ne sera enlevé.
* `jumps` : Liste des endroits où le joueur peut sauter d'une map à l'autre et/ou d'une position à l'autre. Cette liste est constituée de dictionnaires constituées de :
* `x` et `y` : La position de départ.
@ -143,4 +143,24 @@ player = {
* `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`.
La map sur laquelle il est est déjà définie dans `map_num` de `world`.
## Les fonctions de `Scii`
`self` est la classe `Scii`.
* `mainloop(self)` : Lance la boucle du jeu.
* Déjà uilisés dans mainloop :
* `get_map_width(self, map_data)` : Retourne la largeur de la map.
* `map_data` : dictionnaire de la map comme il est dans `world["maps"]`
* `get_map_height(self, map_data)` : Retourne la hauteur de la map.
* `map_data` : dictionnaire de la map comme il est dans `world["maps"]`
* `draw_map(self, mode, show_player)`
* `mode` : Mode de dessin de la map (`STICKY`, `CENTERED`, `BLOCKS` ou `STICKYBLOCKS`)
* `show_player` : Bolléen : est ce que le joueur doit être affiché.
* `def show_text(self, text)` : Affiche du texte. L'historique du texte affiché est disponible en appuyant sur `scii_keys["old_messages"]` ou en appelant `show_old_messages(self)`.
* `text` : Texte à afficher.
* `show_old_messages(self)` : Affiche les anciennes conversations.
* `ask_choice(self, text, choices)` : Demande à l'utilisateur de faire un choix parmi les choix proposés dans `choices`. Retourne le choix fait. Le premier choix est le numéro 1, et les prochains sont à chaque fois de 1 plus grands : dans `["Oui", "Non", "Je ne sais pas"]` "Oui" est le choix numéro 1, "Non" est le choix numéro 2 et "Je ne sais pas" est le choix numéro 3.
* `text` : Texte à afficher avant de demander à l'utilisateur quel proposition il fait. Les choix seront affichés en dessous.
* `choices` : Liste de chaines de caractères des choix que l'utilisateur.