Package org.bukkit.command.defaults
Class HelpCommand
java.lang.Object
org.bukkit.command.Command
org.bukkit.command.defaults.BukkitCommand
org.bukkit.command.defaults.HelpCommand
-
Field Summary
Fields inherited from class org.bukkit.command.Command
description, timings, usageMessage
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected static int
Computes the Dameraur-Levenshtein Distance between two strings.boolean
Executes the command, returning its successfindPossibleMatches
(@NotNull String searchString) tabComplete
(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args) Executed on tab completion for this command, returning a list of options the player can tab through.Methods inherited from class org.bukkit.command.Command
broadcastCommandMessage, broadcastCommandMessage, broadcastCommandMessage, broadcastCommandMessage, canBeOverriden, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getTimingName, getUsage, isRegistered, permissionMessage, permissionMessage, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, tabComplete, testPermission, testPermissionSilent, toString, unregister
-
Constructor Details
-
HelpCommand
public HelpCommand()
-
-
Method Details
-
execute
public boolean execute(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String currentAlias, @NotNull @NotNull String[] args) Description copied from class:Command
Executes the command, returning its success -
tabComplete
@NotNull public @NotNull List<String> tabComplete(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String alias, @NotNull @NotNull String[] args) Description copied from class:Command
Executed on tab completion for this command, returning a list of options the player can tab through.- Overrides:
tabComplete
in classCommand
- Parameters:
sender
- Source object which is executing this commandalias
- the alias being usedargs
- All arguments passed to the command, split via ' '- Returns:
- a list of tab-completions for the specified arguments. This will never be null. List may be immutable.
-
findPossibleMatches
-
damerauLevenshteinDistance
protected static int damerauLevenshteinDistance(@Nullable @Nullable String s1, @Nullable @Nullable String s2) Computes the Dameraur-Levenshtein Distance between two strings. Adapted from the algorithm at Wikipedia: Damerau–Levenshtein distance- Parameters:
s1
- The first string being compared.s2
- The second string being compared.- Returns:
- The number of substitutions, deletions, insertions, and transpositions required to get from s1 to s2.
-