Package org.bukkit.event.server
Class TabCompleteEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.server.TabCompleteEvent
- All Implemented Interfaces:
Cancellable
Called when a
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
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
.- API Note:
- Only called for bukkit API commands
Command
andCommandExecutor
and not for brigadier commands (Commands
).
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
ConstructorDescriptionTabCompleteEvent
(@NotNull CommandSender sender, @NotNull String buffer, @NotNull List<String> completions) TabCompleteEvent
(@NotNull CommandSender sender, @NotNull String buffer, @NotNull List<String> completions, boolean isCommand, Location location) -
Method Summary
Modifier and TypeMethodDescriptionReturn the entire buffer which formed the basis of this completion.The list of completions which will be offered to the sender, in order.static @NotNull HandlerList
Get the sender completing this command.boolean
Gets the cancellation state of this event.boolean
void
setCancelled
(boolean cancelled) Sets the cancellation state of this event.void
setCompletions
(@NotNull List<String> completions) Set the completions offered, overriding any already set.Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
TabCompleteEvent
-
TabCompleteEvent
-
-
Method Details
-
getSender
Get the sender completing this command.- Returns:
- the
CommandSender
instance
-
getBuffer
Return the entire buffer which formed the basis of this completion.- Returns:
- command buffer, as entered
-
getCompletions
The list of completions which will be offered to the sender, in order. This list is mutable and reflects what will be offered.- Returns:
- a list of offered completions
-
isCommand
public boolean isCommand()- Returns:
- True if it is a command being tab completed, false if it is a chat message.
-
getLocation
- Returns:
- The position looked at by the sender, or null if none
-
setCompletions
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- Parameters:
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 interfaceCancellable
- Returns:
- 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 interfaceCancellable
- Parameters:
cancelled
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-