Class AdvancementTab

Method Details

• isActive

  public boolean isActive()

  Returns whether the tab is initialised and not disposed.

  Returns:

  Whether the tab is initialised and not disposed.

• getRootAdvancement

  @NotNull @Contract(pure=true) public @NotNull RootAdvancement getRootAdvancement()

  Returns the root advancement of this tab.

  Returns:

  The root advancement of this tab.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getAdvancements

  @NotNull @Contract(pure=true) public @UnmodifiableView @NotNull Collection<@NotNull Advancement> getAdvancements()

  Gets an unmodifiable Collection of all the tab's advancements.

  Returns:

  An unmodifiable Collection of all the tab's advancements.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getAdvancementsWithoutRoot

  @NotNull public @Unmodifiable @NotNull Collection<@NotNull BaseAdvancement> getAdvancementsWithoutRoot()

  Gets an unmodifiable Collection of all the tab's advancements but the root.

  Returns:

  An unmodifiable Collection of all the tab's advancements but the root.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getAdvancementsByClass

  @NotNull @Contract(pure=true) public @Unmodifiable @NotNull Collection<@NotNull Advancement> getAdvancementsByClass(Class<? extends Advancement> filterClass)

  Gets an unmodifiable Collection of all the tab's advancements that are an instance of the provided class or any of its subclasses.

  If the provided class is null, then an empty Collection is returned.

  Parameters:

  filterClass - The filter class.

  Returns:

  An unmodifiable Collection of all the tab's advancements that are an instance of the provided class or any of its subclasses.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getAdvancementsNamespacedKeys

  @NotNull @Contract(pure=true) public @UnmodifiableView @NotNull Set<@NotNull AdvancementKey> getAdvancementsNamespacedKeys()

  Gets an unmodifiable Set of the AdvancementKeys of all the tab's advancements.

  Returns:

  An unmodifiable Set of the AdvancementKeys of all the tab's advancements.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• hasAdvancement

  @Contract(pure=true, value="null -> false") public boolean hasAdvancement(Advancement advancement)

  Returns whether the provided advancement belongs to the tab.

  Parameters:

  advancement - The advancement.

  Returns:

  Whether the provided advancement belongs to the tab.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• hasAdvancement

  @Contract(pure=true, value="null -> false") public boolean hasAdvancement(AdvancementKey namespacedKey)

  Returns whether an advancement with the provided AdvancementKey belongs to the tab.

  Parameters:

  namespacedKey - The AdvancementKey of the advancement.

  Returns:

  Whether an advancement with the provided AdvancementKey belongs to the tab.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getAdvancement

  @Nullable @Contract(pure=true, value="null -> null") public @Nullable Advancement getAdvancement(AdvancementKey namespacedKey)

  Gets the advancement of the tab with the provided AdvancementKey.

  Parameters:

  namespacedKey - The AdvancementKey of the wanted advancement of this tab.

  Returns:

  The advancement of the tab with the provided AdvancementKey, or null if there's not.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getPlayers

  @NotNull @Contract(pure=true) public @UnmodifiableView @NotNull Set<@NotNull Player> getPlayers()

  Returns an unmodifiable Set of the players the tab is currently shown to.

  Returns:

  An unmodifiable Set of the players the tab is currently shown to.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• grantRootAdvancement

  public void grantRootAdvancement(@NotNull @NotNull Player player)

  Grants the root advancement of the tab to the specified player giving rewards.

  Parameters:

  player - The player who is completing the root advancement.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• grantRootAdvancement

  public void grantRootAdvancement(@NotNull @NotNull UUID uuid)

  Grants the root advancement of the tab to the specified player giving rewards.

  Parameters:

  uuid - The UUID of the player who is completing the root advancement.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• grantRootAdvancement

  public void grantRootAdvancement(@NotNull @NotNull Player player, boolean giveRewards)

  Grants the root advancement of the tab to the specified player.

  Parameters:

  player - The player who is completing the root advancement.

  giveRewards - Whether to give rewards.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• grantRootAdvancement

  public void grantRootAdvancement(@NotNull @NotNull UUID uuid, boolean giveRewards)

  Grants the root advancement of the tab to the specified player.

  Parameters:

  uuid - The UUID of the player who is completing the root advancement.

  giveRewards - Whether to give rewards.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• updateAdvancementsToTeam

  public void updateAdvancementsToTeam(@NotNull @NotNull Player player) throws UserNotLoadedException

  Sends or updates the advancements of the tab to the provided player's team members.

  Parameters:

  player - The player.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

  UserNotLoadedException - If the provided player's team is not loaded.

• updateAdvancementsToTeam

  public void updateAdvancementsToTeam(@NotNull @NotNull UUID uuid) throws UserNotLoadedException

  Sends or updates the advancements of the tab to the provided player's team members.

  Parameters:

  uuid - A UUID of the player.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

  UserNotLoadedException - If the provided player's team is not loaded.

• updateAdvancementsToTeam

  public void updateAdvancementsToTeam(@NotNull @NotNull TeamProgression pro)

  Sends or updates the advancements of the tab to the provided team's members.

  Parameters:

  pro - The TeamProgression of the team.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• updateEveryAdvancement

  @Deprecated(since="2.2.0") public void updateEveryAdvancement(@NotNull @NotNull Player player) throws UserNotLoadedException

  Deprecated.

  Use updateAdvancementsToTeam(Player) instead.

  Sends or updates the advancements of the tab to the provided player.

  Parameters:

  player - The player.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

  UserNotLoadedException - If the provided player's team is not loaded.

• registerAdvancements

  public void registerAdvancements(@NotNull @NotNull RootAdvancement rootAdvancement, @NotNull @NotNull BaseAdvancement... advancements)

  Register the advancements for this tab, initializing the tab. Thus, it cannot be called twice.

  Parameters:

  rootAdvancement - The root of this tab.

  advancements - The advancements of this tab. Cannot include any null advancement or RootAdvancement.

  Throws:

  IllegalStateException - If the tab is already initialised.

  DisposedException - If the tab is disposed.

• registerAdvancements

  public void registerAdvancements(@NotNull @NotNull RootAdvancement rootAdvancement, @NotNull @NotNull Set<BaseAdvancement> advancements)

  Register the advancements for this tab, initializing the tab. Thus, it cannot be called twice.

  Parameters:

  rootAdvancement - The root of this tab.

  advancements - The advancements of this tab. Cannot include any null advancement or RootAdvancement.

  Throws:

  IllegalStateException - If the tab is already initialised.

  DisposedException - If the tab is disposed.

• showTab

  public void showTab(@NotNull @NotNull Player... players)

  Shows the tab to the provided players and sends them the advancements of the tab.

  Parameters:

  players - The players the tab will be shown to.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• showTab

  public void showTab(@NotNull @NotNull Player player)

  Shows the tab to the provided player and sends them the advancements of the tab.

  Parameters:

  player - The player the tab will be shown to.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• hideTab

  public void hideTab(@NotNull @NotNull Player... players)

  Hides the tab and its advancements to the provided players.

  Parameters:

  players - The players the tab will be hid to.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

  Since:

  1.0.2

• hideTab

  public void hideTab(@NotNull @NotNull Player player)

  Hides the tab and its advancements to the provided player.

  Parameters:

  player - The player the tab will be hid to.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• isShownTo

  @Contract(pure=true, value="null -> false") public boolean isShownTo(Player player)

  Returns whether the tab is shown to the specified player.

  Parameters:

  player - The player.

  Returns:

  Whether the tab is shown to the specified player.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• getAdvancementsAsStrings

  @NotNull public @Unmodifiable @NotNull Collection<@NotNull String> getAdvancementsAsStrings()

  Returns an unmodifiable Collection of all the advancement's keys of this tab as Strings.

  Returns:

  An unmodifiable Collection of all the advancement's keys of this tab as Strings.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

• isOwnedByThisTab

  @Contract(pure=true) public boolean isOwnedByThisTab(@NotNull @NotNull Advancement advancement)

  Returns whether the namespace of the specified advancement's key is equals to this tab namespace.

  Parameters:

  advancement - The advancement.

  Returns:

  Whether the namespace of the specified advancement's key is equals to this tab namespace.

• automaticallyShowToPlayers

  @NotNull @Contract("-> this") public @NotNull AdvancementTab automaticallyShowToPlayers()

  Utility method which automatically shows this tab to every player just after they have been loaded.

  More formally, this is equivalent to calling:

   tab.registerEvent(PlayerLoadingCompletedEvent.class, EventPriority.LOWEST, e -> tab.showTab(e.getPlayer()));
   

  Returns:

  This AdvancementTab.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

  Since:

  2.2.0

• automaticallyGrantRootAdvancement

  @NotNull @Contract("-> this") public @NotNull AdvancementTab automaticallyGrantRootAdvancement()

  Utility method which automatically grants the root advancement of this tab to every player after they have been loaded.

  More formally, this is equivalent to calling:

   tab.registerEvent(PlayerLoadingCompletedEvent.class, EventPriority.LOW, e -> tab.grantRootAdvancement(e.getPlayer()));
   

  Returns:

  This AdvancementTab.

  Throws:

  IllegalStateException - If the tab is not initialised.

  DisposedException - If the tab is disposed.

  Since:

  2.2.0

• registerEvent

  public <E extends Event> void registerEvent(@NotNull @NotNull Class<E> eventClass, @NotNull @NotNull Consumer<E> consumer)

  Registers the provided event into the EventManager of this tab.

  Type Parameters:

  E - The class of the event to register.

  Parameters:

  eventClass - The class of the event to register.

  consumer - The code to run when the event occurs.

  Throws:

  DisposedException - If the tab is disposed.

  IllegalArgumentException - If any argument is null.

  Since:

  2.2.0

• registerEvent

  public <E extends Event> void registerEvent(@NotNull @NotNull Class<E> eventClass, @NotNull @NotNull EventPriority priority, @NotNull @NotNull Consumer<E> consumer)

  Registers the provided event into the EventManager of this tab.

  Type Parameters:

  E - The class of the event to register.

  Parameters:

  eventClass - The class of the event to register.

  priority - The priority of the event. See EventPriority.

  consumer - The code to run when the event occurs.

  Throws:

  DisposedException - If the tab is disposed.

  IllegalArgumentException - If any argument is null.

  Since:

  2.2.0

• toString

  @NotNull public @NotNull String toString()

  Returns the namespace of the tab.

  Overrides:

  toString in class Object

  Returns:

  The namespace of the tab.

• equals

  public boolean equals(Object o)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• getOwningPlugin

  @NotNull public @NotNull Plugin getOwningPlugin()

  Gets the plugin that created this advancement tab.

  Returns:

  The plugin that created this advancement tab.

• getEventManager

  @NotNull public @NotNull EventManager getEventManager()

  Gets the EventManager of this tab.

  Returns:

  The EventManager of this tab.

• getNamespace

  @NotNull public @NotNull String getNamespace()

  Gets the unique namespace of this tab.

  Returns:

  The unique namespace of this tab.

• getDatabaseManager

  @NotNull public @NotNull DatabaseManager getDatabaseManager()

  Gets the DatabaseManager of this tab.

  Returns:

  The DatabaseManager of this tab.

• isInitialised

  public boolean isInitialised()

  Gets whether the tab is initialized.

  Returns:

  Whether the tab is initialized.

• isDisposed

  public boolean isDisposed()

  Returns whether the tab is disposed.

  Returns:

  Whether the tab is disposed.