Class KickedFromServerEvent.RedirectPlayer
- java.lang.Object
-
- com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
-
- All Implemented Interfaces:
KickedFromServerEvent.ServerKickResult
,ResultedEvent.Result
- Enclosing class:
- KickedFromServerEvent
public static final class KickedFromServerEvent.RedirectPlayer extends Object implements KickedFromServerEvent.ServerKickResult
Tells the proxy to redirect the player to another server. No messages will be sent from the proxy when this result is used.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static KickedFromServerEvent.ServerKickResult
create(RegisteredServer server)
static KickedFromServerEvent.RedirectPlayer
create(RegisteredServer server, Component message)
Creates a new redirect result to forward the player to the specifiedserver
.static KickedFromServerEvent.RedirectPlayer
create(RegisteredServer server, net.kyori.text.Component message)
Deprecated.net.kyori.text.Component
getMessage()
Deprecated.@Nullable Component
getMessageComponent()
RegisteredServer
getServer()
boolean
isAllowed()
Returns whether or not the event is allowed to proceed.
-
-
-
Method Detail
-
isAllowed
public boolean isAllowed()
Description copied from interface:ResultedEvent.Result
Returns whether or not the event is allowed to proceed. Plugins may choose to skip denied events, and the proxy will respect the result of this method.- Specified by:
isAllowed
in interfaceResultedEvent.Result
- Returns:
- whether or not the event is allowed to proceed
-
getServer
public RegisteredServer getServer()
-
getMessage
@Deprecated public net.kyori.text.Component getMessage()
Deprecated.
-
getMessageComponent
public @Nullable Component getMessageComponent()
-
create
@Deprecated public static KickedFromServerEvent.RedirectPlayer create(RegisteredServer server, net.kyori.text.Component message)
Deprecated.Creates a new redirect result to forward the player to the specifiedserver
.- Parameters:
server
- the server to send the player to- Returns:
- the redirect result
-
create
public static KickedFromServerEvent.RedirectPlayer create(RegisteredServer server, Component message)
Creates a new redirect result to forward the player to the specifiedserver
.- Parameters:
server
- the server to send the player to- Returns:
- the redirect result
-
create
public static KickedFromServerEvent.ServerKickResult create(RegisteredServer server)
-
-