Skip to main content

Developer API


Get the API and some examples

Full js documentation: https://jd.plugily.xyz/apidocs/minecraft/thebridge

caution

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

Maven repository

Maven repository usually contains latest releases, if not, please check in few days if release is there.

How to access repo:

  1. Add repository
        <repositories>
<repository>
<id>plugilyprojects</id>
<url>https://maven.plugily.xyz</url>
</repository>
</repositories>

2. Add the dependency

        <dependencies>
<dependency>
<groupId>plugily.projects</groupId>
<artifactId>thebridge</artifactId>
<version>{version}</version>
<scope>provided</scope>
</dependency>
</dependencies>

Events

TBGameJoinAttemptEvent (Cancellable)

The event is called when a player is trying to join an arena.

Example:

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

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

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

event#isCancelled() - returns true if event is cancelled

warning

A message from language file is sent to the player when the attempt is cancelled (see In-Game.Join-Cancelled-Via-API in language.yml)

TBGameStartEvent

The event is called when the arena starts.

Example:

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

event#getArena() - returns event arena

TBGameLeaveAttemptEvent

The event is called when a player is trying to leave an arena.

Example:

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

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

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

TBGameStopEvent

The event is called when a game is stopped.

Example:

    @EventHandler
public void onGameStop(TBGameStopEvent event){
for(Player p : e.getArena().getPlayers()){
p.sendMessage("You've lost the game! Maybe play again?");
}
}

event#getArena() - returns existing arena that is stopped

TBPlayerChooseKitEvent (Cancellable)

The event is called when the player chose kit in game.

Example:

    @EventHandler
public void onKitChoose(TBPlayerChooseKitEvent event){
Kit kit = event.getKit();
if(kit.getName().contains("knight")){
event.getPlayer().sendMessage("Knight kits aren't for you mate! Use archer kit instead!");
event.setCancelled(true);
}
}

event#getArena() - returns arena player is playing (player is always in arena when this event is called)

event#getPlayer() - returns event player

event#getKit() - returns selected kit

event#isCancelled() - returns true if event is cancelled

caution

Cancelling the event doesn't really influence the in-game kit chooser, #isCancelled()should be used for external add-ons!

****

TBPlayerChooseBaseEvent (Cancellable)

The event is called when the player chose base in game.

Example:

    @EventHandler
public void onKitChoose(TBPlayerChooseBaseEvent event){
Base base = event.getBase();
if(base.getSize == 2){
event.getPlayer().sendMessage("Haha no one can join this base");
event.setCancelled(true);
}
}

event#getArena() - returns arena player is playing (player is always in arena when this event is called)

event#getPlayer() - returns event player

event#getBase() - returns selected base

event#isCancelled() - returns true if event is cancelled

caution

Cancelling the event doesn't really influence the in-game base chooser, #isCancelled()should be used for external add-ons!

TBGameStateChangeEvent

The event is called when arena game state changes.

Example:

    @EventHandler
public void onGameStateChange(TBGameStateChangeEvent event){
String state = event.getArenaState().getFormattedName();
for(Player p : event.getArena().getPlayers()){
p.sendMessage("Arena state changed to " + state);
}
}

event#getArena() - returns event arena

event#getArenaState() - returns current arena state

TBPlayerStatisticChangeEvent

The event is called when the player receives a new statistic.

Example:

    @EventHandler
public void onStatChange(TBPlayerStatisticChangeEvent event){
StatisticType stat = event.getStatisticType();
int statNumber = event.getNumber();
event.getPlayer().sendMessage("Your statistic " + stat.getName() + " has changed to " + statNumber);
}

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

event#getArena() - returns arena player is playing (player is always in arena when this event is called)

event#getStatisticType() - returns statistic of StatsStorage.StatisticType enum

event#getNumber() - returns current value of statistic

Stats storage

Retrieving online players stats

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

Example:

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

Very easy, right?

Requesting sorted statistics of all players

To access sorted statistics Map with players you must call it from StatsStorage class.

Example:

    public void printBestStats(StatsStorage.StatisticType statistic){
Map<UUID, Integer> statsMap = StatsStorage.getStats(statistic);
UUID[] uuidsArray = (UUID[]) StatsStorage.getStats(statistic).keySet().toArray();
for(int i = 0; i < 10; i++){
Bukkit.broadcastMessage("#" + i + " UUID: " + uuidsArray[i] + ", stats: " + statsMap.get(uuidsArray[i]));
}
}
caution

Be aware of IndexOutOfBoundsException as the list might be not enough big!

Available statistic types

caution

Orbs statistic is temporary and shouldn't be used for out game usages!

Statistic name (enum)Statistic identifier (string) (for advanced things)Description
KILLSkillsTotal kills amount
DEATHSdeathsTotal deaths amount
GAMES_PLAYEDgamesplayedTotal games played
LEVELlevelThe current level a player got
XPxpThe current xp a player got
WINSwinsGet all wins a player got
LOSESlosesGet all loses a player got
SCORED_POINTSpointsGet all scored points a player got
LOCAL_KILLS (non-persistent)local_killsGet kills a player got on a round
LOCAL_DEATHS (non-persistent)local_deathsGet deaths a player got on a round
LOCAL__SCORED__POINTS (non-persistent)local_scored_pointsGet scored points a player got on a round

Kit registry

Registering new kit is quite simple. We need to implement all methods from abstract Kit class and edit it by yourself. After that just register it via KitRegistry.

Example:

        //This kit will be premium
Kit supporter = new PremiumKit() {
//We need to implement methods from abstract Kit class

//Permissions needed to unlock it, if it is free just return true
@Override
public boolean isUnlockedByPlayer(Player p) {
return p.hasPermission("my.super.kit");
}

//Items given on game start
@Override
public void giveKitItems(Player player) {
player.getInventory().addItem(new ItemStack(Material.IRON_AXE, 1));
player.getInventory().addItem(new ItemStack(Material.GOLDEN_APPLE, 5));
}

//Material represented by this kit in the kit menu. Must be unique!
@Override
public Material getMaterial() {
return Material.GOLDEN_APPLE;
}

//Items given every respawn if needed
@Override
public void reStock(Player player) {
player.getInventory().addItem(new ItemStack(Material.GOLDEN_APPLE, 1));
}
};
//Now just set kit name and description and register it via KitRegistry
supporter.setName("Supporter");
supporter.setDescription(new String[]{ChatColor.GREEN + "My super description"});
KitRegistry.registerKit(supporter);

Manipulating player join/leave attempts

Join attempt

To force player to join specified arena you can use our ArenaManager class.

  public void sendPlayerToArena(String arena, Player player){
ArenaManager.joinAttempt(player, ArenaRegistry.getArena(arena));
}

// or

public void sendPlayerToArena(Arena arena, Player player){
ArenaManager.joinAttempt(player, arena);
}
warning

You should check is arena name exist otherwise it will throw NullPointerException

After that you can check for #isCancelled() if join attempt was cancelled or not.

Leave attempt

You can also use ArenaManager class to force player to quit arena.

  public void forcePlayerQuit(Player player){
Arena arena = ArenaRegistry.getArena(player);

ArenaManager.leaveAttempt(player, arena);
}
warning

You should check is arena isn't null otherwise it will throw NullPointerException