mibi88
/
libSCII
1
0
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Started the french doc.

This commit is contained in:
mibi88 2023-01-07 00:18:51 +01:00
parent 4bec33fb39
commit 59b69f8cc2
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
DOCS_fr.md Normal file
View File

@ -0,0 +1,28 @@
# libSCII
Pour utiliser libSCII, il faut créer une nouvelle variable de la classe Scii :
## La classe `Scii`
```python
scii = Scii(world, player, npc_collision)
```
Voici les arguments qu'on peut donner à Scii :
```python
world, player, on_npc_collision, scii_keys = None, get_input_text = None, no_collision = None, collision_checker = None, message_history_max = None, screen_width = 21, screen_height = 7
```
* `world` va contenir les données du monde. Des explication plus précises sont plus bas.
* `player` va conten les données du joueur. Des explication plus précises sont plus bas.
* `on_npc_collision` doit être une fonction avec les arguments `self, npc` qui est exécutée lorsque le joueur va vers le pnj.
* `self` contient la classe `Scii` et permet d'y appeler des fonctions.
* `npc` contient les données du pnj, comme elles sont écrites dans `world` (voir plus bas).
* `scii_keys` contient les touches que le joueur utilise pour faire certaines action. Quand `scii_keys` est égal à `None`, les touches utilisés sont : `{"left": '4', "right": '6', "up": '8', "down": '2', "quit": 'q', "old_messages": '0'}`. `"old_messages"` permet de voir les anciennes conversations.
* `get_input_text` est une fonction qui doit retourner une chaine de caractères qui sera affichée dans l'input pour récupérer les touches.
* `no_collision` est une chaine de caractères qui contient les caractères que le joueur peut traverser. Par défaut, lorsque `no_collision` est égal à `None`, la chaine de caractères est `" ^"`.
* `collision_checker` est une fonction qui prend les paramètres `self, world, player, x, y` et qui retourne 0 si le joueur peut passer à (x, y), 1 si il ne peut pas passer à (x, y) et 2 si il y a un pnj à (x, y). `self` permet d'appeler des fonctions de la classe `Scii` ou à en récupérer des données et `world` et `player` contiennent les mêmes données que `world` et `player` qui sont des arguments de `Scii`.
* `message_history_max` contient le nombre de messages maximals qui seront conservés dans l'historique des conversations.
* `screen_width` est un `int` qui contient la largeur de l'écran en nombre de caractères.
* `screen_height` est un `int` qui contient la hauteur de l'écran en nombre de caractères.