Package com.github.johnnyjayjay.discord.commandapi

Class AbstractHelpCommand

java.lang.Object

com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand

All Implemented Interfaces:

ICommand

Direct Known Subclasses:

DefaultHelpCommand

public abstract class AbstractHelpCommand
extends Object
implements ICommand

A template for own help command implementations. This class implements ICommand, therefore each sub class can be added as a normal command with CommandSettings#put. The framework provides a default implementation of this class, DefaultHelpCommand.

Since:

3.2

Version:

3.2

Author:

JohnnyJayJay

See Also:

DefaultHelpCommand

Field Summary

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

DEFAULT_INFO

Constructor Summary

Constructors

Constructor	Description
AbstractHelpCommand()

Method Summary

Modifier and Type	Method	Description
void	onCommand(CommandEvent event, net.dv8tion.jda.core.entities.Member member, net.dv8tion.jda.core.entities.TextChannel channel, String[] args)	This overwrites the method onCommand from ICommand.
abstract void	provideGeneralHelp(CommandEvent event, String prefix, Map<String,ICommand> commands)	This method is called if someone uses this command with no parameters or doesn't give a valid label as an argument.
abstract void	provideSpecificHelp(CommandEvent event, String prefix, ICommand command, Set<String> labels)	This method is called if someone calls the help command and provides a valid label as the first argument.

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

info, info

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHelpCommand

public AbstractHelpCommand()

Method Detail

onCommand

public final void onCommand(CommandEvent event,
                            net.dv8tion.jda.core.entities.Member member,
                            net.dv8tion.jda.core.entities.TextChannel channel,
                            String[] args)

This overwrites the method onCommand from ICommand. It parses the command and decides whether provideGeneralHelp or provideSpecificHelp will be called.
This method is final. To make your own implementation of ICommand, you have to implement this interface on your own.

Specified by:

onCommand in interface ICommand

Parameters:

event - The CommandEvent instance for this execution.

member - The member who called the command.

channel - The TextChannel in which the command has been called.

args - The command arguments, i.e. everything behind the label ([prefix][label] [arg1] [arg2]...)

provideGeneralHelp

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

This method is called if someone uses this command with no parameters or doesn't give a valid label as an argument. The best use would be to display all commands or provide general help in another way.

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 abstract void provideSpecificHelp(CommandEvent event,
                                         String prefix,
                                         ICommand command,
                                         Set<String> labels)

This method is called if someone calls the help command and provides a valid label as the first argument.

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.