Événements

zEssentials déclenche des événements personnalisés qui permettent aux développeurs de réagir aux différentes actions effectuées par le plugin. Ces événements suivent le système d'événements standard de Bukkit et peuvent être écoutés avec @EventHandler dans n'importe quel listener enregistré.

Hiérarchie des événementsCopier le lien vers ce titre

Tous les événements de zEssentials héritent d'une hiérarchie de base :

Event
  └── EssentialsEvent
        ├── UserEvent
        │     └── CancellableUserEvent (implements Cancellable)
        └── CancellableEssentialsEvent (implements Cancellable)

• EssentialsEvent -- Événement de base de tous les événements de zEssentials.
• UserEvent -- Hérite d'EssentialsEvent et contient une référence vers l'utilisateur concerné.
• CancellableUserEvent -- Hérite d'UserEvent et implémente Cancellable, ce qui permet d'annuler l'événement.
• CancellableEssentialsEvent -- Hérite d'EssentialsEvent et implémente Cancellable, pour les événements annulables qui ne concernent pas un utilisateur précis.

Écouter les événementsCopier le lien vers ce titre

Pour écouter les événements de zEssentials, enregistrez un listener Bukkit comme d'habitude :

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;

public class MyListener implements Listener {

    @EventHandler
    public void onUserFirstJoin(UserFirstJoinEvent event) {
        // Your logic here
    }
}

Enregistrez le listener dans le onEnable() de votre plugin :

@Override
public void onEnable() {
    getServer().getPluginManager().registerEvents(new MyListener(), this);
}

Dépendre de zEssentialsCopier le lien vers ce titre

Depuis la 1.0.4.0, zEssentials est chargé en tant que plugin Paper (paper-plugin.yml). Déclarez-le comme dépendance de votre plugin pour qu'il soit chargé en premier et que ses classes soient visibles par votre plugin :

Plugin Bukkit (plugin.yml)

softdepend: [ zEssentials ] # ou depend: [ zEssentials ]

Plugin Paper (paper-plugin.yml)

Les plugins Paper sont isolés les uns des autres : ajoutez join-classpath: true pour accéder à l'API de zEssentials.

dependencies:
  server:
    zEssentials:
      load: BEFORE
      required: false
      join-classpath: true

L'instance principale de zEssentials est enregistrée dans le ServicesManager de Bukkit sous EssentialsPlugin :

RegisteredServiceProvider<EssentialsPlugin> provider = Bukkit.getServicesManager().getRegistration(EssentialsPlugin.class);
if (provider != null) {
    EssentialsPlugin essentials = provider.getProvider();
    // Use the API
}

Référence des événementsCopier le lien vers ce titre

UserFirstJoinEventCopier le lien vers ce titre

Déclenché lorsqu'un joueur rejoint le serveur pour la toute première fois.

@EventHandler
public void onFirstJoin(UserFirstJoinEvent event) {
    User user = event.getUser();
    Bukkit.getLogger().info(user.getName() + " joined for the first time!");
}

UserJoinEventCopier le lien vers ce titre

Déclenché à chaque fois qu'un joueur rejoint le serveur.

@EventHandler
public void onJoin(UserJoinEvent event) {
    User user = event.getUser();
    Bukkit.getLogger().info(user.getName() + " has joined the server.");
}

UserQuitEventCopier le lien vers ce titre

Déclenché lorsqu'un joueur quitte le serveur.

@EventHandler
public void onQuit(UserQuitEvent event) {
    User user = event.getUser();
    Bukkit.getLogger().info(user.getName() + " has left the server.");
}

UserEconomyUpdateEventCopier le lien vers ce titre

Déclenché avant la mise à jour du solde d'un joueur. C'est un événement pré-transaction qui permet d'inspecter, de modifier ou d'annuler l'opération avant qu'elle ne soit appliquée.

Méthodes disponibles :

• getEconomy() / setEconomy() -- obtenir ou changer l'économie ciblée
• getAmount() / setAmount() -- obtenir ou modifier le montant de la transaction
• setCancelled(true) -- annuler complètement la transaction

@EventHandler
public void onEconomyUpdate(UserEconomyUpdateEvent event) {
    User user = event.getUser();
    double amount = event.getAmount();

    // Prevent transactions over 1,000,000
    if (amount > 1_000_000) {
        event.setCancelled(true);
        return;
    }

    // Apply a tax by reducing the amount
    event.setAmount(amount * 0.95);
}

UserEconomyPostUpdateEventCopier le lien vers ce titre

Déclenché après la mise à jour du solde d'un joueur. C'est un événement post-transaction purement informatif : la transaction a déjà été validée et ne peut plus être modifiée ni annulée.

@EventHandler
public void onPostEconomyUpdate(UserEconomyPostUpdateEvent event) {
    User user = event.getUser();
    Bukkit.getLogger().info("Balance updated for " + user.getName());
}

EconomyBaltopUpdateEventCopier le lien vers ce titre

Déclenché lorsque le classement des soldes (baltop) est recalculé et mis à jour.

Méthodes disponibles :

• getBaltop() -- renvoie l'objet Baltop contenant le classement mis à jour

@EventHandler
public void onBaltopUpdate(EconomyBaltopUpdateEvent event) {
    Baltop baltop = event.getBaltop();
    Bukkit.getLogger().info("Baltop rankings have been updated.");
}

DiscordLinkEventCopier le lien vers ce titre

Déclenché lorsqu'un joueur lie son compte Discord à son compte Minecraft.

Méthodes disponibles :

• getDiscordAccount() -- renvoie le DiscordAccount en cours de liaison

@EventHandler
public void onDiscordLink(DiscordLinkEvent event) {
    User user = event.getUser();
    DiscordAccount account = event.getDiscordAccount();

    Bukkit.getLogger().info(user.getName() + " linked Discord account: " + account.getUserId());

    // Cancel the link if needed
    // event.setCancelled(true);
}

DiscordUnlinkEventCopier le lien vers ce titre

Déclenché lorsqu'un joueur supprime la liaison entre son compte Discord et son compte Minecraft.

Méthodes disponibles :

• getDiscordAccount() -- renvoie le DiscordAccount dont la liaison est supprimée

@EventHandler
public void onDiscordUnlink(DiscordUnlinkEvent event) {
    User user = event.getUser();
    DiscordAccount account = event.getDiscordAccount();

    Bukkit.getLogger().info(user.getName() + " unlinked Discord account: " + account.getUserId());

    // Cancel the unlink if needed
    // event.setCancelled(true);
}

StepCreateEventCopier le lien vers ce titre

Déclenché lorsqu'une étape est créée pour un joueur. Les étapes sont des jalons de progression du système d'étapes de zEssentials.

Méthodes disponibles :

• getStep() -- renvoie le Step en cours de création

@EventHandler
public void onStepCreate(StepCreateEvent event) {
    User user = event.getUser();
    Step step = event.getStep();

    Bukkit.getLogger().info("Step created for " + user.getName() + ": " + step.getName());
}

StepFinishEventCopier le lien vers ce titre

Déclenché lorsqu'un joueur termine une étape.

Méthodes disponibles :

• getPlayerStep() -- renvoie le PlayerStep qui vient d'être terminé

@EventHandler
public void onStepFinish(StepFinishEvent event) {
    User user = event.getUser();
    PlayerStep playerStep = event.getPlayerStep();

    Bukkit.getLogger().info(user.getName() + " completed a step!");

    // Cancel to prevent the step from being marked as finished
    // event.setCancelled(true);
}

UserVoteEventCopier le lien vers ce titre

Déclenché lorsqu'un joueur vote pour le serveur.

Méthodes disponibles :

• getUniqueId() -- renvoie l'UUID du joueur qui a voté
• getSiteName() -- renvoie le nom du site de vote

@EventHandler
public void onVote(UserVoteEvent event) {
    UUID playerId = event.getUniqueId();
    String site = event.getSiteName();

    Bukkit.getLogger().info("Player " + playerId + " voted on " + site);

    // Cancel to prevent the vote from being recorded
    // event.setCancelled(true);
}

VotePartyEventCopier le lien vers ce titre

Déclenché au fil de la progression de la vote party. Cet événement est déclenché à chaque vote qui compte pour le seuil de la vote party, ce qui permet de suivre ou de modifier la progression.

Méthodes disponibles :

• getVotePartyAmount() / setVotePartyAmount() -- obtenir ou modifier la progression actuelle de la vote party

@EventHandler
public void onVotePartyProgress(VotePartyEvent event) {
    int currentAmount = event.getVotePartyAmount();

    // Double the vote party contribution
    event.setVotePartyAmount(currentAmount + 1);

    Bukkit.getLogger().info("Vote party progress: " + event.getVotePartyAmount());
}

VotePartyStartEventCopier le lien vers ce titre

Déclenché lorsque le seuil de la vote party est atteint et que la vote party est sur le point de commencer.

@EventHandler
public void onVotePartyStart(VotePartyStartEvent event) {
    Bukkit.getLogger().info("Vote party is starting!");

    // Cancel to prevent the vote party from starting
    // event.setCancelled(true);
}

Tableau récapitulatifCopier le lien vers ce titre