Interface RegisteredServer
-
- All Superinterfaces:
Audience
,ChannelMessageSink
,Pointered
public interface RegisteredServer extends ChannelMessageSink, Audience
Represents a server that has been registered with the proxy. TheAudience
associated with aRegisteredServer
represent all players on the server connected to this proxy and do not interact with the server in any way.
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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 theServerInfo
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
clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, showTitle, stopSound, stopSound
-
Methods inherited from interface com.velocitypowered.api.proxy.messages.ChannelMessageSink
sendPluginMessage
-
Methods inherited from interface net.kyori.adventure.pointer.Pointered
get, getOrDefault, getOrDefaultFrom, pointers
-
-
-
-
Method Detail
-
getServerInfo
ServerInfo getServerInfo()
Returns theServerInfo
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
-
-