From 306a1def9a854a740055383cbd3aad0e292cef1b Mon Sep 17 00:00:00 2001 From: Jason <11360596+jpenilla@users.noreply.github.com> Date: Sun, 11 Dec 2022 09:40:09 -0700 Subject: [PATCH] Add helper to get root index help topic (#415) --- .../cloud/commandframework/CommandHelpHandler.java | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/cloud-core/src/main/java/cloud/commandframework/CommandHelpHandler.java b/cloud-core/src/main/java/cloud/commandframework/CommandHelpHandler.java index 646e841a..eb7fdd0b 100644 --- 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 { 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 queryRootIndex(final @Nullable C recipient) { + return (IndexHelpTopic) this.queryHelp(recipient, ""); + } + /** * Query for help *