Index (com.github.johnnyjayjay:CommandAPI 3.2 API)

A B C D G I J L M O P R S T V

A

AbstractCommand - Class in com.github.johnnyjayjay.discord.commandapi: This abstract class is an alternative implementation of ICommand.
AbstractCommand() - Constructor for class com.github.johnnyjayjay.discord.commandapi.AbstractCommand: Iterates over the SubCommand-annotated methods and saves them in a cache.
AbstractHelpCommand - Class in com.github.johnnyjayjay.discord.commandapi: A template for own help command implementations.
AbstractHelpCommand() - Constructor for class com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand
activate() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Sets the prefix and the command HashMap for the rest of the API.
addChannelsToBlacklist(long...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Adds multiple channels to the blacklist.
addChannelsToBlacklist(Collection<Long>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Adds multiple channels to the blacklist.
addChannelToBlacklist(long) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Adds a given channel to the blacklist (meaning commands can not be executed in there).
addHelpLabel(String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help Commands are now registered like any other command, i.e. using CommandSettings#put. To use the default implementation of the help command, register an instance of DefaultHelpCommand.
addHelpLabels(String...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help Commands are now registered like any other command, i.e. using CommandSettings#put. To use the default implementation of the help command, register an instance of DefaultHelpCommand.
addHelpLabels(Collection<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help Commands are now registered like any other command, i.e. using CommandSettings#put. To use the default implementation of the help command, register an instance of DefaultHelpCommand.
args() - Method in annotation type com.github.johnnyjayjay.discord.commandapi.SubCommand: An array of Strings, specifying a regex for each needed command argument.

B

botPerms() - Method in annotation type com.github.johnnyjayjay.discord.commandapi.SubCommand: An array of Permission that specifies which Permissions the self member has to have in the event channel in order to trigger this method.
botsMayExecute() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns whether bot execution is enabled.

C

CHANNEL_MENTION - Variable in class com.github.johnnyjayjay.discord.commandapi.AbstractCommand: A regex to match text channel mentions.
checkBotPermissions(Permission...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns whether the self member has the given permissions in the event channel.
checkMemberPermissions(Permission...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns whether the Member who executed the command has the given permissions in the event channel.
clear() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Resets this whole instance by clearing the commands and setting everything to how it was at the beginning.
clearBlacklist() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Clears the blacklist so that no channel is blacklisted anymore.
clearCommands() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Clears all commands.
clearCustomPrefixes() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Removes all entries from the prefix map, resetting every custom prefix.
clearHelpLabels() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help commands are now removed like any other command, using CommandSettings#remove.
com.github.johnnyjayjay.discord.commandapi - package com.github.johnnyjayjay.discord.commandapi: Created and maintained by JohnnyJayJay.
CommandEvent - Class in com.github.johnnyjayjay.discord.commandapi: Represents a command event.
CommandEvent(JDA, long, Message, CommandEvent.Command, CommandSettings) - Constructor for class com.github.johnnyjayjay.discord.commandapi.CommandEvent
CommandEvent.Command - Class in com.github.johnnyjayjay.discord.commandapi: Describes an executed Command.
CommandSetException - Exception in com.github.johnnyjayjay.discord.commandapi: Exception that is thrown in case of any problems concerning the CommandSettings.
CommandSetException(String) - Constructor for exception com.github.johnnyjayjay.discord.commandapi.CommandSetException
CommandSetException(String, Throwable) - Constructor for exception com.github.johnnyjayjay.discord.commandapi.CommandSetException
CommandSettings - Class in com.github.johnnyjayjay.discord.commandapi: To use this framework, create a new object of this class and add your command classes by using add(...)
CommandSettings(String, ShardManager, boolean) - Constructor for class com.github.johnnyjayjay.discord.commandapi.CommandSettings: This is the optional constructor in case you are sharding your bot.
CommandSettings(String, JDA, boolean) - Constructor for class com.github.johnnyjayjay.discord.commandapi.CommandSettings: This is the constructor.

D

deactivate() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deactivates the current CommandSettings by removing the command listener from jda.
DEFAULT_INFO - Static variable in interface com.github.johnnyjayjay.discord.commandapi.ICommand: The default info message, which is simply "No info, description or help set for this command".
DefaultHelpCommand - Class in com.github.johnnyjayjay.discord.commandapi: The default implementation for AbstractHelpCommand.
DefaultHelpCommand() - Constructor for class com.github.johnnyjayjay.discord.commandapi.DefaultHelpCommand

G

getArgs() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Returns the arguments of the command.
getArgs() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns the arguments of the command.
getArgsAsList() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Returns the command arguments not as an array, but as a List.
getBlacklistedChannels() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this to get the blacklisted channels.
getCommand() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent
getCommands() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings
getCommandSettings() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns the CommandSettings instance this command was called for.
getCooldown() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns the currently set cooldown for this instance.
getExecutor() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Returns the ICommand instance that executed this command.
getFirstChannelMention() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns the first channel mention in the event message as an Optional.
getFirstMention(Message.MentionType...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns the first mention in the event message as an Optional.
getFirstRoleMention() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns the first role mention in the event message as an Optional.
getFirstUserMention() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Returns the first member mention in the event message as an Optional.
getHelpColor() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns the help color for DefaultHelpCommand.
getHelpLabelSet() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and not supported in this version anymore. It will be removed in a future release. Help labels can now be retrieved with CommandSettings#getLabels(ICommand).
getJoinedArgs() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Returns the arguments as a single String.
getJoinedArgs(int) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Deprecated.
This method was deprecated and replaced by CommandEvent.Command#joinArgs.
getLabel() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Returns the label of the command.
getLabels(ICommand) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns every registered label for an ICommand instance in an immutable Set.
getLabelSet() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns every registered label in a Set.
getPrefix() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to get the default prefix.
getPrefix(long) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to get the prefix for a specific guild.
getRawArgs() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Gets the unmodified arguments of this Command.
getRawMessage() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Returns the raw content of the event message.
getUnknownCommandMessage() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings

I

ICommand - Interface in com.github.johnnyjayjay.discord.commandapi: An interface used to describe a command class.
info(Member) - Method in interface com.github.johnnyjayjay.discord.commandapi.ICommand: Deprecated.
This method is deprecated. Please use the other info-method instead as this is no longer supported.
info(Member, String, Set<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.DefaultHelpCommand: Returns the default info for this command.
info(Member, String, Set<String>) - Method in interface com.github.johnnyjayjay.discord.commandapi.ICommand: In case you are using DefaultHelpCommand of this framework, your command classes should override this method.
isActivated() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns whether this instance is activated or not.
isBlacklisted(long) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns whether the given channel id is blacklisted.
isDefault() - Method in annotation type com.github.johnnyjayjay.discord.commandapi.SubCommand: Setting this to true marks a SubCommand as the default SubCommand.
isLabelIgnoreCase() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns whether command labels are case insensitive on this instance of CommandSettings.
isResetCooldown() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Returns whether the cooldown will be reset for each execution attempt.

J

joinArgs(int) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Joins the command arguments from a specific index on.
joinArgs(int, int) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Joins the command arguments from and to a specific index.
joinArgs(CharSequence, int, int) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command: Joins the command arguments with a specific delimiter from and to a specific index.

L

LOGGER - Static variable in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: The logger of this framework.

M

MEMBER_MENTION - Variable in class com.github.johnnyjayjay.discord.commandapi.AbstractCommand: A regex to match member mentions.
moreArgs() - Method in annotation type com.github.johnnyjayjay.discord.commandapi.SubCommand: A boolean that indicates that there must be more arguments than specified in args in order to be triggered.

O

onCommand(CommandEvent, Member, TextChannel, String[]) - Method in class com.github.johnnyjayjay.discord.commandapi.AbstractCommand: This overrides the method declared in ICommand.
onCommand(CommandEvent, Member, TextChannel, String[]) - Method in class com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand: This overwrites the method onCommand from ICommand.
onCommand(CommandEvent, Member, TextChannel, String[]) - Method in interface com.github.johnnyjayjay.discord.commandapi.ICommand: This method is called if someone calls a corresponding command label to this instance, so it works similar to an event method.

P

parseCommand(String, String, CommandSettings) - Static method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent
provideGeneralHelp(CommandEvent, String, Map<String, ICommand>) - Method in class com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand: This method is called if someone uses this command with no parameters or doesn't give a valid label as an argument.
provideGeneralHelp(CommandEvent, String, Map<String, ICommand>) - Method in class com.github.johnnyjayjay.discord.commandapi.DefaultHelpCommand: Lists all commands along with the information that more help can be received by adding the optional label parameter.
provideSpecificHelp(CommandEvent, String, ICommand, Set<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.AbstractHelpCommand: This method is called if someone calls the help command and provides a valid label as the first argument.
provideSpecificHelp(CommandEvent, String, ICommand, Set<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.DefaultHelpCommand: Shows the command info based on the method ICommand#info in an embed.
put(ICommand, String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to add commands from your project.
put(ICommand, String...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to add commands with aliases.
put(ICommand, Collection<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to add commands with aliases from a Set.

R

remove(String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to remove existing commands.
remove(String...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to remove more than one command at a time.
remove(Collection<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Removes every label that is in the given Collection.
removeChannelFromBlacklist(long) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Removes one channel from the blacklist.
removeChannelsFromBlacklist(long...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Removes one or more channels from the blacklist.
removeChannelsFromBlackList(Collection<Long>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Removes a given Collection of channel ids from the blacklist.
removeHelpLabel(String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help commands are now removed like any other command, using CommandSettings#remove.
removeHelpLabels(String...) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help commands are now removed like any other command, using CommandSettings#remove.
removeHelpLabels(Collection<String>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Deprecated.
This method is deprecated and thus not supported anymore. Help commands are now removed like any other command, using CommandSettings#remove.
respond(String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Sends a message to the event channel.
respond(Message) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Sends a message to the event channel.
respond(MessageEmbed) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandEvent: Sends a message to the event channel.
ROLE_MENTION - Variable in class com.github.johnnyjayjay.discord.commandapi.AbstractCommand: A regex to match role mentions.

S

setBotExecution(boolean) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Setter for the field botExecution.
setCooldown(long) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Sets the cooldown for this instance of settings.
setCustomPrefix(long, String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to add a custom command prefix to a guild.
setCustomPrefixes(Map<Long, String>) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: You may use this method as another way to add custom prefixes.
setDefaultPrefix(String) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Use this method to set the default prefix.
setHelpCommandColor(Color) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Sets the color the help message embed will have if you use DefaultHelpCommand.
setResetCooldown(boolean) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Sets the parameter resetCooldown.
setUnknownCommandMessage(Message) - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Sets a Message that will be sent in the event of a Member using the prefix without executing any valid command.
SubCommand - Annotation Type in com.github.johnnyjayjay.discord.commandapi: This annotation may be used inside of a sub class of AbstractCommand to annotate methods as SubCommand-methods.

T

toString() - Method in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: Transforms this instance to a String, showing the current set options.

V

VALID_LABEL - Static variable in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: A regex that only matches valid labels.
VALID_PREFIX - Static variable in class com.github.johnnyjayjay.discord.commandapi.CommandSettings: A regex that only matches valid prefixes.

A B C D G I J L M O P R S T V