Package eu.bedwarsia.bedsumo.api

Interface BedSumoAPI

All Known Implementing Classes:
BedSumoAPIProvider
public interface BedSumoAPI
The public interface to access BedSumo runtime information and features.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getActiveBedCount()
    Returns active placed bed blocks currently awaiting timeouts.
    List<org.bukkit.Location>
    getArenaSpawnpoints()
    Retrieves immutable snapshot of preconfigured arena fallback spawnpoints.
    List<String>
    getAvailableLanguages()
    Returns a list of all loaded language identifiers available on this server.
    UUID
    getBedOwner(org.bukkit.Location location)
    Retrieves the UUID of the player who placed this bed, if actively tracked.
    int
    getCurrentKillstreak(org.bukkit.entity.Player player)
    Returns the current live in-memory session killstreak of a player.
    static BedSumoAPI
    getInstance()
    Static instance accessor pattern commonly used in Spigot plugins.
    LivePlayerStats
    getLiveStats(UUID playerUuid)
    Returns internal BedSumo live Stats object cached in server memory.
    String
    getPlayerLanguage(UUID playerUuid)
    Get the current language code assigned to a player (e.g.
    PlayerStats
    getPlayerStats(UUID playerUuid)
    Blocks to fetch recent player stats from current database state.
    CompletableFuture<PlayerStats>
    getPlayerStatsAsync(UUID playerUuid)
    Fetch player stats in a separate thread.
    List<PlayerStats>
    getTopDeaths(int limit)
    Retrieves the current leaderboard configuration for Top Deaths.
    List<PlayerStats>
    getTopKills(int limit)
    Retrieves the current leaderboard configuration for Top Kills.
    boolean
    isBuildMode(org.bukkit.entity.Player player)
    Checks if a user currently has administrative build mode enabled.
    void
    reloadConfiguration()
    Triggers system-wide configuration reloading.
    void
    setBuildMode(org.bukkit.entity.Player player, boolean state)
    Explicitly enable/disable administrative building mode for a player.
    void
    setPlayerLanguage(UUID playerUuid, String languageCode)
    Sets the persistent language code for a player.
    void
    setScoreboardVisible(org.bukkit.entity.Player player, boolean visible)
    Toggles dynamic rendering of the BedSumo objective sidebar for a user.
    String
    translate(org.bukkit.entity.Player player, String messageKey, Object... placeholders)
    Translates a message key into the target player's chosen language format with correct color codes and placeholder insertion.

  • Method Details

    • getInstance

      static BedSumoAPI getInstance()
      Static instance accessor pattern commonly used in Spigot plugins.

    • getPlayerLanguage

      String getPlayerLanguage(UUID playerUuid)
      Get the current language code assigned to a player (e.g. "en", "fr"). Defaults to "en".

    • setPlayerLanguage

      void setPlayerLanguage(UUID playerUuid, String languageCode)
      Sets the persistent language code for a player.

    • getAvailableLanguages

      List<String> getAvailableLanguages()
      Returns a list of all loaded language identifiers available on this server.

    • translate

      String translate(org.bukkit.entity.Player player, String messageKey, Object... placeholders)
      Translates a message key into the target player's chosen language format with correct color codes and placeholder insertion.

    • getPlayerStats

      PlayerStats getPlayerStats(UUID playerUuid)
      Blocks to fetch recent player stats from current database state.

    • getPlayerStatsAsync

      CompletableFuture<PlayerStats> getPlayerStatsAsync(UUID playerUuid)
      Fetch player stats in a separate thread.

    • getTopKills

      List<PlayerStats> getTopKills(int limit)
      Retrieves the current leaderboard configuration for Top Kills.

    • getTopDeaths

      List<PlayerStats> getTopDeaths(int limit)
      Retrieves the current leaderboard configuration for Top Deaths.

    • getCurrentKillstreak

      int getCurrentKillstreak(org.bukkit.entity.Player player)
      Returns the current live in-memory session killstreak of a player.

    • getLiveStats

      LivePlayerStats getLiveStats(UUID playerUuid)
      Returns internal BedSumo live Stats object cached in server memory. (Will update constantly as user moves/kills during matches).

    • isBuildMode

      boolean isBuildMode(org.bukkit.entity.Player player)
      Checks if a user currently has administrative build mode enabled.

    • setBuildMode

      void setBuildMode(org.bukkit.entity.Player player, boolean state)
      Explicitly enable/disable administrative building mode for a player.

    • reloadConfiguration

      void reloadConfiguration()
      Triggers system-wide configuration reloading.

    • getArenaSpawnpoints

      List<org.bukkit.Location> getArenaSpawnpoints()
      Retrieves immutable snapshot of preconfigured arena fallback spawnpoints.

    • getBedOwner

      UUID getBedOwner(org.bukkit.Location location)
      Retrieves the UUID of the player who placed this bed, if actively tracked.

    • getActiveBedCount

      int getActiveBedCount()
      Returns active placed bed blocks currently awaiting timeouts.

    • setScoreboardVisible

      void setScoreboardVisible(org.bukkit.entity.Player player, boolean visible)
      Toggles dynamic rendering of the BedSumo objective sidebar for a user.