Aller au contenu principal
Version: v2.0

XpEventCallback

Cette documentation définit les fonctions de rappel (callbacks) utilisées pour gérer différents événements XP. Ces callbacks sont appelés lorsque des événements spécifiques, comme debug, error, info, level-up et warn, se produisent lors de l’exécution d’une fonctionnalité liée à XP.

Tous les callbacks sont optionnels et peuvent retourner soit void, soit Promise<void>.


Callbacks

debug​

Ce callback est utilisé lorsqu’un événement de débogage est émis.

ParamètreTypeDescription
xpFunctionstringNom de la fonction XP déclenchée
messagestringMessage retourné par l'event

error​

Ce callback est utilisé lorsqu’un événement d’erreur est émis.

ParamètreTypeDescription
xpFunctionstringFonction XP
messagestringMessage d'événement

info​

Ce callback est utilisé lorsqu’un événement d’information est émis.

ParamètreTypeDescription
xpFunctionstringFonction XP
messagestringMessage d'événement

levelDown​

Ce callback est utilisé lorsqu’un utilisateur perd un niveau.

ParamètreTypeDescription
dataUserResultInfos user (UserResult)
lostRolesstring[]Array des rôles retirés

levelUp​

Ce callback est utilisé lorsqu’un utilisateur gagne un niveau.

ParamètreTypeDescription
dataUserResultInfos user (UserResult)
newRolesstring[]Array des rôles ajoutés

warn​

Ce callback est utilisé lorsqu’un événement d’avertissement est émis.

ParamètreTypeDescription
xpFunctionstringFonction XP
messagestringMessage d'événement