com.github.afarion1.command_handler.internal_commands

Class CmdInspectCommand

java.lang.Object

com.github.afarion1.command_handler.command.AbstractCommand

com.github.afarion1.command_handler.internal_commands.CmdInspectCommand

public class CmdInspectCommand
extends AbstractCommand

Field Summary

Fields inherited from class com.github.afarion1.command_handler.command.AbstractCommand

argumentsSeparator

Constructor Summary

Constructors

Constructor and Description
CmdInspectCommand(CommandHandler handler)

Method Summary

Modifier and Type	Method and Description
int	chooseArgumentSymbols(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, java.lang.String arguments, int argumentId) Designed to be overridden if CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean) of any argument of the command is set to true.
void	execute(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, CommandArguments args)

Methods inherited from class com.github.afarion1.command_handler.command.AbstractCommand

getCmdWithArgsSignature, getCommandArguments, getConfig, getDescription, getGuildCooldown, getHandler, getListType, getName, getNameAndAliases, getRawArgsDesc, getRawArgsName, getRequiredDiscordPerms, getUserCooldown, getVerboseDesc, hasAnyCooldown, hasGuildCooldown, hasUserCooldown, isExecuteInGuildOnly, isRawArgs, shouldExecuteIfCantCheckOrSaveCooldown

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdInspectCommand

public CmdInspectCommand(CommandHandler handler)

Method Detail

execute

public void execute(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                    CommandArguments args)

Specified by:

execute in class AbstractCommand

chooseArgumentSymbols

public int chooseArgumentSymbols(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                                 java.lang.String arguments,
                                 int argumentId)

Description copied from class: AbstractCommand

Designed to be overridden if CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean) of any argument of the command is set to true.
This method will have to choose amount of consecutive symbols right from the start of a string, the symbols will be value of the argument.
The method will be given MessageReceivedEvent for context, a String which represents the rest of unprocessed arguments sent by user, and ID of argument being processed.

Overrides:

chooseArgumentSymbols in class AbstractCommand

Parameters:

event - jda on message received event, given for context

arguments - string containing the rest of unprocessed arguments sent by user

argumentId - id of argument being processed. Necessary if several arguments marked to use custom argument choosing

Returns:

when overridden, should return amount of chosen symbols, it other words index of last symbol needed + 1

See Also:

CommandArgumentConfigBuilder.enableCustomArgumentChoosing(boolean)