GH-99 Add gui sound click feature

Author: imDMK

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/configuration/serializer/SoundSerializer.java

@@ -0,0 +1,28 @@
+package com.github.imdmk.spenttime.configuration.serializer;
+
+import eu.okaeri.configs.schema.GenericsDeclaration;
+import eu.okaeri.configs.serdes.DeserializationData;
+import eu.okaeri.configs.serdes.ObjectSerializer;
+import eu.okaeri.configs.serdes.SerializationData;
+import org.bukkit.NamespacedKey;
+import org.bukkit.Registry;
+import org.bukkit.Sound;
+import org.jetbrains.annotations.NotNull;
+
+public class SoundSerializer implements ObjectSerializer<Sound> {
+
+    @Override
+    public boolean supports(@NotNull Class<? super Sound> type) {
+        return Sound.class.isAssignableFrom(type);
+    }
+
+    @Override
+    public void serialize(@NotNull Sound sound, @NotNull SerializationData data, @NotNull GenericsDeclaration generics) {
+        data.setValue(sound.getKeyOrThrow().getKey(), String.class);
+    }
+
+    @Override
+    public Sound deserialize(@NotNull DeserializationData data, @NotNull GenericsDeclaration generics) {
+        return Registry.SOUNDS.get(NamespacedKey.minecraft(data.getValue(String.class)));
+    }
+}

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/feature/gui/AbstractGui.java

@@ -1,5 +1,6 @@
 package com.github.imdmk.spenttime.feature.gui;
 
+import com.github.imdmk.spenttime.feature.gui.configuration.GuiConfiguration;
 import com.github.imdmk.spenttime.feature.gui.configuration.item.ItemGuiConfiguration;
 import com.github.imdmk.spenttime.gui.GuiType;
 import com.github.imdmk.spenttime.task.TaskScheduler;
@@ -9,6 +10,7 @@
 import dev.triumphteam.gui.guis.Gui;
 import dev.triumphteam.gui.guis.GuiItem;
 import dev.triumphteam.gui.guis.PaginatedGui;
+import org.bukkit.entity.Player;
 import org.bukkit.event.inventory.InventoryClickEvent;
 import org.jetbrains.annotations.NotNull;
 
@@ -30,6 +32,20 @@ public AbstractGui(
         this.taskScheduler = Objects.requireNonNull(taskScheduler, "task scheduler cannot be null");
     }
 
+    protected void playSoundIfEnabled(BaseGui gui, Player player, GuiConfiguration.GuiSoundConfiguration soundConfiguration) {
+        if (!soundConfiguration.enabled) {
+            return;
+        }
+
+        gui.setDefaultClickAction(event -> {
+            if (event.getCurrentItem() == null) {
+                return;
+            }
+
+            player.playSound(player, soundConfiguration.sound, soundConfiguration.volume, soundConfiguration.pitch);
+        });
+    }
+
     protected BaseGuiBuilder<?, ?> createGuiBuilder(@NotNull GuiType type) {
         return switch (type) {
             case STANDARD -> Gui.gui();

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/feature/gui/ParameterizedGui.java

@@ -13,6 +13,8 @@ default void prepareBorderItems(@NotNull BaseGui gui) {}
 
     default void prepareNavigationItems(@NotNull BaseGui gui, @NotNull Player viewer, @NotNull T parameter) {}
 
+    default void defaultClickAction(@NotNull BaseGui gui, @NotNull Player viewer) {}
+
     void prepareItems(@NotNull BaseGui gui, @NotNull Player viewer, @NotNull T parameter);
 
     default void open(@NotNull Player viewer, @NotNull T parameter) {
@@ -21,6 +23,7 @@ default void open(@NotNull Player viewer, @NotNull T parameter) {
         this.prepareBorderItems(gui);
         this.prepareItems(gui, viewer, parameter);
         this.prepareNavigationItems(gui, viewer, parameter);
+        this.defaultClickAction(gui, viewer);
 
         gui.open(viewer);
     }

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/feature/gui/SimpleGui.java

@@ -13,6 +13,8 @@ default void prepareBorderItems(@NotNull BaseGui gui) {}
 
     default void prepareNavigationItems(@NotNull BaseGui gui, @NotNull Player viewer) {}
 
+    default void defaultClickAction(@NotNull BaseGui gui, @NotNull Player viewer) {}
+
     void prepareItems(@NotNull BaseGui gui, @NotNull Player viewer);
 
     default void open(@NotNull Player viewer) {
@@ -21,6 +23,7 @@ default void open(@NotNull Player viewer) {
         this.prepareBorderItems(gui);
         this.prepareItems(gui, viewer);
         this.prepareNavigationItems(gui, viewer);
+        this.defaultClickAction(gui, viewer);
 
         gui.open(viewer);
     }

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/feature/gui/configuration/GuiConfiguration.java

@@ -4,6 +4,7 @@
 import com.github.imdmk.spenttime.configuration.serializer.ComponentSerializer;
 import com.github.imdmk.spenttime.configuration.serializer.ItemMetaSerializer;
 import com.github.imdmk.spenttime.configuration.serializer.ItemStackSerializer;
+import com.github.imdmk.spenttime.configuration.serializer.SoundSerializer;
 import com.github.imdmk.spenttime.feature.gui.configuration.item.ItemGui;
 import com.github.imdmk.spenttime.feature.gui.configuration.item.ItemGuiConfiguration;
 import com.github.imdmk.spenttime.feature.gui.configuration.item.ItemGuiSerializer;
@@ -14,6 +15,7 @@
 import eu.okaeri.configs.serdes.OkaeriSerdesPack;
 import net.kyori.adventure.text.Component;
 import org.bukkit.Material;
+import org.bukkit.Sound;
 import org.bukkit.event.inventory.ClickType;
 import org.jetbrains.annotations.NotNull;
 
@@ -97,13 +99,28 @@ public static class ConfirmationGuiConfiguration extends OkaeriConfig {
 
     public ItemGuiConfiguration items = new ItemGuiConfiguration();
 
+    public GuiSoundConfiguration sound = new GuiSoundConfiguration();
+
+    public static class GuiSoundConfiguration extends OkaeriConfig {
+
+        public boolean enabled = true;
+
+        @Comment("# List of available sounds: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html")
+        public Sound sound = Sound.ENTITY_EXPERIENCE_ORB_PICKUP;
+
+        public float volume = 1.1F;
+
+        public float pitch = 1F;
+    }
+
     @Override
     public @NotNull OkaeriSerdesPack getSerdesPack() {
         return registry -> {
             registry.register(new ComponentSerializer());
             registry.register(new ItemMetaSerializer());
             registry.register(new ItemStackSerializer());
             registry.register(new ItemGuiSerializer());
+            registry.register(new SoundSerializer());
         };
     }
 

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/feature/gui/configuration/item/ItemGuiConfiguration.java

@@ -18,7 +18,7 @@ public class ItemGuiConfiguration extends OkaeriConfig {
 
     @Comment({"# Exit item", "# Set to -1 to disable"})
     public ItemGui exitItem = ItemGui.builder()
-            .material(Material.ARROW)
+            .material(Material.ACACIA_BUTTON)
             .name("<red>Quit")
             .lore(" ")
             .slot(49)

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/feature/gui/implementation/ConfirmationGui.java

@@ -64,6 +64,11 @@ public void prepareItems(@NotNull BaseGui gui, @NotNull Player viewer, @NotNull
         gui.setItem(cancelItem.slot(), cancelGuiItem);
     }
 
+    @Override
+    public void defaultClickAction(@NotNull BaseGui gui, @NotNull Player viewer) {
+        this.playSoundIfEnabled(gui, viewer, this.guiConfiguration.sound);
+    }
+
     @Override
     public @NotNull String getIdentifier() {
         return GUI_IDENTIFIER;

spenttime-plugin/src/main/java/com/github/imdmk/spenttime/user/gui/SpentTimeTopGui.java

@@ -103,6 +103,11 @@ public void prepareItems(@NotNull BaseGui gui, @NotNull Player viewer, @NotNull
         }
     }
 
+    @Override
+    public void defaultClickAction(@NotNull BaseGui gui, @NotNull Player viewer) {
+        this.playSoundIfEnabled(gui, viewer, this.guiConfiguration.sound);
+    }
+
     private Formatter createFormatter(User user, int position) {
         return new Formatter()
                 .placeholder("{PLAYER}", user.getName())