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. No messages will be sent from the proxy when this result is used.

Method Summary

Modifier and Type	Method and Description
static KickedFromServerEvent.ServerKickResult	create(RegisteredServer server)
static KickedFromServerEvent.RedirectPlayer	create(RegisteredServer server, net.kyori.text.Component message) Deprecated. Use create(RegisteredServer, net.kyori.adventure.text.Component)
static KickedFromServerEvent.RedirectPlayer	create(RegisteredServer server, net.kyori.adventure.text.Component message) Creates a new redirect result to forward the player to the specified server.
net.kyori.text.Component	getMessage() Deprecated.
net.kyori.adventure.text.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()

getMessage

@Deprecated
public net.kyori.text.Component getMessage()

Deprecated.

getMessageComponent

public net.kyori.adventure.text.Component getMessageComponent()

create

@Deprecated
public static KickedFromServerEvent.RedirectPlayer create(RegisteredServer server,
                                                                      net.kyori.text.Component message)

Deprecated. Use create(RegisteredServer, net.kyori.adventure.text.Component)

Creates a new redirect result to forward the player to the specified server.

Parameters:

server - the server to send the player to

Returns:

the redirect result

create

public static KickedFromServerEvent.RedirectPlayer create(RegisteredServer server,
                                                          net.kyori.adventure.text.Component message)

Creates a new redirect result to forward the player to the specified server.

Parameters:

server - the server to send the player to

Returns:

the redirect result

create

public static KickedFromServerEvent.ServerKickResult create(RegisteredServer server)