Events

📡 Game Events

ArenaLegends provides custom Bukkit events that you can listen to in your plugins. These allow you to react when specific actions occur within a match.

Check the Javadocs for reference.

👤 Player Events

Event Class	Description
PlayerJoinEvent	Triggered when a player joins a game.
PlayerQuitEvent	Triggered when a player leaves a game.
PlayerDeathEvent	Triggered when a player dies in-game.
PlayerKillEvent	Triggered when a player kills another entity.
PlayerKillAssistEvent	Triggered when a player assists in a kill.
PlayerWinEvent	Triggered when a player wins the game.
PlayerLoseEvent	Triggered when a player loses the game.
PlayerDamageEvent	Triggered when a player deals or takes damage.

🎮 Game State Events

Event Class	Description
GameStartEvent	Triggered when a game starts.
GameStartCancelEvent	Triggered if the start sequence is cancelled.
GameEndEvent	Triggered when a game ends.
GameUnloadEvent	Triggered when a game is unloaded from memory.
TeamEliminatedEvent	Triggered when an entire team is eliminated.

---

💡 Listening to Events

Here is how you can listen to an ArenaLegends Bukkit event in your plugin.

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import xericker.arenalegends.event.player.event.PlayerKillEvent;

public class MyGameListener implements Listener {

    @EventHandler
    public void onPlayerKill(PlayerKillEvent event) {
        String killer = event.getPlayer().getName();
        String victim = event.getVictim().getName();
        
        System.out.println(killer + " eliminated " + victim + " in ArenaLegends!");
    }
}

---

🧮 Augment Event Triggers

ArenaLegends augments rely on an internal GameEvent enum (xericker.arenalegends.core.game.contract.game.GameEvent) to trigger logic.

If you are developing a custom feature or integrating an external plugin, you can manually trigger an augment event. For example, if your custom plugin handles a unique death or kill mechanic, you can "catch" the logic and forward it to the augment system so that players' kill-related augments still activate.

Triggering an Augment Event

import xericker.arenalegends.core.game.contract.game.GameEvent;
import org.bukkit.entity.Player;

// Trigger the KILL event for augments, passing the relevant objects
// This will force the plugin to check if the player has any augments that trigger on KILL.
GameEvent.KILL.execute(player, eventData);