Module net.kyori.adventure.api

Package net.kyori.adventure.text

Interface StorageNBTComponent

All Superinterfaces:

Buildable<NBTComponentBuilder<StorageNBTComponent,?>>, BuildableComponent<StorageNBTComponent,NBTComponentBuilder<StorageNBTComponent,?>>, Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, NBTComponent<StorageNBTComponent>, ScopedComponent<StorageNBTComponent>, StyleGetter, StyleSetter<Component>

public sealed interface StorageNBTComponent
extends NBTComponent<StorageNBTComponent>, 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

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

INTERPRET_DEFAULT, PLAIN_DEFAULT

Method Summary

Modifier and Type	Method	Description
Key	storage()	Gets the NBT storage's ID.
StorageNBTComponent	storage(Key storage)	Sets the NBT storage.
StorageNBTComponent.Builder	toBuilder()	Create a builder from this component.

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

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

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

asHoverEvent

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

interpret, interpret, nbtPath, nbtPath, plain, plain, separator, separator

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

append, append, append, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, decorationIfAbsent, decorations, font, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style, style

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

decorate, decorations

Method Details

storage

Key storage()

Gets the NBT storage's ID.

Returns:

the NBT storage

Since:

4.0.0

storage

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

Sets the NBT storage.

Parameters:

storage - the identifier of the NBT storage

Returns:

a storage NBT component

Since:

4.0.0

toBuilder

StorageNBTComponent.Builder toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Specified by:

toBuilder in interface Buildable<NBTComponentBuilder<StorageNBTComponent,?>>

Specified by:

toBuilder in interface BuildableComponent<StorageNBTComponent,NBTComponentBuilder<StorageNBTComponent,?>>

Specified by:

toBuilder in interface Component

Specified by:

toBuilder in interface NBTComponent<StorageNBTComponent>

Specified by:

toBuilder in interface ScopedComponent<StorageNBTComponent>

Returns:

the builder