org.spongepowered.api.advancement

Interface Advancement

All Superinterfaces:

CatalogType, TextElement, TextRepresentable

public interface Advancement
extends CatalogType, TextRepresentable

An advancement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Advancement.Builder A builder to create Advancements.

Method Summary

Modifier and Type	Method and Description
static Advancement.Builder	builder() Creates a new Advancement.Builder to create Advancements.
Collection<Advancement>	getChildren() Gets all the children Advancements.
AdvancementCriterion	getCriterion() Gets all the AdvancementCriterion that should be achieved before this advancement is unlocked.
Optional<DisplayInfo>	getDisplayInfo() Gets the DisplayInfo of this advancement, if present.
Optional<Advancement>	getParent() Gets the parent Advancement, if present.
Optional<AdvancementTree>	getTree() Gets the AdvancementTree this advancement is located in, will only be present if the root advancement was used to create a AdvancementTree.
List<Text>	toToastText() Gets the Text lines that would be used to display a toast notification.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo, toText

Method Detail

builder

static Advancement.Builder builder()

Creates a new Advancement.Builder to create Advancements.

Returns:

The new builder

getTree

Optional<AdvancementTree> getTree()

Gets the AdvancementTree this advancement is located in, will only be present if the root advancement was used to create a AdvancementTree.

Returns:

The advancement tree

getChildren

Collection<Advancement> getChildren()

Gets all the children Advancements.

Returns:

The children advancements

getCriterion

AdvancementCriterion getCriterion()

Gets all the AdvancementCriterion that should be achieved before this advancement is unlocked. AdvancementCriterion.EMPTY will be returned if no criterion was assigned.

This AdvancementCriterion can be a AND or OR operation that contains multiple possible AdvancementCriterions.

Returns:

The criterion

getParent

Optional<Advancement> getParent()

Gets the parent Advancement, if present.

Returns:

The parent advancement, if present

getDisplayInfo

Optional<DisplayInfo> getDisplayInfo()

Gets the DisplayInfo of this advancement, if present.

Returns:

The display info, if present

toToastText

List<Text> toToastText()

Gets the Text lines that would be used to display a toast notification.

Returns:

The text lines