org.spongepowered.api.advancement

Interface DisplayInfo

public interface DisplayInfo

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DisplayInfo.Builder A builder to create DisplayInfos.

Method Summary

Modifier and Type	Method and Description
static DisplayInfo.Builder	builder() Creates a new DisplayInfo.Builder to create DisplayInfos.
boolean	doesAnnounceToChat() Gets whether a notification should be shown in the global chat.
boolean	doesShowToast() Gets whether a toast should be shown.
Text	getDescription() Gets the description.
ItemStackSnapshot	getIcon() Gets the icon.
Text	getTitle() Gets the title.
AdvancementType	getType() Gets the AdvancementType.
boolean	isHidden() Gets whether this advancement is hidden.

Method Detail

builder

static DisplayInfo.Builder builder()

Creates a new DisplayInfo.Builder to create DisplayInfos.

Returns:

The new builder

getType

AdvancementType getType()

Gets the AdvancementType.

Returns:

The advancement type

getDescription

Text getDescription()

Gets the description.

Returns:

The description

getIcon

ItemStackSnapshot getIcon()

Gets the icon.

Returns:

The icon

getTitle

Text getTitle()

Gets the title.

Returns:

The title

doesShowToast

boolean doesShowToast()

Gets whether a toast should be shown.

The toast is the notification that will be displayed in the top right corner.

Returns:

Show toast

doesAnnounceToChat

boolean doesAnnounceToChat()

Gets whether a notification should be shown in the global chat.

Returns:

Announce to chat

isHidden

boolean isHidden()

Gets whether this advancement is hidden.

Hidden advancements will only appear in the tree once they are unlocked. The lines that connect them to other advancements are still present.

Returns:

Is hidden