api: clarify the behaviour of setting a null shadow colour

KyoriPowered · Dec 14, 2024 · 2d41dde · 2d41dde
1 parent 60c05c1
commit 2d41dde
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/api/src/main/java/net/kyori/adventure/text/format/StyleSetter.java b/api/src/main/java/net/kyori/adventure/text/format/StyleSetter.java
@@ -77,6 +77,9 @@ public interface StyleSetter<T extends StyleSetter<?>> {
   /**
    * Sets the shadow color.
    *
+   * <p>Setting the color to {@code null} will reset the shadow color to default.
+   * To remove the shadow entirely, use {@link ShadowColor#none()}.</p>
+   *
    * @param argb the color
    * @return an object ({@code T})
    * @since 4.18.0
@@ -86,6 +89,9 @@ public interface StyleSetter<T extends StyleSetter<?>> {
   /**
    * Sets the shadow color if there isn't one set already.
    *
+   * <p>Setting the color to {@code null} will reset the shadow color to default.
+   * To remove the shadow entirely, use {@link ShadowColor#none()}.</p>
+   *
    * @param argb the color
    * @return an object ({@code T})
    * @since 4.18.0