Package org.spongepowered.api.advancement

Interface AdvancementTree

All Superinterfaces:

AdvancementNode, Keyed, ResourceKeyed

public interface AdvancementTree
extends AdvancementNode

Represents a Advancement tree or tab menu. The tree will become visible to a Player once the root advancement gets achieved.

Method Summary

Modifier and Type	Method	Description
Optional<ResourceKey>	backgroundPath()	Gets the background texture of this tree.
Optional<TreeLayoutElement>	layoutElement(AdvancementTemplate advancement)	Gets the TreeLayoutElement for the specified Advancement, Optional.empty() will be returned if the advancement is not present in the tree or if there is no DisplayInfo present.
Optional<TreeLayoutElement>	layoutElement(ResourceKey advancementKey)	Gets the TreeLayoutElement for the specified Advancement, Optional.empty() will be returned if the advancement is not present in the tree or if there is no DisplayInfo present.
Collection<TreeLayoutElement>	layoutElements()	Gets all the TreeLayoutElements that are present in this layout.

Methods inherited from interface org.spongepowered.api.advancement.AdvancementNode

children, rootAdvancement

Methods inherited from interface org.spongepowered.api.ResourceKeyed

key

Method Details

backgroundPath

Optional<ResourceKey> backgroundPath()

Gets the background texture of this tree.

Returns:

The background texture

layoutElements

Collection<TreeLayoutElement> layoutElements()

Gets all the TreeLayoutElements that are present in this layout.

Returns:

The tree layout elements

layoutElement

Optional<TreeLayoutElement> layoutElement(AdvancementTemplate advancement)

Gets the TreeLayoutElement for the specified Advancement, Optional.empty() will be returned if the advancement is not present in the tree or if there is no DisplayInfo present.

Parameters:

advancement - The advancement

Returns:

The tree layout element

layoutElement

Optional<TreeLayoutElement> layoutElement(ResourceKey advancementKey)

Gets the TreeLayoutElement for the specified Advancement, Optional.empty() will be returned if the advancement is not present in the tree or if there is no DisplayInfo present.

Parameters:

advancementKey - The advancement key

Returns:

The tree layout element