Merge pull request #40 from SpigotMC/master

[pull] master from SpigotMC:master

Author: pull[bot]

api/pom.xml

@@ -36,6 +36,12 @@
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>net.md-5</groupId>
+            <artifactId>bungeecord-dialog</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
         <dependency>
             <groupId>net.md-5</groupId>
             <artifactId>bungeecord-event</artifactId>

api/src/main/java/net/md_5/bungee/api/connection/ProxiedPlayer.java

@@ -12,6 +12,7 @@
 import net.md_5.bungee.api.Title;
 import net.md_5.bungee.api.chat.BaseComponent;
 import net.md_5.bungee.api.config.ServerInfo;
+import net.md_5.bungee.api.dialog.Dialog;
 import net.md_5.bungee.api.event.ServerConnectEvent;
 import net.md_5.bungee.api.score.Scoreboard;
 import org.jetbrains.annotations.ApiStatus;
@@ -390,4 +391,23 @@ public enum MainHand
      * @return the brand of the client, or null if not received yet
      */
     String getClientBrand();
+
+    /**
+     * Clear the player's open dialog.
+     *
+     * @throws IllegalStateException if the players version is not at least
+     * 1.21.6
+     */
+    @ApiStatus.Experimental
+    void clearDialog();
+
+    /**
+     * Show a dialog to the player.
+     *
+     * @param dialog the dialog to show
+     * @throws IllegalStateException if the players version is not at least
+     * 1.21.6
+     */
+    @ApiStatus.Experimental
+    void showDialog(Dialog dialog);
 }

api/src/main/java/net/md_5/bungee/api/event/CustomClickEvent.java

@@ -0,0 +1,44 @@
+package net.md_5.bungee.api.event;
+
+import java.util.Map;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import net.md_5.bungee.api.connection.ProxiedPlayer;
+import net.md_5.bungee.api.plugin.Cancellable;
+import net.md_5.bungee.api.plugin.Event;
+
+/**
+ * Called after a {@link ProxiedPlayer} runs a custom action from a chat event
+ * or form submission.
+ */
+@Data
+@ToString(callSuper = false)
+@EqualsAndHashCode(callSuper = false)
+public class CustomClickEvent extends Event implements Cancellable
+{
+
+    /**
+     * Map key containing the form action, if available.
+     */
+    public static final String ACTION_KEY = "action";
+    //
+    /**
+     * Player who clicked.
+     */
+    private final ProxiedPlayer player;
+    /**
+     * Custom action ID.
+     */
+    private final String id;
+    /**
+     * Form data, may be null. If a form submission, usually contains a
+     * {@code CustomClickEvent.ACTION_KEY} key with the ID of the relevant
+     * submission action.
+     */
+    private final Map<String, String> data;
+    /**
+     * Cancelled state.
+     */
+    private boolean cancelled;
+}

chat/src/main/java/net/md_5/bungee/api/chat/ClickEvent.java

@@ -4,12 +4,14 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.ToString;
+import org.jetbrains.annotations.ApiStatus;
 
 @Getter
 @ToString
 @EqualsAndHashCode
 @RequiredArgsConstructor
-public final class ClickEvent
+@ApiStatus.NonExtendable
+public class ClickEvent
 {
 
     /**
@@ -52,11 +54,19 @@ public enum Action
          * {@link net.md_5.bungee.api.chat.ClickEvent#value} in a book.
          */
         CHANGE_PAGE,
+        /**
+         * Must use subclass ShowDialogClickEvent.
+         */
+        SHOW_DIALOG,
         /**
          * Copy the string given by
          * {@link net.md_5.bungee.api.chat.ClickEvent#value} into the player's
          * clipboard.
          */
-        COPY_TO_CLIPBOARD
+        COPY_TO_CLIPBOARD,
+        /**
+         * Must use subclass {@link ClickEventCustom}.
+         */
+        CUSTOM,
     }
 }

chat/src/main/java/net/md_5/bungee/api/chat/ClickEventCustom.java

@@ -0,0 +1,30 @@
+package net.md_5.bungee.api.chat;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Click event which sends a custom payload to the server.
+ */
+@Data
+@ToString(callSuper = true)
+@EqualsAndHashCode(callSuper = true)
+public class ClickEventCustom extends ClickEvent
+{
+
+    /**
+     * The custom payload.
+     */
+    private final String payload;
+
+    /**
+     * @param id identifier for the event (lower case, no special characters)
+     * @param payload custom payload
+     */
+    public ClickEventCustom(String id, String payload)
+    {
+        super( ClickEvent.Action.CUSTOM, id );
+        this.payload = payload;
+    }
+}

chat/src/main/java/net/md_5/bungee/api/chat/HoverEvent.java

@@ -13,7 +13,6 @@
 import net.md_5.bungee.api.chat.hover.content.Entity;
 import net.md_5.bungee.api.chat.hover.content.Item;
 import net.md_5.bungee.api.chat.hover.content.Text;
-import net.md_5.bungee.chat.VersionedComponentSerializer;
 import org.jetbrains.annotations.ApiStatus;
 
 @Getter
@@ -73,22 +72,6 @@ public HoverEvent(Action action, BaseComponent[] value)
         this.legacy = true;
     }
 
-    @Deprecated
-    public BaseComponent[] getValue()
-    {
-        Content content = contents.get( 0 );
-        if ( content instanceof Text && ( (Text) content ).getValue() instanceof BaseComponent[] )
-        {
-            return (BaseComponent[]) ( (Text) content ).getValue();
-        }
-
-        TextComponent component = new TextComponent( VersionedComponentSerializer.getDefault().toString( content ) );
-        return new BaseComponent[]
-        {
-            component
-        };
-    }
-
     /**
      * Adds a content to this hover event.
      *

dialog/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, SpigotMC Pty. Ltd.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dialog/README.md

@@ -0,0 +1,35 @@
+BungeeCord-Dialog
+=================
+
+Highly experimental API, subject to breakage. All contributions welcome, including major refactors/design changes.
+
+Sample Plugin
+-------------
+
+```java
+    private class TestCommand extends Command
+    {
+
+        public TestCommand()
+        {
+            super( "btest" );
+        }
+
+        @Override
+        public void execute(CommandSender sender, String[] args)
+        {
+            ProxiedPlayer player = (ProxiedPlayer) sender;
+
+            Dialog notice = new NoticeDialog( new DialogBase( new ComponentBuilder( "Hello" ).color( ChatColor.RED ).build() ) );
+            player.showDialog( notice );
+
+            notice = new SimpleInputFormDialog(
+                    new DialogBase( new ComponentBuilder( "Hello" ).color( ChatColor.RED ).build() ),
+                    new DialogSubmitAction( "submit", new CustomFormSubmission( "customform" ), new ComponentBuilder( "Submit Button" ).build() ),
+                    new TextInput( "first", new ComponentBuilder( "First" ).build() ),
+                    new TextInput( "second", new ComponentBuilder( "Second" ).build() )
+            );
+            player.sendMessage( new ComponentBuilder( "click me" ).event( new ShowDialogClickEvent( notice ) ).build() );
+        }
+    }
+```

dialog/nb-configuration.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-shared-configuration>
+    <!--
+    This file contains additional configuration written by modules in the NetBeans IDE.
+    The configuration is intended to be shared among all the users of project and
+    therefore it is assumed to be part of version control checkout.
+    Without this configuration present, some functionality in the IDE may be limited or fail altogether.
+    -->
+    <properties xmlns="http://www.netbeans.org/ns/maven-properties-data/1">
+        <!--
+        Properties that influence various parts of the IDE, especially code formatting and the like. 
+        You can copy and paste the single properties, into the pom.xml file and the IDE will pick them up.
+        That way multiple projects can share the same settings (useful for formatting rules for example).
+        Any value defined here will override the pom.xml file value but is only applicable to the current project.
+        -->
+        <org-netbeans-modules-editor-indent.CodeStyle.usedProfile>project</org-netbeans-modules-editor-indent.CodeStyle.usedProfile>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.classDeclBracePlacement>NEW_LINE</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.classDeclBracePlacement>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.otherBracePlacement>NEW_LINE</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.otherBracePlacement>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.methodDeclBracePlacement>NEW_LINE</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.methodDeclBracePlacement>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinMethodCallParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinMethodCallParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinSwitchParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinSwitchParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinCatchParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinCatchParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinTryParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinTryParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinSynchronizedParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinSynchronizedParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinArrayInitBrackets>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinArrayInitBrackets>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinWhileParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinWhileParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinIfParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinIfParens>
+        <org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinForParens>true</org-netbeans-modules-editor-indent.text.x-java.CodeStyle.project.spaceWithinForParens>
+    </properties>
+</project-shared-configuration>

dialog/pom.xml

@@ -0,0 +1,36 @@
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>net.md-5</groupId>
+        <artifactId>bungeecord-parent</artifactId>
+        <version>1.21-R0.3-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <groupId>net.md-5</groupId>
+    <artifactId>bungeecord-dialog</artifactId>
+    <version>1.21-R0.3-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <name>BungeeCord-Dialog</name>
+    <description>Minecraft dialog API intended for use with BungeeCord</description>
+    <licenses>
+        <license>
+            <name>BSD-3-Clause</name>
+            <url>https://github.com/SpigotMC/BungeeCord/blob/master/dialog/LICENSE</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+
+    <dependencies>
+        <dependency>
+            <groupId>net.md-5</groupId>
+            <artifactId>bungeecord-chat</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+</project>