Aller au contenu principal
Version: v2.0

XpEvents.on()

Des événements de rappel pour différents objectifs ! Chaque callback désactivera console.log(), vous donnant un contrôle total sur la sortie.

Toutes les propriétés de callback sont optionnelles, et chaque callback peut retourner void ou Promise<void>.

levelUp et levelDown sont émis par addXP(), removeXP(), setXP(), addLevel(), removeLevel() et setLevel() dès que le niveau d'un utilisateur change.

info

Pour les meilleur résultat, utilisez ceci avant toute autre fonction, y compris connect().

Paramètres

ParamètreTypeRequisDescription
XpEventCallbackXpEventCallbackLe rappel à exécuter lorsque l'événement est émis.

Exemples

const { XpEvents } = require("simply-xp");

XpEvents.on({
debug: (xpFunction, message) => {
// Gérer les événements de débogage
},
error: (xpFunction, message) => {
// Gérer les événements d'erreur
},
info: (xpFunction, message) => {
// Gérer les événements d'information
},
levelDown: (data, lostRoles) => {
// Gérer les événements de levelDown
},
levelUp: (data, newRoles) => {
// Gérer les événements de levelUp
},
warn: (xpFunction, message) => {
// Gérer les événements d'avertissement
},
});

XpEvents.add()

Enregistre des callbacks sans remplacer ceux déjà enregistrés.

XpEvents.on() ne conserve qu'un seul objet de callbacks : l'appeler à nouveau remplace ce qui s'y trouvait, y compris les gestionnaires enregistrés par un plugin ou par une autre partie de votre bot. XpEvents.add() les ajoute à la place, afin qu'un nombre quelconque d'écouteurs reçoive les mêmes événements.

Auteurs de plugins

Utilisez toujours add() dans un plugin. Appeler on() supprimerait silencieusement les gestionnaires de l'auteur du bot.

Paramètres

ParamètreTypeRequisDescription
XpEventCallbackXpEventCallbackLes rappels à exécuter lorsque les événements sont émis.

Retourne

  • () => void - Appelez-la pour retirer à nouveau ces callbacks.

Erreurs

  • XpFatal - Si l'argument des callbacks n'est pas un objet.

Exemple

const { XpEvents } = require("simply-xp");

const removeListener = XpEvents.add({
levelUp: (data, newRoles) => {
// S'exécute en parallèle de tous les autres écouteurs enregistrés
},
});

// Plus tard, lorsque vous n'en avez plus besoin :
removeListener();