Package com.github.johnnyjayjay.discord.commandapi

Interface ICommand

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.

Version:

3.0

Author:

Johnny_JayJay

Method Summary

Modifier and Type	Method	Description
default String	info()	In case you are using the automated help command of this API, 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)	Everything that happens if the command is executed should be written here.

Method Detail

onCommand

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

Everything that happens if the command is executed should be written here. This is also the place for argument handling.

Parameters:

event - By this, you are given access to the CommandEvent, in case you want to get its belongings or even modify it.

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

default String info()

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

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