API - noftaly/GiveAll GitHub Wiki
Comment utiliser l'API ?
Introduction
L'api apparait réellement sous sa forme finale en version 2.0. Quasiment toutes les fonctions sont préfixées de GiveAll_. Je les ai classées en 3 catégories distinctes :
- Les fonctions d'exécution, qui permettent d'exécuter une commande,
- Les fonctions d'information, qui retournent une valeur et qui permettent donc d'avoir des informations sur une donnée
- Les fonctions d'action, qui sont peut utile pour vous car c'est surtout pour manipuler les GUIs etc côté dev. C'est pour ça qu'elle n'apparaitront pas dans cette documentation.
Les fonctions d'exécution
updateCheck()
La fonction updateCheck permet de notifier un joueur de si le script doit être mis a jour ou non.
updateCheck(PLAYER)
GiveAll_init()
La fonction GiveAll_init permet d'initier le script : il recréé toute "l'API" des conditions. Il est fortement déconseillé de l'utiliser, surtout si des GiveAlls sont en cours.
GiveAll_init()
GiveAll_newGiveAll()
La fonction GiveAll_newGiveAll permet de créer un nouveau giveall ! Il y a beaucoup de paramètres :
GiveAll_newGiveAll(NOM, GROUP, DURÉE, COMPTE A REBOURS, DROPTYPE, CRÉATEUR, CRÉATION, ITEMS)
Si vous ne souhaitez pas entrer de groupe, mettez $none. (configurable dans le script). Le nom doit être du texte. La durée doit être un entier. Le compte a rebours doit être un entier Le drop type doit être "give" ou "drop" Le créateur doit être du texte La date de création doit être du texte Les items doit être une liste d'items
GiveAll_newGroup()
La fonction GiveAll_newGroup permet de créer un nouveau groupe. Elle s'utilise comme ceci :
GiveAll_newGroup(NOM, DURÉE, COMPTE A REBOURS, CRÉATEUR, DATE)
La durée et le compte a rebours de sont pas encore utiliser. Les types des paramètres sont les même que pour GiveAll_newGiveAll()
GiveAll_deleteGroup()
La fonction GiveAll_deleteGroup permet de supprimer un groupe. Elle s'utilise comme ceci :
GiveAll_deleteGroup(NOM)
Le nom doit être du texte
GiveAll_deleteGiveAll()
La fonction GiveAll_deleteGiveAll permet de supprimer un GiveAll. Elle s'utilise comme ceci :
GiveAll_deleteGiveAll(NOM)
Le nom doit être du texte
GiveAll_stop()
La fonction GiveAll_stop permet d'arrêter un GiveAll. Elle s'utilise comme ceci :
GiveAll_stop(NOM)
Le nom doit être du texte
GiveAll_purgeGiveAll()
La fonction GiveAll_purgeGiveAll permet de supprimer tous les GiveAlls.
GiveAll_purgeGiveAll()
GiveAll_purgeGroup()
La fonction GiveAll_purgeGroup permet de supprimer tous les groupes.
GiveAll_purgeGroup()
GiveAll_renameGiveAll()
La fonction GiveAll_renameGiveAll permet de renommer un giveall.
GiveAll_renameGiveAll(ANCIEN NOM, NOUVEAU NOM)
Les deux paramètres doivent être du texte.
GiveAll_copyItems()
La fonction GiveAll_copyItems permet de copier les items d'un giveall dans un autre giveall.
GiveAll_copyItems(GIVEALL IMPORT, GIVEALL EXPORT)
Les deux paramètres doivent être du texte.
GiveAll_setDropType()
La fonction GiveAll_setDropType permet de changer le type de drop d'un GiveAll.
GiveAll_setDropType(GIVEALL, TYPE DE DROP)
Les deux paramètres doivent être du texte. Le type de drop doit être "give" ou "drop"
GiveAll_removeItem()
La fonction GiveAll_removeItem permet d'enlever un item d'un GiveAll.
GiveAll_removeItem(GIVEALL, ITEM)
Le nom doit être du texte. Le type doit être un item
GiveAll_addCondition()
La fonction GiveAll_addCondition permet d'ajouter une condition à un GiveAll.
GiveAll_addCondition(GIVEALL, CONDITION, VALEUR)
Les trois paramètres doivent être du texte. La condition doit être une des conditions parmis celle du /ga cond list
GiveAll_removeCondition()
La fonction GiveAll_removeCondition permet d'enlever une condition à un GiveAll.
GiveAll_removeCondition(GIVEALL, CONDITION)
Les deux paramètres doivent être du texte. La condition doit être une des conditions parmis celle du /ga cond list
GiveAll_addGaToGroup()
La fonction GiveAll_addGaToGroup permet d'ajouter un GiveAll à un groupe.
GiveAll_addGaToGroup(GIVEALL, GROUP)
Les deux paramètres doivent être du texte.
GiveAll_removeGaFromGroup()
La fonction GiveAll_removeGaFromGroup permet d'enlever un GiveAll d'un groupe.
GiveAll_removeGaFromGroup(GIVEALL, GROUP)
Les deux paramètres doivent être du texte.
GiveAll_clearGroup()
La fonction GiveAll_clearGroup permet d'enlever tous les GiveAll d'un groupe.
GiveAll_clearGroup(GROUP)
Le paramètres doit être du texte.
Les fonctions d'informations
GiveAll_debug()
La fonction GiveAll_debug retourne une liste de texte, contenant les erreurs dans la configuration. Si vous mettez true en paramètre, alors les erreurs seront fixées.
GiveAll_debug(FIX)
FIX est un booléen facultatif. Il est sur true par défaut
GiveAll_gaExist()
La fonction GiveAll_gaExist permet de savoir si un GiveAll existe
GiveAll_gaExist(GIVEALL)
Le paramètre doit être du texte.
La fonction retourne true si le giveall existe, sinon elle retourne false
GiveAll_grpExist()
La fonction GiveAll_grpExist permet de savoir si un groupe existe
GiveAll_grpExist(GROUP)
Le paramètre doit être du texte.
La fonction retourne true si le groupe existe, sinon elle retourne false
GiveAll_isInProgress()
La fonction GiveAll_isInProgress permet de savoir si un giveall est en cours
GiveAll_isInProgress(GIVEALL)
Le paramètre doit être du texte.
La fonction retourne true si le giveall est en phase de compte a rebours ou de give, sinon elle retourne false
GiveAll_current()
La fonction GiveAll_current retourne une liste de texte de tous les GiveAlls en cours
GiveAll_current()
GiveAll_hasConditions()
La fonction GiveAll_hasConditions permet de savoir si un giveall a des conditions
GiveAll_hasConditions(GIVEALL)
Le paramètre doit être du texte.
La fonction retourne true si le giveall a des conditions, sinon elle retourne false
GiveAll_activeConditions()
La fonction GiveAll_activeConditions retourne le nombre de condition que le GiveAll a.
GiveAll_activeConditions(GIVEALL)
Le paramètre doit être du texte. La fonction retourne un entier.
GiveAll_isBlacklist()
La fonction GiveAll_isBlacklist permet de savoir si un joueur est blacklist d'un giveall.
GiveAll_isBlacklist(PLAYER, GIVEALL)
Les deux paramètres doivent être du texte.
La fonction retourne true si le joueur est blacklist, sinon elle retourne false
GiveAll_isLastGiveAll()
La fonction GiveAll_isLastGiveAll permet de savoir si il ne reste plus de GiveAll.
GiveAll_isLastGiveAll()
La fonction retourne true s'il n'y a plus de giveall, sinon elle retourne false
GiveAll_playerCanReceiveItems()
La fonction GiveAll_playerCanReceiveItems permet de savoir un joueur peu recevoir les items d'un GiveAll.
GiveAll_playerCanReceiveItems(PLAYER, GIVEALL)
Le joueur doit être du type player, et le giveall doit être du texte.
La fonction retourne true s'il le joueur peut recevoir les items d'un giveall, sinon elle retourne false
GiveAll_playerCanReceiveItems()
La fonction GiveAll_playerCanReceiveItems permet de savoir un joueur peu recevoir les items d'un GiveAll.
GiveAll_playerCanReceiveItems(PLAYER, GIVEALL)
Le joueur doit être du type player, et le giveall doit être du texte.
La fonction retourne true s'il le joueur peut recevoir les items d'un giveall, sinon elle retourne false