Uses of Interface
com.velocitypowered.api.proxy.server.RegisteredServer
Packages that use RegisteredServer
Package
Description
Provides events for handling actions performed by players.
Provides an interface to interact with the proxy at a low level.
-
Uses of RegisteredServer in com.velocitypowered.api.event.player
Methods in com.velocitypowered.api.event.player that return RegisteredServerModifier and TypeMethodDescriptionServerPreConnectEvent.getOriginalServer()
Returns the server that the player originally tried to connect to.@Nullable RegisteredServer
ServerPostConnectEvent.getPreviousServer()
Returns the previous server the player was connected to.@Nullable RegisteredServer
ServerPreConnectEvent.getPreviousServer()
Returns the server that the player is currently connected to.@NonNull RegisteredServer
KickedFromServerEvent.getServer()
The server from which the player has been kicked.@NonNull RegisteredServer
KickedFromServerEvent.RedirectPlayer.getServer()
ServerConnectedEvent.getServer()
Methods in com.velocitypowered.api.event.player that return types with arguments of type RegisteredServerModifier and TypeMethodDescriptionPlayerChooseInitialServerEvent.getInitialServer()
ServerConnectedEvent.getPreviousServer()
ServerPreConnectEvent.ServerResult.getServer()
Methods in com.velocitypowered.api.event.player with parameters of type RegisteredServerModifier and TypeMethodDescriptionServerPreConnectEvent.ServerResult.allowed
(RegisteredServer server) Allows the player to connect to the specified server.KickedFromServerEvent.RedirectPlayer.create
(@NonNull RegisteredServer server, Component message) Creates a new redirect result to forward the player to the specifiedserver
.KickedFromServerEvent.RedirectPlayer.create
(RegisteredServer server) Creates a new redirect result to forward the player to the specifiedserver
.void
PlayerChooseInitialServerEvent.setInitialServer
(@Nullable RegisteredServer server) Sets the new initial server.Constructors in com.velocitypowered.api.event.player with parameters of type RegisteredServerModifierConstructorDescriptionKickedFromServerEvent
(Player player, RegisteredServer server, @Nullable Component originalReason, boolean duringServerConnect, KickedFromServerEvent.ServerKickResult result) Creates aKickedFromServerEvent
instance.PlayerChooseInitialServerEvent
(Player player, @Nullable RegisteredServer initialServer) Constructs a PlayerChooseInitialServerEvent.ServerConnectedEvent
(Player player, RegisteredServer server, @Nullable RegisteredServer previousServer) Constructs a ServerConnectedEvent.ServerPostConnectEvent
(Player player, @Nullable RegisteredServer previousServer) ServerPreConnectEvent
(Player player, RegisteredServer originalServer) Creates the ServerPreConnectEvent.ServerPreConnectEvent
(Player player, RegisteredServer originalServer, @Nullable RegisteredServer previousServer) Creates the ServerPreConnectEvent. -
Uses of RegisteredServer in com.velocitypowered.api.event.proxy.server
Methods in com.velocitypowered.api.event.proxy.server that return RegisteredServerModifier and TypeMethodDescription@NotNull RegisteredServer
ServerRegisteredEvent.registeredServer()
Returns the value of theregisteredServer
record component.@NotNull RegisteredServer
ServerUnregisteredEvent.unregisteredServer()
Returns the value of theunregisteredServer
record component.Constructors in com.velocitypowered.api.event.proxy.server with parameters of type RegisteredServerModifierConstructorDescriptionServerRegisteredEvent
(@NotNull RegisteredServer registeredServer) Creates an instance of aServerRegisteredEvent
record class.ServerUnregisteredEvent
(@NotNull RegisteredServer unregisteredServer) Creates an instance of aServerUnregisteredEvent
record class. -
Uses of RegisteredServer in com.velocitypowered.api.proxy
Methods in com.velocitypowered.api.proxy that return RegisteredServerModifier and TypeMethodDescriptionProxyServer.createRawRegisteredServer
(ServerInfo server) Creates a rawRegisteredServer
without tying it into the internal server map.ConnectionRequestBuilder.Result.getAttemptedConnection()
Returns the server we actually tried to connect to.ConnectionRequestBuilder.getServer()
Returns the server that this connection request represents.ServerConnection.getServer()
Returns the server that this connection is connected to.ProxyServer.registerServer
(ServerInfo server) Registers a server with this proxy.Methods in com.velocitypowered.api.proxy that return types with arguments of type RegisteredServerModifier and TypeMethodDescriptionProxyServer.getAllServers()
Retrieves allRegisteredServer
s registered with this proxy.ServerConnection.getPreviousServer()
Returns the server that the player associated with this connection was connected to before switching to this connection.Retrieves a registeredRegisteredServer
instance by its name.ProxyServer.matchServer
(String partialName) Matches allRegisteredServer
s whose names start with the provided partial name.Methods in com.velocitypowered.api.proxy with parameters of type RegisteredServerModifier and TypeMethodDescriptionPlayer.createConnectionRequest
(RegisteredServer server) Creates a new connection request so that the player can connect to another server.