BotCommands-core/io.github.freya022.botcommands.api.commands.text/HelpBuilderConsumer

HelpBuilderConsumer

@NullMarked

@InterfacedService(acceptMultiple = false)

interface HelpBuilderConsumer(source)

A consumer that's called when a help embed is about to be sent. That embed can be for the command list as well as individual commands.

Usage: Register your instance as a service with BService.

See also

acceptGlobal(EmbedBuilder)

acceptCommand(EmbedBuilder, TextCommandInfo)

InterfacedService

@InterfacedService

Functions

open fun ~~accept~~(builder: EmbedBuilder, isGlobal: Boolean, @Nullable commandInfo: @Nullable TextCommandInfo)

The function called when building a help embed

open fun acceptCommand(builder: EmbedBuilder, commandInfo: TextCommandInfo)

Customizes the given EmbedBuilder when showing help for a specific command.

open fun acceptGlobal(builder: EmbedBuilder)

Customizes the given EmbedBuilder when showing help for all commands.