Events

How to create event listeners.

Creating event listeners

Event listeners can be created using the event.addListener function. This function returns the listener, which can later be used to remove the listener if desired.

Syntax: event.addListener(eventName, handler)

For example, setting a custom join and leave message:

event.addListener("PlayerJoinEvent", event => {
    event.setJoinMessage(color(`&8[&a+&8] &7${event.getPlayer().getName()}`));
});

event.addListener("PlayerQuitEvent", event => {
    event.setQuitMessage(color(`&8[&c-&8] &7${event.getPlayer().getName()}`));
});

Removing event listeners

If an event listener is stored, it may be later removed using the event.removeListener function.

Syntax: event.removeListener(eventName, handler)

For example, if you wanted to make a chat reaction system, this would be a simple way to do it:

server.broadcastMessage(color("&8[&3Reaction&8] &7First in chat to type &3Drupi &7is cool!"));

function isCool(player){
    server.broadcastMessage(color(`&8[&3Reaction&8] &3${player.getName()} &7is cool!`));
    event.removeListener("AsyncPlayerChatEvent", listener);
}

const listener = event.addListener("AsyncPlayerChatEvent", event => {
    if(event.getMessage() === "Drupi"){
        event.setCancelled(true);
        isCool(event.getPlayer());
    }
});

Important Note: the call to event.removeListener cannot directly exist inside of your event.addListener callback, it will NOT work!

Supported events

All events in Spigot are supported, and can be listened to in this way. Here is a complete list of all events in Spigot 1.16.1. For other versions, please refer to the Spigot javadocs or similar.

PreviousCommands

Last updated

Was this helpful?