⚙️API

Tower Defense X API Documentation

Welcome to the Tower Defense X API documentation! This page will provide you with all the necessary information to use the Tower Defense X API effectively.

Tower Defense X is a Minecraft game mode where players build towers to defend against waves of enemies. The Tower Defense X API provides a way for developers to interact with the game mode and create custom plugins and addons.

To use the API, you will need to import the me.wazup.addon package and extend the JavaPlugin class. The following code demonstrates how to use the API:

package me.wazup.addon;

import java.sql.SQLException;
import java.util.HashMap;
import java.util.List;
import java.util.Map.Entry;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;
import me.wazup.towerdefense.Enums.Stat;
import me.wazup.towerdefense.PlayerData;
import me.wazup.towerdefense.TowerDefense;
import me.wazup.towerdefense.TowerDefenseAPI;

public class Addon extends JavaPlugin {

  public void example(){
  TowerDefenseAPI api = TowerDefense.api;

  //Get a player playerdata
  Player p = Bukkit.getPlayer("Wazup92");
  PlayerData data = api.getPlayerData(p);

  //Modifying some of their stats
  data.addCoins(p, 50);
  data.kills += 10;

  //Some booleans
  api.isInArena(p);
  api.isSpectating(p);
  api.isPlaying(p);

  //Getting top players
  //First you have to load all players data, this should be Async
  try {
  HashMap<String, String> playersData = api.getAllPlayersData();
  //You can now get top players out of the playersData, ordered by a specfic stat
  //If the third argument (int) is bigger than the amount of entries in the playersData hashmap, it will be filled with 'NO_PLAYER'
  List<Entry<String, Integer>> top = api.getTopPlayers(playersData, Stat.KILLS, 10);
  //Top now contains the top 10 players, ordered by their kills stat
  //Entry key is the player name, and the entry value is their score
  for(int i = 0; i < top.size(); i++){
  Bukkit.broadcastMessage("# " + (i+1) + " is " + top.get(i).getKey() + " with a score of " + top.get(i).getValue());
  }
  } catch (SQLException e){
  e.printStackTrace();
  }
  //If you want to modify offline players stats, then you have to use a different method, because you can't use the PlayerData class on offline players
  //The following method returns true if the stat was updated, and it returns false if the player name wasn't found or the stat wasn't updated for some reason
  //The boolean at the end 'increment' is whether you want to SET their stat to the give value, or you want to add it up
  try {
  boolean updated = api.modifyOfflinePlayerStat("Wazup92", Stat.COINS, 50, true);
  } catch (SQLException e){
  e.printStackTrace();
  }

  }

}

PlayerData

The PlayerData class contains information about a player's stats and progress in the game mode. You can retrieve a player's PlayerData object using the getPlayerData(Player player) method of the TowerDefenseAPI.

Once you have a PlayerData object, you can modify the player's stats using various methods such as addCoins(Player player, int amount) or addKills(int amount). All the methods can be found in your editor.