HelpExtensionBuilder

Builder used for configuring options, specifically related to the help extension.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

List of command checks. These checks will be checked against all commands in the help extension.

Link copied to clipboard
var colourGetter: suspend MessageCreateEvent.() -> Color

For custom help embed colours. Only one may be defined.

Link copied to clipboard

Whether to delete the help command invocation after the paginator timeout ends.

Link copied to clipboard

Whether to delete the help paginator after the timeout ends.

Link copied to clipboard

Whether to enable the bundled help extension. Defaults to true.

Link copied to clipboard

Time to wait before the help paginator times out and can't be used, in seconds. Defaults to 60.

Link copied to clipboard

Whether to ping users when responding to them.

Functions

Link copied to clipboard
fun check(vararg checks: ChatCommandCheck)

Define a check which must pass for help commands to be executed. This check will be applied to all commands in the extension.

Overloaded check function to allow for DSL syntax.

Link copied to clipboard
fun color(builder: suspend MessageCreateEvent.() -> Color)

Like colour, but American.

Link copied to clipboard
fun colour(builder: suspend MessageCreateEvent.() -> Color)

Define a callback that returns a Color to use for help embed colours. Feel free to mix it up!