All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description BrigadierCommandA command that uses Brigadier for parsing the command and providing suggestions to the client. ChannelIdentifierRepresents a channel identifier for use with plugin messaging. ChannelMessageSinkRepresents something that can be sent plugin messages. ChannelMessageSourceIndicates that this may be a source of plugin messages. ChannelRegistrarRepresents an interface to register and unregister
ChannelIdentifiers for the proxy to listen on.
Command CommandExecuteEventThis event is fired when someone executing command. CommandExecuteEvent.CommandResultRepresents the result of the
CommandInvocation<T>Provides information related to the possible execution of a
CommandManagerHandles the registration and execution of commands. CommandMetaContains metadata for a
CommandMeta.BuilderProvides a fluent interface to create
CommandSourceRepresents something that can be used to run a
ConnectionHandshakeEventThis event is fired when a handshake is established between a client and the proxy. ConnectionRequestBuilderProvides a fluent interface to send a connection request to another server on the proxy. ConnectionRequestBuilder.ResultRepresents the result of a connection request. ConnectionRequestBuilder.StatusRepresents the status of a connection request initiated by a
ConsoleCommandSourceIndicates that the executor of the command is the console. ContinuationRepresents a continuation of a paused event handler. DataDirectoryThis annotation requests that Velocity inject a
Pathinstance with a plugin-specific data directory.
DependencyIndicates that the
Plugindepends on another plugin in order to enable.
DisconnectEventThis event is fired when a player disconnects from the proxy. DisconnectEvent.LoginStatus EventHandler<E>Represents an interface to perform direct dispatch of an event. EventManagerAllows plugins to register and deregister listeners for event handlers. EventTaskRepresents a task that can be returned by a
EventHandlerwhich allows event handling to be suspended and resumed at a later time, and executing event handlers completely or partially asynchronously.
EventTask.BasicRepresents a basic
EventTask.WithContinuation FaviconRepresents a Minecraft server favicon. GameProfileRepresents a Mojang game profile. GameProfile.PropertyRepresents a Mojang profile property. GameProfileRequestEventThis event is fired after the
PreLoginEventin order to set up the game profile for the user.
InboundConnectionRepresents an incoming connection to the proxy. InvalidPluginException InvocableCommand<I extends CommandInvocation<?>>A command that can be executed with arbitrary arguments. KickedFromServerEventFired when a player is kicked from a server. KickedFromServerEvent.DisconnectPlayerTells the proxy to disconnect the player with the specified reason. KickedFromServerEvent.NotifyNotifies the player with the specified message but does nothing else. KickedFromServerEvent.RedirectPlayerTells the proxy to redirect the player to another server. KickedFromServerEvent.ServerKickResultRepresents the base interface for
LegacyChannelIdentifierReperesents a legacy channel identifier (for Minecraft 1.12 and below). LoginEventThis event is fired once the player has been authenticated but before they connect to a server on the proxy. MinecraftChannelIdentifierRepresents a Minecraft 1.13+ channel identifier. ModInfo ModInfo.Mod PermissionFunctionFunction that calculates the permission settings for a given
PermissionProvider PermissionsSetupEventCalled when a
PermissionSubject's permissions are being setup.
PermissionSubjectRepresents a object that has a set of queryable permissions. PlayerRepresents a player who is connected to the proxy. PlayerAvailableCommandsEventAllows plugins to modify the packet indicating commands available on the server to a Minecraft 1.13+ client. PlayerChannelRegisterEventThis event is fired when a client (
Player) sends a plugin message through the register channel.
PlayerChatEventThis event is fired when a player types in a chat message. PlayerChatEvent.ChatResultRepresents the result of the
PlayerChooseInitialServerEventFired when a player has finished connecting to the proxy and we need to choose the first server to connect to. PlayerModInfoEventThis event is fired when a Forge client sends its mods to the proxy while connecting to a server. PlayerResourcePackStatusEventThis event is fired when the status of a resource pack sent to the player by the server is changed. PlayerResourcePackStatusEvent.StatusRepresents the possible statuses for the resource pack. PlayerSettingsRepresents the client settings for the player. PlayerSettings.ChatMode PlayerSettings.MainHand PlayerSettingsChangedEvent PluginAnnotation used to describe a Velocity plugin. PluginContainerA wrapper around a plugin loaded by the proxy. PluginDependencyRepresents a dependency on another plugin. PluginDescriptionRepresents metadata for a specific version of a plugin. PluginManagerManages plugins loaded on the proxy. PluginMessageEvent PluginMessageEvent.ForwardResultA result determining whether or not to forward this message on. PostLoginEventThis event is fired once the player has been fully initialized and is about to connect to their first server. PostOrderProvides convenient shorthands for represents the order an event will be posted to a listener. PreLoginEventThis event is fired when a player has initiated a connection with the proxy but before the proxy authenticates the player with Mojang or before the player's proxy connection is fully established (for offline mode). PreLoginEvent.PreLoginComponentResultRepresents an "allowed/allowed with forced online\offline mode/denied" result with a reason allowed for denial. ProtocolVersionRepresents each Minecraft protocol version. ProxyConfigExposes certain proxy configuration information that plugins may use. ProxyInitializeEventThis event is fired by the proxy after plugins have been loaded but before the proxy starts accepting connections. ProxyPingEventThis event is fired when a server list ping request is sent by a remote client. ProxyQueryEventThis event is fired if proxy is getting queried over GS4 Query protocol. ProxyQueryEvent.QueryTypeRepresents the type of query the client is asking for. ProxyReloadEventThis event is fired when the proxy is reloaded by the user using
ProxyServerProvides an interface to a Minecraft server proxy. ProxyShutdownEventThis event is fired by the proxy after the proxy has stopped accepting connections but before the proxy process exits. ProxyVersionProvides a version object for the proxy. QueryResponseGS4 query response. QueryResponse.BuilderA builder for
QueryResponse.PluginInformationRepresents a plugin in the query response. RawCommandA specialized sub-interface of
Commandwhich indicates the proxy should pass the command and its arguments directly without further processing.
RawCommand.InvocationContains the invocation data for a raw command. RegisteredServerRepresents a server that has been registered with the proxy. ResultedEvent<R extends ResultedEvent.Result>Indicates an event that has a result attached to it. ResultedEvent.ComponentResultRepresents an "allowed/denied" result with a reason allowed for denial. ResultedEvent.GenericResultA generic "allowed/denied" result. ResultedEvent.ResultRepresents a result for an event. ScheduledTaskRepresents a task that is scheduled to run on the proxy. SchedulerRepresents a scheduler to execute tasks on the proxy. Scheduler.TaskBuilderRepresents a fluent interface to schedule tasks on the proxy. ServerConnectedEventThis event is fired once the player has successfully connected to the target server and the connection to the previous server has been de-established. ServerConnectionRepresents a connection to a backend server from the proxy for a client. ServerInfoServerInfo represents a server that a player can connect to. ServerPingRepresents a 1.7 and above server list ping response. ServerPing.BuilderA builder for
ServerPing.Players ServerPing.SamplePlayer ServerPing.Version ServerPostConnectEventFired after the player has connected to a server. ServerPreConnectEventThis event is fired before the player connects to a server. ServerPreConnectEvent.ServerResultRepresents the result of the
SimpleCommandA simple command, modelled after the convention popularized by Bukkit and BungeeCord. SimpleCommand.InvocationContains the invocation data for a simple command. SkinParts SubscribeAn annotation that indicates that this method can be used to listen for an event from the proxy. TabCompleteEventThis event is fired after a tab complete response is sent by the remote server, for clients on 1.12.2 and below. TabListRepresents the tab list of a
TabListEntryRepresents a single entry in a
TabListEntry.BuilderRepresents a builder which creates
TaskStatus TristateRepresents three different states of a setting. UuidUtilsProvides a small, useful selection of utilities for working with Minecraft UUIDs.