Class DefaultHelpFormatter

Default CommandsNext help formatter.

Inheritance
System.Object
BaseHelpFormatter
DefaultHelpFormatter
Inherited Members
Namespace: DisCatSharp.CommandsNext.Converters
Assembly: DisCatSharp.CommandsNext.dll
Syntax
public class DefaultHelpFormatter : BaseHelpFormatter

Constructors

| Improve this Doc View Source

DefaultHelpFormatter(CommandContext)

Creates a new default help formatter.

Declaration
public DefaultHelpFormatter(CommandContext ctx)
Parameters
Type Name Description
CommandContext ctx

Context in which this formatter is being invoked.

Properties

| Improve this Doc View Source

EmbedBuilder

Gets the embed builder.

Declaration
public DiscordEmbedBuilder EmbedBuilder { get; }
Property Value
Type Description
DiscordEmbedBuilder

Methods

| Improve this Doc View Source

Build()

Construct the help message.

Declaration
public override CommandHelpMessage Build()
Returns
Type Description
CommandHelpMessage

Data for the help message.
Overrides
| Improve this Doc View Source

WithCommand(Command)

Sets the command this help message will be for.

Declaration
public override BaseHelpFormatter WithCommand(Command command)
Parameters
Type Name Description
Command command

Command for which the help message is being produced.
Returns
Type Description
BaseHelpFormatter

This help formatter.
Overrides
| Improve this Doc View Source

WithSubcommands(IEnumerable<Command>)

Sets the subcommands for this command, if applicable. This method will be called with filtered data.

Declaration
public override BaseHelpFormatter WithSubcommands(IEnumerable<Command> subcommands)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<Command> subcommands

Subcommands for this command group.
Returns
Type Description
BaseHelpFormatter

This help formatter.
Overrides

Extension Methods