Module net.kyori.adventure.api

Package net.kyori.adventure.text

Interface NBTComponent<C extends NBTComponent<C>>

Type Parameters:

C - component type

All Superinterfaces:

Buildable<NBTComponentBuilder<C,?>>, BuildableComponent<C,NBTComponentBuilder<C,?>>, Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, StyleGetter, StyleSetter<Component>

All Known Subinterfaces:

BlockNBTComponent, EntityNBTComponent, StorageNBTComponent

public sealed interface NBTComponent<C extends NBTComponent<C>>
extends BuildableComponent<C,NBTComponentBuilder<C,?>>
permits BlockNBTComponent, EntityNBTComponent, StorageNBTComponent

A component that can display NBT fetched from different locations, optionally trying to interpret the NBT as JSON using the net.kyori.adventure.text.serializer.gson.GsonComponentSerializer to convert the JSON to a Component. Sending interpreted NBT to the chat would be similar to using /tellraw.

This component consists of:

nbtPath

a path to specify which parts of the nbt you want displayed(examples).

interpret

a boolean telling adventure if the fetched NBT value should be parsed as JSON

plain

a boolean telling adventure if the fetched NBT value should be pretty-printed without styling

This component is rendered serverside and can therefore receive platform-defined context. See the documentation for your respective platform for more info

Since:

4.0.0

Since Minecraft:

1.14

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	INTERPRET_DEFAULT	The default value for interpret().
static final boolean	PLAIN_DEFAULT	The default value for plain().

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

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
boolean	interpret()	Gets if we should be interpreting.
C	interpret(boolean interpret)	Sets if we should be interpreting.
String	nbtPath()	Gets the NBT path.
C	nbtPath(String nbtPath)	Sets the NBT path.
boolean	plain()	Gets if styling should be removed from pretty-printed NBT.
C	plain(boolean plain)	Sets if styling should be removed from pretty-printed NBT.
@Nullable Component	separator()	Gets the separator.
C	separator(@Nullable ComponentLike separator)	Sets the separator.
NBTComponentBuilder<C,? extends NBTComponentBuilder<C,?>>	toBuilder()	Create a builder from this component.

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

append, append, append, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, asHoverEvent, children, children, clickEvent, clickEvent, color, color, colorIfAbsent, compact, compact, componentBuilderApply, contains, contains, decorate, decoration, decoration, decoration, decorationIfAbsent, decorations, decorations, font, font, hasDecoration, hasStyling, hoverEvent, hoverEvent, insertion, insertion, iterable, iterable, iterator, iterator, mergeStyle, mergeStyle, mergeStyle, replaceText, replaceText, shadowColor, shadowColor, shadowColorIfAbsent, spliterator, spliterator, style, style, style, style, style

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

asHoverEvent

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

decorate, decorations

Field Details

INTERPRET_DEFAULT

static final boolean INTERPRET_DEFAULT

The default value for interpret().

Since:

5.0.0

See Also:

• Constant Field Values

PLAIN_DEFAULT

static final boolean PLAIN_DEFAULT

The default value for plain().

Since:

5.0.0

See Also:

• Constant Field Values

Method Details

nbtPath

String nbtPath()

Gets the NBT path.

Returns:

the NBT path

Since:

4.0.0

nbtPath

@Contract(pure=true)
C nbtPath(String nbtPath)

Sets the NBT path.

Parameters:

nbtPath - the NBT path

Returns:

an NBT component

Since:

4.0.0

interpret

boolean interpret()

Gets if we should be interpreting.

This cannot be true if plain() is also true.

Returns:

if we should be interpreting

Since:

4.0.0

interpret

@Contract(pure=true)
C interpret(boolean interpret)

Sets if we should be interpreting.

This cannot be true if plain() is also true.

Parameters:

interpret - if we should be interpreting.

Returns:

an NBT component

Throws:

IllegalArgumentException - if set to true and plain() is also true

Since:

4.0.0

separator

@Nullable Component separator()

Gets the separator.

Returns:

the separator

Since:

4.8.0

separator

C separator(@Nullable ComponentLike separator)

Sets the separator.

Parameters:

separator - the separator

Returns:

an NBT component

Since:

4.8.0

plain

boolean plain()

Gets if styling should be removed from pretty-printed NBT.

This cannot be true if interpret() is also true.

Returns:

if styling should be removed when pretty-printed

Since:

5.0.0

Since Minecraft:

26.1

plain

C plain(boolean plain)

Sets if styling should be removed from pretty-printed NBT.

This cannot be true if interpret() is also true.

Parameters:

plain - if styling should be removed when pretty-printed

Returns:

an NBT component

Throws:

IllegalArgumentException - if set to true and interpret() is also true

Since:

5.0.0

Since Minecraft:

26.1

toBuilder

NBTComponentBuilder<C,? extends NBTComponentBuilder<C,?>> toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Specified by:

toBuilder in interface Buildable<C extends NBTComponent<C>>

Specified by:

toBuilder in interface BuildableComponent<C extends NBTComponent<C>,NBTComponentBuilder<C extends NBTComponent<C>,?>>

Specified by:

toBuilder in interface Component

Returns:

the builder