Add helper to get root index help topic (#415)

Incendo · Dec 11, 2022 · a53b321 · a53b321
1 parent ae0150f
commit a53b321
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/cloud-core/src/main/java/cloud/commandframework/CommandHelpHandler.java b/cloud-core/src/main/java/cloud/commandframework/CommandHelpHandler.java
@@ -112,6 +112,19 @@ public final class CommandHelpHandler<C> {
         return this.queryHelp(null, query);
     }
 
+    /**
+     * Query a root index help topic. This is the topic returned when querying {@link #queryHelp(Object, String)} with
+     * an empty string, or when there are no results.
+     *
+     * @param recipient The recipient of this help query to check permissions against (if Non-Null)
+     * @return index help topic
+     * @since 1.8.0
+     */
+    @API(status = API.Status.STABLE, since = "1.8.0")
+    public @NonNull IndexHelpTopic<C> queryRootIndex(final @Nullable C recipient) {
+        return (IndexHelpTopic<C>) this.queryHelp(recipient, "");
+    }
+
     /**
      * Query for help
      *