getMainHelpPaginator

abstract suspend fun getMainHelpPaginator(event: MessageCreateEvent, prefix: String): BasePaginator

Given an event and prefix, return a BasePaginator containing help information for all loaded commands with passing checks.

While it shouldn't really be possible, this will also handle the case where there are no commands registered at all, for all you weirdos out there breaking everything intentionally.

This will only return help information for commands with checks that pass. If a command's checks fail, it will not be listed. Similarly, a command will only show subcommands with passing checks.

Return

Paginator containing help information for all loaded commands with passing checks.

Parameters

event

MessageCreateEvent that triggered this help invocation.

prefix

Command prefix to use for formatting.


Given a command context, return a BasePaginator containing help information for all loaded commands with passing checks.

While it shouldn't really be possible, this will also handle the case where there are no commands registered at all, for all you weirdos out there breaking everything intentionally.

This will only return help information for commands with checks that pass. If a command's checks fail, it will not be listed. Similarly, a command will only show subcommands with passing checks.

Return

BasePaginator containing help information for all loaded commands with passing checks.

Parameters

context

MessageCommandContext object that triggered this help invocation..