Package fr.multimc.api.spigot.common.advancements

Class AdvancementBuilder

java.lang.Object
fr.multimc.api.spigot.common.advancements.AdvancementBuilder
public class AdvancementBuilder extends Object
A builder class for AdvancementDisplay.

  • Constructor Details

    • AdvancementBuilder

      public AdvancementBuilder()

  • Method Details

    • setIcon

      public AdvancementBuilder setIcon(@NotNull @NotNull org.bukkit.Material material)
      Sets the icon of the AdvancementDisplay.
      Parameters:
      material - the Material to use as the icon.
      Returns:
      this builder instance.

    • setTitle

      public AdvancementBuilder setTitle(@NotNull @NotNull String title)
      Sets the title of the AdvancementDisplay.
      Parameters:
      title - the title of the AdvancementDisplay.
      Returns:
      this builder instance.

    • setDescription

      public AdvancementBuilder setDescription(@NotNull @NotNull List<String> description)
      Sets the description of the AdvancementDisplay.
      Parameters:
      description - the description of the AdvancementDisplay.
      Returns:
      this builder instance.

    • setFrameType

      public AdvancementBuilder setFrameType(@NotNull @NotNull com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementFrameType frameType)
      Sets the frame type of the AdvancementDisplay.
      Parameters:
      frameType - the AdvancementFrameType of the AdvancementDisplay.
      Returns:
      this builder instance.

    • setLocation

      public AdvancementBuilder setLocation(float x, float y)
      Set the advancement location
      Parameters:
      x - the x coordinate of the AdvancementDisplay.
      y - the y coordinate of the AdvancementDisplay.
      Returns:
      this builder instance.

    • setShowToast

      public AdvancementBuilder setShowToast(boolean showToast)
      Sets whether the AdvancementDisplay should show a toast.
      Parameters:
      showToast - `true` if the AdvancementDisplay should show a toast, `false` otherwise.
      Returns:
      this builder instance.

    • setAnnounceToChat

      public AdvancementBuilder setAnnounceToChat(boolean announceToChat)
      Specifies whether the advancement should be announced in the chat.
      Parameters:
      announceToChat - true if the advancement should be announced in the chat, false otherwise.
      Returns:
      the current AdvancementBuilder instance.

    • build

      public com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplay build()
      Builds and returns the AdvancementDisplay object based on the previously set properties.
      Returns:
      a new instance of AdvancementDisplay.