Package com.github.johnnyjayjay.discord.commandapi

Interface ICommand

All Known Implementing Classes:

AbstractCommand, AbstractHelpCommand, DefaultHelpCommand

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ICommand

An interface used to describe a command class. In order to use this API, every class which is supposed to execute commands must implement this interface.

Since:

1.1

Version:

3.2

Author:

Johnny_JayJay

See Also:

AbstractCommand, AbstractHelpCommand

Field Summary

Fields

Modifier and Type	Field	Description
static net.dv8tion.jda.core.entities.Message	DEFAULT_INFO	The default info message, which is simply "No info, description or help set for this command".

Method Summary

Modifier and Type	Method	Description
default String	info(net.dv8tion.jda.core.entities.Member member)	Deprecated. This method is deprecated.
default net.dv8tion.jda.core.entities.Message	info(net.dv8tion.jda.core.entities.Member member, String prefix, Set<String> labels)	In case you are using DefaultHelpCommand of this framework, your command classes should override this method.
void	onCommand(CommandEvent event, net.dv8tion.jda.core.entities.Member member, net.dv8tion.jda.core.entities.TextChannel channel, String[] args)	This method is called if someone calls a corresponding command label to this instance, so it works similar to an event method.

Field Detail

DEFAULT_INFO

static final net.dv8tion.jda.core.entities.Message DEFAULT_INFO

The default info message, which is simply "No info, description or help set for this command". This is returned in Message info(Member, String, Set<String>) if not overwritten.

Method Detail

onCommand

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

This method is called if someone calls a corresponding command label to this instance, so it works similar to an event method.

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]...)

info

@Deprecated
default String info(net.dv8tion.jda.core.entities.Member member)

Deprecated.

This method is deprecated. Please use the other info-method instead as this is no longer supported.

In case you are using the automated help command of this API, your command classes should override this method.

Parameters:

member - The member who requested help.

Returns:

By default, this returns "No info, description or help set" which will be displayed if someone demands help for this command. An Override should return info about the command, such as usage, description, permissions, aliases...

info

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

In case you are using DefaultHelpCommand of this framework, your command classes should override this method. It will be displayed if someone requests help for this command. This returns the Message that will be displayed.

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:

the Message object, that, if DefaultHelpCommand is used, will be sent to the channel the help was requested in.

See Also:

DefaultHelpCommand, AbstractHelpCommand, MessageBuilder