Class AdvancementMain

Method Details

• load

  public void load() throws InvalidVersionException

  Loads the API.

  Cannot be called twice until disable() is called.

  Throws:

  InvalidVersionException - If the minecraft version in use is not supported by this API version.

  IllegalStateException - If it is called at an invalid moment.

• enableSQLite

  public void enableSQLite(File SQLiteDatabase)

  Enables the API using a SQLite database.

  Must be called after load() and cannot be called twice until disable() is called. Also, only one enable method can be called per loading.

  Parameters:

  SQLiteDatabase - The SQLite database file.

  Throws:

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

  InvalidVersionException - If the minecraft version in use is not supported by this API version.

  IllegalStateException - If it is called at an invalid moment.

• enableMySQL

  public void enableMySQL(String username, String password, String databaseName, String host, @Range(from=1, to=Integer.MAX_VALUE) int port, @Range(from=1, to=Integer.MAX_VALUE) int poolSize, @Range(from=250L, to=Long.MAX_VALUE) long connectionTimeout)

  Enables the API using a MySQL database.

  Must be called after load() and cannot be called twice until disable() is called. Also, only one enable method can be called per loading.

  Parameters:

  username - The username.

  password - The password.

  databaseName - The name of the database.

  host - The MySQL host.

  port - The MySQL port. Must be greater than zero.

  poolSize - The pool size. Must be greater than zero.

  connectionTimeout - The connection timeout. Must be greater or equal to 250.

  Throws:

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

  IllegalStateException - If it is called at an invalid moment.

• enableInMemory

  public void enableInMemory()

  Enables the API using an in-memory database.

  Must be called after load() and cannot be called twice until disable() is called. Also, only one enable method can be called per loading.

  Throws:

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

  InvalidVersionException - If the minecraft version in use is not supported by this API version.

  IllegalStateException - If it is called at an invalid moment.

• disable

  public void disable()

  Disables the API.

  If not called after an enable method or load() no action is done.

  Throws:

  InvalidVersionException - If the minecraft version in use is not supported by this API version.

• createAdvancementTab

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

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

  Parameters:

  plugin - The owner of the new tab.

  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.

  See Also:

  • UltimateAdvancementAPI.createAdvancementTab(String)

• 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.

  See Also:

  • UltimateAdvancementAPI.getAdvancementTab(String)

• 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.

  See Also:

  • UltimateAdvancementAPI.isAdvancementTabRegistered(String)

• getPluginAdvancementTabs

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

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

  Parameters:

  plugin - The plugin that owns the returned advancement tabs.

  Returns:

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

  Throws:

  IllegalStateException - If the API is not enabled.

  See Also:

  • UltimateAdvancementAPI.getPluginAdvancementTabs()

• 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.

  See Also:

  • UltimateAdvancementAPI.unregisterAdvancementTab(String)

• unregisterAdvancementTabs

  public void unregisterAdvancementTabs(@NotNull @NotNull Plugin plugin)

  Unregisters all the advancement tabs owned by the provided plugin.

  Parameters:

  plugin - The plugin that owns the advancement tabs to be unregistered.

  Throws:

  IllegalStateException - If the API is not enabled.

  See Also:

  • UltimateAdvancementAPI.unregisterPluginAdvancementTabs()

• 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.

  IllegalArgumentException - If the namespaced key is malformed.

  See Also:

  • UltimateAdvancementAPI.getAdvancement(String)

• 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.

  See Also:

  • UltimateAdvancementAPI.getAdvancement(String, String)

• 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.

  See Also:

  • UltimateAdvancementAPI.getAdvancement(AdvancementKey)

• 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.

  See Also:

  • UltimateAdvancementAPI.getAdvancementTabNamespaces()

• 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.

  See Also:

  • UltimateAdvancementAPI.filterNamespaces(String)

• getTabs

  @NotNull public @UnmodifiableView @NotNull 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.

  See Also:

  • UltimateAdvancementAPI.getTabs()

• 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.

  See Also:

  • UltimateAdvancementAPI.updatePlayer(Player)

• getOwningPlugin

  @NotNull public @NotNull Plugin getOwningPlugin()

  Gets the plugin that instantiated the API.

  Returns:

  The plugin that instantiated the API.

• getEventManager

  @NotNull public @NotNull EventManager getEventManager()

  Gets the EventManager API global instance.

  Returns:

  The EventManager API global instance.

• getDatabaseManager

  @NotNull public @NotNull DatabaseManager getDatabaseManager()

  Gets the DatabaseManager.

  Returns:

  The DatabaseManager.

• getLibbyManager

  @NotNull public @NotNull net.byteflux.libby.BukkitLibraryManager getLibbyManager()

  Gets the libby manager.

  Libby is a library to handle dependencies at runtime. Check it out here.

  Returns:

  The libby manager.

• isLoaded

  public static boolean isLoaded()

  Returns whether the API is loaded.

  Returns:

  Whether the API is loaded.

• isEnabled

  public static boolean isEnabled()

  Returns whether the API is enabled.

  Returns:

  Whether the API is enabled.

• getLogger

  @NotNull public @NotNull Logger getLogger()

  Gets the owning plugin Logger.

  This method is equivalent to getOwningPlugin().getLogger().

  Returns:

  The owning plugin Logger.

• getDataFolder

  public File getDataFolder()

  Gets the owning plugin data folder.

  This method is equivalent to getOwningPlugin().getDataFolder().

  Returns:

  The owning plugin data folder.