chore: replace NBTSerializerOptions#SHADOW_COLOR_MODE with NBTSerializerOptions#EMIT_SHADOW_COLOR, fix: versioned option state of NBTSerializerOptions serializes shadow color as a list by default

Author: Codestech1

text-serializer-nbt/src/main/java/net/kyori/adventure/text/serializer/nbt/NBTSerializerOptions.java

@@ -39,11 +39,12 @@
 public final class NBTSerializerOptions {
 
   /**
-   * How to emit shadow colour data.
+   * Whether to emit shadow colour data.
    *
    * @since 4.24.0
+   * @sinceMinecraft 1.21.4
    */
-  public static final Option<ShadowColorEmitMode> SHADOW_COLOR_MODE;
+  public static final Option<Boolean> EMIT_SHADOW_COLOR;
 
   /**
    * Control how hover event values should be emitted.
@@ -95,7 +96,7 @@ public final class NBTSerializerOptions {
 
   static {
     final OptionSchema.Mutable schema = OptionSchema.emptySchema();
-    SHADOW_COLOR_MODE = schema.enumOption(key("emit/shadow_color"), ShadowColorEmitMode.class, ShadowColorEmitMode.EMIT_INTEGER);
+    EMIT_SHADOW_COLOR = schema.booleanOption(key("emit/shadow_color"), true);
     EMIT_HOVER_EVENT_TYPE = schema.enumOption(key("emit/hover_value_mode"), HoverEventValueMode.class, HoverEventValueMode.SNAKE_CASE);
     EMIT_CLICK_EVENT_TYPE = schema.enumOption(key("emit/click_value_mode"), ClickEventValueMode.class, ClickEventValueMode.SNAKE_CASE);
     EMIT_DEFAULT_ITEM_HOVER_QUANTITY = schema.booleanOption(key("emit/default_item_hover_quantity"), true);
@@ -106,7 +107,7 @@ public final class NBTSerializerOptions {
     BY_DATA_VERSION = SCHEMA.versionedStateBuilder()
       .version(
         VERSION_23W40A,
-        builder -> builder.value(SHADOW_COLOR_MODE, ShadowColorEmitMode.NONE)
+        builder -> builder.value(EMIT_SHADOW_COLOR, false)
           .value(EMIT_HOVER_EVENT_TYPE, HoverEventValueMode.CAMEL_CASE)
           .value(EMIT_CLICK_EVENT_TYPE, ClickEventValueMode.CAMEL_CASE)
           .value(EMIT_DEFAULT_ITEM_HOVER_QUANTITY, false)
@@ -123,7 +124,7 @@ public final class NBTSerializerOptions {
       )
       .version(
         VERSION_24W44A,
-        builder -> builder.value(SHADOW_COLOR_MODE, ShadowColorEmitMode.EMIT_ARRAY)
+        builder -> builder.value(EMIT_SHADOW_COLOR, true)
       )
       .version(
         VERSION_25W02A,
@@ -217,31 +218,6 @@ public enum ClickEventValueMode {
     BOTH,
   }
 
-  /**
-   * How text shadow colors should be emitted.
-   *
-   * @since 4.24.0
-   * @sinceMinecraft 1.21.4
-   */
-  public enum ShadowColorEmitMode {
-    /**
-     * Do not emit shadow colours.
-     */
-    NONE,
-    /**
-     * Emit as a single packed integer value containing, in order, ARGB bytes.
-     *
-     * @since 4.24.0
-     */
-    EMIT_INTEGER,
-    /**
-     * Emit a colour as 4-element float array of the RGBA components of the colour.
-     *
-     * @since 4.24.0
-     */
-    EMIT_ARRAY
-  }
-
   /**
    * Configure how to emit show item hovers in {@code hoverEvent} (camelCase) fields.
    *

text-serializer-nbt/src/main/java/net/kyori/adventure/text/serializer/nbt/ShadowColorSerializer.java

@@ -24,8 +24,6 @@
 package net.kyori.adventure.text.serializer.nbt;
 
 import net.kyori.adventure.nbt.BinaryTag;
-import net.kyori.adventure.nbt.BinaryTagTypes;
-import net.kyori.adventure.nbt.FloatBinaryTag;
 import net.kyori.adventure.nbt.IntBinaryTag;
 import net.kyori.adventure.nbt.ListBinaryTag;
 import net.kyori.adventure.text.format.ShadowColor;
@@ -55,30 +53,10 @@ private ShadowColorSerializer() {
   }
 
   static @Nullable BinaryTag serialize(final @NotNull ShadowColor color, final @NotNull NBTComponentSerializerImpl serializer) {
-    final NBTSerializerOptions.ShadowColorEmitMode emitMode = serializer.options().value(NBTSerializerOptions.SHADOW_COLOR_MODE);
-    switch (emitMode) {
-      case NONE:
-        return null;
-      case EMIT_INTEGER:
-        return IntBinaryTag.intBinaryTag(color.value());
-      case EMIT_ARRAY:
-        final ListBinaryTag.Builder<FloatBinaryTag> builder = ListBinaryTag.builder(BinaryTagTypes.FLOAT);
-        addShadowColorComponent(builder, color.red());
-        addShadowColorComponent(builder, color.green());
-        addShadowColorComponent(builder, color.blue());
-        addShadowColorComponent(builder, color.alpha());
-        return builder.build();
-      default:
-        // Never called, but needed for proper compilation
-        throw new IllegalArgumentException("Unknown shadow color emit mode: " + emitMode);
-    }
+    return serializer.options().value(NBTSerializerOptions.EMIT_SHADOW_COLOR) ? IntBinaryTag.intBinaryTag(color.value()) : null;
   }
 
   private static int shadowColorComponent(final @NotNull ListBinaryTag tag, final int index) {
     return (int) (tag.getFloat(index) * 0xff);
   }
-
-  private static void addShadowColorComponent(final ListBinaryTag.@NotNull Builder<FloatBinaryTag> builder, final int element) {
-    builder.add(FloatBinaryTag.floatBinaryTag((float) element / 0xff));
-  }
 }

text-serializer-nbt/src/test/java/net/kyori/adventure/text/serializer/nbt/StyleTest.java

@@ -46,6 +46,7 @@
 import static net.kyori.adventure.text.serializer.nbt.SerializerTests.deserializeStyle;
 import static net.kyori.adventure.text.serializer.nbt.SerializerTests.name;
 import static net.kyori.adventure.text.serializer.nbt.SerializerTests.testStyle;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 final class StyleTest {
@@ -117,23 +118,22 @@ void testShadowColorInt() {
   }
 
   @Test
-  void testShadowColorFloats() {
-    testStyle(
-      NBTComponentSerializer.builder()
-        .editOptions(builder -> builder.value(NBTSerializerOptions.SHADOW_COLOR_MODE, NBTSerializerOptions.ShadowColorEmitMode.EMIT_ARRAY))
-        .build(),
+  void testShadowColorFloatList() {
+    assertEquals(
       Style.style(ShadowColor.shadowColor(0x80, 0x40, 0xcc, 0xff)),
-      CompoundBinaryTag.builder()
-        .put(
-          ComponentTreeConstants.SHADOW_COLOR,
-          ListBinaryTag.builder(BinaryTagTypes.FLOAT)
-            .add(FloatBinaryTag.floatBinaryTag(0.5019608f))
-            .add(FloatBinaryTag.floatBinaryTag(0.2509804f))
-            .add(FloatBinaryTag.floatBinaryTag(0.8f))
-            .add(FloatBinaryTag.floatBinaryTag(1f))
-            .build()
-        )
-        .build()
+      deserializeStyle(
+        CompoundBinaryTag.builder()
+          .put(
+            ComponentTreeConstants.SHADOW_COLOR,
+            ListBinaryTag.builder(BinaryTagTypes.FLOAT)
+              .add(FloatBinaryTag.floatBinaryTag(0.5019608f))
+              .add(FloatBinaryTag.floatBinaryTag(0.2509804f))
+              .add(FloatBinaryTag.floatBinaryTag(0.8f))
+              .add(FloatBinaryTag.floatBinaryTag(1f))
+              .build()
+          )
+          .build()
+      )
     );
   }