Class TabCompleteEvent

All Implemented Interfaces:

public class TabCompleteEvent extends Event implements Cancellable
Called when a CommandSender of any description (ie: player or console) attempts to tab complete.
Note that due to client changes, if the sender is a Player, this event will only begin to fire once command arguments are specified, not commands themselves. Plugins wishing to remove commands from tab completion are advised to ensure the client does not have permission for the relevant commands, or use PlayerCommandSendEvent.
  • Constructor Details

  • Method Details

    • getSender

      @NotNull public @NotNull CommandSender getSender()
      Get the sender completing this command.
      the CommandSender instance
    • getBuffer

      @NotNull public @NotNull String getBuffer()
      Return the entire buffer which formed the basis of this completion.
      command buffer, as entered
    • getCompletions

      @NotNull public @NotNull List<String> getCompletions()
      The list of completions which will be offered to the sender, in order. This list is mutable and reflects what will be offered.
      a list of offered completions
    • isCommand

      public boolean isCommand()
      True if it is a command being tab completed, false if it is a chat message.
    • getLocation

      @Nullable public Location getLocation()
      The position looked at by the sender, or null if none
    • setCompletions

      public void setCompletions(@NotNull @NotNull List<String> completions)
      Set the completions offered, overriding any already set. The passed collection will be cloned to a new List. You must call {getCompletions()} to mutate from here
      completions - the new completions
    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
      Specified by:
      isCancelled in interface Cancellable
      true if this event is cancelled
    • setCancelled

      public void setCancelled(boolean cancelled)
      Description copied from interface: Cancellable
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
      Specified by:
      setCancelled in interface Cancellable
      cancelled - true if you wish to cancel this event
    • getHandlers

      @NotNull public @NotNull HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()