Package com.velocitypowered.api.event.player

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.

Method Summary

Modifier and Type	Method	Description
static KickedFromServerEvent.ServerKickResult	create(RegisteredServer server)	Creates a new redirect result to forward the player to the specified server.
static KickedFromServerEvent.RedirectPlayer	create(RegisteredServer server, Component message)	Creates a new redirect result to forward the player to the specified server.
@Nullable Component	getMessageComponent()
RegisteredServer	getServer()
boolean	isAllowed()	Returns whether or not the event is allowed to proceed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 interface ResultedEvent.Result

Returns:

whether or not the event is allowed to proceed

getServer

public RegisteredServer getServer()

getMessageComponent

public @Nullable Component getMessageComponent()

create

public static KickedFromServerEvent.RedirectPlayer create(RegisteredServer server,
                                                          Component message)

Creates a new redirect result to forward the player to the specified server. The specified message will be sent to the player after the redirection. Use Component.empty() to skip sending any messages to the player.

Parameters:

server - the server to send the player to

message - the message will be sent to the player after redirecting

Returns:

the redirect result

create

public static KickedFromServerEvent.ServerKickResult create(RegisteredServer server)

Creates a new redirect result to forward the player to the specified server. The kick reason will be displayed to the player

Parameters:

server - the server to send the player to

Returns:

the redirect result