Skip to main content

Using the BattleArena API

BattleArena offers an API for developers to use if they wish to interface with the plugin. 

The main entrypoint into BattleArena is the BattleArenaApi class, which can be accessed by running BattleArenaApi.get().

The more important methods are documented below, but the full javadoc can be found here.

  • isInArena(Player) - Returns whether the given Player is in an Arena
  • arena(String) / getArena(String) - Returns the Arena from the given name, or null if not found
  • getArenas() - Returns all the Arenas for the plugin
  • registerArena(Plugin, String, Class, Supplier) - Registers the given Arena
  • getCompetitions(Arena) - Returns all the existing Competitions for the Arena
  • getCompetitions(Arena, String) - Returns all the Competitions for the given Arena and map name
  • findJoinableCompetition(List<Competition>, Player, PlayerRole) - Finds a joinable competition for the given player with a player role
Back to top