API

Developer API

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

Table of contents

• API Events
• Stats storage

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 a game instance.

Example:

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

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

event#getTargetGameInstance() - returns existing game instance where player is attempting to join

---

VillageGameStartEvent

Event is called when game instance starts.

Example:

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

event#getGameInstance() - returns event game instance

---

VillageGameLeaveAttemptEvent

Event is called when player is trying to leave a game instance.

Example:

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

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

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

Stats storage

This part of wiki will be finished later!