Package com.velocitypowered.api.proxy

Interface ProxyServer

  • All Superinterfaces:
    net.kyori.adventure.audience.Audience
    public interface ProxyServer
extends net.kyori.adventure.audience.Audience
    Provides an interface to a Minecraft server proxy.

    • Method Detail

      • shutdown

        void shutdown​(net.kyori.adventure.text.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

        java.util.Optional<Player> getPlayer​(java.lang.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

        java.util.Optional<Player> getPlayer​(java.util.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

      • getAllPlayers

        java.util.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

        java.util.Optional<RegisteredServer> getServer​(java.lang.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

        java.util.Collection<RegisteredServer> getAllServers()
        Retrieves all RegisteredServers registered with this proxy.
        Returns:
        the servers registered with this proxy

      • matchPlayer

        java.util.Collection<Player> matchPlayer​(java.lang.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

        java.util.Collection<RegisteredServer> matchServer​(java.lang.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

      • getScheduler

        Scheduler getScheduler()
        Gets the Scheduler instance.
        Returns:
        the scheduler instance

      • getBoundAddress

        java.net.SocketAddress 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

      • getVersion

        ProxyVersion getVersion()
        Returns the version of the proxy.
        Returns:
        the proxy version