Package com.ticxo.modelengine.api.command

Class AbstractCommand

java.lang.Object

com.ticxo.modelengine.api.command.AbstractCommand

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor

public abstract class AbstractCommand
extends Object
implements org.bukkit.command.TabExecutor

Viking-pillaged from LumineUtils Thanks Ash :kekw:

Field Summary

Fields

Modifier and Type	Field	Description
protected final ModelEngineAPI	plugin

Constructor Summary

Constructors

Constructor	Description
AbstractCommand(AbstractCommand parent)
AbstractCommand(ModelEngineAPI plugin)

Method Summary

Modifier and Type	Method	Description
final void	addSubCommands(AbstractCommand... commands)
String[]	getAliases()	Can be overridden to add aliases for the command
abstract String	getName()
abstract String	getPermissionNode()	Permission node for this command.
protected ModelEngineAPI	getPlugin()
abstract boolean	isConsoleFriendly()	Whether this command supports ConsoleCommandSender
boolean	onCommand(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command cmd, @NotNull String label, String[] args)
abstract boolean	onCommand(org.bukkit.command.CommandSender sender, String[] args)	Called when someone uses this command
List<String>	onTabComplete(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command cmd, @NotNull String label, String[] args)
abstract List<String>	onTabComplete(org.bukkit.command.CommandSender sender, String[] args)	Called when someone requests tab completion for this command

Methods inherited from class java.lang.Object

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

Field Details

plugin

protected final ModelEngineAPI plugin

Constructor Details

AbstractCommand

public AbstractCommand(AbstractCommand parent)

AbstractCommand

public AbstractCommand(ModelEngineAPI plugin)

Method Details

addSubCommands

public final void addSubCommands(AbstractCommand... commands)

onCommand

public boolean onCommand(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull org.bukkit.command.Command cmd,
 @NotNull
 @NotNull String label,
 String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

onTabComplete

public List<String> onTabComplete(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull org.bukkit.command.Command cmd,
 @NotNull
 @NotNull String label,
 String[] args)

Specified by:

onTabComplete in interface org.bukkit.command.TabCompleter

onCommand

public abstract boolean onCommand(org.bukkit.command.CommandSender sender,
 String[] args)

Called when someone uses this command

Parameters:

sender - Sender of this command

args - Arguments used

Returns:

same as a normal onCommand method

onTabComplete

public abstract List<String> onTabComplete(org.bukkit.command.CommandSender sender,
 String[] args)

Called when someone requests tab completion for this command

Parameters:

sender - The CommandSender who is tab-completing

args - Tab completion arguments

Returns:

A list of possible completions

getPermissionNode

public abstract String getPermissionNode()

Permission node for this command.

Returns:

Permission node

isConsoleFriendly

public abstract boolean isConsoleFriendly()

Whether this command supports ConsoleCommandSender

Returns:

true if command can be used by console, false otherwise

getAliases

public String[] getAliases()

Can be overridden to add aliases for the command

Returns:

List

getName

public abstract String getName()

Returns:

The name of this command (or subcommand)

getPlugin

protected ModelEngineAPI getPlugin()