Implement new sound system (#3880)

Co-authored-by: TheBusyBiscuit <[email protected]> Co-authored-by: TheBusyBiscuit <[email protected]>
Slimefun · Jun 29, 2023 · f0ac184 · f0ac184
1 parent 811933b
commit f0ac184
Show file tree

Hide file tree

Showing 73 changed files with 316 additions and 283 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -38,8 +38,10 @@
 ## Release Candidate 35 (TBD)
 
 #### Additions
+* Added `sounds.yml` file to configure sound effects for Slimefun
 
 #### Changes
+* Moved all sound effects to the new sound system
 
 #### Fixes
 

diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/api/gps/GPSNetwork.java b/src/main/java/io/github/thebusybiscuit/slimefun4/api/gps/GPSNetwork.java
@@ -15,7 +15,6 @@
 import org.bukkit.ChatColor;
 import org.bukkit.Location;
 import org.bukkit.Server;
-import org.bukkit.Sound;
 import org.bukkit.World;
 import org.bukkit.World.Environment;
 import org.bukkit.entity.Player;
@@ -29,6 +28,7 @@
 import io.github.thebusybiscuit.slimefun4.api.geo.ResourceManager;
 import io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem;
 import io.github.thebusybiscuit.slimefun4.api.player.PlayerProfile;
+import io.github.thebusybiscuit.slimefun4.core.services.sounds.SoundEffect;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.implementation.SlimefunItems;
 import io.github.thebusybiscuit.slimefun4.implementation.items.gps.GPSTransmitter;
@@ -257,7 +257,7 @@ public void openWaypointControlPanel(@Nonnull Player p) {
                 menu.addItem(slot, new CustomItemStack(waypoint.getIcon(), waypoint.getName().replace("player:death ", ""), "&8\u21E8 &7World: &f" + l.getWorld().getName(), "&8\u21E8 &7X: &f" + l.getX(), "&8\u21E8 &7Y: &f" + l.getY(), "&8\u21E8 &7Z: &f" + l.getZ(), "", "&8\u21E8 &cClick to delete"));
                 menu.addMenuClickHandler(slot, (pl, s, item, action) -> {
                     profile.removeWaypoint(waypoint);
-                    pl.playSound(pl.getLocation(), Sound.UI_BUTTON_CLICK, 1F, 1F);
+                    SoundEffect.GPS_NETWORK_OPEN_PANEL_SOUND.playFor(p);
 
                     openWaypointControlPanel(pl);
                     return false;
@@ -290,7 +290,7 @@ public void createWaypoint(@Nonnull Player p, @Nonnull Location l) {
             }
 
             Slimefun.getLocalization().sendMessage(p, "gps.waypoint.new", true);
-            p.playSound(p.getLocation(), Sound.BLOCK_NOTE_BLOCK_PLING, 0.5F, 1F);
+            SoundEffect.GPS_NETWORK_CREATE_WAYPOINT.playFor(p);
 
             ChatInput.waitForPlayer(Slimefun.instance(), p, message -> addWaypoint(p, message, l));
         });
@@ -333,7 +333,7 @@ public void addWaypoint(@Nonnull Player p, @Nonnull String name, @Nonnull Locati
 
                     profile.addWaypoint(new Waypoint(profile, id, event.getLocation(), event.getName()));
 
-                    p.playSound(p.getLocation(), Sound.BLOCK_NOTE_BLOCK_PLING, 1F, 1F);
+                    SoundEffect.GPS_NETWORK_ADD_WAYPOINT.playFor(p);
                     Slimefun.getLocalization().sendMessage(p, "gps.waypoint.added", true);
                 }
             });

diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/api/gps/TeleportationManager.java b/src/main/java/io/github/thebusybiscuit/slimefun4/api/gps/TeleportationManager.java
@@ -13,7 +13,6 @@
 import org.bukkit.ChatColor;
 import org.bukkit.Location;
 import org.bukkit.Particle;
-import org.bukkit.Sound;
 import org.bukkit.block.Block;
 import org.bukkit.entity.Player;
 import org.bukkit.potion.PotionEffect;
@@ -22,6 +21,7 @@
 import io.github.bakedlibs.dough.common.ChatColors;
 import io.github.bakedlibs.dough.items.CustomItemStack;
 import io.github.thebusybiscuit.slimefun4.api.player.PlayerProfile;
+import io.github.thebusybiscuit.slimefun4.core.services.sounds.SoundEffect;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.implementation.items.teleporter.Teleporter;
 import io.github.thebusybiscuit.slimefun4.utils.ChestMenuUtils;
@@ -70,8 +70,7 @@ public void openTeleporterGUI(Player p, UUID ownerUUID, Block b) {
     @ParametersAreNonnullByDefault
     public void openTeleporterGUI(Player p, UUID ownerUUID, Block b, int complexity) {
         if (teleporterUsers.add(p.getUniqueId())) {
-            p.playSound(p.getLocation(), Sound.UI_BUTTON_CLICK, 1F, 1F);
-
+            SoundEffect.TELEPORTATION_MANAGER_OPEN_GUI.playFor(p);
             PlayerProfile.fromUUID(ownerUUID, profile -> {
                 ChestMenu menu = new ChestMenu("&3Teleporter");
                 menu.addMenuCloseHandler(pl -> teleporterUsers.remove(pl.getUniqueId()));
@@ -203,8 +202,7 @@ private void updateProgress(UUID uuid, int speed, int progress, Location source,
                 p.sendTitle(ChatColors.color(Slimefun.getLocalization().getMessage(p, "machines.TELEPORTER.teleporting")), ChatColors.color("&b" + progress + "%"), 0, 60, 0);
 
                 source.getWorld().spawnParticle(Particle.PORTAL, source, progress * 2, 0.2F, 0.8F, 0.2F);
-                source.getWorld().playSound(source, Sound.BLOCK_BEACON_AMBIENT, 1F, 0.6F);
-
+                SoundEffect.TELEPORT_UPDATE_SOUND.playFor(p);
                 Slimefun.runSync(() -> updateProgress(uuid, speed, progress + speed, source, destination, resistance), 10L);
             }
         } else {
@@ -229,7 +227,7 @@ private void onTeleport(Player p, Location destination, boolean success, boolean
                 // Spawn some particles for aesthetic reasons.
                 Location loc = new Location(destination.getWorld(), destination.getX(), destination.getY() + 1, destination.getZ());
                 destination.getWorld().spawnParticle(Particle.PORTAL, loc, 200, 0.2F, 0.8F, 0.2F);
-                destination.getWorld().playSound(destination, Sound.BLOCK_BEACON_ACTIVATE, 1F, 1F);
+                SoundEffect.TELEPORT_SOUND.playFor(p);
                 teleporterUsers.remove(p.getUniqueId());
             } else {
                 /*

diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/NestedItemGroup.java b/src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/NestedItemGroup.java
@@ -17,6 +17,7 @@
 import io.github.thebusybiscuit.slimefun4.core.guide.GuideHistory;
 import io.github.thebusybiscuit.slimefun4.core.guide.SlimefunGuide;
 import io.github.thebusybiscuit.slimefun4.core.guide.SlimefunGuideMode;
+import io.github.thebusybiscuit.slimefun4.core.services.sounds.SoundEffect;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.implementation.guide.SurvivalSlimefunGuide;
 import io.github.thebusybiscuit.slimefun4.utils.ChestMenuUtils;
@@ -86,7 +87,7 @@ private void openGuide(Player p, PlayerProfile profile, SlimefunGuideMode mode,
         SurvivalSlimefunGuide guide = (SurvivalSlimefunGuide) Slimefun.getRegistry().getSlimefunGuide(mode);
 
         menu.setEmptySlotsClickable(false);
-        menu.addMenuOpeningHandler(pl -> pl.playSound(pl.getLocation(), guide.getSound(), 1, 1));
+        menu.addMenuOpeningHandler(SoundEffect.GUIDE_BUTTON_CLICK_SOUND::playFor);
         guide.createHeader(p, profile, menu);
 
         menu.addItem(1, new CustomItemStack(ChestMenuUtils.getBackButton(p, "", ChatColor.GRAY + Slimefun.getLocalization().getMessage(p, "guide.back.guide"))));

diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/core/attributes/DamageableItem.java b/src/main/java/io/github/thebusybiscuit/slimefun4/core/attributes/DamageableItem.java
@@ -59,7 +59,7 @@ default void damageItem(@Nonnull Player p, @Nullable ItemStack item) {
 
             ItemMeta meta = item.getItemMeta();
 
-            if (!meta.isUnbreakable()) {
+            if (meta != null && !meta.isUnbreakable()) {
                 Damageable damageable = (Damageable) meta;
 
                 if (damageable.getDamage() >= item.getType().getMaxDurability()) {

diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/core/guide/options/ContributorsMenu.java b/src/main/java/io/github/thebusybiscuit/slimefun4/core/guide/options/ContributorsMenu.java
@@ -6,7 +6,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.bukkit.Sound;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.SkullMeta;
@@ -15,6 +14,7 @@
 import io.github.bakedlibs.dough.common.CommonPatterns;
 import io.github.bakedlibs.dough.items.CustomItemStack;
 import io.github.thebusybiscuit.slimefun4.core.services.github.Contributor;
+import io.github.thebusybiscuit.slimefun4.core.services.sounds.SoundEffect;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.utils.ChatUtils;
 import io.github.thebusybiscuit.slimefun4.utils.ChestMenuUtils;
@@ -36,7 +36,7 @@ public static void open(Player p, int page) {
         ChestMenu menu = new ChestMenu(Slimefun.getLocalization().getMessage(p, "guide.title.credits"));
 
         menu.setEmptySlotsClickable(false);
-        menu.addMenuOpeningHandler(pl -> pl.playSound(pl.getLocation(), Sound.BLOCK_NOTE_BLOCK_HARP, 0.7F, 0.7F));
+        menu.addMenuOpeningHandler(SoundEffect.GUIDE_CONTRIBUTORS_OPEN_SOUND::playFor);
 
         ChestMenuUtils.drawBackground(menu, 0, 2, 3, 4, 5, 6, 7, 8, 45, 47, 48, 49, 50, 51, 53);
 

diff --git a/...main/java/io/github/thebusybiscuit/slimefun4/core/guide/options/PlayerLanguageOption.java b/...main/java/io/github/thebusybiscuit/slimefun4/core/guide/options/PlayerLanguageOption.java
@@ -6,7 +6,6 @@
 
 import org.bukkit.ChatColor;
 import org.bukkit.NamespacedKey;
-import org.bukkit.Sound;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 
@@ -15,6 +14,7 @@
 import io.github.thebusybiscuit.slimefun4.api.SlimefunAddon;
 import io.github.thebusybiscuit.slimefun4.api.events.PlayerLanguageChangeEvent;
 import io.github.thebusybiscuit.slimefun4.core.services.localization.Language;
+import io.github.thebusybiscuit.slimefun4.core.services.sounds.SoundEffect;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.utils.ChatUtils;
 import io.github.thebusybiscuit.slimefun4.utils.ChestMenuUtils;
@@ -79,7 +79,7 @@ private void openLanguageSelection(Player p, ItemStack guide) {
         ChestMenu menu = new ChestMenu(Slimefun.getLocalization().getMessage(p, "guide.title.languages"));
 
         menu.setEmptySlotsClickable(false);
-        menu.addMenuOpeningHandler(pl -> pl.playSound(pl.getLocation(), Sound.BLOCK_NOTE_BLOCK_HARP, 0.7F, 0.7F));
+        menu.addMenuOpeningHandler(SoundEffect.GUIDE_LANGUAGE_OPEN_SOUND::playFor);
 
         for (int i = 0; i < 9; i++) {
             if (i == 1) {

diff --git a/...ain/java/io/github/thebusybiscuit/slimefun4/core/guide/options/SlimefunGuideSettings.java b/...ain/java/io/github/thebusybiscuit/slimefun4/core/guide/options/SlimefunGuideSettings.java
@@ -10,7 +10,6 @@
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
 import org.bukkit.Material;
-import org.bukkit.Sound;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 
@@ -21,6 +20,7 @@
 import io.github.thebusybiscuit.slimefun4.core.services.LocalizationService;
 import io.github.thebusybiscuit.slimefun4.core.services.github.GitHubService;
 import io.github.thebusybiscuit.slimefun4.core.services.localization.Language;
+import io.github.thebusybiscuit.slimefun4.core.services.sounds.SoundEffect;
 import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
 import io.github.thebusybiscuit.slimefun4.utils.ChatUtils;
 import io.github.thebusybiscuit.slimefun4.utils.ChestMenuUtils;
@@ -63,7 +63,7 @@ public static void openSettings(Player p, ItemStack guide) {
         ChestMenu menu = new ChestMenu(Slimefun.getLocalization().getMessage(p, "guide.title.settings"));
 
         menu.setEmptySlotsClickable(false);
-        menu.addMenuOpeningHandler(pl -> pl.playSound(pl.getLocation(), Sound.BLOCK_NOTE_BLOCK_HARP, 0.7F, 0.7F));
+        menu.addMenuOpeningHandler(SoundEffect.GUIDE_OPEN_SETTING_SOUND::playFor);
 
         ChestMenuUtils.drawBackground(menu, BACKGROUND_SLOTS);
 

diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/core/services/PermissionsService.java b/src/main/java/io/github/thebusybiscuit/slimefun4/core/services/PermissionsService.java
@@ -1,6 +1,7 @@
 package io.github.thebusybiscuit.slimefun4.core.services;
 
 import java.io.File;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -36,11 +37,12 @@ public PermissionsService(@Nonnull Slimefun plugin) {
         config = new Config(plugin, "permissions.yml");
 
         // @formatter:off
-        config.getConfiguration().options().header(
-            "This file is used to assign permission nodes to items from Slimefun or any of its addons.\n" +
-            "To assign an item a certain permission node you simply have to set the 'permission' attribute\n" +
-            "to your desired permission node.\n" +
-            "You can also customize the text that is displayed when a Player does not have that permission."
+        config.getConfiguration().options().setHeader(Collections.singletonList("""
+            This file is used to assign permission nodes to items from Slimefun or any of its addons.
+            To assign an item a certain permission node you simply have to set the 'permission' attribute
+            to your desired permission node.
+            You can also customize the text that is displayed when a Player does not have that permission.
+            """)
         );
         // @formatter:on