Package net.md_5.bungee.api.event
Class ServerKickEvent
java.lang.Object
net.md_5.bungee.api.plugin.Event
net.md_5.bungee.api.event.ServerKickEvent
- All Implemented Interfaces:
Cancellable
Represents a player getting kicked from a server.
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionServerKickEvent
(ProxiedPlayer player, BaseComponent[] kickReasonComponent, ServerInfo cancelServer) Deprecated.ServerKickEvent
(ProxiedPlayer player, BaseComponent[] kickReasonComponent, ServerInfo cancelServer, ServerKickEvent.State state) Deprecated.ServerKickEvent
(ProxiedPlayer player, ServerInfo kickedFrom, BaseComponent[] kickReasonComponent, ServerInfo cancelServer, ServerKickEvent.State state) Deprecated.ServerKickEvent
(ProxiedPlayer player, ServerInfo kickedFrom, BaseComponent reason, ServerInfo cancelServer, ServerKickEvent.State state) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Server to send player to if this event is cancelled.The server the player was kicked from, should be used in preference toProxiedPlayer.getServer()
.Deprecated.use component methods insteadDeprecated.use single component methods insteadPlayer being kicked.Kick reason.getState()
State in which the kick occured.int
hashCode()
boolean
Cancelled status.void
setCancelled
(boolean cancelled) Cancelled status.void
setCancelServer
(ServerInfo cancelServer) Server to send player to if this event is cancelled.void
setKickReason
(String reason) Deprecated.use component methods insteadvoid
setKickReasonComponent
(BaseComponent[] kickReasonComponent) Deprecated.use single component methods insteadvoid
setReason
(BaseComponent reason) Kick reason.void
setState
(ServerKickEvent.State state) State in which the kick occured.toString()
-
Constructor Details
-
ServerKickEvent
@Deprecated public ServerKickEvent(ProxiedPlayer player, BaseComponent[] kickReasonComponent, ServerInfo cancelServer) Deprecated. -
ServerKickEvent
@Deprecated public ServerKickEvent(ProxiedPlayer player, BaseComponent[] kickReasonComponent, ServerInfo cancelServer, ServerKickEvent.State state) Deprecated. -
ServerKickEvent
@Deprecated public ServerKickEvent(ProxiedPlayer player, ServerInfo kickedFrom, BaseComponent[] kickReasonComponent, ServerInfo cancelServer, ServerKickEvent.State state) Deprecated. -
ServerKickEvent
public ServerKickEvent(ProxiedPlayer player, ServerInfo kickedFrom, BaseComponent reason, ServerInfo cancelServer, ServerKickEvent.State state)
-
-
Method Details
-
getKickReason
Deprecated.use component methods instead- Returns:
- the kick reason
-
setKickReason
Deprecated.use component methods instead- Parameters:
reason
- the kick reason
-
getKickReasonComponent
Deprecated.use single component methods instead- Returns:
- the kick reason
-
setKickReasonComponent
Deprecated.use single component methods instead- Parameters:
kickReasonComponent
- the kick reason
-
isCancelled
public boolean isCancelled()Cancelled status.- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- the cancelled state of this event
-
getPlayer
Player being kicked. -
getKickedFrom
The server the player was kicked from, should be used in preference toProxiedPlayer.getServer()
. -
getReason
Kick reason. -
getCancelServer
Server to send player to if this event is cancelled. -
getState
State in which the kick occured. -
setCancelled
public void setCancelled(boolean cancelled) Cancelled status.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancelled
- the state to set
-
setReason
Kick reason. -
setCancelServer
Server to send player to if this event is cancelled. -
setState
State in which the kick occured. -
toString
-
equals
-
canEqual
-
hashCode
public int hashCode()
-