Sound element

Author: Grabsky

src/main/java/cloud/grabsky/dialogs/Dialog.java

@@ -19,6 +19,7 @@
 import cloud.grabsky.dialogs.elements.CommandElement;
 import cloud.grabsky.dialogs.elements.MessageElement;
 import cloud.grabsky.dialogs.elements.PauseElement;
+import cloud.grabsky.dialogs.elements.SoundElement;
 import me.clip.placeholderapi.PlaceholderAPI;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.text.Component;
@@ -29,6 +30,7 @@
 
 import java.util.Collection;
 import java.util.Iterator;
+import java.util.List;
 import java.util.UUID;
 
 import org.jetbrains.annotations.NotNull;
@@ -122,12 +124,29 @@ else if (element instanceof CommandElement commandElement) {
                     // Cancelling task in case Player connection has been reset OR other dialog has been started in the meanwhile.
                     if (isDialogStillValid(target, dialogIdentifier) == false)
                         return;
-                    // Preparing command string.
-                    final String command = (Dialogs.isPlaceholderAPI() == true) ? PlaceholderAPI.setPlaceholders(target, commandElement.value()) : commandElement.value();
+                    // Setting placeholders in commands.
+                    final List<String> commands = (Dialogs.isPlaceholderAPI() == true)
+                            ? commandElement.value().stream().map(command -> PlaceholderAPI.setPlaceholders(target, command)).toList()
+                            : commandElement.value();
                     // Getting the command sender.
                     final CommandSender sender = (commandElement.type() == CommandElement.Type.PLAYER_COMMAND) ? target : plugin.getServer().getConsoleSender();
-                    // Dispatching the command.
-                    plugin.getServer().dispatchCommand(sender, command);
+                    // Dispatching commands.
+                    commands.forEach(command -> plugin.getServer().dispatchCommand(sender, command));
+                });
+                // Calculating "start" time of the next element.
+                nextTaskStartsIn += element.ticksToWait();
+            }
+
+            else if (element instanceof SoundElement soundElement) {
+                // Scheduling a new run task. Command dispatch have to be called on the main thread.
+                plugin.getBedrockScheduler().run(nextTaskStartsIn, (task) -> {
+                    // Cancelling task in case Player connection has been reset OR other dialog has been started in the meanwhile.
+                    if (isDialogStillValid(target, dialogIdentifier) == false)
+                        return;
+                    // Getting the audience.
+                    final Audience audience = (soundElement.audience() == SoundElement.AudienceType.PLAYER) ? target : plugin.getServer();
+                    // Playing sounds.
+                    soundElement.value().forEach(audience::playSound);
                 });
                 // Calculating "start" time of the next element.
                 nextTaskStartsIn += element.ticksToWait();

src/main/java/cloud/grabsky/dialogs/configuration/adapter/DialogElementAdapterFactory.java

@@ -21,6 +21,7 @@
 import cloud.grabsky.dialogs.elements.CommandElement;
 import cloud.grabsky.dialogs.elements.MessageElement;
 import cloud.grabsky.dialogs.elements.PauseElement;
+import cloud.grabsky.dialogs.elements.SoundElement;
 import cloud.grabsky.dialogs.util.Enums;
 import com.squareup.moshi.JsonAdapter;
 import com.squareup.moshi.JsonReader;
@@ -33,6 +34,7 @@
 import java.io.IOException;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Type;
+import java.util.Collections;
 import java.util.List;
 import java.util.Set;
 
@@ -49,6 +51,8 @@ public final class DialogElementAdapterFactory implements JsonAdapter.Factory {
     /* SINGLETON */ public static DialogElementAdapterFactory INSTANCE = new DialogElementAdapterFactory();
 
     private static final Type LIST_OF_CONDITIONS = Types.newParameterizedType(List.class, Condition.class);
+    private static final Type LIST_OF_STRINGS = Types.newParameterizedType(List.class, String.class);
+    private static final Type LIST_OF_SOUNDS = Types.newParameterizedType(List.class, Sound.class);
 
     @Override
     public @Nullable JsonAdapter<DialogElement> create(final @NotNull Type type, final @NotNull Set<? extends Annotation> annotations, final @NotNull Moshi moshi) {
@@ -57,6 +61,8 @@ public final class DialogElementAdapterFactory implements JsonAdapter.Factory {
         // ...
         final var adapter0 = moshi.adapter(Sound.class);
         final var adapter1 = moshi.adapter(LIST_OF_CONDITIONS);
+        final var adapter2 = moshi.adapter(LIST_OF_STRINGS);
+        final var adapter3 = moshi.adapter(LIST_OF_SOUNDS);
         // ...
         return new JsonAdapter<>() {
 
@@ -131,7 +137,42 @@ public final class DialogElementAdapterFactory implements JsonAdapter.Factory {
                             final String name = in.nextName().toLowerCase();
                             // ...
                             switch (name) {
-                                case "value" -> init.value = in.nextString();
+                                case "value" -> {
+                                    if (in.peek() == Token.BEGIN_ARRAY) {
+                                        init.value = (List<String>) adapter2.nullSafe().fromJson(in);
+                                        continue;
+                                    }
+                                    init.value = List.of(in.nextString());
+                                }
+                                case "ticks_to_wait_before_continuing" -> init.ticks_to_wait_before_continuing = in.nextInt();
+                                case "conditions" -> {
+                                    // Parsing the Sound object.
+                                    final @Nullable List<Condition> conditions = (List<Condition>) adapter1.nullSafe().fromJson(in);
+                                    // Skipping when specified as null.
+                                    if (conditions != null) init.conditions = conditions;
+                                }
+                            }
+                        }
+                        // Ending the JSON object.
+                        in.endObject();
+                        // Initializing and returning the value.
+                        yield init.init();
+                    }
+                    case "sound" -> {
+                        final SoundElement.Init init = new SoundElement.Init();
+                        // ...
+                        while (in.hasNext() == true) {
+                            final String name = in.nextName().toLowerCase();
+                            // ...
+                            switch (name) {
+                                case "audience" -> init.audience = Enums.fromName(SoundElement.AudienceType.class, in.nextString());
+                                case "value" -> {
+                                    if (in.peek() == Token.BEGIN_ARRAY) {
+                                        init.value = (List<Sound>) adapter3.nullSafe().fromJson(in);
+                                        continue;
+                                    }
+                                    init.value = Collections.singletonList(adapter0.nullSafe().fromJson(in));
+                                }
                                 case "ticks_to_wait_before_continuing" -> init.ticks_to_wait_before_continuing = in.nextInt();
                                 case "conditions" -> {
                                     // Parsing the Sound object.

src/main/java/cloud/grabsky/dialogs/elements/CommandElement.java

@@ -41,10 +41,10 @@ public class CommandElement implements DialogElement {
     private final CommandElement.Type type;
 
     /**
-     * Command {@link String} to be executed.
+     * List of commands to be executed.
      */
     @Getter(AccessLevel.PUBLIC)
-    private final String value;
+    private final List<String> value;
 
     @Getter(AccessLevel.PUBLIC)
     private final int ticksToWait;
@@ -70,7 +70,7 @@ public static final class Init implements LazyInit<CommandElement> {
         private final @NotNull CommandElement.Type type;
 
         // Nullability cannot be determined because it depends entirely on the end-user.
-        public @UnknownNullability String value;
+        public @UnknownNullability List<String> value;
 
         // Following field(s) have defaults and can be omitted or defined as null by the end-user.
         public @NotNull Integer ticks_to_wait_before_continuing = 1;

src/main/java/cloud/grabsky/dialogs/elements/SoundElement.java

@@ -0,0 +1,92 @@
+/*
+ * Dialogs (https://github.com/Grabsky/Dialogs)
+ *
+ * Copyright (C) 2024  Grabsky <[email protected]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License v3 as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License v3 for more details.
+ */
+package cloud.grabsky.dialogs.elements;
+
+import cloud.grabsky.configuration.util.LazyInit;
+import cloud.grabsky.dialogs.Condition;
+import cloud.grabsky.dialogs.DialogElement;
+import net.kyori.adventure.sound.Sound;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.jetbrains.annotations.ApiStatus.Internal;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.UnknownNullability;
+
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
+
+@Accessors(fluent = true)
+@RequiredArgsConstructor(access = AccessLevel.PUBLIC)
+public final class SoundElement implements DialogElement {
+
+    /**
+     * Audience to forward this message to.
+     */
+    @Getter(AccessLevel.PUBLIC)
+    private final transient AudienceType audience;
+
+    /**
+     * List of sounds to be played.
+     */
+    @Getter(AccessLevel.PUBLIC)
+    private final List<Sound> value;
+
+    @Getter(AccessLevel.PUBLIC)
+    private final int ticksToWait;
+
+    @Getter(AccessLevel.PUBLIC)
+    private final List<Condition> conditions;
+
+
+    /**
+     * Defines support audience types to forward the {@link SoundElement} to.
+     */
+    public enum AudienceType {
+        PLAYER, SERVER;
+    }
+
+
+    @Internal
+    @RequiredArgsConstructor(access = AccessLevel.PUBLIC)
+    // NOTE: Field names does not follow Java Naming Convention to provide 1:1 mapping with JSON keys.
+    public static final class Init implements LazyInit<SoundElement> {
+
+        // Following field(s) have defaults and can be omitted or defined as null by the end-user.
+        public @NotNull AudienceType audience = AudienceType.PLAYER;
+
+        // Nullability cannot be determined because it depends entirely on the end-user.
+        public @UnknownNullability List<Sound> value;
+
+        // Following field(s) have defaults and can be omitted or defined as null by the end-user.
+        public @NotNull Integer ticks_to_wait_before_continuing = 1;
+        public @NotNull List<Condition> conditions = Collections.emptyList();
+
+
+        @Override
+        public @NotNull SoundElement init() throws IllegalStateException {
+            // Throwing an error in case "value" field is invalid.
+            if (value == null)
+                throw new IllegalStateException("Field \"value\" is required but is either null or has not been found.");
+            // Creating and returning element.
+            return new SoundElement(audience, value, ticks_to_wait_before_continuing, conditions);
+        }
+
+    }
+
+}