us.myles.ViaVersion.commands

Class ViaCommandHandler

java.lang.Object

us.myles.ViaVersion.commands.ViaCommandHandler

All Implemented Interfaces:

ViaVersionCommand

Direct Known Subclasses:

BukkitCommandHandler, BungeeCommandHandler, SpongeCommandHandler, VelocityCommandHandler

public abstract class ViaCommandHandler
extends Object
implements ViaVersionCommand

Constructor Summary

Constructors

Constructor and Description
ViaCommandHandler()

Method Summary

Modifier and Type	Method and Description
static String	color(String string) Replaces colour codes in a string
ViaSubCommand	getSubCommand(String name) Get subcommand instance by name
boolean	hasSubCommand(String name) Check if a subcommand is registered.
boolean	onCommand(ViaCommandSender sender, String[] args) Executed when the Command sender executes the commands
List<String>	onTabComplete(ViaCommandSender sender, String[] args) Executed when the Command sender tab-completes
void	registerSubCommand(ViaSubCommand command) Register your own subcommand inside ViaVersion
static void	sendMessage(ViaCommandSender sender, String message, Object... args) Send a colour coded string with replacements to a user
void	showHelp(ViaCommandSender sender) Shows the ViaVersion help to a sender

Methods inherited from class java.lang.Object

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

Constructor Detail

ViaCommandHandler

public ViaCommandHandler()

Method Detail

registerSubCommand

public void registerSubCommand(ViaSubCommand command)
                        throws Exception

Description copied from interface: ViaVersionCommand

Register your own subcommand inside ViaVersion

Specified by:

registerSubCommand in interface ViaVersionCommand

Parameters:

command - Your own SubCommand instance to handle it.

Throws:

Exception - throws an exception when the subcommand already exists or if it's not valid, example: spacee

hasSubCommand

public boolean hasSubCommand(String name)

Description copied from interface: ViaVersionCommand

Check if a subcommand is registered.

Specified by:

hasSubCommand in interface ViaVersionCommand

Parameters:

name - Subcommand name

Returns:

true if it exists

getSubCommand

public ViaSubCommand getSubCommand(String name)

Description copied from interface: ViaVersionCommand

Get subcommand instance by name

Specified by:

getSubCommand in interface ViaVersionCommand

Parameters:

name - subcommand name

Returns:

ViaSubCommand instance

onCommand

public boolean onCommand(ViaCommandSender sender,
                         String[] args)

Description copied from interface: ViaVersionCommand

Executed when the Command sender executes the commands

Specified by:

onCommand in interface ViaVersionCommand

Parameters:

sender - Sender object

args - arguments provided

Returns:

was successful

onTabComplete

public List<String> onTabComplete(ViaCommandSender sender,
                                  String[] args)

Description copied from interface: ViaVersionCommand

Executed when the Command sender tab-completes

Specified by:

onTabComplete in interface ViaVersionCommand

Parameters:

sender - Sender object

args - arguments provided

Returns:

was successful

showHelp

public void showHelp(ViaCommandSender sender)

Shows the ViaVersion help to a sender

Parameters:

sender - The sender to send the help to

color

public static String color(String string)

Replaces colour codes in a string

Parameters:

string - String to replace

Returns:

The output String

sendMessage

public static void sendMessage(ViaCommandSender sender,
                               String message,
                               Object... args)

Send a colour coded string with replacements to a user

Parameters:

sender - The target to send the message to

message - The message

args - The objects to replace