Package com.velocitypowered.api.proxy.server

Interface RegisteredServer

All Superinterfaces:

Audience, ChannelMessageSink, Pointered

public interface RegisteredServer
extends ChannelMessageSink, Audience

Represents a server that has been registered with the proxy. The Audience associated with a RegisteredServer represent all players on the server connected to this proxy and do not interact with the server in any way.

Method Summary

Modifier and Type	Method	Description
Collection<Player>	getPlayersConnected()	Returns a list of all the players currently connected to this server on this proxy.
ServerInfo	getServerInfo()	Returns the ServerInfo for this server.
CompletableFuture<ServerPing>	ping()	Attempts to ping the remote server and return the server list ping result.
CompletableFuture<ServerPing>	ping(PingOptions pingOptions)	Attempts to ping the remote server and return the server list ping result according to the options provided.

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

clearResourcePacks, clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, sendResourcePacks, sendTitlePart, showBossBar, showTitle, stopSound, stopSound

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

sendPluginMessage, sendPluginMessage

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Method Details

getServerInfo

ServerInfo getServerInfo()

Returns the ServerInfo for this server.

Returns:

the server info

getPlayersConnected

Collection<Player> getPlayersConnected()

Returns a list of all the players currently connected to this server on this proxy.

Returns:

the players on this proxy

ping

CompletableFuture<ServerPing> ping()

Attempts to ping the remote server and return the server list ping result.

Returns:

the server ping result from the server

ping

CompletableFuture<ServerPing> ping(PingOptions pingOptions)

Attempts to ping the remote server and return the server list ping result according to the options provided.

Parameters:

pingOptions - the options provided for pinging the server

Returns:

the server ping result from the server

Since:

3.2.0