Package org.spongepowered.api.advancement

Interface Advancement

All Superinterfaces:

ComponentLike, DataPackSerializable, DefaultedRegistryValue

public interface Advancement
extends DefaultedRegistryValue, 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 an Advancement.
AdvancementCriterion	criterion()	Gets all the AdvancementCriterion that should be achieved before this advancement is unlocked.
Optional<DisplayInfo>	displayInfo()	Gets the DisplayInfo of this advancement, if present.
Optional<ResourceKey>	parent()	Gets the parent Advancement, if present.
List<Component>	toToastText()	Gets the Component lines that would be used to display a toast notification.

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

asComponent

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

toDataPack

Methods inherited from interface org.spongepowered.api.registry.DefaultedRegistryValue

asDefaultedReference, findKey, key

Method Details

builder

static Advancement.Builder builder()

Creates a new Advancement.Builder to create an Advancement.

Returns:

The new builder

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

Optional<ResourceKey> parent()

Gets the parent Advancement, if present.

Returns:

The parent advancement, if present

displayInfo

Optional<DisplayInfo> displayInfo()

Gets the DisplayInfo of this advancement, if present.

Returns:

The display info, if present

toToastText

List<Component> toToastText()

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

Returns:

The text lines