Package net.kyori.adventure.text

Interface StorageNBTComponent

All Superinterfaces:

Buildable<StorageNBTComponent,StorageNBTComponent.Builder>, BuildableComponent<StorageNBTComponent,StorageNBTComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, NBTComponent<StorageNBTComponent,StorageNBTComponent.Builder>, ScopedComponent<StorageNBTComponent>, StyleGetter, StyleSetter<Component>

public interface StorageNBTComponent
extends NBTComponent<StorageNBTComponent,StorageNBTComponent.Builder>, ScopedComponent<StorageNBTComponent>

Given a Key, this component reads the NBT of the associated command storage and displays that information.

This component consists of:

storage

a key that represents the resource location of a command storage (eg. my_plugin:actions.punches_entity)

everything in

NBTComponent

Since:

4.0.0

See Also:

NBTComponent

Since Minecraft:

1.15

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StorageNBTComponent.Builder	A command storage NBT component builder.

Field Summary

Fields inherited from interface net.kyori.adventure.text.Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
@NotNull Key	storage()	Gets the NBT storage's ID.
@NotNull StorageNBTComponent	storage(@NotNull Key storage)	Sets the NBT storage.

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

toBuilder

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

applyFallbackStyle, applyFallbackStyle, asComponent, asHoverEvent, children, clickEvent, color, compact, componentBuilderApply, contains, contains, decoration, decorations, decorations, detectCycle, font, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, spliterator, spliterator, style, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

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

interpret, interpret, nbtPath, nbtPath, separator, separator

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

append, append, append, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, style, style, style

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter

decorate, decorations

Method Detail

storage

@NotNull
@NotNull Key storage()

Gets the NBT storage's ID.

Returns:

the NBT storage

Since:

4.0.0

storage

@Contract(pure=true)
@NotNull
@NotNull StorageNBTComponent storage(@NotNull
                                     @NotNull Key storage)

Sets the NBT storage.

Parameters:

storage - the identifier of the NBT storage

Returns:

a storage NBT component

Since:

4.0.0

examinableProperties

@NotNull
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface Component

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

Specified by:

examinableProperties in interface NBTComponent<StorageNBTComponent,StorageNBTComponent.Builder>