Class FormattedCommandAlias

java.lang.Object

org.bukkit.command.Command

org.bukkit.command.FormattedCommandAlias

@Obsolete(since="26.3")
public class FormattedCommandAlias
extends Command

API Note:

plugin developers should prefer to use the Brigadier command API. For a direct alternative to Bukkit commands, Basic commands are recommended

Field Summary

Fields inherited from class Command

description, timings, usageMessage

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class Command

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

Methods inherited from class Object

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

Constructor Details

FormattedCommandAlias

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

Method Details

execute

public boolean execute(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String commandLabel,
 @NotNull
 @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

getTimingName

@NotNull
public @NotNull String getTimingName()

Overrides:

getTimingName in class Command