me.piggypiglet.framework.commands.framework

Class Command.Options

java.lang.Object

me.piggypiglet.framework.commands.framework.Command.Options

Enclosing class:

Command<T extends User>

protected class Command.Options
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Options()

Method Summary

Modifier and Type	Method and Description
Command.Options	def(boolean value) Is this a default command? For example a help command.
Command.Options	description(java.lang.String description) Description that will show for this command in the help command
Command.Options	handlers(java.lang.String... handlers) Which handlers should be able to process this command? Leave empty for it to be runnable on all handlers.
Command.Options	permissions(java.lang.String... permissions) What permissions will the User need to run this command? Leave empty for no permissions needed.
Command.Options	usage(java.lang.String usage) Command's usage, should be self explanatory, but an example is <required args> [optional args].

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

protected Options()

Method Detail

handlers

public Command.Options handlers(java.lang.String... handlers)

Which handlers should be able to process this command? Leave empty for it to be runnable on all handlers.

Parameters:

handlers - Handler references

Returns:

Options

description

public Command.Options description(java.lang.String description)

Description that will show for this command in the help command

Parameters:

description - String describing the command, keep it short

Returns:

Options

usage

public Command.Options usage(java.lang.String usage)

Command's usage, should be self explanatory, but an example is <required args> [optional args].

Parameters:

usage - String

Returns:

Options

permissions

public Command.Options permissions(java.lang.String... permissions)

What permissions will the User need to run this command? Leave empty for no permissions needed.

Parameters:

permissions - Permissions

Returns:

Options

def

public Command.Options def(boolean value)

Is this a default command? For example a help command.

Parameters:

value - Boolean

Returns:

Options