kord-extensions/dev.kordex.core.extensions.base/HelpProvider/formatCommandHelp

formatCommandHelp

abstract suspend fun formatCommandHelp(prefix: String, event: MessageCreateEvent, command: ChatCommand<out Arguments>, longDescription: Boolean = false): Triple<String, String, String>

Given a command object and command prefix string, return a triple representing the formatted command name and signature, formatted command description and formatted argument list.

Return

Tripe containing three formatted elements - the command's name and signature with prefix, the command's description, and the command's argument list.

Parameters

prefix

Command prefix character to use while formatting.

event

MessageCreateEvent that triggered this help invocation, used to run subcommand checks.

command

Command object to format the help for.

longDescription

Whether to include more than the first line of the command description, false by default.

open suspend fun formatCommandHelp(context: ChatCommandContext<*>, command: ChatCommand<out Arguments>, longDescription: Boolean = false): Triple<String, String, String>

Given a command object and command context, return a triple representing the formatted command name and signature, formatted command description and formatted argument list.