feature: NBT component plain

Author: kezz

api/src/main/java/net/kyori/adventure/text/AbstractNBTComponentBuilder.java

@@ -31,6 +31,7 @@ abstract sealed class AbstractNBTComponentBuilder<C extends NBTComponent<C>, B e
   protected @Nullable String nbtPath;
   protected boolean interpret = NBTComponent.INTERPRET_DEFAULT;
   protected @Nullable Component separator;
+  protected boolean plain;
 
   AbstractNBTComponentBuilder() {
   }
@@ -40,6 +41,7 @@ abstract sealed class AbstractNBTComponentBuilder<C extends NBTComponent<C>, B e
     this.nbtPath = component.nbtPath();
     this.interpret = component.interpret();
     this.separator = component.separator();
+    this.plain = component.plain();
   }
 
   @Override
@@ -52,14 +54,31 @@ public B nbtPath(final String nbtPath) {
   @Override
   @SuppressWarnings("unchecked")
   public B interpret(final boolean interpret) {
+    if (this.interpret == interpret) return (B) this;
+    checkInterpretPlainState(interpret, this.plain);
     this.interpret = interpret;
     return (B) this;
   }
 
+  @Override
+  @SuppressWarnings("unchecked")
+  public B plain(final boolean plain) {
+    if (this.plain == plain) return (B) this;
+    checkInterpretPlainState(this.interpret, plain);
+    this.plain = plain;
+    return (B) this;
+  }
+
   @Override
   @SuppressWarnings("unchecked")
   public B separator(final @Nullable ComponentLike separator) {
     this.separator = ComponentLike.unbox(separator);
     return (B) this;
   }
+
+  static void checkInterpretPlainState(final boolean interpret, final boolean plain) {
+    if (interpret && plain) {
+      throw new IllegalArgumentException("Cannot have `interpret` and `plain` set to `true` at the same time");
+    }
+  }
 }

api/src/main/java/net/kyori/adventure/text/BlockNBTComponentImpl.java

@@ -30,56 +30,67 @@
 import org.jspecify.annotations.Nullable;
 
 import static java.util.Objects.requireNonNull;
+import static net.kyori.adventure.text.AbstractNBTComponentBuilder.checkInterpretPlainState;
 
 record BlockNBTComponentImpl(
   List<Component> children,
   Style style,
   String nbtPath,
   boolean interpret,
   @Nullable Component separator,
-  Pos pos
+  Pos pos,
+  boolean plain
 ) implements BlockNBTComponent {
-  static BlockNBTComponent create(final List<? extends ComponentLike> children, final Style style, final String nbtPath, final boolean interpret, final @Nullable ComponentLike separator, final Pos pos) {
+  static BlockNBTComponent create(final List<? extends ComponentLike> children, final Style style, final String nbtPath, final boolean interpret, final @Nullable ComponentLike separator, final Pos pos, final boolean plain) {
     return new BlockNBTComponentImpl(
       ComponentLike.asComponents(children, IS_NOT_EMPTY),
       requireNonNull(style, "style"),
       requireNonNull(nbtPath, "nbtPath"),
       interpret,
       ComponentLike.unbox(separator),
-      requireNonNull(pos, "pos")
+      requireNonNull(pos, "pos"),
+      plain
     );
   }
 
   @Override
   public BlockNBTComponent nbtPath(final String nbtPath) {
     if (Objects.equals(this.nbtPath, nbtPath)) return this;
-    return create(this.children, this.style, nbtPath, this.interpret, this.separator, this.pos);
+    return create(this.children, this.style, nbtPath, this.interpret, this.separator, this.pos, this.plain);
   }
 
   @Override
   public BlockNBTComponent interpret(final boolean interpret) {
     if (this.interpret == interpret) return this;
-    return create(this.children, this.style, this.nbtPath, interpret, this.separator, this.pos);
+    checkInterpretPlainState(interpret, this.plain);
+    return create(this.children, this.style, this.nbtPath, interpret, this.separator, this.pos, this.plain);
+  }
+
+  @Override
+  public BlockNBTComponent plain(final boolean plain) {
+    if (this.plain == plain) return this;
+    checkInterpretPlainState(this.interpret, plain);
+    return create(this.children, this.style, this.nbtPath, this.interpret, this.separator, this.pos, plain);
   }
 
   @Override
   public BlockNBTComponent separator(final @Nullable ComponentLike separator) {
-    return create(this.children, this.style, this.nbtPath, this.interpret, separator, this.pos);
+    return create(this.children, this.style, this.nbtPath, this.interpret, separator, this.pos, this.plain);
   }
 
   @Override
   public BlockNBTComponent pos(final Pos pos) {
-    return create(this.children, this.style, this.nbtPath, this.interpret, this.separator, pos);
+    return create(this.children, this.style, this.nbtPath, this.interpret, this.separator, pos, this.plain);
   }
 
   @Override
   public BlockNBTComponent children(final List<? extends ComponentLike> children) {
-    return create(children, this.style, this.nbtPath, this.interpret, this.separator, this.pos);
+    return create(children, this.style, this.nbtPath, this.interpret, this.separator, this.pos, this.plain);
   }
 
   @Override
   public BlockNBTComponent style(final Style style) {
-    return create(this.children, style, this.nbtPath, this.interpret, this.separator, this.pos);
+    return create(this.children, style, this.nbtPath, this.interpret, this.separator, this.pos, this.plain);
   }
 
   @Override
@@ -108,7 +119,7 @@ public Builder pos(final Pos pos) {
     public BlockNBTComponent build() {
       if (this.nbtPath == null) throw new IllegalStateException("nbt path must be set");
       if (this.pos == null) throw new IllegalStateException("pos must be set");
-      return create(this.children, this.buildStyle(), this.nbtPath, this.interpret, this.separator, this.pos);
+      return create(this.children, this.buildStyle(), this.nbtPath, this.interpret, this.separator, this.pos, this.plain);
     }
   }
 

api/src/main/java/net/kyori/adventure/text/Component.java

@@ -326,7 +326,7 @@ static BlockNBTComponent blockNBT(final String nbtPath, final boolean interpret,
    */
   @Contract(value = "_, _, _, _ -> new", pure = true)
   static BlockNBTComponent blockNBT(final String nbtPath, final boolean interpret, final @Nullable ComponentLike separator, final BlockNBTComponent.Pos pos) {
-    return BlockNBTComponentImpl.create(List.of(), Style.empty(), nbtPath, interpret, separator, pos);
+    return BlockNBTComponentImpl.create(List.of(), Style.empty(), nbtPath, interpret, separator, pos, NBTComponent.PLAIN_DEFAULT);
   }
 
   /*
@@ -753,7 +753,7 @@ static StorageNBTComponent storageNBT(final String nbtPath, final boolean interp
    */
   @Contract(value = "_, _, _, _ -> new", pure = true)
   static StorageNBTComponent storageNBT(final String nbtPath, final boolean interpret, final @Nullable ComponentLike separator, final Key storage) {
-    return StorageNBTComponentImpl.create(List.of(), Style.empty(), nbtPath, interpret, separator, storage);
+    return StorageNBTComponentImpl.create(List.of(), Style.empty(), nbtPath, interpret, separator, storage, NBTComponent.PLAIN_DEFAULT);
   }
 
   /*

api/src/main/java/net/kyori/adventure/text/EntityNBTComponentImpl.java

@@ -29,57 +29,68 @@
 import org.jspecify.annotations.Nullable;
 
 import static java.util.Objects.requireNonNull;
+import static net.kyori.adventure.text.AbstractNBTComponentBuilder.checkInterpretPlainState;
 
 record EntityNBTComponentImpl(
   List<Component> children,
   Style style,
   String nbtPath,
   boolean interpret,
   Component separator,
-  String selector
+  String selector,
+  boolean plain
 ) implements EntityNBTComponent {
-  static EntityNBTComponent create(final List<? extends ComponentLike> children, final Style style, final String nbtPath, final boolean interpret, final @Nullable ComponentLike separator, final String selector) {
+  static EntityNBTComponent create(final List<? extends ComponentLike> children, final Style style, final String nbtPath, final boolean interpret, final @Nullable ComponentLike separator, final String selector, final boolean plain) {
     return new EntityNBTComponentImpl(
       ComponentLike.asComponents(children, IS_NOT_EMPTY),
       requireNonNull(style, "style"),
       requireNonNull(nbtPath, "nbtPath"),
       interpret,
       ComponentLike.unbox(separator),
-      requireNonNull(selector, "selector")
+      requireNonNull(selector, "selector"),
+      plain
     );
   }
 
   @Override
   public EntityNBTComponent nbtPath(final String nbtPath) {
     if (Objects.equals(this.nbtPath, nbtPath)) return this;
-    return create(this.children, this.style, nbtPath, this.interpret, this.separator, this.selector);
+    return create(this.children, this.style, nbtPath, this.interpret, this.separator, this.selector, this.plain);
   }
 
   @Override
   public EntityNBTComponent interpret(final boolean interpret) {
     if (this.interpret == interpret) return this;
-    return create(this.children, this.style, this.nbtPath, interpret, this.separator, this.selector);
+    checkInterpretPlainState(interpret, this.plain);
+    return create(this.children, this.style, this.nbtPath, interpret, this.separator, this.selector, this.plain);
+  }
+
+  @Override
+  public EntityNBTComponent plain(final boolean plain) {
+    if (this.plain == plain) return this;
+    checkInterpretPlainState(this.interpret, plain);
+    return create(this.children, this.style, this.nbtPath, this.interpret, this.separator, this.selector, plain);
   }
 
   @Override
   public EntityNBTComponent separator(final @Nullable ComponentLike separator) {
-    return create(this.children, this.style, this.nbtPath, this.interpret, separator, this.selector);
+    return create(this.children, this.style, this.nbtPath, this.interpret, separator, this.selector, this.plain);
   }
 
   @Override
   public EntityNBTComponent selector(final String selector) {
     if (Objects.equals(this.selector, selector)) return this;
-    return create(this.children, this.style, this.nbtPath, this.interpret, this.separator, selector);
+    return create(this.children, this.style, this.nbtPath, this.interpret, this.separator, selector, this.plain);
   }
 
   @Override
   public EntityNBTComponent children(final List<? extends ComponentLike> children) {
-    return create(children, this.style, this.nbtPath, this.interpret, this.separator, this.selector);
+    return create(children, this.style, this.nbtPath, this.interpret, this.separator, this.selector, this.plain);
   }
 
   @Override
   public EntityNBTComponent style(final Style style) {
-    return create(this.children, style, this.nbtPath, this.interpret, this.separator, this.selector);
+    return create(this.children, style, this.nbtPath, this.interpret, this.separator, this.selector, this.plain);
   }
 
   @Override
@@ -108,7 +119,7 @@ public Builder selector(final String selector) {
     public EntityNBTComponent build() {
       if (this.nbtPath == null) throw new IllegalStateException("nbt path must be set");
       if (this.selector == null) throw new IllegalStateException("selector must be set");
-      return create(this.children, this.buildStyle(), this.nbtPath, this.interpret, this.separator, this.selector);
+      return create(this.children, this.buildStyle(), this.nbtPath, this.interpret, this.separator, this.selector, this.plain);
     }
   }
 }

api/src/main/java/net/kyori/adventure/text/NBTComponent.java

@@ -37,6 +37,8 @@
  *   <dd>a path to specify which parts of the nbt you want displayed(<a href="https://minecraft.wiki/w/NBT_path_format#Examples">examples</a>).</dd>
  *   <dt>interpret</dt>
  *   <dd>a boolean telling adventure if the fetched NBT value should be parsed as JSON</dd>
+ *   <dt>plain</dt>
+ *   <dd>a boolean telling adventure if the fetched NBT value should be pretty-printed without styling</dd>
  * </dl>
  *
  * <p>This component is rendered serverside and can therefore receive platform-defined
@@ -55,6 +57,13 @@ public sealed interface NBTComponent<C extends NBTComponent<C>> extends Componen
    */
   boolean INTERPRET_DEFAULT = false;
 
+  /**
+   * The default value for {@link #plain()}.
+   *
+   * @since 5.0.0
+   */
+  boolean PLAIN_DEFAULT = false;
+
   /**
    * Gets the NBT path.
    *
@@ -76,6 +85,8 @@ public sealed interface NBTComponent<C extends NBTComponent<C>> extends Componen
   /**
    * Gets if we should be interpreting.
    *
+   * <p>This cannot be {@code true} if {@link #plain()} is also {@code true}.</p>
+   *
    * @return if we should be interpreting
    * @since 4.0.0
    */
@@ -84,8 +95,11 @@ public sealed interface NBTComponent<C extends NBTComponent<C>> extends Componen
   /**
    * Sets if we should be interpreting.
    *
+   * <p>This cannot be {@code true} if {@link #plain()} is also {@code true}.</p>
+   *
    * @param interpret if we should be interpreting.
    * @return an NBT component
+   * @throws IllegalArgumentException if set to {@code true} and {@link #plain()} is also {@code true}
    * @since 4.0.0
    */
   @Contract(pure = true)
@@ -103,11 +117,35 @@ public sealed interface NBTComponent<C extends NBTComponent<C>> extends Componen
    * Sets the separator.
    *
    * @param separator the separator
-   * @return the separator
+   * @return an NBT component
    * @since 4.8.0
    */
   C separator(final @Nullable ComponentLike separator);
 
+  /**
+   * Gets if styling should be removed from pretty-printed NBT.
+   *
+   * <p>This cannot be {@code true} if {@link #interpret()} is also {@code true}.</p>
+   *
+   * @return if styling should be removed when pretty-printed
+   * @since 5.0.0
+   * @sinceMinecraft 26.1
+   */
+  boolean plain();
+
+  /**
+   * Sets if styling should be removed from pretty-printed NBT.
+   *
+   * <p>This cannot be {@code true} if {@link #interpret()} is also {@code true}.</p>
+   *
+   * @param plain if styling should be removed when pretty-printed
+   * @return an NBT component
+   * @throws IllegalArgumentException if set to {@code true} and {@link #interpret()} is also {@code true}
+   * @since 5.0.0
+   * @sinceMinecraft 26.1
+   */
+  C plain(final boolean plain);
+
   @Override
   NBTComponentBuilder<C, ? extends NBTComponentBuilder<C, ?>> toBuilder();
 }

api/src/main/java/net/kyori/adventure/text/NBTComponentBuilder.java

@@ -51,8 +51,11 @@ public sealed interface NBTComponentBuilder<C extends NBTComponent<C>, B extends
   /**
    * Sets whether to interpret.
    *
+   * <p>This cannot be {@code true} if {@link #plain(boolean)} is also {@code true}.</p>
+   *
    * @param interpret if we should be interpreting
    * @return this builder
+   * @throws IllegalArgumentException if set to {@code true} and {@link #plain(boolean)} is also {@code true}
    * @since 4.0.0
    */
   @Contract("_ -> this")
@@ -67,4 +70,17 @@ public sealed interface NBTComponentBuilder<C extends NBTComponent<C>, B extends
    */
   @Contract("_ -> this")
   B separator(final @Nullable ComponentLike separator);
+
+  /**
+   * Sets if styling should be removed from pretty-printed NBT.
+   *
+   * <p>This cannot be {@code true} if {@link #interpret(boolean)} is also {@code true}.</p>
+   *
+   * @param plain if styling should be removed when pretty-printed
+   * @return this builder
+   * @throws IllegalArgumentException if set to {@code true} and {@link #interpret(boolean)} is also {@code true}
+   * @since 5.0.0
+   * @sinceMinecraft 26.1
+   */
+  B plain(final boolean plain);
 }