Package cloud.commandframework
Class CommandHelpHandler<C>
java.lang.Object
cloud.commandframework.CommandHelpHandler<C>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Something that can be returned as the result of a help querystatic final class
Index of available commandsstatic final class
Help topic with multiple semi-verbose command descriptionsstatic final class
static final class
Verbose information about a specificCommand
-
Method Summary
Modifier and TypeMethodDescription@NonNull List<@NonNull CommandHelpHandler.VerboseHelpEntry<C>>
Get exact syntax hints for all commandsGet a list of the longest shared command chains of all commands.@NonNull CommandHelpHandler.HelpTopic<C>
Query for help@NonNull CommandHelpHandler.HelpTopic<C>
Query for help
-
Method Details
-
getAllCommands
Get exact syntax hints for all commands- Returns:
- Syntax hints for all registered commands, order in lexicographical order
-
queryHelp
Query for help- Parameters:
query
- Query string- Returns:
- Help topic, will return an empty
CommandHelpHandler.IndexHelpTopic
if no results were found
-
queryHelp
public @NonNull CommandHelpHandler.HelpTopic<C> queryHelp(@Nullable C recipient, @NonNull String query) Query for help- Parameters:
recipient
- The recipient of this help query to check permissions against (if Non-Null)query
- Query string- Returns:
- Help topic, will return an empty
CommandHelpHandler.IndexHelpTopic
if no results were found
-