Package com.velocitypowered.api.proxy

Interface Player

All Superinterfaces:

Audience, ChannelMessageSink, ChannelMessageSource, CommandSource, Identified, InboundConnection, PermissionSubject

public interface Player
extends CommandSource, Identified, InboundConnection, ChannelMessageSource, ChannelMessageSink

Represents a player who is connected to the proxy.

Method Summary

Modifier and Type	Method	Description
void	clearHeaderAndFooter()	Deprecated. Use TabList.clearHeaderAndFooter().
ConnectionRequestBuilder	createConnectionRequest(RegisteredServer server)	Creates a new connection request so that the player can connect to another server.
void	disconnect(Component reason)	Disconnects the player with the specified reason.
void	disconnect(net.kyori.text.Component reason)	Deprecated. Use disconnect(Component) instead
Optional<ServerConnection>	getCurrentServer()	Returns the server that the player is currently connected to.
GameProfile	getGameProfile()	Returns the player's game profile.
List<GameProfile.Property>	getGameProfileProperties()	Gets the player's profile properties.
Optional<ModInfo>	getModInfo()	Returns the player's mod info if they have a modded client.
long	getPing()	Returns the current player's ping.
Component	getPlayerListFooter()	Returns the player's player list footer.
Component	getPlayerListHeader()	Returns the player's player list header.
PlayerSettings	getPlayerSettings()	Returns the player's client settings.
TabList	getTabList()	Returns the player's tab list.
UUID	getUniqueId()	Returns the player's UUID.
String	getUsername()	Returns the player's current username.
boolean	isOnlineMode()	Returns the player's connection status.
default void	sendMessage(net.kyori.text.Component component)	Deprecated. Use Audience.sendMessage(Identified, Component) or Audience.sendMessage(Identity, Component) instead
void	sendMessage(net.kyori.text.Component component, MessagePosition position)	Deprecated. Use @deprecated Use Audience.sendMessage(Identified, Component) or Audience.sendMessage(Identity, Component) for chat messages, or Audience.sendActionBar(net.kyori.adventure.text.Component) for action bar messages
void	sendResourcePack(String url)	Sends the specified resource pack from url to the user.
void	sendResourcePack(String url, byte[] hash)	Sends the specified resource pack from url to the user, using the specified 20-byte SHA-1 hash.
void	sendTitle(Title title)	Deprecated. Use Audience.showTitle(net.kyori.adventure.title.Title) and Audience.resetTitle()
void	setGameProfileProperties(List<GameProfile.Property> properties)	Sets the player's profile properties.
void	setHeaderAndFooter(net.kyori.text.Component header, net.kyori.text.Component footer)	Deprecated. Use TabList.setHeaderAndFooter(Component, Component).
void	spoofChatInput(String input)	Sends chat input onto the players current server as if they typed it into the client chat box.

Methods inherited from interface net.kyori.adventure.audience.Audience

clearTitle, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound

Methods inherited from interface com.velocitypowered.api.proxy.messages.ChannelMessageSink

sendPluginMessage

Methods inherited from interface com.velocitypowered.api.command.CommandSource

sendMessage

Methods inherited from interface net.kyori.adventure.identity.Identified

identity

Methods inherited from interface com.velocitypowered.api.proxy.InboundConnection

getProtocolVersion, getRemoteAddress, getVirtualHost, isActive

Methods inherited from interface com.velocitypowered.api.permission.PermissionSubject

getPermissionValue, hasPermission

Method Detail

getUsername

String getUsername()

Returns the player's current username.

Returns:

the username

getUniqueId

UUID getUniqueId()

Returns the player's UUID.

Returns:

the UUID

getCurrentServer

Optional<ServerConnection> getCurrentServer()

Returns the server that the player is currently connected to.

Returns:

an Optional the server that the player is connected to, which may be empty

getPlayerSettings

PlayerSettings getPlayerSettings()

Returns the player's client settings.

Returns:

the settings

getModInfo

Optional<ModInfo> getModInfo()

Returns the player's mod info if they have a modded client.

Returns:

an Optional the mod info. which may be empty

getPing

long getPing()

Returns the current player's ping.

Returns:

the player's ping or -1 if ping information is currently unknown

isOnlineMode

boolean isOnlineMode()

Returns the player's connection status.

Returns:

true if the player is authenticated with Mojang servers

sendMessage

@Deprecated
default void sendMessage(net.kyori.text.Component component)

Deprecated.

Use Audience.sendMessage(Identified, Component) or Audience.sendMessage(Identity, Component) instead

Sends a chat message to the player's client.

Specified by:

sendMessage in interface CommandSource

Parameters:

component - the chat message to send

sendMessage

@Deprecated
void sendMessage(net.kyori.text.Component component,
                 MessagePosition position)

Deprecated.

Use @deprecated Use Audience.sendMessage(Identified, Component) or Audience.sendMessage(Identity, Component) for chat messages, or Audience.sendActionBar(net.kyori.adventure.text.Component) for action bar messages

Sends a chat message to the player's client in the specified position.

Parameters:

component - the chat message to send

position - the position for the message

createConnectionRequest

ConnectionRequestBuilder createConnectionRequest(RegisteredServer server)

Creates a new connection request so that the player can connect to another server.

Parameters:

server - the server to connect to

Returns:

a new connection request

getGameProfileProperties

List<GameProfile.Property> getGameProfileProperties()

Gets the player's profile properties.

The returned list may be unmodifiable.

Returns:

the player's profile properties

setGameProfileProperties

void setGameProfileProperties(List<GameProfile.Property> properties)

Sets the player's profile properties.

Parameters:

properties - the properties

getGameProfile

GameProfile getGameProfile()

Returns the player's game profile.

setHeaderAndFooter

@Deprecated
void setHeaderAndFooter(net.kyori.text.Component header,
                        net.kyori.text.Component footer)

Deprecated.

Use TabList.setHeaderAndFooter(Component, Component).

Sets the tab list header and footer for the player.

Parameters:

header - the header component

footer - the footer component

clearHeaderAndFooter

@Deprecated
void clearHeaderAndFooter()

Deprecated.

Use TabList.clearHeaderAndFooter().

Clears the tab list header and footer for the player.

getPlayerListHeader

Component getPlayerListHeader()

Returns the player's player list header.

Returns:

this player's player list header

getPlayerListFooter

Component getPlayerListFooter()

Returns the player's player list footer.

Returns:

this player's tab list

getTabList

TabList getTabList()

Returns the player's tab list.

Returns:

this player's tab list

disconnect

@Deprecated
void disconnect(net.kyori.text.Component reason)

Deprecated.

Use disconnect(Component) instead

Disconnects the player with the specified reason. Once this method is called, further calls to other Player methods will become undefined.

Parameters:

reason - component with the reason

disconnect

void disconnect(Component reason)

Disconnects the player with the specified reason. Once this method is called, further calls to other Player methods will become undefined.

Parameters:

reason - component with the reason

sendTitle

@Deprecated
void sendTitle(Title title)

Deprecated.

Use Audience.showTitle(net.kyori.adventure.title.Title) and Audience.resetTitle()

Sends the specified title to the client.

Parameters:

title - the title to send

spoofChatInput

void spoofChatInput(String input)

Sends chat input onto the players current server as if they typed it into the client chat box.

Parameters:

input - the chat input to send

sendResourcePack

void sendResourcePack(String url)

Sends the specified resource pack from url to the user. If at all possible, send the resource pack using sendResourcePack(String, byte[]). To monitor the status of the sent resource pack, subscribe to PlayerResourcePackStatusEvent.

Parameters:

url - the URL for the resource pack

sendResourcePack

void sendResourcePack(String url,
                      byte[] hash)

Sends the specified resource pack from url to the user, using the specified 20-byte SHA-1 hash. To monitor the status of the sent resource pack, subscribe to PlayerResourcePackStatusEvent.

Parameters:

url - the URL for the resource pack

hash - the SHA-1 hash value for the resource pack