Interface ScoreboardAPI<P>


public interface ScoreboardAPI<P>
API for managing game scoreboards. Supports module-specific scoreboards with automatic placeholder resolution.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Clear any pending final-scoreboard override for the player.
    void
    remove(P player)
    Remove scoreboard from player.
    void
    setLines(P player, List<String> lines)
    Set custom scoreboard lines directly.
    void
    setTitle(P player, String title)
    Set custom scoreboard title.
    void
    showModuleFinalScoreboard(P player, String scoreboardPath)
    Show a module-defined final scoreboard to the player using the provided path.
    void
    showModuleFinalScoreboard(P player, String scoreboardPath, Map<String,String> placeholders)
    Show a module-defined final scoreboard with custom placeholders.
    void
    Show module-specific scoreboard to player.
    void
    showScoreboard(P player, String scoreboardPath)
    Show custom scoreboard to player using specified path.
    void
    update(P player)
    Update scoreboard for player using module's scoreboard configuration.
    void
    update(P player, String scoreboardPath)
    Update scoreboard for player using custom scoreboard path.
    void
    update(P player, String scoreboardPath, Map<String,String> placeholders)
    Update scoreboard with custom path and placeholders.
    void
    update(P player, Map<String,String> placeholders)
    Update scoreboard with custom placeholders.
  • Method Details

    • update

      void update(P player)
      Update scoreboard for player using module's scoreboard configuration. Automatically resolves placeholders from: - Core placeholders ({arena}, {round}, {time}, etc.) - Module custom placeholders
      Parameters:
      player - Player to update
    • update

      void update(P player, Map<String,String> placeholders)
      Update scoreboard with custom placeholders.
      Parameters:
      player - Player
      placeholders - Additional placeholders to add/override
    • update

      void update(P player, String scoreboardPath)
      Update scoreboard for player using custom scoreboard path.
      Parameters:
      player - Player to update
      scoreboardPath - Path to scoreboard config (e.g., "scoreboard", "scoreboards.team_red")
    • update

      void update(P player, String scoreboardPath, Map<String,String> placeholders)
      Update scoreboard with custom path and placeholders.
    • showScoreboard

      void showScoreboard(P player, String scoreboardPath)
      Show custom scoreboard to player using specified path.
    • setTitle

      void setTitle(P player, String title)
      Set custom scoreboard title.
      Parameters:
      player - Player
      title - Formatted title
    • setLines

      void setLines(P player, List<String> lines)
      Set custom scoreboard lines directly.
      Parameters:
      player - Player
      lines - List of formatted lines
    • remove

      void remove(P player)
      Remove scoreboard from player.
      Parameters:
      player - Player
    • showModuleScoreboard

      void showModuleScoreboard(P player)
      Show module-specific scoreboard to player. Loads title and lines from module's language file.
      Parameters:
      player - Player
    • showModuleFinalScoreboard

      void showModuleFinalScoreboard(P player, String scoreboardPath)
      Show a module-defined final scoreboard to the player using the provided path. Intended for end-of-game views (e.g., team outcomes) that should override the default finish scoreboard.
      Parameters:
      player - Player
      scoreboardPath - Path in the module language file (e.g., "scoreboard.final.team_win")
    • showModuleFinalScoreboard

      void showModuleFinalScoreboard(P player, String scoreboardPath, Map<String,String> placeholders)
      Show a module-defined final scoreboard with custom placeholders.
      Parameters:
      player - Player
      scoreboardPath - Path in the module language file
      placeholders - Additional placeholders to add/override
    • clearFinalScoreboard

      void clearFinalScoreboard(P player)
      Clear any pending final-scoreboard override for the player.
      Parameters:
      player - Player