[−][src]Attribute Macro command_attr::help

#[help]

A brother macro to command, but for the help command. An interface for simple browsing of all the available commands the bot provides, and reading through specific information regarding a command.

As such, the options here will pertain in the help command's layout than its functionality.

Options

  • #[suggestion_text(s)]/#[suggestion_text = s] For suggesting a command's name.

  • #[no_help_available_text(s)]/#[no_help_available_text = s] When help is unavailable for a command.

  • #[usage_label(s)]/#[usage_label = s] How should the command be used.

  • #[usage_sample_label(s)]/#[usage_sample_label = s] Actual sample label.

  • #[ungrouped_label(s)]/#[ungrouped_label = s] Ungrouped commands label.

  • #[description_label(s)]/#[description_label = s] Label at the start of the description.

  • #[grouped_label(s)]/#[grouped_label = s] Grouped commands label.

  • #[aliases_label(s)]/#[aliases_label = s] Label for a command's aliases.

  • #[guild_only_text(s)]/#[guild_only_text = s] When a command is specific to guilds only.

  • #[checks_label(s)]/#[checks_label = s] The header text when showing checks in the help command.

  • #[dm_only_text(s)]/#[dm_only_text = s] When a command is specific to dms only.

  • #[dm_and_guild_text(s)]/#[dm_guild_only_text = s] When a command is usable in both guilds and dms.

  • #[available_text(s)]/#[available_text = s] When a command is available.

  • #[command_not_found_text(s)]/#[command_not_found_text = s] When a command wasn't found.

  • #[individual_command_tip(s)]/#[individual_command_tip = s] How the user should access a command's details.

  • #[strikethrough_commands_tip_in_dm]/#[strikethrough_commands_tip_in_dm(s)]/#[strikethrough_commands_tip_in_dm = s] Reasoning behind strikethrough-commands.

If there wasn't any text passed, default text will be used instead.

Only used in dms.

  • #[strikethrough_commands_tip_in_guild]/#[strikethrough_commands_tip_in_guild(s)]/#[strikethrough_commands_tip_in_guild = s] Reasoning behind strikethrough-commands.

If there wasn't any text passed, default text will be used instead.

Only used in guilds.

  • #[group_prefix(s)]/#[group_prefix = s] For introducing a group's prefix

  • #[lacking_role(s)]/#[lacking_role = s] If a user lacks required roles, this will treat how commands will be displayed.

Accepts strike (strikethroughs), hide (will not be listed) or nothing (leave be).

  • #[lacking_permissions(s)]/#[lacking_role = s] If a user lacks permissions, this will treat how commands will be displayed.

Accepts strike (strikethroughs), hide (will not be listed) or nothing (leave be).

  • #[embed_error_colour(n)] Colour that the help-embed will use upon an error.

Value is a name to one of the provided constants of the Colour struct.

  • #[embed_success_colour(n)] Colour that the help-embed will use normally.

Value is a name to one of the provided constants of the Colour struct.

  • #[max_levenshtein_distance(n)] How much should the help command search for a similiar name.

Indicator for a nested guild. The prefix will be repeated based on what kind of level the item sits. A sub-group would be level two, a sub-sub-group would be level three.

  • #[indention_prefix = s]