Package com.velocitypowered.api.proxy

Interface ProxyServer

All Superinterfaces:

Audience

public interface ProxyServer
extends Audience

Provides an interface to a Minecraft server proxy.

Method Summary

Modifier and Type	Method	Description
void	broadcast(net.kyori.text.Component component)	Deprecated. Use Audience.sendMessage(Identified, Component) or Audience.sendMessage(Identity, Component) instead
@NonNull BossBar	createBossBar(net.kyori.text.Component title, @NonNull BossBarColor color, @NonNull BossBarOverlay overlay, float progress)	Deprecated. Use BossBar instead
Collection<Player>	getAllPlayers()	Retrieves all players currently connected to this proxy.
Collection<RegisteredServer>	getAllServers()	Retrieves all RegisteredServers registered with this proxy.
InetSocketAddress	getBoundAddress()	Gets the address that this proxy is bound to.
ChannelRegistrar	getChannelRegistrar()	Gets the ChannelRegistrar instance.
CommandManager	getCommandManager()	Gets the CommandManager instance.
ProxyConfig	getConfiguration()	Gets the ProxyConfig instance.
ConsoleCommandSource	getConsoleCommandSource()	Returns an instance of CommandSource that can be used to determine if the command is being invoked by the console or a console-like executor.
EventManager	getEventManager()	Gets the EventManager instance.
Optional<Player>	getPlayer(String username)	Retrieves the player currently connected to this proxy by their Minecraft username.
Optional<Player>	getPlayer(UUID uuid)	Retrieves the player currently connected to this proxy by their Minecraft UUID.
int	getPlayerCount()	Returns the number of players currently connected to this proxy.
PluginManager	getPluginManager()	Gets the PluginManager instance.
Scheduler	getScheduler()	Gets the Scheduler instance.
Optional<RegisteredServer>	getServer(String name)	Retrieves a registered RegisteredServer instance by its name.
ProxyVersion	getVersion()	Returns the version of the proxy.
Collection<Player>	matchPlayer(String partialName)	Matches all Players whose names start with the provided partial name.
Collection<RegisteredServer>	matchServer(String partialName)	Matches all RegisteredServers whose names start with the provided partial name.
RegisteredServer	registerServer(ServerInfo server)	Registers a server with this proxy.
void	shutdown()	Shuts down the proxy, kicking players with the default reason.
void	shutdown(Component reason)	Shuts down the proxy, kicking players with the specified reason.
void	unregisterServer(ServerInfo server)	Unregisters this server from the proxy.

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, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound

Method Detail

shutdown

void shutdown(Component reason)

Shuts down the proxy, kicking players with the specified reason.

Parameters:

reason - message to kick online players with

shutdown

void shutdown()

Shuts down the proxy, kicking players with the default reason.

getPlayer

Optional<Player> getPlayer(String username)

Retrieves the player currently connected to this proxy by their Minecraft username. The search is case-insensitive.

Parameters:

username - the username to search for

Returns:

an Optional with the player, which may be empty

getPlayer

Optional<Player> getPlayer(UUID uuid)

Retrieves the player currently connected to this proxy by their Minecraft UUID.

Parameters:

uuid - the UUID

Returns:

an Optional with the player, which may be empty

broadcast

@Deprecated
void broadcast(net.kyori.text.Component component)

Deprecated.

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

Broadcasts a message to all players currently online.

Parameters:

component - the message to send

getAllPlayers

Collection<Player> getAllPlayers()

Retrieves all players currently connected to this proxy. This call may or may not be a snapshot of all players online.

Returns:

the players online on this proxy

getPlayerCount

int getPlayerCount()

Returns the number of players currently connected to this proxy.

Returns:

the players on this proxy

getServer

Optional<RegisteredServer> getServer(String name)

Retrieves a registered RegisteredServer instance by its name. The search is case-insensitive.

Parameters:

name - the name of the server

Returns:

the registered server, which may be empty

getAllServers

Collection<RegisteredServer> getAllServers()

Retrieves all RegisteredServers registered with this proxy.

Returns:

the servers registered with this proxy

matchPlayer

Collection<Player> matchPlayer(String partialName)

Matches all Players whose names start with the provided partial name.

Parameters:

partialName - the partial name to check for

Returns:

a collection of mathed Players

matchServer

Collection<RegisteredServer> matchServer(String partialName)

Matches all RegisteredServers whose names start with the provided partial name.

Parameters:

partialName - the partial name to check for

Returns:

a collection of mathed RegisteredServers

registerServer

RegisteredServer registerServer(ServerInfo server)

Registers a server with this proxy. A server with this name should not already exist.

Parameters:

server - the server to register

Returns:

the newly registered server

unregisterServer

void unregisterServer(ServerInfo server)

Unregisters this server from the proxy.

Parameters:

server - the server to unregister

getConsoleCommandSource

ConsoleCommandSource getConsoleCommandSource()

Returns an instance of CommandSource that can be used to determine if the command is being invoked by the console or a console-like executor. Plugins that execute commands are strongly urged to implement their own CommandSource instead of using the console invoker.

Returns:

the console command invoker

getPluginManager

PluginManager getPluginManager()

Gets the PluginManager instance.

Returns:

the plugin manager instance

getEventManager

EventManager getEventManager()

Gets the EventManager instance.

Returns:

the event manager instance

getCommandManager

CommandManager getCommandManager()

Gets the CommandManager instance.

Returns:

the command manager

getScheduler

Scheduler getScheduler()

Gets the Scheduler instance.

Returns:

the scheduler instance

getChannelRegistrar

ChannelRegistrar getChannelRegistrar()

Gets the ChannelRegistrar instance.

Returns:

the channel registrar

getBoundAddress

InetSocketAddress getBoundAddress()

Gets the address that this proxy is bound to. This does not necessarily indicate the external IP address of the proxy.

Returns:

the address the proxy is bound to

getConfiguration

ProxyConfig getConfiguration()

Gets the ProxyConfig instance.

Returns:

the proxy config

getVersion

ProxyVersion getVersion()

Returns the version of the proxy.

Returns:

the proxy version

createBossBar

@Deprecated
@NonNull BossBar createBossBar(net.kyori.text.Component title,
                               @NonNull BossBarColor color,
                               @NonNull BossBarOverlay overlay,
                               float progress)

Deprecated.

Use BossBar instead

Creates a new BossBar.

Parameters:

title - boss bar title

color - boss bar color

overlay - boss bar overlay

progress - boss bar progress

Returns:

a completely new and fresh boss bar