Aller au contenu principal

Se repérer dans le wiki aoi.js

Se repérer dans un wiki peut être difficile pour ceux qui débutent le codage, mais ce guide simple devrait vous être utile ! Tout d'abord, au cas où vous ne l'auriez pas, je vous donne le lien de la documentation aoi.js.

Où et comment faire des recherches ?

La barre de recherches

Sur le site d'aoi.js, vous remarquerez une barre de recherche qui peut être très utile pour trouver des fonctions ! Avantage : Beaucoup de précision si vous arrivez à deviner une partie de la fonction Désavantage : Il faut savoir deviner une partie de la fonction pour chercher un minimum !

Tips

Pour deviner une partie de la fonction, demandez vous ce qu'elle pourrait contenir.
Exemple : je cherche une fonction qui me permet de désactiver les mentions, donc je recherche mention et je cherche dans la liste.
Pour aller un peu plus loin, je cherche comment dire désactiver en anglais, et je trouve disable.
Je suis bien avancé, donc je cherche disableMention et je trouve la fonction parfaite : $disableMentionType !

image

Les catégories

Vous pouvez également chercher, plus simplement dans les catégories de fonctions dans la sidebar du site !
Cette technique est assez pratique quand vous commencez, car les catégories ne nécessitent pas de connaissances de base pour trouver une fonction !

Tips

Pour trouver la bonne catégorie, soit vous le savez à l'avance par déduction, soit vous faites par élimination ! Exemple : je cherche des fonctions d'information sur les rôles.
Je vais dans la catégorie info, à la lettre r (c'est dans l'ordre alphabétique).
Il y a tout ce qu'il me faut !

img

Comprendre les pages de documentation

La partie la plus importante des fonctions est le nom de la fonction, mais parfois, des paramètres sont possibles ou même requis !
Pour comprendre et utiliser ces paramètres, rendez vous dans la deuxième partie de la page de documentation Parameters.

Exemple !

Pour la fonction $addEmoji, on trouve 6 paramètres, dont 3 sont requis.
Grâce au nom et à la description, il est souvent simple de comprendre ce qu'il faut mettre dans ces paramètres, mais certains sont plus complexes que d'autres !
Si je ne comprends pas comment utiliser certains paramètres, je peux me rendre dans la troisième partie de la page, l'exemple.
Ici, il est souvent possible de comprendre facilement comment utiliser les fonctions, et si vous ne comprenez vraiment pas, n'hésitez pas à demander de l'aide sur le serveur discord !

emoji