Package net.kyori.adventure.text
Interface NBTComponent<C extends NBTComponent<C,B>,B extends NBTComponentBuilder<C,B>>
-
- All Superinterfaces:
Buildable<C,B>
,BuildableComponent<C,B>
,Component
,ComponentBuilderApplicable
,ComponentLike
,net.kyori.examination.Examinable
,HoverEventSource<Component>
- All Known Subinterfaces:
BlockNBTComponent
,EntityNBTComponent
,StorageNBTComponent
public interface NBTComponent<C extends NBTComponent<C,B>,B extends NBTComponentBuilder<C,B>> extends BuildableComponent<C,B>
A component that can display NBT fetched from different locations, optionally trying to interpret the NBT as JSON using thenet.kyori.adventure.text.serializer.gson.GsonComponentSerializer
to convert the JSON to aComponent
. 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
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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.kyori.adventure.util.Buildable
Buildable.Builder<R>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
interpret()
Gets if we should be interpreting.@NonNull C
interpret(boolean interpret)
Sets if we should be interpreting.@NonNull String
nbtPath()
Gets the NBT path.@NonNull C
nbtPath(@NonNull String nbtPath)
Sets the NBT path.-
Methods inherited from interface net.kyori.adventure.text.BuildableComponent
toBuilder
-
Methods inherited from interface net.kyori.adventure.text.Component
append, append, append, asComponent, asHoverEvent, children, children, clickEvent, clickEvent, color, color, colorIfAbsent, componentBuilderApply, contains, decorate, decoration, decoration, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, hoverEvent, insertion, insertion, mergeStyle, mergeStyle, mergeStyle, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, style, style, style, style, style
-
Methods inherited from interface net.kyori.examination.Examinable
examinableName, examinableProperties, examine
-
Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource
asHoverEvent
-
-
-
-
Method Detail
-
nbtPath
@NonNull String nbtPath()
Gets the NBT path.- Returns:
- the NBT path
- Since:
- 4.0.0
-
nbtPath
@Contract(pure=true) @NonNull C nbtPath(@NonNull 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.- Returns:
- if we should be interpreting
- Since:
- 4.0.0
-
interpret
@Contract(pure=true) @NonNull C interpret(boolean interpret)
Sets if we should be interpreting.- Parameters:
interpret
- if we should be interpreting.- Returns:
- an NBT component
- Since:
- 4.0.0
-
-