java.lang.Object

com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>

com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplay.Builder

Enclosing class:: AdvancementDisplay

public static class AdvancementDisplay.Builder extends AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>

A builder for AdvancementDisplay.

Since:: 2.1.0

Field Summary

Fields

Modifier and Type

Field

Description

protected ChatColor

defaultColor

The default color of the title and description.

Fields inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplayBuilder
announceChat, description, frame, icon, showToast, title, x, y
Constructor Summary

Constructors

Constructor

Description

Builder(@NotNull Material icon, @NotNull String title)

Creates a new AdvancementDisplay.Builder.

Builder(@NotNull ItemStack icon, @NotNull String title)

Creates a new AdvancementDisplay.Builder.
Method Summary

Modifier and Type

Method

Description

@NotNull AdvancementDisplay

build()

Builds the advancement display.

@NotNull AdvancementDisplay.Builder

challengeFrame()

Sets the shape of the advancement frame to AdvancementFrameType.CHALLENGE.

@NotNull AdvancementDisplay.Builder

defaultColor(@NotNull ChatColor defaultColor)

Sets the default color of the title and description.

@NotNull AdvancementDisplay.Builder

frame(@NotNull AdvancementFrameType frame)

Sets the shape of the advancement frame in the advancement GUI.

@NotNull ChatColor

getDefaultColor()

Gets the default color of the title and description.

@NotNull AdvancementDisplay.Builder

goalFrame()

Sets the shape of the advancement frame to AdvancementFrameType.GOAL.

@NotNull AdvancementDisplay.Builder

taskFrame()

Sets the shape of the advancement frame to AdvancementFrameType.TASK.

Methods inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplayBuilder
announceChat, announceChat, coords, coords, description, description, doesAnnounceToChat, doesShowToast, getDescription, getFrame, getIcon, getTitle, getX, getY, showToast, showToast, x, y

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- defaultColor
  
  protected ChatColor defaultColor
  
  The default color of the title and description.
Constructor Details
- Builder
  
  public Builder(@NotNull @NotNull Material icon, @NotNull @NotNull String title)
  
  Creates a new AdvancementDisplay.Builder.
  By default, the advancement display returned by build() won't show both the toast message and the announcement message in the chat upon advancement completion.
  The default frame is AdvancementFrameType.TASK.
  The default defaultColor is AdvancementFrameType.TASK.getColor().
  
  Parameters:
  
  icon - The material of the advancement's icon in the advancement GUI.
  
  title - The title of the advancement.
- Builder
  
  public Builder(@NotNull @NotNull ItemStack icon, @NotNull @NotNull String title)
  
  Creates a new AdvancementDisplay.Builder.
  By default, the advancement display returned by build() won't show both the toast message and the announcement message in the chat upon advancement completion.
  The default frame is AdvancementFrameType.TASK.
  The default defaultColor is AdvancementFrameType.TASK.getColor().
  
  Parameters:
  
  icon - The advancement's icon in the advancement GUI.
  
  title - The title of the advancement.
Method Details
- frame
  
  @NotNull public @NotNull AdvancementDisplay.Builder frame(@NotNull @NotNull AdvancementFrameType frame)
  
  Sets the shape of the advancement frame in the advancement GUI.
  If builder.defaultColor(...) hasn't been called yet (or if it will never be called), also sets the default color to frame.getColor().
  
  Overrides:
  
  frame in class AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>
  
  Parameters:
  
  frame - The shape of the advancement frame in the advancement GUI.
  
  Returns:
  
  This builder.
- taskFrame
  
  @NotNull public @NotNull AdvancementDisplay.Builder taskFrame()
  
  Sets the shape of the advancement frame to AdvancementFrameType.TASK.
  If builder.defaultColor(...) hasn't been called yet (or if it will never be called), also sets the default color to AdvancementFrameType.TASK.getColor().
  
  Overrides:
  
  taskFrame in class AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>
  
  Returns:
  
  This builder.
- goalFrame
  
  @NotNull public @NotNull AdvancementDisplay.Builder goalFrame()
  
  Sets the shape of the advancement frame to AdvancementFrameType.GOAL.
  If builder.defaultColor(...) hasn't been called yet (or if it will never be called), also sets the default color to AdvancementFrameType.GOAL.getColor().
  
  Overrides:
  
  goalFrame in class AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>
  
  Returns:
  
  This builder.
- challengeFrame
  
  @NotNull public @NotNull AdvancementDisplay.Builder challengeFrame()
  
  Sets the shape of the advancement frame to AdvancementFrameType.CHALLENGE.
  If builder.defaultColor(...) hasn't been called yet (or if it will never be called), also sets the default color to AdvancementFrameType.CHALLENGE.getColor().
  
  Overrides:
  
  challengeFrame in class AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>
  
  Returns:
  
  This builder.
- defaultColor
  
  @NotNull public @NotNull AdvancementDisplay.Builder defaultColor(@NotNull @NotNull ChatColor defaultColor)
  
  Sets the default color of the title and description.
  
  Parameters:
  
  defaultColor - The default color of the title and description.
  
  Returns:
  
  This builder.
- build
  
  @NotNull public @NotNull AdvancementDisplay build()
  
  Builds the advancement display.
  
  Specified by:
  
  build in class AdvancementDisplayBuilder<AdvancementDisplay.Builder,AdvancementDisplay>
  
  Returns:
  
  The built advancement display.
- getDefaultColor
  
  @NotNull public @NotNull ChatColor getDefaultColor()
  
  Gets the default color of the title and description.
  
  Returns:
  
  The default color of the title and description.

Class AdvancementDisplay.Builder

Field Summary

Fields inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplayBuilder

Constructor Summary

Method Summary

Methods inherited from class com.fren_gor.ultimateAdvancementAPI.advancement.display.AdvancementDisplayBuilder

Methods inherited from class java.lang.Object

Field Details

defaultColor

Constructor Details

Builder

Builder

Method Details

frame

taskFrame

goalFrame

challengeFrame

defaultColor

build

getDefaultColor