Package dev.drawethree.xprison.api.history

Interface XPrisonHistoryAPI

public interface XPrisonHistoryAPI
API for interacting with player history within the XPrison plugin. Provides methods for retrieving and creating HistoryLine entries related to specific XPrisonModules and players.

  • Method Details

    • getPlayerHistory

      Collection<HistoryLine> getPlayerHistory(org.bukkit.OfflinePlayer player)
      Retrieves all history lines associated with the given player across all modules.
      Parameters:
      player - the OfflinePlayer whose history is being requested
      Returns:
      a Collection of HistoryLine representing the player's full history

    • getPlayerHistory

      Collection<HistoryLine> getPlayerHistory(org.bukkit.OfflinePlayer player, XPrisonModule module)
      Retrieves the history lines associated with the given player and a specific module.
      Parameters:
      player - the OfflinePlayer whose history is being requested
      module - the XPrisonModule to filter history lines by
      Returns:
      a Collection of HistoryLine filtered by the specified module

    • createHistoryLine

      HistoryLine createHistoryLine(org.bukkit.OfflinePlayer player, XPrisonModule module, String context)
      Creates a new history line entry for the specified player, associated with the provided module and context.
      Parameters:
      player - the OfflinePlayer for whom the history line is created
      module - the XPrisonModule that the history line is associated with
      context - a String describing the context or reason for the history entry
      Returns:
      the created HistoryLine