refactor: move sound methods and refactor sound structure (#292)

Author: Snabeldier

src/main/java/minevalley/core/api/audio/SoundReceiver.java

@@ -0,0 +1,28 @@
+package minevalley.core.api.audio;
+
+import net.kyori.adventure.sound.Sound;
+import org.bukkit.Location;
+
+import javax.annotation.Nonnull;
+
+@SuppressWarnings("unused")
+public interface SoundReceiver {
+
+    /**
+     * Plays a specific sound.
+     *
+     * @param sound sound to be played
+     * @throws IllegalArgumentException if sound is null or an empty string
+     */
+    void playSound(@Nonnull Sound.Type sound) throws IllegalArgumentException;
+
+    /**
+     * Plays a specific sound.
+     *
+     * @param sound    sound to be played
+     * @param location location where the sound will be played
+     * @param spatial  defines whether the sound should be spatial
+     * @throws IllegalArgumentException if sound or location is null, or the location is not in the same world as the user
+     */
+    void playSound(@Nonnull Sound.Type sound, @Nonnull Location location, boolean spatial) throws IllegalArgumentException;
+}

src/main/java/minevalley/core/api/enums/sounds/Sound.java renamed to src/main/java/minevalley/core/api/audio/sounds/SystemSound.java

@@ -1,12 +1,16 @@
-package minevalley.core.api.enums.sounds;
+package minevalley.core.api.audio.sounds;
 
 import lombok.AccessLevel;
-import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import net.kyori.adventure.key.Key;
+import net.kyori.adventure.sound.Sound;
+import org.bukkit.NamespacedKey;
 
-@Getter
+import javax.annotation.Nonnull;
+
+@SuppressWarnings("unused")
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
-public enum Sound {
+public enum SystemSound implements Sound.Type {
 
     /**
      * Used to get the user's attention.
@@ -23,5 +27,10 @@ public enum Sound {
      */
     NOTIFICATION_ERROR("notification_error");
 
-    private final String name;
+    private final String key;
+
+    @Override
+    public @Nonnull Key key() {
+        return new NamespacedKey("minevalley", key);
+    }
 }

src/main/java/minevalley/core/api/enums/sounds/AmbientSound.java

@@ -1,11 +1,12 @@
 package minevalley.core.api.server;
 
+import minevalley.core.api.audio.SoundReceiver;
 import minevalley.core.api.messaging.MessageReceiver;
 
 import javax.annotation.Nonnull;
 
 @SuppressWarnings("unused")
-public interface Server extends MessageReceiver {
+public interface Server extends MessageReceiver, SoundReceiver {
 
     /**
      * Get the server type.

src/main/java/minevalley/core/api/server/Server.java

@@ -1,12 +1,13 @@
 package minevalley.core.api.team;
 
+import minevalley.core.api.audio.SoundReceiver;
 import minevalley.core.api.messaging.MessageReceiver;
 import minevalley.core.api.messaging.instruction.Instruction;
 
 import javax.annotation.Nonnull;
 
 @SuppressWarnings("unused")
-public interface Team extends MessageReceiver {
+public interface Team extends MessageReceiver, SoundReceiver {
 
     /**
      * Send a message to the team chat.

src/main/java/minevalley/core/api/team/Team.java

@@ -0,0 +1,7 @@
+package minevalley.core.api.users;
+
+public enum Ambient {
+
+    NONE,
+    TRAIN_STATION
+}

src/main/java/minevalley/core/api/users/Ambient.java

@@ -1,9 +1,8 @@
 package minevalley.core.api.users;
 
+import minevalley.core.api.audio.SoundReceiver;
 import minevalley.core.api.economy.AccountUser;
 import minevalley.core.api.economy.BankAccount;
-import minevalley.core.api.enums.sounds.AmbientSound;
-import minevalley.core.api.enums.sounds.Sound;
 import minevalley.core.api.messaging.MessageReceiver;
 import minevalley.core.api.messaging.instruction.Instruction;
 import minevalley.core.api.regions.utils.PlayerLocation;
@@ -31,7 +30,7 @@
 import java.util.function.Consumer;
 
 @SuppressWarnings("unused")
-public interface OnlineUser extends User, MessageReceiver {
+public interface OnlineUser extends User, MessageReceiver, SoundReceiver {
 
     /**
      * Gets the player object of this user.
@@ -137,60 +136,22 @@ void input(@Nonnull String text, @Nonnull Instruction instruction, @Nonnull Cons
     @Contract(pure = true)
     McVersion getVersion();
 
-    // Sounds
-
-    /**
-     * Plays a specific sound.
-     *
-     * @param sound sound to be played
-     * @throws IllegalArgumentException if sound is null or an empty string
-     */
-    void playSound(@Nonnull String sound) throws IllegalArgumentException;
-
-    /**
-     * Plays a specific sound.
-     *
-     * @param sound sound to be played
-     * @throws IllegalArgumentException if sound is null
-     */
-    void playSound(@Nonnull Sound sound) throws IllegalArgumentException;
-
-    /**
-     * Plays a specific sound.
-     *
-     * @param sound    sound to be played
-     * @param location location where the sound will be played
-     * @param spatial  defines whether the sound should be spatial
-     * @throws IllegalArgumentException if sound or location is null, or the location is not in the same world as the user
-     */
-    void playSound(@Nonnull Sound sound, @Nonnull Location location, boolean spatial) throws IllegalArgumentException;
-
-    /**
-     * Plays a specific sound.
-     *
-     * @param sound    sound to be played
-     * @param location location where the sound will be played
-     * @param spatial  defines whether the sound should be spatial
-     * @throws IllegalArgumentException if sound or location is null, or the location is not in the same world as the user
-     */
-    void playSound(@Nonnull String sound, @Nonnull Location location, boolean spatial) throws IllegalArgumentException;
-
     /**
      * Gets the ambient this user is currently hearing
      *
      * @return ambient this user is hearing
      */
     @Nonnull
     @Contract(pure = true)
-    AmbientSound getAmbient();
+    Ambient getAmbient();
 
     /**
      * Sets the ambient this user is hearing
      *
      * @param ambient ambient to be set
      * @throws IllegalArgumentException if ambient is null
      */
-    void setAmbient(@Nonnull AmbientSound ambient) throws IllegalArgumentException;
+    void setAmbient(@Nonnull Ambient ambient) throws IllegalArgumentException;
 
     /**
      * Starts the credits sequence.