AlonsoLeaderboardsAPI - AlonsoAliaga/AlonsoLeaderboards GitHub Wiki

AlonsoLeaguesAPI

AlonsoLeaguesAPI can be used to make some checks and modify player data easily.

com.alonsoaliaga.alonsoleaderboards.api.AlonsoLeaderboardsAPI

Available methods

List<String> getRegisteredIdentifiers()

  • Returns registered leaderboards identifiers

boolean isIdentifierRegistered(@NotNull String leaderboardIdentifier)

  • Returns whether or not a leaderboard identifier is registered

boolean hasRanking(@Nonnull String leaderboardIdentifier, int ranking)

  • Returns if leaderboard with specified leaderboard identifier has an entry registered with that ranking.

Map.Entry<String,Object> getRanking(@Nonnull String leaderboardIdentifier, int ranking)

  • Returns entry from leaderboard mapped by playername as key and score as value. Returns null if not found or invalid identifier.

Map.Entry<Integer,Map.Entry<String,Object>> getRanking(@Nonnull String leaderboardIdentifier,@Nonnull String playername)

  • Returns entry mapped by ranking and map entry as value (playername, score). Returns null if not found or invalid identifier.

Available events

LeaderboardExpansionRegisterEvent

  • When leaderboard expansion is registered.

LeaderboardExpansionUnregisterEvent

  • When leaderboard expansion is unregistered. (Potentially fired several times when reloading/stopping the server)

LeaderboardSignCreatedEvent

  • When leaderboard sign is created.

LeaderboardSignInteractEvent

  • When player interacts with leaderboard sign.
⚠️ **GitHub.com Fallback** ⚠️