me.piggypiglet.framework.commands.implementations

Class HelpCommand

java.lang.Object

me.piggypiglet.framework.commands.framework.Command

me.piggypiglet.framework.commands.implementations.HelpCommand

public final class HelpCommand
extends Command

Nested Class Summary

Nested classes/interfaces inherited from class me.piggypiglet.framework.commands.framework.Command

Command.Options

Field Summary

Fields inherited from class me.piggypiglet.framework.commands.framework.Command

options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HelpCommand()

Method Summary

Modifier and Type	Method and Description
protected boolean	execute(User user, java.lang.String[] args)

Methods inherited from class me.piggypiglet.framework.commands.framework.Command

getCommand, getDescription, getHandler, getHandlers, getPermissions, getUsage, isDefault, run

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

protected HelpCommand()

Method Detail

execute

protected boolean execute(User user,
                          java.lang.String[] args)

Specified by:

execute in class Command

Parameters:

user - Wrapper for any sort of user interaction

args - Message, excluding the prefix and command, split via space. Multiple word arguments can be achieved by using double quotes in the user's input. For example, test "multi word" would only be two arguments.

Returns:

Whether the command's usage method should be sent or not. Returning false will send the message.