Class MultiTasksAdvancement

Method Details

• registerTasks

  public void registerTasks(@NotNull @NotNull TaskAdvancement... tasks)

  Register the tasks for this multi-task advancement, initializing it. Thus, it cannot be called twice.

  Parameters:

  tasks - The tasks to register. Cannot include any null task.

• registerTasks

  public void registerTasks(@NotNull @NotNull Set<TaskAdvancement> tasks)

  Register the tasks for this multi-task advancement, initializing it. Thus, it cannot be called twice.

  Parameters:

  tasks - The tasks to register. Cannot include any null task.

• getTasks

  @NotNull public @NotNull @UnmodifiableView Set<@NotNull TaskAdvancement> getTasks()

  Gets an unmodifiable Set of the registered tasks.

  Returns:

  An unmodifiable Set of the registered tasks.

  Throws:

  IllegalStateException - If the multi-task advancement is not initialised.

• getProgression

  public @Range(from=0, to=Integer.MAX_VALUE) int getProgression(@NotNull @NotNull TeamProgression progression)

  Gets the current progression of the provided team.

  Overrides:

  getProgression in class Advancement

  Parameters:

  progression - The TeamProgression of the team.

  Returns:

  The current progression of the team.

  Throws:

  IllegalStateException - If the multi-task advancement is not initialised.

• isGranted

  public boolean isGranted(@NotNull @NotNull TeamProgression pro)

  Returns whether the advancement has been completed by the provided team.

  Overrides:

  isGranted in class Advancement

  Parameters:

  pro - The TeamProgression of the team.

  Returns:

  Whether the advancement has been completed by the provided team.

  Throws:

  IllegalStateException - If the multi-task advancement is not initialised.

• setProgression

  protected void setProgression(@NotNull @NotNull TeamProgression progression, @Nullable @Nullable Player player, @Range(from=0, to=Integer.MAX_VALUE) int newProgression, boolean giveRewards) throws ArbitraryMultiTaskProgressionUpdateException

  Sets a progression for the provided player's team. Since MultiTasksAdvancement handles a set of TaskAdvancements, it is not possible (by default) to set any progression, but 0 or Advancement.maxProgression. Setting any progression between those will result in an ArbitraryMultiTaskProgressionUpdateException.

  To enable arbitrary progression updates, set ENABLE_ARBITRARY_SET_PROGRESSION to true (false by default). To prevent the throwing of ArbitraryMultiTaskProgressionUpdateExceptions set DISABLE_EXCEPTION_ON_ARBITRARY_SET_PROGRESSION to true.

  Overrides:

  setProgression in class Advancement

  Parameters:

  progression - The TeamProgression of the player.

  player - The player, null if it's not online. (Note: it must have been loaded into cache)

  newProgression - The new progression to set. Must be between 0 and Advancement.maxProgression.

  giveRewards - Whether to give rewards to player if the team's progression reaches Advancement.maxProgression.

  Throws:

  ArbitraryMultiTaskProgressionUpdateException - When the provided new progression is not 0 or Advancement.maxProgression and either ENABLE_ARBITRARY_SET_PROGRESSION or DISABLE_EXCEPTION_ON_ARBITRARY_SET_PROGRESSION are not set to true.

  IllegalStateException - If the multi-task advancement is not initialised.

• reloadTasks

  protected void reloadTasks(@NotNull @NotNull TeamProgression progression, @Nullable @Nullable Player player, boolean giveRewards)

  Reloads and updates the tasks to the provided team members.

  This method should be invoked when the progression of a task changes.

  Specified by:

  reloadTasks in class AbstractMultiTasksAdvancement

  Parameters:

  progression - The TeamProgression of the team.

  player - The player responsible for the task's progression update, or null if there's not. In this case, the implementation can choose a random online member.

  Throws:

  IllegalStateException - If the multi-task advancement is not initialised.

• resetProgressionCache

  public void resetProgressionCache()

  Resets the progression cache for every team.

• resetProgressionCache

  public void resetProgressionCache(@NotNull @NotNull TeamProgression pro)

  Resets the progression cache for the provided team.

  Parameters:

  pro - The team to remove from the cache.

• updateProgressionCache

  protected void updateProgressionCache(@NotNull @NotNull TeamProgression pro, @Range(from=0, to=Integer.MAX_VALUE) int progression)

  Updates the progression cache for the provided team.

  Parameters:

  pro - The team to update.

  progression - The new progression to store in cache.

• validateRegister

  public void validateRegister() throws InvalidAdvancementException

  Validate the advancement after it has been registered by the advancement tab. If the validation fails, a InvalidAdvancementException should be thrown.

  For example, BaseAdvancement overrides this method to make sure it and its parent belongs to the same tab.

  Note that every method of AdvancementTab is available, since this method is called after every advancement has been registered and the tab has already been initialised.

  Overrides:

  validateRegister in class BaseAdvancement

  Throws:

  InvalidAdvancementException - If the validation fails.

• onDispose

  public void onDispose()

  Called when the advancement is disposed.

  Overrides:

  onDispose in class Advancement

  Throws:

  IllegalStateException - If the multi-task advancement is not initialised.

• isInitialised

  public boolean isInitialised()

  Returns whether the multi-task advancement is initialised.

  Returns:

  Whether the multi-task advancement is initialised.