Package com.burchard36.api.command

Class ApiCommand

java.lang.Object

org.bukkit.command.Command

com.burchard36.api.command.ApiCommand

All Implemented Interfaces:

org.bukkit.command.TabCompleter

public class ApiCommand
extends org.bukkit.command.Command
implements org.bukkit.command.TabCompleter

The class you want to use when registering commands. You are meant to extend this class

Since:

2.1.5

Author:

Dalton Burchard

Field Summary

Fields

Modifier and Type	Field	Description
protected OnConsoleSender	onConsoleSender
protected OnPlayerSender	onPlayerSender
protected OnTabComplete	onTabComplete

Fields inherited from class org.bukkit.command.Command

description, timings, usageMessage

Constructor Summary

Constructors

Constructor	Description
ApiCommand()

Method Summary

Modifier and Type	Method	Description
boolean	execute(org.bukkit.command.CommandSender sender, String commandLabel, String[] args)
ApiCommand	onConsoleSender(OnConsoleSender sender)	Sets the function to run when a ConsoleCommandSender sends a command
ApiCommand	onPlayerSender(OnPlayerSender sender)	Sets the function to run when a Player sends a command
ApiCommand	onTabComplete(OnTabComplete onComplete)	Executes a TabCompleter for this command, only usage if you set a OnPlayerSender interface using onPlayerSender
List<String>	onTabComplete(org.bukkit.command.CommandSender sender, org.bukkit.command.Command command, String label, String[] args)
ApiCommand	setCommandAliases(String... aliases)	Sets the aliases of this command
ApiCommand	setCommandDescription(String newDesc)	Sets the description of this command
ApiCommand	setCommandName(String newName)	Sets the command name when executing eg /
ApiCommand	setCommandUsage(String usage)	Sets the Command usage message for this command

Methods inherited from class org.bukkit.command.Command

broadcastCommandMessage, broadcastCommandMessage, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getUsage, isRegistered, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, tabComplete, tabComplete, testPermission, testPermissionSilent, toString, unregister

Methods inherited from class java.lang.Object

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

Field Details

onPlayerSender

protected OnPlayerSender onPlayerSender

onConsoleSender

protected OnConsoleSender onConsoleSender

onTabComplete

protected OnTabComplete onTabComplete

Constructor Details

ApiCommand

public ApiCommand()

Method Details

execute

public boolean execute(@Nonnull
 org.bukkit.command.CommandSender sender,
 @Nonnull
 String commandLabel,
 @Nonnull
 String[] args)

Specified by:

execute in class org.bukkit.command.Command

onPlayerSender

public ApiCommand onPlayerSender(OnPlayerSender sender)

Sets the function to run when a Player sends a command

Parameters:

sender - A OnPlayerSender lambda interface

Returns:

instance of this ApiCommand

Since:

2.1.5

onConsoleSender

public ApiCommand onConsoleSender(OnConsoleSender sender)

Sets the function to run when a ConsoleCommandSender sends a command

Parameters:

sender - A OnConsoleSender lambda interface

Returns:

instance of this ApiCommand

Since:

2.1.5

onTabComplete

public ApiCommand onTabComplete(OnTabComplete onComplete)

Executes a TabCompleter for this command, only usage if you set a OnPlayerSender interface using onPlayerSender

Parameters:

onComplete - A OnTabComplete functional interface lambda

Returns:

instance of this ApiCommand

Since:

2.1.5

setCommandName

public ApiCommand setCommandName(String newName)

Sets the command name when executing eg /

Parameters:

newName - A String without spaces

Returns:

instance of this ApiCommand

Since:

2.1.5

setCommandDescription

public ApiCommand setCommandDescription(String newDesc)

Sets the description of this command

Parameters:

newDesc - Any String

Returns:

instance of this ApiCommand

Since:

2.1.5

setCommandUsage

public ApiCommand setCommandUsage(String usage)

Sets the Command usage message for this command

Parameters:

usage - String to set usage message to

Returns:

instance of this ApiCommand

Since:

2.1.5

setCommandAliases

public ApiCommand setCommandAliases(String... aliases)

Sets the aliases of this command

Parameters:

aliases - Varargs of String's, no strings with spaces

Returns:

instance of this ApiCommand

Since:

2.1.5

onTabComplete

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

Specified by:

onTabComplete in interface org.bukkit.command.TabCompleter