org.bukkit.command

Interface TabCompleter

All Known Subinterfaces:

Plugin, TabExecutor

All Known Implementing Classes:

JavaPlugin, PluginBase

public interface TabCompleter

Represents a class which can suggest tab completions for commands.

Method Summary

Modifier and Type	Method and Description
List<String>	onTabComplete(CommandSender sender, Command command, String alias, String[] args) Requests a list of possible completions for a command argument.

Method Detail

onTabComplete

@Nullable
List<String> onTabComplete(@NotNull
                                     CommandSender sender,
                                     @NotNull
                                     Command command,
                                     @NotNull
                                     String alias,
                                     @NotNull
                                     String[] args)

Requests a list of possible completions for a command argument.

Parameters:

sender - Source of the command. For players tab-completing a command inside of a command block, this will be the player, not the command block.

command - Command which was executed

alias - The alias used

args - The arguments passed to the command, including final partial argument to be completed and command label

Returns:

A List of possible completions for the final argument, or null to default to the command executor