Package com.github.johnnyjayjay.discord.commandapi

Class CommandSettings

java.lang.Object

com.github.johnnyjayjay.discord.commandapi.CommandSettings

public class CommandSettings
extends Object

To use this API, create a new object of this class and add your command classes by using add(...)

When you want your commands to become active, use activate()

Version:

3.0

Author:

Johnny_JayJay

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALID_LABEL
static String	VALID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CommandSettings(String defaultPrefix, net.dv8tion.jda.bot.sharding.ShardManager shardManager, boolean useHelpCommand, boolean labelIgnoreCase)	This is the optional constructor in case you are sharding your bot.
CommandSettings(String defaultPrefix, net.dv8tion.jda.core.JDA jda, boolean useHelpCommand, boolean labelIgnoreCase)	This is the constructor.

Method Summary

Modifier and Type	Method	Description
void	activate()	Sets the prefix and the command HashMap for the rest of the API.
void	deactivate()	Deactivates the current CommandSettings by removing the command listener from jda.
protected Map<String,ICommand>	getCommands()
protected Set<String>	getHelpLabels()
String	getPrefix()	Use this method to get the default prefix.
String	getPrefix(long guildId)	Use this method to get the prefix for a specific guild.
protected boolean	labelIgnoreCase()
CommandSettings	put(ICommand command, String label)	Use this method to add commands from your project.
CommandSettings	put(ICommand command, String... labels)	Use this method to add commands with aliases.
boolean	remove(String label)	Use this method to remove existing commands.
boolean	remove(String... labels)	Use this method to remove more than one command at a time.
void	setCustomPrefix(long guildId, String prefix)	Use this method to add a custom command prefix to a guild.
void	setDefaultPrefix(String prefix)	Use this method to set the default prefix.
CommandSettings	setHelpLabel(String... labels)	Use this method to add help labels.
protected boolean	useHelpCommand()

Methods inherited from class java.lang.Object

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

Field Detail

VALID_PREFIX

public static final String VALID_PREFIX

See Also:

Constant Field Values

VALID_LABEL

public static final String VALID_LABEL

See Also:

Constant Field Values

Constructor Detail

CommandSettings

public CommandSettings(@Nonnull
                       String defaultPrefix,
                       @Nonnull
                       net.dv8tion.jda.bot.sharding.ShardManager shardManager,
                       boolean useHelpCommand,
                       boolean labelIgnoreCase)

This is the optional constructor in case you are sharding your bot. The parameters are validated automatically. In case of any problems (if the prefix is empty), this will throw a CommandSetException.

Parameters:

shardManager - Put your active ShardManager here. This is important for the activation of the CommandListener.

defaultPrefix - The String you will have to put before every command in order to get your command execution registered. This can later be changed.

useHelpCommand - Set this to true, if you want to use the auto-generated help command of this API. You can configure this by setting the help labels with setHelpLabel(String...) and by overriding the method info() in your command classes.

labelIgnoreCase - Set this to true, if you want deactivate case sensitivity for the recognition of labels. E.g.: there will be no difference between the labels "foo", "FOO", "FoO" and so on.

CommandSettings

public CommandSettings(@Nonnull
                       String defaultPrefix,
                       @Nonnull
                       net.dv8tion.jda.core.JDA jda,
                       boolean useHelpCommand,
                       boolean labelIgnoreCase)

This is the constructor. The parameters are validated automatically. In case of any problems (if the prefix is empty), this will throw a CommandSetException.

Parameters:

jda - Put your active JDA here. This is important for the activation of the CommandListener.

defaultPrefix - The String you will have to put before every command in order to get your command execution registered. This can later be changed.

useHelpCommand - Set this to true, if you want to use the auto-generated help command of this API. You can configure this by setting the help labels with setHelpLabel(String...) and by overriding the method info() in your command classes.

labelIgnoreCase - Set this to true, if you want deactivate case sensitivity for the recognition of labels. E.g.: there will be no difference between the labels "foo", * "FOO", "FoO" and so on.

Method Detail

setHelpLabel

public CommandSettings setHelpLabel(String... labels)

Use this method to add help labels. This will only work if you instantiated this class with the parameter useHelpCommand as true.

Parameters:

labels - One or more labels which may later be called by members to list all commands or to show info about one specific command.

Returns:

The current object. This is to use fluent interface.

put

public CommandSettings put(@Nonnull
                           ICommand command,
                           @Nonnull
                           String label)

Use this method to add commands from your project. Every command which is supposed to be active should be added by this.

The two parameters will be put in a HashMap which is used by the API to notice commands.

Parameters:

label - The label which describes your command, i.e. the string after the prefix [prefix][label].

command - An instance of your command class which implements ICommand.

Returns:

The current object. This is to use fluent interface.

Throws:

CommandSetException - If the label is empty or consists of multiple words.

put

public CommandSettings put(@Nonnull
                           ICommand command,
                           @Nonnull
                           String... labels)

Use this method to add commands with aliases.

Works like put(ICommand, String) but adds multiple labels to the same command.

Parameters:

command - An instance of your command class which implements ICommand.

labels - One or more labels. This will throw a CommandSetException, if the label is empty or contains spaces.

Returns:

The current object. This is to use fluent interface.

remove

public boolean remove(@Nonnull
                      String label)

Use this method to remove existing commands.

Parameters:

label - The label of the command to remove.

Returns:

true, if the label was successfully removed. false, if the given label doesn't exist.

remove

public boolean remove(@Nonnull
                      String... labels)

Use this method to remove more than one command at a time.

Parameters:

labels - One or more labels to remove

Returns:

true, if every label was successfully removed. false, if one of the given labels does not exist and thus was not removed.

setDefaultPrefix

public void setDefaultPrefix(@Nonnull
                             String prefix)

Use this method to set the default prefix.

Parameters:

prefix - The prefix to set. In case the given String is empty, this will throw a CommandSetException.

Throws:

CommandSetException - if the prefix is empty.

setCustomPrefix

public void setCustomPrefix(long guildId,
                            String prefix)

Use this method to add a custom command prefix to a guild. This will only work if you instantiated this class with useCustomPrefixes set to true. You can remove the custom prefix from a guild by setting its prefix to null.

Parameters:

guildId - The guild id as a long.

prefix - The prefix to be set.

Throws:

CommandSetException - if a non-null prefix is empty.

activate

public void activate()

Sets the prefix and the command HashMap for the rest of the API. This is the last method to call when having finished setting up your commands.

Note that activating multiple CommandSettings may cause problems. You can do this to use multiple prefixes, but it is not recommended.

This method is important to call because otherwise no command will be registered by the internal command listener.

Throws:

CommandSetException - if you already activated this instance.

deactivate

public void deactivate()

Deactivates the current CommandSettings by removing the command listener from jda. The CommandSettings can be activated again by using activate().

Throws:

CommandSetException - if you either did not activate this instance or already deactivated it.

getPrefix

public String getPrefix(long guildId)

Use this method to get the prefix for a specific guild.

Parameters:

guildId - The id of the guild to check.

Returns:

the default prefix, if there is no custom prefix set for the given guild id. Otherwise, it returns the custom prefix.

getPrefix

public String getPrefix()

Use this method to get the default prefix.

Returns:

default prefix set in the constructor or the method setDefaultPrefix(String).

labelIgnoreCase

protected boolean labelIgnoreCase()

getHelpLabels

protected Set<String> getHelpLabels()

useHelpCommand

protected boolean useHelpCommand()

getCommands

protected Map<String,ICommand> getCommands()