Merge pull request #1246 from KyoriPowered/feature/clear-dialog

feature(api): Add a method to close an open dialog

Author: kezz

api/src/main/java/net/kyori/adventure/audience/Audience.java

@@ -878,4 +878,16 @@ default void clearResourcePacks() {
    */
   default void showDialog(final @NotNull DialogLike dialog) {
   }
+
+  /**
+   * Closes the dialog that is currently being shown to this audience, if any.
+   *
+   * <p>This will return the user to the previous dialog if one was opened from the
+   * current dialog.</p>
+   *
+   * @since 4.24.0
+   * @sinceMinecraft 1.21.6
+   */
+  default void closeDialog() {
+  }
 }

api/src/main/java/net/kyori/adventure/audience/ForwardingAudience.java

@@ -227,6 +227,11 @@ default void showDialog(final @NotNull DialogLike dialog) {
     for (final Audience audience : this.audiences()) audience.showDialog(dialog);
   }
 
+  @Override
+  default void closeDialog() {
+    for (final Audience audience : this.audiences()) audience.closeDialog();
+  }
+
   /**
    * An audience that forwards everything to a single other audience.
    *
@@ -414,5 +419,10 @@ default void clearResourcePacks() {
     default void showDialog(final @NotNull DialogLike dialog) {
       this.audience().showDialog(dialog);
     }
+
+    @Override
+    default void closeDialog() {
+      this.audience().closeDialog();
+    }
   }
 }