net.md_5.bungee.api.connection

Interface ProxiedPlayer

All Superinterfaces:

CommandSender, Connection

All Known Subinterfaces:

ConnectedPlayer

public interface ProxiedPlayer
extends Connection, CommandSender

Represents a player who's connection is being connected to somewhere else, whether it be a remote or embedded server.

Nested Class Summary

Nested classes/interfaces inherited from interface net.md_5.bungee.api.connection.Connection

Connection.Unsafe

Method Summary

Methods

Modifier and Type	Method and Description
void	chat(String message) Make this player chat (say something), to the server he is currently on.
void	connect(ServerInfo target) Connects / transfers this user to the specified connection, gracefully closing the current one.
void	connect(ServerInfo target, Callback<Boolean> callback) Connects / transfers this user to the specified connection, gracefully closing the current one.
String	getDisplayName() Gets this player's display name.
Locale	getLocale() Gets this player's locale.
PendingConnection	getPendingConnection() Get the pending connection that belongs to this player.
int	getPing() Gets the ping time between the proxy and this connection.
ServerInfo	getReconnectServer() Get the server which this player will be sent to next time the log in.
Server	getServer() Gets the server this player is connected to.
UUID	getUniqueId() Get this connection's UUID, if set.
String	getUUID() Deprecated. In favour of getUniqueId()
void	sendData(String channel, byte[] data) Send a plugin message to this player.
void	setDisplayName(String name) Sets this players display name to be used as their nametag and tab list name.
void	setReconnectServer(ServerInfo server) Set the server which this player will be sent to next time the log in.

Methods inherited from interface net.md_5.bungee.api.connection.Connection

disconnect, disconnect, disconnect, getAddress, unsafe

Methods inherited from interface net.md_5.bungee.api.CommandSender

addGroups, getGroups, getName, getPermissions, hasPermission, removeGroups, sendMessage, sendMessage, sendMessage, sendMessages, setPermission

Method Detail

getDisplayName

String getDisplayName()

Gets this player's display name.

Returns:

the players current display name

setDisplayName

void setDisplayName(String name)

Sets this players display name to be used as their nametag and tab list name.

Parameters:

name - the name to set

connect

void connect(ServerInfo target)

Connects / transfers this user to the specified connection, gracefully closing the current one. Depending on the implementation, this method might return before the user has been connected.

Parameters:

target - the new server to connect to

connect

void connect(ServerInfo target,
           Callback<Boolean> callback)

Connects / transfers this user to the specified connection, gracefully closing the current one. Depending on the implementation, this method might return before the user has been connected.

Parameters:

target - the new server to connect to

callback - the method called when the connection is complete, or when an exception is encountered. The boolean parameter denotes success or failure.

getServer

Server getServer()

Gets the server this player is connected to.

Returns:

the server this player is connected to

getPing

int getPing()

Gets the ping time between the proxy and this connection.

Returns:

the current ping time

sendData

void sendData(String channel,
            byte[] data)

Send a plugin message to this player.

Parameters:

channel - the channel to send this data via

data - the data to send

getPendingConnection

PendingConnection getPendingConnection()

Get the pending connection that belongs to this player.

Returns:

the pending connection that this player used

chat

void chat(String message)

Make this player chat (say something), to the server he is currently on.

Parameters:

message - the message to say

getReconnectServer

ServerInfo getReconnectServer()

Get the server which this player will be sent to next time the log in.

Returns:

the server, or null if default

setReconnectServer

void setReconnectServer(ServerInfo server)

Set the server which this player will be sent to next time the log in.

Parameters:

server - the server to set

getUUID

@Deprecated
String getUUID()

Deprecated. In favour of getUniqueId()

Get this connection's UUID, if set.

Returns:

the UUID

getUniqueId

UUID getUniqueId()

Get this connection's UUID, if set.

Returns:

the UUID

getLocale

Locale getLocale()

Gets this player's locale.

Returns:

the locale