Package org.bukkit.advancement

Interface AdvancementDisplay

public interface AdvancementDisplay

Holds information about how the advancement is displayed by the game.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the visible description of the advancement.
ItemStack	getIcon()	The icon that is used for this advancement.
String	getTitle()	Gets the title of the advancement.
AdvancementDisplayType	getType()	The display type of this advancement.
float	getX()	The X position of the advancement in the advancement screen.
float	getY()	The Y position of the advancement in the advancement screen.
boolean	isHidden()	Whether to hide this advancement and all its children from the advancement screen until this advancement have been completed.
boolean	shouldAnnounceChat()	Whether to announce in the chat when this advancement has been completed.
boolean	shouldShowToast()	Whether to show a toast to the player when this advancement has been completed.

Method Details

getTitle

@NotNull
String getTitle()

Gets the title of the advancement.

Returns:

The advancement title without colour codes.

getDescription

@NotNull
String getDescription()

Gets the visible description of the advancement.

Returns:

The advancement description without colour codes.

getIcon

@NotNull
ItemStack getIcon()

The icon that is used for this advancement.

Returns:

an ItemStack that represents the advancement.

shouldShowToast

boolean shouldShowToast()

Whether to show a toast to the player when this advancement has been completed.

Returns:

true if a toast is shown.

shouldAnnounceChat

boolean shouldAnnounceChat()

Whether to announce in the chat when this advancement has been completed.

Returns:

true if announced in chat.

isHidden

boolean isHidden()

Whether to hide this advancement and all its children from the advancement screen until this advancement have been completed. Has no effect on root advancements themselves, but still affects all their children.

Returns:

true if hidden.

getX

float getX()

The X position of the advancement in the advancement screen.

Returns:

the X coordinate as float

getY

float getY()

The Y position of the advancement in the advancement screen.

Returns:

the Y coordinate as float

getType

@NotNull
AdvancementDisplayType getType()

The display type of this advancement.

Returns:

an enum representing the type.