As with the rest of the API, Voxy is present at runtime, so do not shade these modules. Use compileOnly (Gradle) or <scope>provided</scope> (Maven).

Spigot / Paper

Voxy's Spigot events extend Bukkit's org.bukkit.event.Event. Listen to them with an ordinary Listener and @EventHandler, and register through Bukkit's plugin manager.

public final class MyPlugin extends JavaPlugin implements Listener {

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

    @EventHandler
    public void onPunish(PlayerPunishEvent event) {
        // Block any punishment aimed at a protected player
        if (event.getTarget().getName().equalsIgnoreCase("Notch")) {
            event.setCancelled(true);
        }
    }
}

The party events live in dev.iiahmed.voxy.api.event.party, the punishment events in dev.iiahmed.voxy.api.event.punishment, the rank events in dev.iiahmed.voxy.api.event.rank, and VanishEvent sits in dev.iiahmed.voxy.api.event.

When each event fires:

• PartyCreateEvent - a new party is being created.
• PartyDisbandEvent - an existing party is disbanded.
• PartyMemberJoinEvent - a member is about to join a party.
• PartyMemberLeaveEvent - after a member leaves a party.
• PartyRoleChangeEvent - a member's party role is changed.
• PlayerPunishEvent - before a punishment is applied to a player.
• PlayerPunishmentAppliedEvent - after a punishment has been applied.
• PlayerPunishmentRemovedEvent - a punishment is removed before it expires.
• PlayerRankChangeEvent - a player's primary rank is changed.
• RankCreateEvent - a new rank is about to be created.
• RankDeleteEvent - a rank is about to be deleted.
• RankUpdateEvent - a rank's data is modified.
• VanishEvent - a player's vanish state is toggled.

getUpdateType() returns a nested UpdateType enum: PERMISSION_ADDED, PERMISSION_REMOVED, INHERITANCE_ADDED, INHERITANCE_REMOVED, METADATA, PRIORITY, OTHER. Its getActor() may be null when the change was not driven by a player.

Only PartyMemberJoinEvent, PartyRoleChangeEvent, PlayerPunishEvent, and VanishEvent implement org.bukkit.event.Cancellable. They fire before their action is committed, so calling setCancelled(true) prevents it. The remaining events are notifications fired after the fact.

Velocity

Voxy's Velocity events are plain objects (they do not extend a base class). Handle them with a method annotated @Subscribe and register the listener through the proxy's EventManager.

@Plugin(id = "myplugin")
public final class MyPlugin {

    private final ProxyServer proxy;

    @Inject
    public MyPlugin(ProxyServer proxy) {
        this.proxy = proxy;
    }

    @Subscribe
    public void onInit(ProxyInitializeEvent event) {
        proxy.getEventManager().register(this, this);
    }

    @Subscribe
    public void onMessage(ProxyPrivateMessageEvent event) {
        // Rewrite or cancel the private message before it is delivered
        if (event.getMessage().contains("badword")) {
            event.setCancelled(true);
        }
    }

    @Subscribe
    public void onSwitch(ProxyServerSwitchEvent event) {
        long seconds = event.getSessionDuration() / 1000;
    }
}

Both events live in dev.iiahmed.voxy.proxy.velocity.api.event.

When each event fires:

• ProxyPrivateMessageEvent - a player sends a private message to another player through the proxy.
• ProxyServerSwitchEvent - a player switches from one backend server to another.

ProxyPrivateMessageEvent is not a Bukkit-style Cancellable; it simply carries a mutable cancelled flag. Call setCancelled(true) to stop the message, and use setMessage(String) to rewrite it. ProxyServerSwitchEvent is a read-only notification. getSessionDuration() is reported in milliseconds.

Bungee

Voxy's Bungee events extend BungeeCord's net.md_5.bungee.api.plugin.Event. Handle them with a Listener and @EventHandler (from net.md_5.bungee.event.EventHandler), and register the listener through the proxy's plugin manager.

public final class MyPlugin extends Plugin implements Listener {

    @Override
    public void onEnable() {
        getProxy().getPluginManager().registerListener(this, this);
    }

    @EventHandler
    public void onMessage(ProxyPrivateMessageEvent event) {
        // Rewrite or cancel the private message before it is delivered
        if (event.getMessage().contains("badword")) {
            event.setCancelled(true);
        }
    }
}

Both events live in dev.iiahmed.voxy.proxy.bungee.api.event.

When each event fires:

• ProxyPrivateMessageEvent - a player sends a private message to another player through the proxy.
• ProxyServerSwitchEvent - a player switches from one backend server to another.

ProxyPrivateMessageEvent implements net.md_5.bungee.api.plugin.Cancellable, so setCancelled(true) stops delivery and setMessage(String) rewrites the text. Unlike Velocity, Bungee reports the from/to server as a String name rather than a server object. ProxyServerSwitchEvent is a read-only notification and getSessionDuration() is in milliseconds.