Package com.github.johnnyjayjay.discord.commandapi

Annotation Type SubCommand

@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface SubCommand

This annotation may be used inside of a sub class of AbstractCommand to annotate methods as SubCommand-methods. Methods annotated with this annotation must have the signature void (com.github.johnnyjayjay.commandapi.CommandEvent, net.dv8tion.jda.core.entities.Member, net.dv8tion.jda.core.entities.TextChannel, java.lang.String[]) in order to be registered (you will get a warning if a signature violates that).

Since:

3.2

Version:

3.2

Author:

JohnnyJayJay

See Also:

AbstractCommand

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	args	An array of Strings, specifying a regex for each needed command argument.
net.dv8tion.jda.core.Permission[]	botPerms	An array of Permission that specifies which Permissions the self member has to have in the event channel in order to trigger this method.
boolean	isDefault	Setting this to true marks a SubCommand as the default SubCommand.
boolean	moreArgs	A boolean that indicates that there must be more arguments than specified in args in order to be triggered.

Element Detail

isDefault

boolean isDefault

Setting this to true marks a SubCommand as the default SubCommand. This means that it will be executed if no other SubCommand is triggered. This might be useful for "incorrect usage" messages.

Returns:

false by default.

Default:

false

args

String[] args

An array of Strings, specifying a regex for each needed command argument. E.g.: if this is set to {"get", "<@!?\\d+>"}, the method will only be triggered if the command matches: [prefix][label] get [member mention]. Of course, you don't have to use regex. You may also use just normal words and then make your checks inside of the method. Values specified in isDefault-SubCommands are ignored.

Returns:

an empty array by default. Meaning, a method that does not specify a value will be called if there are no arguments.

Default:

{}

moreArgs

boolean moreArgs

A boolean that indicates that there must be more arguments than specified in args in order to be triggered. This might be useful for commands with an open argument length. If this is set to true, the command argument length must be greater than SubCommand#args().length. This is ignored if specified in an isDefault-SubCommand.

Returns:

false by default.

Default:

false

botPerms

net.dv8tion.jda.core.Permission[] botPerms

An array of Permission that specifies which Permissions the self member has to have in the event channel in order to trigger this method. This is NOT ignored for isDefault-SubCommands.

Returns:

an empty array by default.

Default:

{}