Index (Command Framework 1.5.9 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

addCustomParameter(Class<T>, Function<CommandArguments, T>) - Method in class dev.despical.commandframework.CommandFramework: Adds a custom parameter to the parameter handler using a class type.
addCustomParameter(String, Function<CommandArguments, B>) - Method in class dev.despical.commandframework.CommandFramework: Adds a custom parameter to the parameter handler.
aliases() - Element in annotation interface dev.despical.commandframework.annotations.Command: An alternative name list of command.
aliases() - Element in annotation interface dev.despical.commandframework.annotations.Completer: An alternative name list of command.
allowSeparating() - Element in annotation interface dev.despical.commandframework.annotations.Option: Determines whether separating multiple values is allowed.
async() - Element in annotation interface dev.despical.commandframework.annotations.Command: This option is now deprecated.

B

BOTH - Enum constant in enum class dev.despical.commandframework.annotations.Command.SenderType
bypassPerm() - Element in annotation interface dev.despical.commandframework.annotations.Confirmation: The permission to bypass confirmations.
bypassPerm() - Element in annotation interface dev.despical.commandframework.annotations.Cooldown: Command senders that have this permission will bypass the command cooldown.

C

checkCooldown() - Method in class dev.despical.commandframework.CommandArguments: This method checks if the current command sender has a cooldown on the command that is associated with current CommandArguments object.
Command - Annotation Interface in dev.despical.commandframework.annotations: Main class of the framework to create commands in easy way.
Command.SenderType - Enum Class in dev.despical.commandframework.annotations: Available command sender or senders.
CommandArguments - Class in dev.despical.commandframework: A utility class to use command arguments without external Bukkit parameters and includes some useful methods to improve code quality and performance.
CommandException - Exception Class in dev.despical.commandframework.exceptions
CommandException() - Constructor for exception class dev.despical.commandframework.exceptions.CommandException
CommandException(String) - Constructor for exception class dev.despical.commandframework.exceptions.CommandException
CommandException(String, Object...) - Constructor for exception class dev.despical.commandframework.exceptions.CommandException
CommandFramework - Class in dev.despical.commandframework: Main class of the framework to register commands, add tab completions and implement a function to run if there is no matched commands related this framework.
CommandFramework(Plugin) - Constructor for class dev.despical.commandframework.CommandFramework
Completer - Annotation Interface in dev.despical.commandframework.annotations: A utility class in framework to create argument completions for commands.
CompleterHelper - Class in dev.despical.commandframework: A utility class designed to simplify the process of handling tab completion for commands.
CompleterHelper(CommandArguments) - Constructor for class dev.despical.commandframework.CompleterHelper
concatArguments() - Method in class dev.despical.commandframework.CommandArguments: Concatenates all arguments into a single String object.
concatRangeOf(int, int) - Method in class dev.despical.commandframework.CommandArguments: Concatenates a range of elements from the specified array into a single string, using a space as the delimiter.
Confirmation - Annotation Interface in dev.despical.commandframework.annotations
CONFIRMATIONS - Enum constant in enum class dev.despical.commandframework.options.FrameworkOption: This option allows users to check for command confirmations.
CONSOLE - Enum constant in enum class dev.despical.commandframework.annotations.Command.SenderType
Cooldown - Annotation Interface in dev.despical.commandframework.annotations
CooldownException - Exception Class in dev.despical.commandframework.exceptions
CooldownException() - Constructor for exception class dev.despical.commandframework.exceptions.CooldownException
copyMatches(int, Iterable<String>) - Method in class dev.despical.commandframework.CompleterHelper: Filters a collection of strings based on the argument at the specified index.
copyMatches(int, Iterable<String>, T) - Method in class dev.despical.commandframework.CompleterHelper: Filters a collection of strings based on the argument at the specified index and adds matches to the provided collection.
copyMatches(String, Iterable<String>) - Method in class dev.despical.commandframework.CompleterHelper: Filters a collection of strings based on a specific token string.
copyMatches(String, Iterable<String>, T) - Method in class dev.despical.commandframework.CompleterHelper: Filters a collection of strings based on a specific token string and adds matches to the provided collection.
CUSTOM_COOLDOWN_CHECKER - Enum constant in enum class dev.despical.commandframework.options.FrameworkOption: This option allows user to call CommandArguments.checkCooldown() method.

D

Debug - Annotation Interface in dev.despical.commandframework.debug: Marks a Command to be registered only if FrameworkOption.DEBUG mode is enabled.
DEBUG - Enum constant in enum class dev.despical.commandframework.options.FrameworkOption: This option enables the debug mode for this framework.
DebugLogger - Class in dev.despical.commandframework.debug
DebugLogger(Logger) - Constructor for class dev.despical.commandframework.debug.DebugLogger
Default - Annotation Interface in dev.despical.commandframework.annotations
desc() - Element in annotation interface dev.despical.commandframework.annotations.Command: The description of the command that will be showed when sender executes Bukkit's help command.
dev.despical.commandframework - module dev.despical.commandframework
dev.despical.commandframework - package dev.despical.commandframework: The main package of the Command Framework containing all core classes and components related to the framework.
dev.despical.commandframework.annotations - package dev.despical.commandframework.annotations: Contains all annotations provided by the Command Framework.
dev.despical.commandframework.debug - package dev.despical.commandframework.debug: Contains the Debug annotation and DebugLogger, used exclusively for debugging purposes.
dev.despical.commandframework.exceptions - package dev.despical.commandframework.exceptions: Provides custom exception classes used by the Command Framework.
dev.despical.commandframework.options - package dev.despical.commandframework.options: Contains classes that define and handle framework options.

E

empty() - Method in class dev.despical.commandframework.CompleterHelper: Returns an empty, immutable list of strings.
enableOption(FrameworkOption) - Method in class dev.despical.commandframework.options.OptionManager
enableOptions(FrameworkOption...) - Method in class dev.despical.commandframework.options.OptionManager
equalsAny(int, String...) - Method in class dev.despical.commandframework.CompleterHelper: Checks if the argument at the specified index matches any of the provided candidate strings.
equalsAny(String, String...) - Method in class dev.despical.commandframework.CompleterHelper: Checks if the given input string matches any of the provided candidate strings.
expireAfter() - Element in annotation interface dev.despical.commandframework.annotations.Confirmation: How many seconds should pass so the confirmation gets expired.

F

fallbackPrefix() - Element in annotation interface dev.despical.commandframework.annotations.Command: By default, using the plugin's name as a fallback prefix.
findOption(String) - Method in class dev.despical.commandframework.CommandArguments
Flag - Annotation Interface in dev.despical.commandframework.annotations: Annotation to specify flags for command arguments.
Flag.FlagContainer - Annotation Interface in dev.despical.commandframework.annotations: Container annotation for holding multiple Flag annotations on the same method.
FrameworkOption - Enum Class in dev.despical.commandframework.options

G

getAllCommands() - Method in class dev.despical.commandframework.CommandFramework: Get an unmodifiable copy of registered commands and sub-commands.
getArgument(int) - Method in class dev.despical.commandframework.CommandArguments: Retrieves the argument at the specified index.
getArgument(int, String) - Method in class dev.despical.commandframework.CommandArguments: Returns the indexed element from the arguments array, or the defaultValue if and only if index is out the bounds.
getArgumentAsBoolean(int) - Method in class dev.despical.commandframework.CommandArguments: Returns the boolean value of the indexed element from the arguments array.
getArgumentAsDouble(int) - Method in class dev.despical.commandframework.CommandArguments: Returns the double value of the indexed element from the arguments array.
getArgumentAsFloat(int) - Method in class dev.despical.commandframework.CommandArguments: Returns the float value of the indexed element from the arguments array.
getArgumentAsInt(int) - Method in class dev.despical.commandframework.CommandArguments: Returns the integer value of the indexed element from the arguments array.
getArgumentAsLong(int) - Method in class dev.despical.commandframework.CommandArguments: Returns the long value of the indexed element from the arguments array.
getArguments() - Method in class dev.despical.commandframework.CommandArguments: Retrieves the array of arguments associated with this object.
getBukkitCommand() - Method in class dev.despical.commandframework.CommandArguments: Retrieves the Bukkit command associated with this object.
getCommand() - Method in class dev.despical.commandframework.CommandArguments: Retrieves the base command associated with this object.
getCommands() - Method in class dev.despical.commandframework.CommandFramework: Get an unmodifiable copy of registered commands.
getFirst() - Method in class dev.despical.commandframework.CommandArguments: Gets the first argument.
getInstance() - Static method in class dev.despical.commandframework.CommandFramework
getLabel() - Method in class dev.despical.commandframework.CommandArguments: Retrieves the label associated with this object.
getLast() - Method in class dev.despical.commandframework.CommandArguments: Gets the last argument.
getLength() - Method in class dev.despical.commandframework.CommandArguments: Returns the number of arguments passed to the command.
getLogger() - Method in class dev.despical.commandframework.CommandFramework: Returns the logger instance of Command Framework.
getOption(String) - Method in class dev.despical.commandframework.CommandArguments
getPlayer(int) - Method in class dev.despical.commandframework.CommandArguments: Gets player object from the server with given argument.
getPlayer(String) - Method in class dev.despical.commandframework.CommandArguments: Gets player object from the server with given name.
getPlugin() - Method in class dev.despical.commandframework.CommandFramework
getSender() - Method in class dev.despical.commandframework.CommandArguments: Do not try to cast objects except subclasses of CommandSender otherwise ClassCastException will occur.
getSubCommands() - Method in class dev.despical.commandframework.CommandFramework: Get an unmodifiable copy of registered sub-commands-.

H

hasPermission(String) - Method in class dev.despical.commandframework.CommandArguments: Returns true if the command sender has required permission or, if permission is empty.

I

instance - Static variable in class dev.despical.commandframework.CommandFramework
isArgumentsEmpty() - Method in class dev.despical.commandframework.CommandArguments: Returns true if the arguments array is empty, otherwise false.
isEnabled(FrameworkOption) - Method in class dev.despical.commandframework.options.OptionManager
isFlagPresent(String) - Method in class dev.despical.commandframework.CommandArguments
isFloatingDecimal(int) - Method in class dev.despical.commandframework.CommandArguments: Checks if the value obtained from the argument at the specified index can be successfully parsed into a floating-point decimal using Double.parseDouble.
isFloatingDecimal(String) - Method in class dev.despical.commandframework.CommandArguments: Checks if the given string can be successfully parsed into a floating decimal using Double.parseDouble.
isInteger(int) - Method in class dev.despical.commandframework.CommandArguments: Checks if the value obtained from the argument at the specified index can be successfully parsed into an integer using Integer.parseInt.
isInteger(String) - Method in class dev.despical.commandframework.CommandArguments: Checks if the given string can be successfully parsed into an integer using Integer.parseInt.
isNumeric(int) - Method in class dev.despical.commandframework.CommandArguments: Checks if the value obtained from the argument at the specified index is numeric, i.e., if it contains only digit characters (0-9).
isNumeric(String) - Method in class dev.despical.commandframework.CommandArguments: Checks if the given string is numeric, i.e., if it contains only digit characters (0-9).
isSenderConsole() - Method in class dev.despical.commandframework.CommandArguments: Returns true if, and only if, command sender is console.
isSenderPlayer() - Method in class dev.despical.commandframework.CommandArguments: Returns true if, and only if, command sender is player.

K

keySeparator() - Element in annotation interface dev.despical.commandframework.annotations.Option: Specifies the separator between key and value.

L

log(LogRecord) - Method in class dev.despical.commandframework.debug.DebugLogger
LONG_ARG_SIZE - Enum constant in enum class dev.despical.commandframework.Message

M

max() - Element in annotation interface dev.despical.commandframework.annotations.Command: Maximum value of arguments. -1 for infinite.
message() - Element in annotation interface dev.despical.commandframework.annotations.Confirmation: The message will be sent to the sender if they have not confirmed yet.
Message - Enum Class in dev.despical.commandframework
min() - Element in annotation interface dev.despical.commandframework.annotations.Command: Minimum value of arguments.
MUST_HAVE_OP - Enum constant in enum class dev.despical.commandframework.Message

N

name() - Element in annotation interface dev.despical.commandframework.annotations.Command: The name of the command.
name() - Element in annotation interface dev.despical.commandframework.annotations.Completer: The name of the command.
NO_PERMISSION - Enum constant in enum class dev.despical.commandframework.Message

O

onCommand(CommandSender, Command, String, String[]) - Method in class dev.despical.commandframework.CommandFramework
ONLY_BY_CONSOLE - Enum constant in enum class dev.despical.commandframework.Message
ONLY_BY_PLAYERS - Enum constant in enum class dev.despical.commandframework.Message
onlyOp() - Element in annotation interface dev.despical.commandframework.annotations.Command: Only op players can execute this command.
onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.despical.commandframework.CommandFramework
Option - Annotation Interface in dev.despical.commandframework.annotations: Annotation to define options for command arguments.
Option.OptionContainer - Annotation Interface in dev.despical.commandframework.annotations: Container annotation for holding multiple Option annotations on the same method.
OptionManager - Class in dev.despical.commandframework.options: This class handles the options related Command Framework.
OptionManager() - Constructor for class dev.despical.commandframework.options.OptionManager
options() - Method in class dev.despical.commandframework.CommandFramework: Returns the option manager.
overrideConsole() - Element in annotation interface dev.despical.commandframework.annotations.Confirmation: If option is true, console will be affected by confirmations; otherwise, it will override the confirmation period to use the command again.
overrideConsole() - Element in annotation interface dev.despical.commandframework.annotations.Cooldown: If option is true, console will be affected by cooldowns; otherwise, it will override the delay to use the command again.

P

Param - Annotation Interface in dev.despical.commandframework.annotations
parameterHandler - Variable in class dev.despical.commandframework.CommandFramework
permission() - Element in annotation interface dev.despical.commandframework.annotations.Command: The permission that sender has to have to execute command.
permission() - Element in annotation interface dev.despical.commandframework.annotations.Completer: The permission that sender must have to receive tab complete.
PLAYER - Enum constant in enum class dev.despical.commandframework.annotations.Command.SenderType
playerNames() - Method in class dev.despical.commandframework.CompleterHelper: Retrieves a list of names for all players currently online on the server.
prefix() - Element in annotation interface dev.despical.commandframework.annotations.Flag: Specifies the prefix for the flags.
prefix() - Element in annotation interface dev.despical.commandframework.annotations.Option: Specifies the prefix for the options.

R

registerAllInPackage(String) - Method in class dev.despical.commandframework.CommandFramework: Scans all classes within the specified package, creates instances of them, and registers them as commands.
registerCommands(Object) - Method in class dev.despical.commandframework.CommandFramework: Registers commands from the specified instance's class.
registry - Variable in class dev.despical.commandframework.CommandFramework

S

senderType() - Element in annotation interface dev.despical.commandframework.annotations.Command: Enum value of command sender type to define who will use the command.
sendMessage(Message) - Method in class dev.despical.commandframework.CommandArguments: Sends the specified Message to command sender associated with this object.
sendMessage(String) - Method in class dev.despical.commandframework.CommandArguments: Sends message to sender without receiving the command sender.
sendMessage(String, Object...) - Method in class dev.despical.commandframework.CommandArguments: Sends message to sender without receiving command sender with the given parameters.
sendMessage(Component) - Method in class dev.despical.commandframework.CommandArguments: Sends the specified Component to command sender associated with this object.
setColorFormatter(Function<String, String>) - Static method in enum class dev.despical.commandframework.Message: For instance, can be used to translate Minecraft color and Hex color codes.
setCommandMap(CommandMap) - Method in class dev.despical.commandframework.CommandFramework
setLogger(Logger) - Method in class dev.despical.commandframework.CommandFramework: Changes default logger
setMessage(BiFunction<Command, CommandArguments, Boolean>) - Method in enum class dev.despical.commandframework.Message: Set a custom error message.
SHORT_ARG_SIZE - Enum constant in enum class dev.despical.commandframework.Message

T

timeUnit() - Element in annotation interface dev.despical.commandframework.annotations.Confirmation: The time unit for #expireAfter().
timeUnit() - Element in annotation interface dev.despical.commandframework.annotations.Cooldown: The time unit of command cooldown.

U

unregisterCommand(String) - Method in class dev.despical.commandframework.CommandFramework: Unregisters a command and its associated tab completer if they are registered with the specified name.
unregisterCommands() - Method in class dev.despical.commandframework.CommandFramework: Unregisters all commands and tab completers that were registered using the instance of this object.
usage() - Element in annotation interface dev.despical.commandframework.annotations.Command: The usage of the command that will be showed when sender executes command without required or missing arguments.

V

value() - Element in annotation interface dev.despical.commandframework.annotations.Cooldown: The time between using command again.
value() - Element in annotation interface dev.despical.commandframework.annotations.Default: The default value for the parameter annotated with Param, if the value of parameter is null.
value() - Element in annotation interface dev.despical.commandframework.annotations.Flag.FlagContainer: Holds an array of Flag annotations.
value() - Element in annotation interface dev.despical.commandframework.annotations.Flag: Specifies the list of flag values.
value() - Element in annotation interface dev.despical.commandframework.annotations.Option.OptionContainer: Holds an array of Option annotations.
value() - Element in annotation interface dev.despical.commandframework.annotations.Option: Specifies the key of the option.
value() - Element in annotation interface dev.despical.commandframework.annotations.Param: The unique id of the parameter.
valueOf(String) - Static method in enum class dev.despical.commandframework.annotations.Command.SenderType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.despical.commandframework.Message: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.despical.commandframework.options.FrameworkOption: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.despical.commandframework.annotations.Command.SenderType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.despical.commandframework.Message: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.despical.commandframework.options.FrameworkOption: Returns an array containing the constants of this enum class, in the order they are declared.
valueSeparator() - Element in annotation interface dev.despical.commandframework.annotations.Option: Specifies the separator used between values.

W

WAIT_BEFORE_USING_AGAIN - Enum constant in enum class dev.despical.commandframework.Message

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form