Self emitter changes, javadoc changes

KyoriPowered · Jun 7, 2021 · 540e39b · 540e39b
1 parent e279a0f
commit 540e39b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/api/src/main/java/net/kyori/adventure/audience/Audience.java b/api/src/main/java/net/kyori/adventure/audience/Audience.java
@@ -476,12 +476,12 @@ default void playSound(final @NotNull Sound sound, final double x, final double
    *   In this case the sound will be played at the location of the emitter and will not follow them.
    * </p>
    *
+   * <p>To play a sound that follows the recipient, use {@link Sound.Emitter#self()}.</p>
+   *
    * <p><b>Note</b>: Due to <a href="https://bugs.mojang.com/browse/MC-138832">MC-138832</a>, the volume and pitch may be ignored when using this method.</p>
    *
    * @param sound a sound
    * @param emitter an emitter
-   * @see Sound
-   * @see Sound.Emitter
    * @since 4.8.0
    */
   default void playSound(final @NotNull Sound sound, final Sound.@NotNull Emitter emitter) {

diff --git a/api/src/main/java/net/kyori/adventure/sound/Sound.java b/api/src/main/java/net/kyori/adventure/sound/Sound.java
@@ -263,7 +263,7 @@ interface Emitter {
      * @since 4.8.0
      */
     static @NotNull Emitter self() {
-      return SoundImpl.SELF;
+      return SoundImpl.EMITTER_SELF;
     }
   }
 }
diff --git a/api/src/main/java/net/kyori/adventure/sound/SoundImpl.java b/api/src/main/java/net/kyori/adventure/sound/SoundImpl.java
@@ -31,7 +31,12 @@
 import org.jetbrains.annotations.Nullable;
 
 abstract class SoundImpl implements Sound {
-  static final Emitter SELF = new Emitter() {};
+  static final Emitter EMITTER_SELF = new Emitter() {
+    @Override
+    public String toString() {
+      return "SelfSoundEmitter";
+    }
+  };
 
   private final Source source;
   private final float volume;