com.ericramirezs.commando4j.command

Class Command

java.lang.Object

com.ericramirezs.commando4j.command.Command

All Implemented Interfaces:

ICommand, PermissionsName

Direct Known Subclasses:

HelpCommand, LanguageCommand, PingCommandExample, PrefixCommand

public abstract class Command
extends Object
implements ICommand, PermissionsName

Implementation of ICommand interface.

Field Summary

Fields inherited from interface com.ericramirezs.commando4j.command.PermissionsName

NAME

Constructor Summary

Constructors

Constructor and Description
Command(@NotNull String name, @NotNull String group, String description, IArgument... args) Creates a new Command Object.

Method Summary

Modifier and Type	Method and Description
protected Command	addAliases(String... aliases) Add alternative names to call this command.
protected Command	addClientPermissions(net.dv8tion.jda.api.Permission... permissions) Add Discord Permissions required by the bot in order to run this command.
protected Command	addExample(String example) Add a usage example to display in help command.
protected Command	addExamples(String... example) Add multiple usage examples to display in help command.
protected Command	addMemberPermissions(net.dv8tion.jda.api.Permission... permissions) Add Discord Permissions required by the user in order to run this command.
@NotNull String	anyUsage(net.dv8tion.jda.api.events.Event event) Generates example usages of the command.
protected @Nullable String	checkClientPermissions(net.dv8tion.jda.api.events.Event event) Check if the Client has the required permissions to run this command.
protected @Nullable String	checkMemberPermissions(net.dv8tion.jda.api.events.Event event) Check if the User has the required permissions to run this command.
String	checkPermissions(net.dv8tion.jda.api.events.Event event) Check if the user has permission to run this command, and to run it in the current channel.
List<String>	getAliases() Get a list of alternative names to call this command.
IArgument	getArgument(String name) Get a specific argument by its name.
List<IArgument>	getArguments() Get a list of arguments expected by this command.
List<net.dv8tion.jda.api.Permission>	getClientPermissions() Get the list of Permission required by the bot in the server to execute this command.
String	getDescription() Get the command's short description.
String	getDescription(net.dv8tion.jda.api.events.Event event) Get the command's short description.
String	getDetails() Get the command's detailed description.
String	getDetails(net.dv8tion.jda.api.events.Event event) Get the command's detailed description.
List<String>	getExamples() Get a list of example usages.
String	getGroup() get the command group's name or category.
String	getGroup(net.dv8tion.jda.api.events.Event event) get the command group's name or category.
List<net.dv8tion.jda.api.Permission>	getMemberPermissions() Get the list of Permission required by the Discord member in the server to execute this command.
String	getName() get the command's name.
String	getName(net.dv8tion.jda.api.events.Event event) get the command's name.
Throttling	getThrottling() Get the Throttling configuration for this command.
protected String	hasPermission(net.dv8tion.jda.api.events.Event event) Custom check of permission.
protected String	hasPermission(net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Custom check of permission
protected String	hasPermission(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event) Custom check of permission
boolean	isGuildOnly() Checks if the command should only be used inside a Discord server.
boolean	isNsfw() Checks if the command should only be used in channels marked as NSFW.
boolean	isPrivateUseOnly() Checks if the command should only be used in Direct Messages.
boolean	isRunInThread() Checks if the command should run inside a Discord Thread.
boolean	isThreadOnly() Checks if the command should only be used inside threads.
void	onDirectMessageReceived(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Handles a command call from Direct Messages.
void	onGuildMessageReceived(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Handles a command call from a Normal Server Channel.
void	onGuildThreadMessageReceived(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Handles a command call from a Thread Server Channel.
abstract void	run(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, @NotNull Map<String,IArgument> args) Command execution after all validations has been passed.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.Event event, @NotNull net.dv8tion.jda.api.EmbedBuilder reply) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.Event event, @NotNull net.dv8tion.jda.api.entities.MessageEmbed reply) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.Event event, @NotNull String reply) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, @NotNull net.dv8tion.jda.api.EmbedBuilder reply) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, @NotNull net.dv8tion.jda.api.entities.MessageEmbed reply) Reply to the Original Message that executed this command.
void	sendReply(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, @NotNull String reply) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull net.dv8tion.jda.api.EmbedBuilder reply, boolean ephemeral) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull net.dv8tion.jda.api.entities.MessageEmbed reply, boolean ephemeral) Reply to the Original Message that executed this command.
protected void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull String reply, boolean ephemeral) Reply to the Original Message that executed this command.
Command	setDetails(String details) Set a detailed description of this command
protected Command	setGuildOnly() Mark this command as Guild only.
protected Command	setNotRunInThreads() Mark this command as not compatible with Threads The command will not be available to run inside Discord's threads NOTE: this flag will remove Thread Only flag.
protected Command	setNsfw() Mark this command to only be usable in channels marked as NSFW.
protected Command	setPrivateUseOnly() Mark this command as Private Only This command will not be able inside any Discord Server.
protected Command	setThreadOnly() Mark this command as Thread only The command will not be available to run in a normal Text Channel The command will not be available inside a Private Message.
protected Command	setThrottling(Throttling throttling) Set the throttling configuration for this command.
protected boolean	shouldRun(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event) Check if the command should be run in the current Message Channel.
String	toString()
String	usage(String arg, @NotNull net.dv8tion.jda.api.events.Event event) Generates an example usage of the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(@NotNull
               @NotNull String name,
               @NotNull
               @NotNull String group,
               String description,
               IArgument... args)
        throws DuplicatedArgumentNameException

Creates a new Command Object. Run method is required to be implemented.

You may implement Slash to include this command as a Discord's Slash Command

Parameters:

name - Command name. It must be unique.

group - Group's name. It is used by the default help command to categorize commands. It has no real effects in the engine.

description - Command's description, It is used by the default help command to explain what the command do. It has no real effects in the engine.

args - List of Arguments accepted by this command.

Throws:

DuplicatedArgumentNameException - Thrown when another Command with the same name has already been registered in the Engine

Method Detail

run

public abstract void run(@NotNull
                         @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                         @NotNull
                         @NotNull Map<String,IArgument> args)

Command execution after all validations has been passed.

Parameters:

event - Discord event that triggered this command call

args - Already parsed arguments, Map's keys are the argument's name

setDetails

public Command setDetails(String details)

Set a detailed description of this command

Parameters:

details - detailed description

Returns:

a reference to this object.

addAliases

protected final Command addAliases(String... aliases)

Add alternative names to call this command.

Parameters:

aliases - list of aliases or alternative names.

Returns:

a reference to this object.

addExample

protected final Command addExample(String example)

Add a usage example to display in help command.

Parameters:

example - usage example.

Returns:

a reference to this object.

addExamples

protected final Command addExamples(String... example)

Add multiple usage examples to display in help command.

Parameters:

example - usage examples list.

Returns:

a reference to this object.

addClientPermissions

protected final Command addClientPermissions(net.dv8tion.jda.api.Permission... permissions)

Add Discord Permissions required by the bot in order to run this command.

i.e. SEND_MESSAGE in order to send a message to a Discord Channel.

Parameters:

permissions - Discord Permissions list.

Returns:

a reference to this object.

See Also:

Permission

addMemberPermissions

protected final Command addMemberPermissions(net.dv8tion.jda.api.Permission... permissions)

Add Discord Permissions required by the user in order to run this command.

i.e. ADMINISTRATOR in order to prevent normal users to modify the bot setting in this server.

Parameters:

permissions - Discord Permissions list.

Returns:

a reference to this object.

See Also:

Permission

shouldRun

protected final boolean shouldRun(@NotNull
                                  @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Check if the command should be run in the current Message Channel.

Parameters:

event - Discord Event that triggered this function call.

Returns:

true if the command is compatible with the current Message Channel.

checkClientPermissions

@Nullable
protected final @Nullable String checkClientPermissions(net.dv8tion.jda.api.events.Event event)

Check if the Client has the required permissions to run this command.

Parameters:

event - Discord Event that triggered this function call.

Returns:

Error message with the first missing Permission find. Null if no Permission is missing.

See Also:

Permission

checkMemberPermissions

@Nullable
protected final @Nullable String checkMemberPermissions(net.dv8tion.jda.api.events.Event event)

Check if the User has the required permissions to run this command.

Parameters:

event - Discord Event that triggered this function call.

Returns:

Error message with the first missing Permission find. Null if no Permission is missing.

See Also:

Permission

hasPermission

protected String hasPermission(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Custom check of permission

Parameters:

event - Message Event that triggered this function Call

Returns:

null if there's no permission issues with this command, a string with the permission problem if the user or client cannot execute the command.

hasPermission

protected String hasPermission(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)

Custom check of permission

Parameters:

event - Slash Command Event that triggered this function Call

Returns:

null if there's no permission issues with this command, a string with the permission problem if the user or client cannot execute the command.

hasPermission

protected String hasPermission(net.dv8tion.jda.api.events.Event event)

Custom check of permission. Override to add complex or customized usage validations.

Parameters:

event - Generic Event that triggered this function Call

Returns:

null if there's no permission issues with this command, a string with the permission problem if the user or client cannot execute the command.

sendReply

public final void sendReply(@NotNull
                            @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                            @NotNull
                            @NotNull String reply)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - reply message

See Also:

Permission, Guild

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                               @NotNull
                               @NotNull net.dv8tion.jda.api.EmbedBuilder reply)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - EmbedBuilder message

See Also:

Permission, Guild, EmbedBuilder

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                               @NotNull
                               @NotNull net.dv8tion.jda.api.entities.MessageEmbed reply)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - MessageEmbed

See Also:

Permission, Guild, MessageEmbed

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.Event event,
                               @NotNull
                               @NotNull String reply)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - reply message

See Also:

Permission, Guild

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.Event event,
                               @NotNull
                               @NotNull net.dv8tion.jda.api.EmbedBuilder reply)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - EmbedBuilder message

See Also:

Permission, Guild, EmbedBuilder

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.Event event,
                               @NotNull
                               @NotNull net.dv8tion.jda.api.entities.MessageEmbed reply)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - MessageEmbed

See Also:

Permission, Guild, MessageEmbed

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                               @NotNull
                               @NotNull String reply,
                               boolean ephemeral)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - reply message

ephemeral - True, if this message should be invisible for other users.

See Also:

Permission, Guild

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                               @NotNull
                               @NotNull net.dv8tion.jda.api.EmbedBuilder reply,
                               boolean ephemeral)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - EmbedBuilder message

ephemeral - True, if this message should be invisible for other users.

See Also:

Permission, Guild, EmbedBuilder

sendReply

protected final void sendReply(@NotNull
                               @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                               @NotNull
                               @NotNull net.dv8tion.jda.api.entities.MessageEmbed reply,
                               boolean ephemeral)

Reply to the Original Message that executed this command.

If the command was called inside a Guild

• If the bot has MESSAGE_HISTORY and MESSAGE_SEND permissions, it will reply referencing the original Message
• If the bot has MESSAGE_SEND permissions, it will reply mentioning the author of the original message.
• If the bot doesn't has any of the previous permissions, it will send a DM to the author of the original message.

Parameters:

event - Discord event that triggered this function call

reply - MessageEmbed

ephemeral - True, if this message should be invisible for other users.

See Also:

Permission, Guild, MessageEmbed

setThrottling

protected Command setThrottling(Throttling throttling)

Set the throttling configuration for this command.

Parameters:

throttling - throttling configuration

Returns:

a reference to this object.

setNsfw

protected Command setNsfw()

Mark this command to only be usable in channels marked as NSFW.

NOTE: If the command is called in a Private message, it will be treated as a NSFW channel.

Returns:

a reference to this object.

setGuildOnly

protected Command setGuildOnly()

Mark this command as Guild only.

The command will not be available inside a Private message.

The command will not be listed by the default help command in a Private message, unless the argument all is included

Returns:

a reference to this object.

setNotRunInThreads

protected Command setNotRunInThreads()

Mark this command as not compatible with Threads

The command will not be available to run inside Discord's threads

NOTE: this flag will remove Thread Only flag.

Returns:

a reference to this object.

setThreadOnly

protected Command setThreadOnly()

Mark this command as Thread only

The command will not be available to run in a normal Text Channel

The command will not be available inside a Private Message.

NOTE: this flag will remove the Not Run in threads flag.

Returns:

a reference to this object.

setPrivateUseOnly

protected Command setPrivateUseOnly()

Mark this command as Private Only

This command will not be able inside any Discord Server.

NOTE: this flag has priority over Guild only and Thread only tags.

Returns:

a reference to this object.

onDirectMessageReceived

public final void onDirectMessageReceived(@NotNull
                                          @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Description copied from interface: ICommand

Handles a command call from Direct Messages.

Specified by:

onDirectMessageReceived in interface ICommand

Parameters:

event - Discord event that triggered this function call.

onGuildThreadMessageReceived

public final void onGuildThreadMessageReceived(@NotNull
                                               @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Description copied from interface: ICommand

Handles a command call from a Thread Server Channel.

Specified by:

onGuildThreadMessageReceived in interface ICommand

Parameters:

event - Discord event that triggered this function call.

onGuildMessageReceived

public final void onGuildMessageReceived(@NotNull
                                         @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Description copied from interface: ICommand

Handles a command call from a Normal Server Channel.

Specified by:

onGuildMessageReceived in interface ICommand

Parameters:

event - Discord event that triggered this function call.

checkPermissions

public String checkPermissions(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

Check if the user has permission to run this command, and to run it in the current channel.

Specified by:

checkPermissions in interface ICommand

Parameters:

event - Discord event that triggered this function call.

Returns:

Error message explaining why the command cannot be executed.

getName

public String getName()

Description copied from interface: ICommand

get the command's name.

Specified by:

getName in interface ICommand

Returns:

command's name.

getGroup

public String getGroup()

Description copied from interface: ICommand

get the command group's name or category.

Specified by:

getGroup in interface ICommand

Returns:

command group's name.

getDescription

public String getDescription()

Description copied from interface: ICommand

Get the command's short description.

Specified by:

getDescription in interface ICommand

Returns:

command's description.

getName

public String getName(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

get the command's name.

Specified by:

getName in interface ICommand

Parameters:

event - Discord's event that triggered this function call.

Returns:

command's name.

getGroup

public String getGroup(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

get the command group's name or category.

Specified by:

getGroup in interface ICommand

Parameters:

event - Discord's event that triggered this function call.

Returns:

command group's name.

getDescription

public String getDescription(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

Get the command's short description.

Specified by:

getDescription in interface ICommand

Parameters:

event - Discord's event that triggered this function call.

Returns:

command's description.

getDetails

public String getDetails(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

Get the command's detailed description.

Specified by:

getDetails in interface ICommand

Parameters:

event - Discord's event that triggered this function call.

Returns:

command's detailed description.

getArguments

public List<IArgument> getArguments()

Description copied from interface: ICommand

Get a list of arguments expected by this command.

Specified by:

getArguments in interface ICommand

Returns:

list of arguments.

getExamples

public List<String> getExamples()

Description copied from interface: ICommand

Get a list of example usages.

Specified by:

getExamples in interface ICommand

Returns:

list of example usages.

getArgument

public IArgument getArgument(String name)

Description copied from interface: ICommand

Get a specific argument by its name.

Specified by:

getArgument in interface ICommand

Parameters:

name - Argument's name.

Returns:

Argument's object.

getThrottling

public Throttling getThrottling()

Description copied from interface: ICommand

Get the Throttling configuration for this command.

Specified by:

getThrottling in interface ICommand

Returns:

Throttling configuration.

isNsfw

public boolean isNsfw()

Description copied from interface: ICommand

Checks if the command should only be used in channels marked as NSFW.

Specified by:

isNsfw in interface ICommand

Returns:

true if the command is marked as NSFW, false otherwise.

getAliases

public List<String> getAliases()

Description copied from interface: ICommand

Get a list of alternative names to call this command.

Specified by:

getAliases in interface ICommand

Returns:

list of alternative names.

getClientPermissions

public List<net.dv8tion.jda.api.Permission> getClientPermissions()

Description copied from interface: ICommand

Get the list of Permission required by the bot in the server to execute this command.

Specified by:

getClientPermissions in interface ICommand

Returns:

list of Permission.

getMemberPermissions

public List<net.dv8tion.jda.api.Permission> getMemberPermissions()

Description copied from interface: ICommand

Get the list of Permission required by the Discord member in the server to execute this command.

Specified by:

getMemberPermissions in interface ICommand

Returns:

list of Permission.

isGuildOnly

public boolean isGuildOnly()

Description copied from interface: ICommand

Checks if the command should only be used inside a Discord server.

Specified by:

isGuildOnly in interface ICommand

Returns:

true if the command is only usable in a Discord Server, false if compatible with Direct Message.

isRunInThread

public boolean isRunInThread()

Description copied from interface: ICommand

Checks if the command should run inside a Discord Thread.

Specified by:

isRunInThread in interface ICommand

Returns:

true if the command can run inside a Discord Thread, false if it can only run in normal channels.

isThreadOnly

public boolean isThreadOnly()

Description copied from interface: ICommand

Checks if the command should only be used inside threads.

Specified by:

isThreadOnly in interface ICommand

Returns:

true if the command is only usable in threads, false otherwise.

isPrivateUseOnly

public boolean isPrivateUseOnly()

Description copied from interface: ICommand

Checks if the command should only be used in Direct Messages.

Specified by:

isPrivateUseOnly in interface ICommand

Returns:

True if command should only be used inside Direct Messages.

toString

public String toString()

Overrides:

toString in class Object

getDetails

public String getDetails()

Description copied from interface: ICommand

Get the command's detailed description.

Specified by:

getDetails in interface ICommand

Returns:

command's detailed description.

anyUsage

@NotNull
public final @NotNull String anyUsage(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

Generates example usages of the command.

Specified by:

anyUsage in interface ICommand

Parameters:

event - Discord's event that triggered this function call.

Returns:

Usage example for discord chat.

usage

public String usage(String arg,
                    @NotNull
                    @NotNull net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

Generates an example usage of the command.

Specified by:

usage in interface ICommand

Parameters:

arg - Arguments in the example.

event - Discord event that triggered this function call.

Returns:

example usage of the command.