Package net.md_5.bungee.api.event
Class TabCompleteEvent
- java.lang.Object
-
- net.md_5.bungee.api.plugin.Event
-
- net.md_5.bungee.api.event.TargetedEvent
-
- net.md_5.bungee.api.event.TabCompleteEvent
-
- All Implemented Interfaces:
Cancellable
public class TabCompleteEvent extends TargetedEvent implements Cancellable
Event called when a player uses tab completion.
-
-
Constructor Summary
Constructors Constructor Description TabCompleteEvent(Connection sender, Connection receiver, String cursor, List<String> suggestions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
String
getCursor()
The message the player has already entered.List<String>
getSuggestions()
The suggestions that will be sent to the client.int
hashCode()
boolean
isCancelled()
Cancelled state.void
setCancelled(boolean cancelled)
Cancelled state.String
toString()
-
Methods inherited from class net.md_5.bungee.api.event.TargetedEvent
getReceiver, getSender
-
-
-
-
Constructor Detail
-
TabCompleteEvent
public TabCompleteEvent(Connection sender, Connection receiver, String cursor, List<String> suggestions)
-
-
Method Detail
-
isCancelled
public boolean isCancelled()
Cancelled state.- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- the cancelled state of this event
-
getCursor
public String getCursor()
The message the player has already entered.
-
getSuggestions
public List<String> getSuggestions()
The suggestions that will be sent to the client. This list is mutable. If this list is empty, the request will be forwarded to the server.
-
setCancelled
public void setCancelled(boolean cancelled)
Cancelled state.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancelled
- the state to set
-
toString
public String toString()
- Overrides:
toString
in classTargetedEvent
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classTargetedEvent
-
canEqual
protected boolean canEqual(Object other)
- Overrides:
canEqual
in classTargetedEvent
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classTargetedEvent
-
-