Package com.velocitypowered.api.event.connection

Class PreTransferEvent

java.lang.Object

com.velocitypowered.api.event.connection.PreTransferEvent

All Implemented Interfaces:

ResultedEvent<PreTransferEvent.TransferResult>

@AwaitingEvent
@Experimental
public final class PreTransferEvent
extends Object
implements ResultedEvent<PreTransferEvent.TransferResult>

This event is executed before sending a player to another host, either by the backend server or by a plugin using the Player.transferToHost(InetSocketAddress) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreTransferEvent.TransferResult	Transfer Result of a player to another host.

Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
PreTransferEvent(Player player, InetSocketAddress address)	Constructs a new PreTransferEvent.

Method Summary

Modifier and Type	Method	Description
PreTransferEvent.TransferResult	getResult()	Returns the result associated with this event.
InetSocketAddress	originalAddress()	Returns the original target address the player is attempting to connect to.
Player	player()	Returns the player attempting to transfer.
void	setResult(PreTransferEvent.TransferResult result)	Sets the result of this event.

Methods inherited from class java.lang.Object

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

Constructor Details

PreTransferEvent

public PreTransferEvent(Player player,
 InetSocketAddress address)

Constructs a new PreTransferEvent.

Parameters:

player - the player being transferred

address - the destination address

Method Details

player

public Player player()

Returns the player attempting to transfer.

Returns:

the player

originalAddress

public InetSocketAddress originalAddress()

Returns the original target address the player is attempting to connect to.

Returns:

the original address

getResult

public PreTransferEvent.TransferResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<PreTransferEvent.TransferResult>

Returns:

the result of this event

setResult

public void setResult(PreTransferEvent.TransferResult result)

Description copied from interface: ResultedEvent

Sets the result of this event. The result must be non-null.

Specified by:

setResult in interface ResultedEvent<PreTransferEvent.TransferResult>

Parameters:

result - the new result