NBTComponentBuilder (adventure-api 5.0.1 API)

Type Parameters:: C - component type; B - builder type

All Superinterfaces:: AbstractBuilder<C>, ComponentBuilder<C,B>, ComponentBuilderApplicable, ComponentLike, MutableStyleSetter<B>, StyleSetter<B>

All Known Subinterfaces:: BlockNBTComponent.Builder, EntityNBTComponent.Builder, StorageNBTComponent.Builder

public sealed interface NBTComponentBuilder<C extends NBTComponent<C>,B extends NBTComponentBuilder<C,B>> extends ComponentBuilder<C,B> permits BlockNBTComponent.Builder, EntityNBTComponent.Builder, StorageNBTComponent.Builder (not exhaustive)

An NBT component builder.

Since:: 4.0.0

Method Summary

Modifier and Type

Method

Description

B

interpret(boolean interpret)

Sets whether to interpret.

B

nbtPath(String nbtPath)

Sets the NBT path content.

B

plain(boolean plain)

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

B

separator(@Nullable ComponentLike separator)

Sets the separator.

Methods inherited from interface net.kyori.adventure.text.ComponentBuilder
append, append, append, append, append, append, appendNewline, appendSpace, applicableApply, apply, applyDeep, asComponent, build, children, clickEvent, color, colorIfAbsent, componentBuilderApply, decorate, decorate, decoration, decoration, decorationIfAbsent, decorations, decorations, font, hoverEvent, insertion, mapChildren, mapChildrenDeep, mergeStyle, mergeStyle, mergeStyle, resetStyle, style, style

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter
shadowColor, shadowColorIfAbsent

Method Details
- nbtPath
  
  @Contract("_ -> this") B nbtPath(String nbtPath)
  
  Sets the NBT path content.
  
  Parameters:
  
  nbtPath - the NBT path
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- interpret
  
  @Contract("_ -> this") B interpret(boolean interpret)
  
  Sets whether to interpret.
  This cannot be true if plain(boolean) is also true.
  
  Parameters:
  
  interpret - if we should be interpreting
  
  Returns:
  
  this builder
  
  Throws:
  
  IllegalArgumentException - if set to true and plain(boolean) is also true
  
  Since:
  
  4.0.0
- separator
  
  @Contract("_ -> this") B separator(@Nullable ComponentLike separator)
  
  Sets the separator.
  
  Parameters:
  
  separator - the separator
  
  Returns:
  
  this builder
  
  Since:
  
  4.8.0
- plain
  
  B plain(boolean plain)
  
  Sets if styling should be removed from pretty-printed NBT.
  This cannot be true if interpret(boolean) is also true.
  
  Parameters:
  
  plain - if styling should be removed when pretty-printed
  
  Returns:
  
  this builder
  
  Throws:
  
  IllegalArgumentException - if set to true and interpret(boolean) is also true
  
  Since:
  
  5.0.0
  
  Since Minecraft:
  
  26.1