Package org.spongepowered.api.advancement

Interface Advancement

All Superinterfaces:

ComponentLike, DataPackSerializable, DataSerializable, Keyed, ResourceKeyed

public interface Advancement
extends ComponentLike, DataPackSerializable

An advancement.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface net.kyori.adventure.text.ComponentLike

asComponent

Methods inherited from interface org.spongepowered.api.datapack.DataPackSerializable

type

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Methods inherited from interface org.spongepowered.api.ResourceKeyed

key

Method Detail

builder

static Advancement.Builder builder()

Creates a new Advancement.Builder to create Advancements.

Returns:

The new builder

tree

java.util.Optional<AdvancementTree> tree()

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

children

java.util.Collection<Advancement> children()

Gets all the children Advancements.

Returns:

The children advancements

criterion

AdvancementCriterion criterion()

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

parent

java.util.Optional<Advancement> parent()

Gets the parent Advancement, if present.

Returns:

The parent advancement, if present

displayInfo

java.util.Optional<DisplayInfo> displayInfo()

Gets the DisplayInfo of this advancement, if present.

Returns:

The display info, if present

toToastText

java.util.List<Component> toToastText()

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

Returns:

The text lines