Package org.spongepowered.api.advancement

Interface DisplayInfo

public interface DisplayInfo

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Details

builder

static DisplayInfo.Builder builder()

Creates a new DisplayInfo.Builder to create DisplayInfos.

Returns:

The new builder

type

AdvancementType type()

Gets the AdvancementType.

Returns:

The advancement type

description

Component description()

Gets the description.

Returns:

The description

icon

ItemStackSnapshot icon()

Gets the icon.

Returns:

The icon

title

Component title()

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