API

Developer API

Full java documentation: https://plajer.github.io/Village_Defense/

Table of contents

• API Events
• Stats storage
• Kit registry

Contents may be not up to date! Please use java docs instead. Here you can only get some simple examples.

Events

• VillageGameJoinAttemptEvent
• VillageGameLeaveAttemptEvent
• VillageGameStartEvent
• VillageGameStopEvent
• VillagePlayerChooseKitEvent
• VillageWaveEndEvent
• VillageWaveStartEvent

---

VillageGameJoinAttemptEvent (Cancellable)

Event is called when player is trying to join an arena.

Example:

    @EventHandler
    public void onGameJoin(VillageGameJoinAttemptEvent e){
        e.getPlayer().sendMessage("You have joined " + e.getTargetArena().getID());
        e.setCancelled(true);
        e.getPlayer().sendMessage("Or maybe not? :D");
    }

event#getPlayer() - returns player involved in this event

event#getTargetArena() - returns existing arena where player is attempting to join

---

VillageGameStartEvent

Event is called when arena starts.

Example:

    @EventHandler
    public void onGameStart(VillageGameStartEvent e){
        for(Player p : e.getArena().getPlayers()){
            p.sendMessage("Game has started!");
        }
    }

event#getArena() - returns event game instance

---

VillageGameLeaveAttemptEvent

Event is called when player is trying to leave an arena.

Example:

    @EventHandler
    public void onGameQuit(VillageGameLeaveAttemptEvent e){
        e.getPlayer().sendMessage("You have quitted" + e.getArena().getID());
    }

event#getPlayer() - returns player involved in this event

event#getArena() - returns existing game instance what player is attempting to leave

Stats storage

Table of contents

• Retrieving online players stats
• Retrieving offline players stats (soon)
• Statistic types

Retrieving online players stats

You can easily get online players stats using VD3 API - Stats Storage class.

Example:

    public int getZombieKills(Player p){
        return StatsStorage.getUserStats(p, StatsStorage.StatisticType.KILLS);
    }

Very easy, right?

Available statistic types

Statistic name (enum)	Statistic identifier (string) (for advanced things)	Type
KILLS	kills	int
DEATHS	deaths	int
GAMES_PLAYED	gamesplayed	int
HIGHEST_WAVE	highestwave	int
LEVEL	level	int
XP	xp	int