Package cz.jeme.advancium

Interface CustomAdvancementTab

All Superinterfaces:
Keyed, net.kyori.adventure.key.Keyed
@NullMarked public sealed interface CustomAdvancementTab extends Keyed
Represents a custom advancement tab.

Custom advancement tabs group advancements under a single category.

All display data for a tab are copied from its root advancement.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    CustomAdvancementTab.Builder
    Builder for creating and configuring instances of CustomAdvancementTab.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bukkit.NamespacedKey
    background()
    Gets the background of the tab as a NamespacedKey.
    org.bukkit.plugin.Plugin
    plugin()
    Gets the plugin associated with this custom advancement tab.
    CustomAdvancement
    root()
    Gets the root advancement of this tab.
    static CustomAdvancementTab.Builder
    tab(org.bukkit.plugin.Plugin plugin)
    Creates a new builder for configuring and constructing a CustomAdvancementTab.

    Methods inherited from interface cz.jeme.advancium.Keyed

    key

  • Method Details

    • tab

      static CustomAdvancementTab.Builder tab(org.bukkit.plugin.Plugin plugin)
      Creates a new builder for configuring and constructing a CustomAdvancementTab.
      Parameters:
      plugin - the plugin associated with this tab
      Returns:
      a new builder instance

    • root

      CustomAdvancement root()
      Gets the root advancement of this tab.

      The root advancement is considered the primary or starting point of this tab.

      All display data for this tab are copied from this root advancement.

      Returns:
      the root CustomAdvancement

    • background

      org.bukkit.NamespacedKey background()
      Gets the background of the tab as a NamespacedKey.

      The background determines the texture or image displayed on this tab.

      For example: minecraft:textures/gui/advancements/backgrounds/stone.png

      Returns:
      the NamespacedKey for the tab's background texture

    • plugin

      org.bukkit.plugin.Plugin plugin()
      Gets the plugin associated with this custom advancement tab.
      Returns:
      the plugin associated with this tab