Package com.github.johnnyjayjay.discord.commandapi

Class DefaultHelpCommand

java.lang.Object

com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand

com.github.johnnyjayjay.discord.commandapi.DefaultHelpCommand

All Implemented Interfaces:

ICommand

public final class DefaultHelpCommand
extends AbstractHelpCommand

The default implementation for AbstractHelpCommand. If you want to use this, add a new instance of this class as a command in your CommandSettings with the put-method. This class is final. To create your own help command implementation, please refer to AbstractHelpCommand.

Since:

3.2

Version:

3.2

Author:

JohnnyJayJay

See Also:

AbstractHelpCommand

Field Summary

Fields inherited from interface com.github.johnnyjayjay.discord.commandapi.ICommand

DEFAULT_INFO

Constructor Summary

Constructors

Constructor	Description
DefaultHelpCommand()

Method Summary

Modifier and Type	Method	Description
net.dv8tion.jda.core.entities.Message	info(net.dv8tion.jda.core.entities.Member member, String prefix, Set<String> labels)	Returns the default info for this command.
void	provideGeneralHelp(CommandEvent event, String prefix, Map<String,ICommand> commands)	Lists all commands along with the information that more help can be received by adding the optional label parameter.
void	provideSpecificHelp(CommandEvent event, String prefix, ICommand command, Set<String> labels)	Shows the command info based on the method ICommand#info in an embed.

Methods inherited from class com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand

onCommand

Methods inherited from interface com.github.johnnyjayjay.discord.commandapi.ICommand

info

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultHelpCommand

public DefaultHelpCommand()

Method Detail

provideGeneralHelp

public void provideGeneralHelp(CommandEvent event,
                               String prefix,
                               Map<String,ICommand> commands)

Lists all commands along with the information that more help can be received by adding the optional label parameter.

Specified by:

provideGeneralHelp in class AbstractHelpCommand

Parameters:

event - the CommandEvent as for usual commands.

prefix - The prefix of the guild this command was called on.

commands - an unmodifiable Map that contains all the prefixes with their corresponding commands that are registered for these CommandSettings.

provideSpecificHelp

public void provideSpecificHelp(CommandEvent event,
                                String prefix,
                                ICommand command,
                                Set<String> labels)

Shows the command info based on the method ICommand#info in an embed.

Specified by:

provideSpecificHelp in class AbstractHelpCommand

Parameters:

event - the CommandEvent as for usual commands.

prefix - The prefix of the guild this command was called on.

command - The ICommand that the help was requested for.

labels - All the labels that are associated with the ICommand instance.

info

public net.dv8tion.jda.core.entities.Message info(net.dv8tion.jda.core.entities.Member member,
                                                  String prefix,
                                                  Set<String> labels)

Returns the default info for this command.

Parameters:

member - The Member that called the command. Might be helpful to check for permissions or make mentions possible.

prefix - The prefix of the guild the help command was called on.

labels - The registered labels of this ICommand instance. Useful to display aliases.

Returns:

A message with content "Shows all available commands or provides help for a specific command."

See Also:

DefaultHelpCommand, AbstractHelpCommand, MessageBuilder