Struct serenity::framework::standard::CreateHelpCommand

pub struct CreateHelpCommand(pub HelpOptions, pub HelpFunction);

Methods

impl CreateHelpCommand

pub fn suggestion_text(self, text: &str) -> Self

Sets a message displaying if input could not be found but a similar command is available.

Note: {} will be substituted with the actual suggested command-name. Hence no {} results in no command-name.

pub fn no_help_available_text(self, text: &str) -> Self

Sets a message displaying if there is no help available.

pub fn usage_label(self, text: &str) -> Self

Sets a label for usage of a command.

pub fn usage_sample_label(self, text: &str) -> Self

Sets a label for the usage examples of a command.

pub fn ungrouped_label(self, text: &str) -> Self

Sets a label for ungrouped-commands

pub fn grouped_label(self, text: &str) -> Self

Sets a label for grouped-commands.

pub fn aliases_label(self, text: &str) -> Self

Sets a label for aliases.

pub fn guild_only_text(self, text: &str) -> Self

Sets a message displaying if a command is only available in guilds.

pub fn dm_only_text(self, text: &str) -> Self

Sets a message displaying if a command is only available in direct messages (DMs);

pub fn dm_and_guilds_text(self, text: &str) -> Self

Sets a message displaying if a command is available in guilds and DMs.

pub fn available_text(self, text: &str) -> Self

Sets a message displaying if a command is available to use.

pub fn command_not_found_text(self, text: &str) -> Self

Sets a message that will appear upon failing to find an individual command. As in: {prefix}help {command_name}, but a command or alias like {command_name} does not exist.

Note: {} will be substituted with the actual suggested command-name. Hence no {} results in no command-name.

pub fn individual_command_tip(self, text: &str) -> Self

Sets the message on top of the help-menu, informing the user how to obtain more information about a single command.

pub fn group_prefix(self, text: &str) -> Self

Sets how the group-prefix shall be labeled.

pub fn lacking_role(self, behaviour: HelpBehaviour) -> Self

Sets how a command requiring roles, that a user is lacking, shall appear in the help-menu.

pub fn lacking_permissions(self, behaviour: HelpBehaviour) -> Self

Sets how a command requiring permission, that a user is lacking, shall be appear in the help-menu.

pub fn wrong_channel(self, behaviour: HelpBehaviour) -> Self

Sets how a command requiring to be sent in either via DM or a guild should be treated in the help-menu.

pub fn striked_commands_tip(self, text: Option<String>) -> Self

Sets the tip (or legend) explaining why some commands are striked, given text will be used in guilds and direct messages.

By default this is Some(String) and the String is empty resulting in an automated substitution based on your HelpBehaviour-settings. If set to None, no tip will be given nor will it be substituted. If set to a non-empty Some(String), the String will be displayed as tip.

Note: CreateHelpCommand::striked_commands_tip_in_direct_message and CreateHelpCommand::striked_commands_tip_in_guild can specifically set this text for direct messages and guilds.

pub fn striked_commands_tip_in_guild(self, text: Option<String>) -> Self

Sets the tip (or legend) explaining why some commands are striked, given text will be used in guilds.

By default this is Some(String) and the String is empty resulting in an automated substitution based on your HelpBehaviour-settings. If set to None, no tip will be given nor will it be substituted. If set to a non-empty Some(String), the String will be displayed as tip.

pub fn striked_commands_tip_in_direct_message(     self,     text: Option<String> ) -> Self

Sets the tip (or legend) explaining why some commands are striked, given text will be used in direct messages.

By default this is Some(String) and the String is empty resulting in an automated substitution based on your HelpBehaviour-settings. If set to None, no tip will be given nor will it be substituted. If set to a non-empty Some(String), the String will be displayed as tip.

pub fn embed_success_colour(self, colour: Colour) -> Self

Sets the colour for the embed if no error occurred.

pub fn embed_error_colour(self, colour: Colour) -> Self

Sets the colour for the embed if an error occurred.

pub fn max_levenshtein_distance(self, distance: usize) -> Self

Sets the maximum Levenshtein-distance to find similar commands.