Class UltimateAdvancementAPI

Method Details

• getInstance

  @NotNull public static @NotNull UltimateAdvancementAPI getInstance(@NotNull @NotNull Plugin plugin) throws APINotInstantiatedException

  Returns a new instance of UltimateAdvancementAPI.

  Parameters:

  plugin - The plugin that is going to use the instance.

  Returns:

  A new instance of UltimateAdvancementAPI.

  Throws:

  APINotInstantiatedException - If the API is not enabled.

• createAdvancementTab

  @NotNull @Contract("_ -> new") public @NotNull AdvancementTab createAdvancementTab(@NotNull @NotNull String namespace) throws DuplicatedException

  Creates a new AdvancementTab with the provided namespace. The namespace must be unique.

  Parameters:

  namespace - The unique namespace of the tab.

  Returns:

  The new AdvancementTab.

  Throws:

  DuplicatedException - If another tab with the name already exists.

  IllegalStateException - If the API is not enabled.

• getAdvancementTab

  @Nullable public @Nullable AdvancementTab getAdvancementTab(@NotNull @NotNull String namespace)

  Gets an advancement tab by its namespace.

  Parameters:

  namespace - The namespace of the advancement tab.

  Returns:

  The advancement tab with the provided namespace, or null if there isn't any tab with such namespace.

  Throws:

  IllegalStateException - If the API is not enabled.

• isAdvancementTabRegistered

  public boolean isAdvancementTabRegistered(@NotNull @NotNull String namespace)

  Returns whether an advancement tab with the provided namespace has already been registered.

  Parameters:

  namespace - The namespace of the advancement tab.

  Returns:

  Whether an advancement tab with the provided namespace has already been registered.

  Throws:

  IllegalStateException - If the API is not enabled.

• getPluginAdvancementTabs

  @NotNull public @UnmodifiableView @NotNull Collection<@NotNull AdvancementTab> getPluginAdvancementTabs()

  Returns an unmodifiable Collection of the advancement tabs registered by the provided plugin.

  Returns:

  An unmodifiable Collection of the advancement tabs registered by the provided plugin.

  Throws:

  IllegalStateException - If the API is not enabled.

• unregisterAdvancementTab

  public void unregisterAdvancementTab(@NotNull @NotNull String namespace)

  Unregisters an advancement tab.

  Parameters:

  namespace - The namespace of the advancement tab to be unregistered.

  Throws:

  IllegalStateException - If the API is not enabled.

• unregisterPluginAdvancementTabs

  public void unregisterPluginAdvancementTabs()

  Unregisters all the advancement tabs owned by the provided plugin.

  Throws:

  IllegalStateException - If the API is not enabled.

• getAdvancementTabNamespaces

  @NotNull @Contract(pure=true) public @NotNull @UnmodifiableView Set<@NotNull String> getAdvancementTabNamespaces()

  Returns an unmodifiable Set containing the namespaces of every registered advancement tab.

  Returns:

  An unmodifiable Set containing the namespaces of every registered advancement tab.

  Throws:

  IllegalStateException - If the API is not enabled.

• filterNamespaces

  @NotNull @Contract(pure=true, value="_ -> new") public @NotNull List<@NotNull String> filterNamespaces(@Nullable @Nullable String input)

  Returns the namespaced keys of every registered advancement which namespaced key starts with the provided one.

  Parameters:

  input - The partial namespaced key that acts as a filter.

  Returns:

  A filtered List that contains only the matching namespaced keys of the registered advancements.

  Throws:

  IllegalStateException - If the API is not enabled.

• getTabs

  @NotNull public @NotNull @UnmodifiableView Collection<@NotNull AdvancementTab> getTabs()

  Returns an unmodifiable Collection of every registered advancement tab.

  Returns:

  An unmodifiable Collection of every registered advancement tab.

  Throws:

  IllegalStateException - If the API is not enabled.

• updatePlayer

  public void updatePlayer(@NotNull @NotNull Player player)

  Updates every advancement to a player.

  An advancement is updated only if its tab is shown to the player (see AdvancementTab.isShownTo(Player)).

  Parameters:

  player - The player to be updated.

  Throws:

  IllegalStateException - If the API is not enabled.

• getAdvancement

  @Nullable public @Nullable Advancement getAdvancement(@NotNull @NotNull String namespacedKey)

  Returns the advancement with the provided namespaced key.

  Parameters:

  namespacedKey - The namespaced key of the advancement. It must be in the format "namespace:key".

  Returns:

  The advancement with the provided namespaced key., or null if it doesn't exist.

  Throws:

  IllegalStateException - If the API is not enabled.

• getAdvancement

  @Nullable public @Nullable Advancement getAdvancement(@NotNull @NotNull String namespace, @NotNull @NotNull String key)

  Returns the advancement with the provided namespaced key.

  Parameters:

  namespace - The namespace of the advancement's tab.

  key - The key of the advancement.

  Returns:

  The advancement with the provided namespaced key, or null if it doesn't exist.

  Throws:

  IllegalStateException - If the API is not enabled.

• getAdvancement

  @Nullable public @Nullable Advancement getAdvancement(@NotNull @NotNull AdvancementKey namespacedKey)

  Returns the advancement with the provided namespaced key.

  Parameters:

  namespacedKey - The AdvancementKey of the advancement.

  Returns:

  The advancement with the provided namespaced key, or null if it doesn't exist.

  Throws:

  IllegalStateException - If the API is not enabled.

• displayCustomToast

  public void displayCustomToast(@NotNull @NotNull Player player, @NotNull @NotNull AdvancementDisplay display)

  Displays a custom toast notification to a player.

  Parameters:

  player - The player the toast notification will be shown to.

  display - The AdvancementDisplay that contains the graphic information to show.

• displayCustomToast

  public void displayCustomToast(@NotNull @NotNull Player player, @NotNull @NotNull ItemStack icon, @NotNull @NotNull String title, @NotNull @NotNull AdvancementFrameType frame)

  Displays a custom toast notification to a player.

  Parameters:

  player - The player the toast notification will be shown to.

  icon - The item of the toast notification.

  title - The title of the toast notification.

  frame - The shape of the toast notification frame.

• disableVanillaAdvancements

  public void disableVanillaAdvancements() throws RuntimeException

  Disables the vanilla advancements until next server restart or reload.

  Throws:

  RuntimeException - If the operation fails. It is a wrapper for the real exception.

• getTeamProgression

  @NotNull public @NotNull TeamProgression getTeamProgression(@NotNull @NotNull Player player) throws UserNotLoadedException

  Returns the TeamProgression of the team of the provided player.

  Parameters:

  player - The player.

  Returns:

  The TeamProgression of the player's team.

  Throws:

  UserNotLoadedException - If the player was not loaded into the caching system. For more information about the caching system see DatabaseManager.

• getTeamProgression

  @NotNull public @NotNull TeamProgression getTeamProgression(@NotNull @NotNull UUID uuid) throws UserNotLoadedException

  Returns the TeamProgression of the team of the provided player.

  Parameters:

  uuid - The UUID of the player.

  Returns:

  The TeamProgression of the player's team.

  Throws:

  UserNotLoadedException - If the player was not loaded into the caching system. For more information about the caching system see DatabaseManager.

• updatePlayerTeam

  public void updatePlayerTeam(@NotNull @NotNull Player playerToMove, @NotNull @NotNull Player aDestTeamPlayer)

  Moves the provided player from their team to the second player's one.

  Parameters:

  playerToMove - The player to move.

  aDestTeamPlayer - A player of the destination team.

• updatePlayerTeam

  public void updatePlayerTeam(@NotNull @NotNull Player playerToMove, @NotNull @NotNull Player aDestTeamPlayer, @Nullable @Nullable Consumer<Result> action)

  Moves the provided player from their team to the second player's one.

  Parameters:

  playerToMove - The player to move.

  aDestTeamPlayer - A player of the destination team.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

• updatePlayerTeam

  public void updatePlayerTeam(@NotNull @NotNull UUID playerToMove, @NotNull @NotNull UUID aDestTeamPlayer)

  Moves the provided player from their team to the second player's one.

  Parameters:

  playerToMove - The UUID of the player to move.

  aDestTeamPlayer - The UUID of a player of the destination team.

• updatePlayerTeam

  public void updatePlayerTeam(@NotNull @NotNull UUID playerToMove, @NotNull @NotNull UUID aDestTeamPlayer, @Nullable @Nullable Consumer<Result> action)

  Moves the provided player from their team to the second player's one.

  Parameters:

  playerToMove - The UUID of the player to move.

  aDestTeamPlayer - The UUID of a player of the destination team.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

• movePlayerInNewTeam

  public void movePlayerInNewTeam(@NotNull @NotNull Player playerToMove)

  Moves the provided player into a new team.

  Parameters:

  playerToMove - The player to be moved.

• movePlayerInNewTeam

  public void movePlayerInNewTeam(@NotNull @NotNull Player playerToMove, @Nullable @Nullable Consumer<ObjectResult<@NotNull TeamProgression>> action)

  Moves the provided player into a new team.

  Parameters:

  playerToMove - The player to be moved.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the TeamProgression of the player's new team (when the operation is successful). If no code should be called, it can be put to null.

• movePlayerInNewTeam

  public void movePlayerInNewTeam(@NotNull @NotNull UUID playerToMove)

  Moves the provided player into a new team.

  Parameters:

  playerToMove - The UUID of the player to be moved.

• movePlayerInNewTeam

  public void movePlayerInNewTeam(@NotNull @NotNull UUID playerToMove, @Nullable @Nullable Consumer<ObjectResult<@NotNull TeamProgression>> action)

  Moves the provided player into a new team.

  Parameters:

  playerToMove - The UUID of the player to be moved.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the TeamProgression of the player's new team (when the operation is successful). If no code should be called, it can be put to null.

• unregisterOfflinePlayer

  public void unregisterOfflinePlayer(@NotNull @NotNull OfflinePlayer player) throws IllegalStateException

  Unregisters the provided offline player, removing they from the database.

  They must be offline and not loaded into the caching system. For more information about the caching system see DatabaseManager.

  Parameters:

  player - The offline player to unregister.

  Throws:

  IllegalStateException - If the player is online or loaded into the caching system.

• unregisterOfflinePlayer

  public void unregisterOfflinePlayer(@NotNull @NotNull OfflinePlayer player, @Nullable @Nullable Consumer<Result> action) throws IllegalStateException

  Unregisters the provided offline player, removing they from the database.

  They must be offline and not loaded into the caching system. For more information about the caching system see DatabaseManager.

  Parameters:

  player - The offline player to unregister.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

  Throws:

  IllegalStateException - If the player is online or loaded into the caching system.

• unregisterOfflinePlayer

  public void unregisterOfflinePlayer(@NotNull @NotNull UUID uuid) throws IllegalStateException

  Unregisters the provided player, removing they from the database.

  They must be offline and not loaded into the caching system. For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player to unregister.

  Throws:

  IllegalStateException - If the player is online or loaded into the caching system.

• unregisterOfflinePlayer

  public void unregisterOfflinePlayer(@NotNull @NotNull UUID uuid, @Nullable @Nullable Consumer<Result> action) throws IllegalStateException

  Unregisters the provided player, removing they from the database.

  They must be offline and not loaded into the caching system. For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player to unregister.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

  Throws:

  IllegalStateException - If the player is online or loaded into the caching system.

• updatePlayerName

  public void updatePlayerName(@NotNull @NotNull Player player)

  Updates the name of the specified player in the database.

  Parameters:

  player - The player to update.

• updatePlayerName

  public void updatePlayerName(@NotNull @NotNull Player player, @Nullable @Nullable Consumer<Result> action)

  Updates the name of the specified player in the database.

  Parameters:

  player - The player to update.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

• isUnredeemed

  public void isUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player, @NotNull @NotNull Consumer<ObjectResult<@NotNull Boolean>> action)

  Gets whether the provided advancement is unredeemed for the specified player.

  Parameters:

  advancement - The advancement.

  player - The player.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the Boolean result.

• isUnredeemed

  public void isUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid, @NotNull @NotNull Consumer<ObjectResult<@NotNull Boolean>> action)

  Returns whether the provided advancement is unredeemed for the specified team.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the Boolean result.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Rewards will be given on redeem.

  Parameters:

  advancement - The advancement.

  player - The player.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player, @Nullable @Nullable Consumer<Result> action) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Rewards will be given on redeem.

  Parameters:

  advancement - The advancement.

  player - The player.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player, boolean giveRewards) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Parameters:

  advancement - The advancement.

  player - The player.

  giveRewards - Whether to give rewards on redeem.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player, boolean giveRewards, @Nullable @Nullable Consumer<Result> action) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Parameters:

  advancement - The advancement.

  player - The player.

  giveRewards - Whether to give rewards on redeem.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Rewards will be given on redeem.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid, @Nullable @Nullable Consumer<Result> action) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Rewards will be given on redeem.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid, boolean giveRewards) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

  giveRewards - Whether to give rewards on redeem.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• setUnredeemed

  public void setUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid, boolean giveRewards, @Nullable @Nullable Consumer<Result> action) throws NotGrantedException

  Sets the provided advancement unredeemed for the specified player.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

  giveRewards - Whether to give rewards on redeem.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

  Throws:

  NotGrantedException - If the advancement is not granted for the specified player.

• unsetUnredeemed

  public void unsetUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player)

  Redeems the specified advancement for the provided player.

  Parameters:

  advancement - The advancement.

  player - The player.

• unsetUnredeemed

  public void unsetUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull Player player, @Nullable @Nullable Consumer<Result> action)

  Redeems the specified advancement for the provided player.

  Parameters:

  advancement - The advancement.

  player - The player.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

• unsetUnredeemed

  public void unsetUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid)

  Redeems the specified advancement for the provided player.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

• unsetUnredeemed

  public void unsetUnredeemed(@NotNull @NotNull Advancement advancement, @NotNull @NotNull UUID uuid, @Nullable @Nullable Consumer<Result> action)

  Redeems the specified advancement for the provided player.

  Parameters:

  advancement - The advancement.

  uuid - The UUID of the player.

  action - A Consumer that is called synchronously after the operation with a Result. If no code should be called, it can be put to null.

• isLoaded

  public boolean isLoaded(@NotNull @NotNull Player player)

  Returns whether the provided player is loaded into the caching system.

  For more information about the caching system see DatabaseManager.

  Parameters:

  player - The player.

  Returns:

  Whether the provided player is loaded into the caching system.

• isLoaded

  public boolean isLoaded(@NotNull @NotNull OfflinePlayer player)

  Returns whether the provided offline player is loaded into the caching system.

  For more information about the caching system see DatabaseManager.

  Parameters:

  player - The offline player.

  Returns:

  Whether the provided player is loaded into the caching system.

• isLoaded

  public boolean isLoaded(@NotNull @NotNull UUID uuid)

  Returns whether the provided offline player is loaded into the caching system.

  For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player.

  Returns:

  Whether the provided player is loaded into the caching system.

• loadOfflinePlayer

  public void loadOfflinePlayer(@NotNull @NotNull OfflinePlayer player)

  Loads the provided offline player from the database into the caching system.

  The offline player will be loaded manually (see CacheFreeingOption.MANUAL(Plugin)), so unloadOfflinePlayer(OfflinePlayer) must be called to unload they.

  For more information about the caching system see DatabaseManager.

  Parameters:

  player - The offline player to load.

• loadOfflinePlayer

  public void loadOfflinePlayer(@NotNull @NotNull UUID uuid)

  Loads the provided player from the database into the caching system.

  The player will be loaded manually (see CacheFreeingOption.MANUAL(Plugin)), so unloadOfflinePlayer(UUID) must be called to unload they.

  For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player to load.

• loadOfflinePlayer

  public void loadOfflinePlayer(@NotNull @NotNull OfflinePlayer player, @Nullable @Nullable Consumer<ObjectResult<@Nullable TeamProgression>> action)

  Loads the provided offline player from the database without putting they into the caching system (see CacheFreeingOption.DONT_CACHE()).

  The loaded TeamProgression can be retrieved through the Consumer<ObjectResult>.

  For more information about the caching system see DatabaseManager.

  Parameters:

  player - The offline player to load.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the loaded TeamProgression.

• loadOfflinePlayer

  public void loadOfflinePlayer(@NotNull @NotNull UUID uuid, @Nullable @Nullable Consumer<ObjectResult<@Nullable TeamProgression>> action)

  Loads the provided player from the database without putting they into the caching system (see CacheFreeingOption.DONT_CACHE()).

  The loaded TeamProgression can be retrieved through the Consumer<ObjectResult>.

  For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player to load.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the loaded TeamProgression.

• loadOfflinePlayer

  public void loadOfflinePlayer(@NotNull @NotNull OfflinePlayer player, @NotNull @NotNull CacheFreeingOption option, @Nullable @Nullable Consumer<ObjectResult<@Nullable TeamProgression>> action)

  Loads the provided offline player from the database with the specified CacheFreeingOption.

  For more information about the CacheFreeingOption see DatabaseManager.loadOfflinePlayer(UUID, CacheFreeingOption).

  For more information about the caching system see DatabaseManager.

  Parameters:

  player - The offline player to load.

  option - The chosen CacheFreeingOption.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the loaded TeamProgression.

• loadOfflinePlayer

  public void loadOfflinePlayer(@NotNull @NotNull UUID uuid, @NotNull @NotNull CacheFreeingOption option, @Nullable @Nullable Consumer<ObjectResult<@Nullable TeamProgression>> action)

  Loads the provided player from the database with the specified CacheFreeingOption.

  For more information about the CacheFreeingOption see DatabaseManager.loadOfflinePlayer(UUID, CacheFreeingOption).

  For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player to load.

  option - The chosen CacheFreeingOption.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the loaded TeamProgression.

• isOfflinePlayerLoaded

  public boolean isOfflinePlayerLoaded(@NotNull @NotNull OfflinePlayer player)

  Returns whether at least one loading request is currently active for the specified offline player.

  Parameters:

  player - The offline player.

  Returns:

  Whether at least one loading request is currently active for the specified offline player.

• isOfflinePlayerLoaded

  @Contract(pure=true, value="null -> false") public boolean isOfflinePlayerLoaded(UUID uuid)

  Returns whether at least one loading request is currently active for the specified player.

  Parameters:

  uuid - The UUID of the player.

  Returns:

  Whether at least one loading request is currently active for the specified player.

• getLoadingRequestsAmount

  public int getLoadingRequestsAmount(@NotNull @NotNull Player player, @NotNull CacheFreeingOption.Option type)

  Returns the number of currently active loading requests for the specified player with the provided CacheFreeingOption.Option.

  Parameters:

  player - The player.

  type - The CacheFreeingOption.Option.

  Returns:

  The number of the currently active player loading requests.

  See Also:

  • DatabaseManager.getLoadingRequestsAmount(Plugin, UUID, Option)

• getLoadingRequestsAmount

  public int getLoadingRequestsAmount(@NotNull @NotNull OfflinePlayer offlinePlayer, @NotNull CacheFreeingOption.Option type)

  Returns the number of currently active loading requests for the specified offline player with the provided CacheFreeingOption.Option.

  Parameters:

  offlinePlayer - The offline player.

  type - The CacheFreeingOption.Option.

  Returns:

  The number of the currently active player loading requests.

  See Also:

  • DatabaseManager.getLoadingRequestsAmount(Plugin, UUID, Option)

• getLoadingRequestsAmount

  public int getLoadingRequestsAmount(@NotNull @NotNull UUID uuid, @NotNull CacheFreeingOption.Option type)

  Returns the number of currently active loading requests for the specified player with the provided CacheFreeingOption.Option.

  Parameters:

  uuid - The UUID of the player.

  type - The CacheFreeingOption.Option.

  Returns:

  The number of the currently active player loading requests.

  See Also:

  • DatabaseManager.getLoadingRequestsAmount(Plugin, UUID, Option)

• unloadOfflinePlayer

  public void unloadOfflinePlayer(@NotNull @NotNull OfflinePlayer player)

  Removes one manual caching request for the provided offline player. If the counter reaches zero, they will be unloaded from the caching system.

  Note that this method will only unload players loaded with CacheFreeingOption.MANUAL(Plugin).

  For more information about the caching system see DatabaseManager.

  Parameters:

  player - The player to unload.

• unloadOfflinePlayer

  public void unloadOfflinePlayer(@NotNull @NotNull UUID uuid)

  Removes one manual caching request for the provided player. If the counter reaches zero, they will be unloaded from the caching system.

  Note that this method will only unload players loaded with CacheFreeingOption.MANUAL(Plugin).

  For more information about the caching system see DatabaseManager.

  Parameters:

  uuid - The UUID of the player to unload.

• getStoredPlayerName

  public void getStoredPlayerName(@NotNull @NotNull OfflinePlayer player, @NotNull @NotNull Consumer<ObjectResult<@Nullable String>> action)

  Gets the in-database stored name of the provided player.

  Parameters:

  player - The player.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the in-database stored name of the player.

• getStoredPlayerName

  public void getStoredPlayerName(@NotNull @NotNull UUID uuid, @NotNull @NotNull Consumer<ObjectResult<@Nullable String>> action)

  Gets the in-database stored name of the provided player.

  Parameters:

  uuid - The UUID of the player.

  action - A Consumer that is called synchronously after the operation with an ObjectResult, which provides the in-database stored name of the player.