Package org.bukkit.command

Class FormattedCommandAlias

java.lang.Object

org.bukkit.command.Command

org.bukkit.command.FormattedCommandAlias

public class FormattedCommandAlias
extends Command

Field Summary

Fields inherited from class org.bukkit.command.Command

description, timings, usageMessage

Constructor Summary

Constructors

Constructor	Description
FormattedCommandAlias(String alias, String[] formatStrings)

Method Summary

Modifier and Type	Method	Description
boolean	execute(CommandSender sender, String commandLabel, String[] args)	Executes the command, returning its success

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

Constructor Detail

FormattedCommandAlias

public FormattedCommandAlias(@NotNull
                             String alias,
                             @NotNull
                             String[] formatStrings)

Method Detail

execute

public boolean execute(@NotNull
                       CommandSender sender,
                       @NotNull
                       String commandLabel,
                       @NotNull
                       String[] args)

Description copied from class: Command

Executes the command, returning its success

Specified by:

execute in class Command

Parameters:

sender - Source object which is executing this command

commandLabel - The alias of the command used

args - All arguments passed to the command, split via ' '

Returns:

true if the command was successful, otherwise false