Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ACCEPTED - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The player has accepted the resource pack and is now downloading it.
- ACTION_BAR - Enum constant in enum class com.velocitypowered.api.util.MessagePosition
-
The chat message will appear above the player's main HUD.
- addCustomChatCompletions(Collection<String>) - Method in interface com.velocitypowered.api.proxy.Player
-
Add custom chat completion suggestions shown to the player while typing a message.
- addEntries(TabListEntry...) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Adds an array of
TabListEntry
's to thePlayer
's tab list. - addEntries(Iterable<TabListEntry>) - Method in interface com.velocitypowered.api.proxy.player.TabList
- addEntry(TabListEntry) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Adds a
TabListEntry
to thePlayer
's tab list. - addProperties(Iterable<GameProfile.Property>) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfile
with the properties of this object plus the specified properties. - addProperty(GameProfile.Property) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfile
with the properties of this object plus the specified property. - address() - Method in class com.velocitypowered.api.event.connection.PreTransferEvent.TransferResult
- addToClasspath(Object, Path) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Adds the specified
path
to the plugin classpath. - alias() - Method in interface com.velocitypowered.api.command.RawCommand.Invocation
-
Returns the used alias to execute the command.
- alias() - Method in interface com.velocitypowered.api.command.SimpleCommand.Invocation
-
Returns the used alias to execute the command.
- aliases(String...) - Method in interface com.velocitypowered.api.command.CommandMeta.Builder
-
Specifies additional aliases that can be used to execute the command.
- allowed() - Static method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Allows the command to be sent, without modification.
- allowed() - Static method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
-
Returns a result indicating the connection will be allowed through the proxy.
- allowed() - Static method in class com.velocitypowered.api.event.connection.PreTransferEvent.TransferResult
- allowed() - Static method in class com.velocitypowered.api.event.player.PlayerChatEvent.ChatResult
-
Allows the message to be sent, without modification.
- allowed() - Static method in class com.velocitypowered.api.event.ResultedEvent.ComponentResult
- allowed() - Static method in class com.velocitypowered.api.event.ResultedEvent.GenericResult
- allowed(RegisteredServer) - Static method in class com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult
-
Allows the player to connect to the specified server.
- ALREADY_CONNECTED - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
The player is already connected to this server.
- ALWAYS_FALSE - Static variable in interface com.velocitypowered.api.permission.PermissionFunction
-
A permission function that always returns
Tristate.FALSE
. - ALWAYS_TRUE - Static variable in interface com.velocitypowered.api.permission.PermissionFunction
-
A permission function that always returns
Tristate.TRUE
. - ALWAYS_UNDEFINED - Static variable in interface com.velocitypowered.api.permission.PermissionFunction
-
A permission function that always returns
Tristate.UNDEFINED
. - ANNOUNCEMENTS - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- arguments() - Method in interface com.velocitypowered.api.command.CommandInvocation
-
Returns the arguments after the command alias.
- asBoolean() - Method in enum class com.velocitypowered.api.permission.Tristate
-
Returns the value of the Tristate as a boolean.
- asBuilder() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Returns a copy of this
ResourcePackInfo
instance as a builder so that it can be modified. - asBuilder() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Returns a copy of this
ServerPing
instance as a builder so that it can be modified. - asBuilder(String) - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Returns a copy of this
ResourcePackInfo
instance as a builder, using the new URL. - asComponent() - Method in class com.velocitypowered.api.command.VelocityBrigadierMessage
- asHoverEvent(UnaryOperator<HoverEvent.ShowEntity>) - Method in interface com.velocitypowered.api.proxy.Player
- asKey() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- async() - Element in annotation interface com.velocitypowered.api.event.Subscribe
-
Whether the handler must be called asynchronously.
- async(Runnable) - Static method in interface com.velocitypowered.api.event.EventTask
- authors() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The author of the plugin.
- AwaitingEvent - Annotation Interface in com.velocitypowered.api.event.annotation
-
Marks an event as an event the proxy will wait on to completely fire (including any
EventTask
s) before continuing handling it. - AwaitingEventExecutor<E> - Interface in com.velocitypowered.api.event
-
An event handler that returns an
EventTask
to await on.
B
- BASIC - Enum constant in enum class com.velocitypowered.api.event.query.ProxyQueryEvent.QueryType
-
Basic query asks only a subset of information, such as hostname, game type (hardcoded to
- BrigadierCommand - Class in com.velocitypowered.api.command
-
A command that uses Brigadier for parsing the command and providing suggestions to the client.
- BrigadierCommand(LiteralArgumentBuilder<CommandSource>) - Constructor for class com.velocitypowered.api.command.BrigadierCommand
-
Constructs a
BrigadierCommand
from the node returned by the given builder. - BrigadierCommand(LiteralCommandNode<CommandSource>) - Constructor for class com.velocitypowered.api.command.BrigadierCommand
-
Constructs a
BrigadierCommand
from the given command node. - BUG_REPORT - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- build() - Method in interface com.velocitypowered.api.command.CommandMeta.Builder
-
Returns a newly-created
CommandMeta
based on the specified parameters. - build() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Builds the
ResourcePackInfo
from the provided info for use withPlayer.sendResourcePackOffer(ResourcePackInfo)
. - build() - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
- build() - Method in class com.velocitypowered.api.proxy.server.PingOptions.Builder
-
Create a new
PingOptions
with the values of this Builder. - build() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Builds a new
QueryResponse
with the supplied data. - build() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the information from this builder to create a new
ServerPing
instance. - buildEntry(GameProfile, Component, int, int) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.
- buildEntry(GameProfile, Component, int, int, IdentifiedKey) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builder
instead. - buildEntry(GameProfile, Component, int, int, ChatSession) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builder
instead. - buildEntry(GameProfile, Component, int, int, ChatSession, boolean) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builder
instead. - builder() - Static method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns a
TabListEntry.Builder
to create aTabListEntry
. - builder() - Static method in class com.velocitypowered.api.proxy.server.PingOptions
-
Create a new builder to assign values to a new PingOptions.
- builder() - Static method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Creates a new
QueryResponse.Builder
instance. - builder() - Static method in class com.velocitypowered.api.proxy.server.ServerPing
- buildTask(Object, Runnable) - Method in interface com.velocitypowered.api.scheduler.Scheduler
-
Initializes a new
Scheduler.TaskBuilder
for creating a task on the proxy. - buildTask(Object, Consumer<ScheduledTask>) - Method in interface com.velocitypowered.api.scheduler.Scheduler
-
Initializes a new
Scheduler.TaskBuilder
for creating a task on the proxy.
C
- cancel() - Method in interface com.velocitypowered.api.scheduler.ScheduledTask
-
Cancels this task.
- CANCELLED - Enum constant in enum class com.velocitypowered.api.scheduler.TaskStatus
-
The task was cancelled with
ScheduledTask.cancel()
. - CANCELLED_BY_PROXY - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
- CANCELLED_BY_USER - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
- CANCELLED_BY_USER_BEFORE_COMPLETE - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
- ChannelIdentifier - Interface in com.velocitypowered.api.proxy.messages
-
Represents a channel identifier for use with plugin messaging.
- ChannelMessageSink - Interface in com.velocitypowered.api.proxy.messages
-
Represents something that can be sent plugin messages.
- ChannelMessageSource - Interface in com.velocitypowered.api.proxy.messages
-
Indicates that this may be a source of plugin messages.
- ChannelRegistrar - Interface in com.velocitypowered.api.proxy.messages
-
Represents an interface to register and unregister
ChannelIdentifier
s for the proxy to listen on. - CHAT - Enum constant in enum class com.velocitypowered.api.util.MessagePosition
-
The chat message will appear in the client's HUD.
- chatSession(ChatSession) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the
IdentifiedKey
of theTabListEntry
. - ChatSession - Interface in com.velocitypowered.api.proxy.player
-
Represents a chat session held by a player.
- clearAll() - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Clears all entries from the tab list.
- clearDelay() - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Clears the delay on this task.
- clearFavicon() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- clearHeaderAndFooter() - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.
- clearHeaderAndFooter() - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Clears the tab list header and footer for the player.
- clearMods() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- clearPlayerListHeaderAndFooter() - Method in interface com.velocitypowered.api.proxy.Player
-
Clears the player list header and footer.
- clearPlayers() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Removes all players from the builder.
- clearPlugins() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Clears all currently set plugins.
- clearRepeat() - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Clears the repeat interval on this task.
- clearSamplePlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- closeListeners() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Closes all listening endpoints for this server.
- com.velocitypowered.api.command - package com.velocitypowered.api.command
-
Provides a command framework.
- com.velocitypowered.api.event - package com.velocitypowered.api.event
-
Provides core support for handling events with Velocity.
- com.velocitypowered.api.event.annotation - package com.velocitypowered.api.event.annotation
- com.velocitypowered.api.event.command - package com.velocitypowered.api.event.command
- com.velocitypowered.api.event.connection - package com.velocitypowered.api.event.connection
-
Provides events for handling incoming connections to the proxy and logins.
- com.velocitypowered.api.event.permission - package com.velocitypowered.api.event.permission
-
Provides events to handle setting up permissions for permission subjects.
- com.velocitypowered.api.event.player - package com.velocitypowered.api.event.player
-
Provides events for handling actions performed by players.
- com.velocitypowered.api.event.player.configuration - package com.velocitypowered.api.event.player.configuration
- com.velocitypowered.api.event.proxy - package com.velocitypowered.api.event.proxy
-
Provides events for handling the lifecycle of the proxy.
- com.velocitypowered.api.event.proxy.server - package com.velocitypowered.api.event.proxy.server
- com.velocitypowered.api.event.query - package com.velocitypowered.api.event.query
-
Provides events for handling GS4 queries.
- com.velocitypowered.api.network - package com.velocitypowered.api.network
- com.velocitypowered.api.permission - package com.velocitypowered.api.permission
-
Provides the basic building blocks for a custom permission system.
- com.velocitypowered.api.plugin - package com.velocitypowered.api.plugin
-
Provides the Velocity plugin API.
- com.velocitypowered.api.plugin.annotation - package com.velocitypowered.api.plugin.annotation
-
Provides annotations to handle injecting dependencies for plugins.
- com.velocitypowered.api.plugin.meta - package com.velocitypowered.api.plugin.meta
-
Provides metadata for plugins.
- com.velocitypowered.api.proxy - package com.velocitypowered.api.proxy
-
Provides an interface to interact with the proxy at a low level.
- com.velocitypowered.api.proxy.config - package com.velocitypowered.api.proxy.config
- com.velocitypowered.api.proxy.crypto - package com.velocitypowered.api.proxy.crypto
- com.velocitypowered.api.proxy.messages - package com.velocitypowered.api.proxy.messages
-
Provides an interface to receive, handle, and send plugin messages on the proxy from clients and servers.
- com.velocitypowered.api.proxy.player - package com.velocitypowered.api.proxy.player
-
Provides an interface to work with players connected to the proxy.
- com.velocitypowered.api.proxy.server - package com.velocitypowered.api.proxy.server
-
Provides utilities to handle server information.
- com.velocitypowered.api.scheduler - package com.velocitypowered.api.scheduler
-
Provides utilities for scheduling tasks with a fluent builder.
- com.velocitypowered.api.util - package com.velocitypowered.api.util
-
Provides a selection of miscellaneous utilities for use by plugins and the proxy.
- command(String) - Static method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Allows the command to be executed, but silently replaces the command with a different command.
- Command - Interface in com.velocitypowered.api.command
-
Represents a command that can be executed by a
CommandSource
such as aPlayer
or the console. - CommandExecuteEvent - Class in com.velocitypowered.api.event.command
-
This event is fired when someone executes a command.
- CommandExecuteEvent(CommandSource, String) - Constructor for class com.velocitypowered.api.event.command.CommandExecuteEvent
-
Constructs a CommandExecuteEvent.
- CommandExecuteEvent.CommandResult - Class in com.velocitypowered.api.event.command
-
Represents the result of the
CommandExecuteEvent
. - CommandInvocation<T> - Interface in com.velocitypowered.api.command
-
Provides information related to the possible execution of a
Command
. - CommandManager - Interface in com.velocitypowered.api.command
-
Handles the registration and execution of commands.
- CommandMeta - Interface in com.velocitypowered.api.command
-
Contains metadata for a
Command
. - CommandMeta.Builder - Interface in com.velocitypowered.api.command
-
Provides a fluent interface to create
CommandMeta
s. - CommandResult - Enum Class in com.velocitypowered.api.command
-
The result of a command invocation attempt.
- COMMANDS_ONLY - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
- CommandSource - Interface in com.velocitypowered.api.command
-
Represents something that can be used to run a
Command
. - COMMUNITY - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- COMMUNITY_GUIDELINES - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- compareTo(ServerInfo) - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- ComponentResult(boolean, Component) - Constructor for class com.velocitypowered.api.event.ResultedEvent.ComponentResult
- CONFIGURATION - Enum constant in enum class com.velocitypowered.api.network.ProtocolState
-
Configuration State of a connection.
- CONFLICTING_LOGIN - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
- connect() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder
-
Initiates the connection to the remote server and emits a result on the
CompletableFuture
after the user has logged on. - CONNECTION_CANCELLED - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
A plugin has cancelled this connection.
- CONNECTION_IN_PROGRESS - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
The connection is already in progress.
- ConnectionHandshakeEvent - Class in com.velocitypowered.api.event.connection
-
This event is fired when a handshake is established between a client and the proxy.
- ConnectionHandshakeEvent(InboundConnection) - Constructor for class com.velocitypowered.api.event.connection.ConnectionHandshakeEvent
-
Deprecated, for removal: This API element is subject to removal in a future version.
- ConnectionHandshakeEvent(InboundConnection, HandshakeIntent) - Constructor for class com.velocitypowered.api.event.connection.ConnectionHandshakeEvent
- ConnectionRequestBuilder - Interface in com.velocitypowered.api.proxy
-
Provides a fluent interface to send a connection request to another server on the proxy.
- ConnectionRequestBuilder.Result - Interface in com.velocitypowered.api.proxy
-
Represents the result of a connection request.
- ConnectionRequestBuilder.Status - Enum Class in com.velocitypowered.api.proxy
-
Represents the status of a connection request initiated by a
ConnectionRequestBuilder
. - connectWithIndication() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder
-
Initiates the connection to the remote server and emits a result on the
CompletableFuture
after the user has logged on. - ConsoleCommandSource - Interface in com.velocitypowered.api.proxy
-
Indicates that the executor of the command is the console.
- containsEntry(UUID) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Determines if the specified entry exists in the tab list.
- contentsAsDataStream() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Returns the contents of the login plugin message sent by the server as an
ByteArrayDataInput
. - contentsAsInputStream() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Returns the contents of the login plugin message sent by the server as an
InputStream
. - Continuation - Interface in com.velocitypowered.api.event
-
Represents a continuation of a paused event handler.
- CookieReceiveEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when a cookie response from a client is received by the proxy.
- CookieReceiveEvent(Player, Key, byte[]) - Constructor for class com.velocitypowered.api.event.player.CookieReceiveEvent
-
Creates a new instance.
- CookieReceiveEvent.ForwardResult - Class in com.velocitypowered.api.event.player
-
A result determining whether or not to forward the cookie response on.
- CookieRequestEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when a cookie from a client is requested either by a proxy plugin or by a backend server.
- CookieRequestEvent(Player, Key) - Constructor for class com.velocitypowered.api.event.player.CookieRequestEvent
-
Creates a new instance.
- CookieRequestEvent.ForwardResult - Class in com.velocitypowered.api.event.player
-
A result determining whether or not to forward the cookie request on.
- CookieStoreEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when a cookie should be stored on a player's client.
- CookieStoreEvent(Player, Key, byte[]) - Constructor for class com.velocitypowered.api.event.player.CookieStoreEvent
-
Creates a new instance.
- CookieStoreEvent.ForwardResult - Class in com.velocitypowered.api.event.player
-
A result determining whether or not to forward the cookie on.
- create(RegisteredServer, Component) - Static method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
-
Creates a new redirect result to forward the player to the specified
server
. - create(Component) - Static method in class com.velocitypowered.api.event.player.KickedFromServerEvent.Notify
-
Notifies the player with the specified message but does nothing else.
- create(RegisteredServer) - Static method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
-
Creates a new redirect result to forward the player to the specified
server
. - create(BufferedImage) - Static method in class com.velocitypowered.api.util.Favicon
-
Creates a new
Favicon
from the specifiedimage
. - create(String, String) - Static method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Creates an identifier in the specified namespace.
- create(Path) - Static method in class com.velocitypowered.api.util.Favicon
-
Creates a new
Favicon
by reading the image from the specifiedpath
. - create(Component) - Static method in class com.velocitypowered.api.event.player.KickedFromServerEvent.DisconnectPlayer
-
Creates a new
KickedFromServerEvent.DisconnectPlayer
with the specified reason. - createConnectionRequest(RegisteredServer) - Method in interface com.velocitypowered.api.proxy.Player
-
Creates a new connection request so that the player can connect to another server.
- createFunction(PermissionSubject) - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
-
Uses the provider function to obtain a
PermissionFunction
for the subject. - createFunction(PermissionSubject) - Method in interface com.velocitypowered.api.permission.PermissionProvider
-
Creates a
PermissionFunction
for the subject. - createRawRegisteredServer(ServerInfo) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Creates a raw
RegisteredServer
without tying it into the internal server map. - createResourcePackBuilder(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Creates a builder to build a
ResourcePackInfo
instance for use withPlayer.sendResourcePackOffer(ResourcePackInfo)
. - currentPlayers(int) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the players that are currently claimed to be online.
- CUSTOM - Enum constant in enum class com.velocitypowered.api.event.PostOrder
D
- data(byte[]) - Static method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
-
Allows the cookie response to be forwarded to the backend server, but silently replaces the data of the cookie with another.
- data(byte[]) - Static method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
-
Allows the cookie to be forwarded to the client so that it can store it, but silently replaces the data of the cookie with another.
- dataAsDataStream() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- dataAsInputStream() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- DataDirectory - Annotation Interface in com.velocitypowered.api.plugin.annotation
-
This annotation requests that Velocity inject a
Path
instance with a plugin-specific data directory. - DECLINED - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The player declined to download the resource pack.
- DEFAULT - Static variable in class com.velocitypowered.api.proxy.server.PingOptions
-
Default PingOptions.
- DEFAULT - Static variable in class com.velocitypowered.api.util.ModInfo
- delay(long, TimeUnit) - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Specifies that the task should delay its execution by the specified amount of time.
- delay(Duration) - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Specifies that the task should delay its execution by the specified amount of time.
- denied() - Static method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Prevents the command from being executed.
- denied() - Static method in class com.velocitypowered.api.event.connection.PreTransferEvent.TransferResult
- denied() - Static method in class com.velocitypowered.api.event.player.PlayerChatEvent.ChatResult
-
Prevents the message from being sent.
- denied() - Static method in class com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult
-
Returns a result that will prevent players from connecting to another server.
- denied() - Static method in class com.velocitypowered.api.event.ResultedEvent.GenericResult
- denied(Component) - Static method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
-
Denies the login with the specified reason.
- denied(Component) - Static method in class com.velocitypowered.api.event.ResultedEvent.ComponentResult
- dependencies() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The dependencies required to load before this plugin.
- Dependency - Annotation Interface in com.velocitypowered.api.plugin
-
Indicates that the
Plugin
depends on another plugin in order to enable. - description() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The description of the plugin, explaining what it can be used for.
- description(Component) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- DISCARDED - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The resource pack was discarded.
- disconnect(Component) - Method in interface com.velocitypowered.api.proxy.Player
-
Disconnects the player with the specified reason.
- DisconnectEvent - Class in com.velocitypowered.api.event.connection
-
This event is fired when a player disconnects from the proxy.
- DisconnectEvent(Player, DisconnectEvent.LoginStatus) - Constructor for class com.velocitypowered.api.event.connection.DisconnectEvent
- DisconnectEvent.LoginStatus - Enum Class in com.velocitypowered.api.event.connection
-
The status of the connection when the player disconnected.
- displayName(Component) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the displayed name of the
TabListEntry
. - DOWNLOADED - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The player has downloaded the resource pack.
- DOWNSTREAM_SERVER - Enum constant in enum class com.velocitypowered.api.proxy.player.ResourcePackInfo.Origin
-
Resource-pack originated from the downstream server.
E
- EARLY - Enum constant in enum class com.velocitypowered.api.event.PostOrder
- encode(ByteArrayDataOutput) - Method in interface com.velocitypowered.api.proxy.messages.PluginMessageEncoder
-
Encodes data into a
ByteArrayDataOutput
to be transmitted by plugin messages. - ensurePluginContainer(Object) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Ensures a plugin container exists for the given
plugin
. - equals(Object) - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
- equals(Object) - Method in class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
- equals(Object) - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- equals(Object) - Method in class com.velocitypowered.api.proxy.player.SkinParts
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- equals(Object) - Method in class com.velocitypowered.api.util.Favicon
- equals(Object) - Method in class com.velocitypowered.api.util.ProxyVersion
- equals(Object) - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
- equals(Object) - Method in record class com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.PingOptions
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.QueryResponse
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.ServerPing
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Players
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
- equals(Object) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Version
- equals(Object) - Method in class com.velocitypowered.api.util.ModInfo
- equals(Object) - Method in class com.velocitypowered.api.util.ModInfo.Mod
- EventHandler<E> - Interface in com.velocitypowered.api.event
-
Represents an interface to perform direct dispatch of an event.
- EventManager - Interface in com.velocitypowered.api.event
-
Allows plugins to register and deregister listeners for event handlers.
- EventTask - Interface in com.velocitypowered.api.event
-
Represents a task that can be returned by a
EventHandler
which allows event handling to be suspended and resumed at a later time, and executing event handlers completely or partially asynchronously. - EXCEPTION - Enum constant in enum class com.velocitypowered.api.command.CommandResult
-
An unexpected exception occurred while executing the command in the proxy.
- execute(Continuation) - Method in interface com.velocitypowered.api.event.EventTask
-
Runs this event task with the given
Continuation
. - execute(E) - Method in interface com.velocitypowered.api.event.AwaitingEventExecutor
- execute(E) - Method in interface com.velocitypowered.api.event.EventHandler
- execute(I) - Method in interface com.velocitypowered.api.command.InvocableCommand
-
Executes the command for the specified invocation.
- executeAsync(CommandSource, String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Attempts to asynchronously execute a command from the given
cmdLine
. - executeAsync(E) - Method in interface com.velocitypowered.api.event.AwaitingEventExecutor
- executeAsync(E) - Method in interface com.velocitypowered.api.event.EventHandler
- EXECUTED - Enum constant in enum class com.velocitypowered.api.command.CommandResult
-
The command was successfully executed by the proxy.
- executeImmediatelyAsync(CommandSource, String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Attempts to asynchronously execute a command from the given
cmdLine
without firing aCommandExecuteEvent
.
F
- FAILED_DOWNLOAD - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The player could not download the resource pack.
- FAILED_RELOAD - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The player failed to reload the resource pack.
- FALSE - Enum constant in enum class com.velocitypowered.api.permission.Tristate
-
A value indicating a negative (negated) setting.
- favicon(Favicon) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- Favicon - Class in com.velocitypowered.api.util
-
Represents a Minecraft server favicon.
- Favicon(String) - Constructor for class com.velocitypowered.api.util.Favicon
-
Directly create a favicon using its Base64 URL directly.
- FEEDBACK - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- FINISHED - Enum constant in enum class com.velocitypowered.api.scheduler.TaskStatus
-
The task has run to completion.
- fire(E) - Method in interface com.velocitypowered.api.event.EventManager
-
Fires the specified event to the event bus asynchronously.
- fireAndForget() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder
-
Initiates the connection to the remote server without waiting for a result.
- fireAndForget(Object) - Method in interface com.velocitypowered.api.event.EventManager
-
Posts the specified event to the event bus and discards the result.
- FIRST - Enum constant in enum class com.velocitypowered.api.event.PostOrder
- forceOfflineMode() - Static method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
-
Returns a result indicating the connection will be allowed through the proxy, but the connection will be forced to use offline mode even when the proxy is running in online mode.
- forceOnlineMode() - Static method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
-
Returns a result indicating the connection will be allowed through the proxy, but the connection will be forced to use online mode provided that the proxy is in offline mode.
- forDefaultNamespace(String) - Static method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Creates an identifier in the default namespace (
minecraft
). - forOfflinePlayer(String) - Static method in class com.velocitypowered.api.util.GameProfile
-
Creates a game profile suitable for use in offline-mode.
- FORUMS - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- forward() - Static method in class com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult
- forward() - Static method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
-
Allows the cookie response to be forwarded to the backend server.
- forward() - Static method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
-
Allows the cookie request to be forwarded to the client.
- forward() - Static method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
-
Allows the cookie to be forwarded to the client so that it can store it.
- FORWARD - Static variable in class com.velocitypowered.api.command.BrigadierCommand
-
The return code used by a
Command
to indicate the command execution should be forwarded to the backend server. - FORWARDED - Enum constant in enum class com.velocitypowered.api.command.CommandResult
-
The command was forwarded to the backend server.
- forwardToServer() - Static method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Forwards the command to server instead of executing it on the proxy.
- forwardToServer(String) - Static method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Prevents the command from being executed on proxy, but forward command to server.
- from(String) - Static method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Creates an channel identifier from the specified Minecraft identifier.
- from(Key) - Static method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Creates an channel identifier from the specified Minecraft identifier.
- fromBoolean(boolean) - Static method in enum class com.velocitypowered.api.permission.Tristate
-
Returns a
Tristate
from a boolean. - fromInstance(Object) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Gets the plugin container from an instance.
- fromNullableBoolean(Boolean) - Static method in enum class com.velocitypowered.api.permission.Tristate
-
Returns a
Tristate
from a nullable boolean. - fromOptionalBoolean(Optional<Boolean>) - Static method in enum class com.velocitypowered.api.permission.Tristate
- fromUndashed(String) - Static method in class com.velocitypowered.api.util.UuidUtils
-
Converts from an undashed Mojang-style UUID into a Java
UUID
object. - FULL - Enum constant in enum class com.velocitypowered.api.event.query.ProxyQueryEvent.QueryType
-
Full query asks pretty much everything present on this event (only hardcoded values cannot be modified here).
G
- gameMode(int) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the game mode of the
TabListEntry
. - GameProfile - Class in com.velocitypowered.api.util
-
Represents a Mojang game profile.
- GameProfile(String, String, List<GameProfile.Property>) - Constructor for class com.velocitypowered.api.util.GameProfile
-
Creates a new Mojang game profile.
- GameProfile(UUID, String, List<GameProfile.Property>) - Constructor for class com.velocitypowered.api.util.GameProfile
-
Creates a new Mojang game profile.
- GameProfile.Property - Class in com.velocitypowered.api.util
-
Represents a Mojang profile property.
- GameProfileRequestEvent - Class in com.velocitypowered.api.event.player
-
This event is fired after the
PreLoginEvent
in order to set up the game profile for the user. - GameProfileRequestEvent(InboundConnection, GameProfile, boolean) - Constructor for class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Creates a new instance.
- gameVersion(String) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the game version for the response.
- generateOfflinePlayerUuid(String) - Static method in class com.velocitypowered.api.util.UuidUtils
-
Generates a UUID for use for offline mode.
- GENERIC_V1 - Enum constant in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
- getAddress() - Method in class com.velocitypowered.api.event.proxy.ListenerBoundEvent
- getAddress() - Method in class com.velocitypowered.api.event.proxy.ListenerCloseEvent
- getAddress() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- getAliases() - Method in interface com.velocitypowered.api.command.CommandManager
-
Returns an immutable collection of the case-insensitive aliases registered on this manager.
- getAliases() - Method in interface com.velocitypowered.api.command.CommandMeta
-
Returns a non-empty collection containing the case-insensitive aliases used to execute the command.
- getAllPlayers() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves all players currently connected to this proxy.
- getAllServers() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves all
RegisteredServer
s registered with this proxy. - getApplicableTo() - Method in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
- getAppliedResourcePack() - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.
- getAppliedResourcePacks() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the
ResourcePackInfo
of the currently applied resource-packs. - getAttemptConnectionOrder() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the order of servers that players will be connected to.
- getAttemptedConnection() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder.Result
-
Returns the server we actually tried to connect to.
- getAuthors() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the authors of the
Plugin
within this container. - getBackwardsCompatibleTo() - Method in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
- getBase64Url() - Method in class com.velocitypowered.api.util.Favicon
-
Returns the Base64-encoded URI for this image.
- getBoundAddress() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the address that this proxy is bound to.
- getBrand() - Method in class com.velocitypowered.api.event.player.PlayerClientBrandEvent
- getBuiltInType() - Method in class com.velocitypowered.api.util.ServerLink
-
Get the type of the server link.
- getById(int) - Static method in enum class com.velocitypowered.api.network.HandshakeIntent
-
Obtain the HandshakeIntent by ID.
- getChannelRegistrar() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
ChannelRegistrar
instance. - getChannels() - Method in class com.velocitypowered.api.event.player.PlayerChannelRegisterEvent
- getChatMode() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns the chat setting for the client.
- getChatSession() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns the
ChatSession
associated with this entry. - getClientBrand() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the player's client brand.
- getCommand() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
- getCommand() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent
-
Gets the original command being executed without the first slash.
- getCommand() - Method in class com.velocitypowered.api.event.command.PostCommandInvocationEvent
-
Gets the original command line executed without the first slash.
- getCommandManager() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
CommandManager
instance. - getCommandMeta(String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Retrieves the
CommandMeta
from the specified command alias, if registered. - getCommandSource() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent
-
Gets the source responsible for the execution of this command.
- getCommandSource() - Method in class com.velocitypowered.api.event.command.PostCommandInvocationEvent
-
Get the source of this executed command.
- getCompressionLevel() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the level of compression that packets will be compressed to.
- getCompressionThreshold() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the minimum compression threshold for packets.
- getConfiguration() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
ProxyConfig
instance. - getConnection() - Method in class com.velocitypowered.api.event.connection.ConnectionHandshakeEvent
- getConnection() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
- getConnection() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
- getConnection() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
- getConnection() - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Obtain the connection to which the corresponding ServerPing will be sent.
- getConnectTimeout() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get how long this proxy will wait for a connection to be established before timing it out.
- getConsoleCommandSource() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
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. - getContents() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Returns a copy of the contents of the login plugin message sent by the server.
- getCurrentPlayers() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get current online player count which will be used to reply to the query.
- getCurrentServer() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the server that the player is currently connected to.
- getCustomLabel() - Method in class com.velocitypowered.api.util.ServerLink
-
Get the custom component label of the server link.
- getData() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- getData() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
- getData() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
- getDependencies() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets a
Collection
of all dependencies of thePlugin
within this container. - getDependency(String) - Method in interface com.velocitypowered.api.plugin.PluginDescription
- getDescription() - Method in interface com.velocitypowered.api.plugin.PluginContainer
-
Returns the plugin's description.
- getDescription() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the description of the
Plugin
within this container. - getDescriptionComponent() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getDescriptionComponent() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- getDisplayNameComponent() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns
Optional
textComponent
, which if present is the text displayed forthis
entry in theTabList
, otherwiseGameProfile.getName()
is shown. - getEffectiveLocale() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the locale the proxy will use to send messages translated via the Adventure global translator.
- getEntries() - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Returns an immutable
Collection
of theTabListEntry
s in the tab list. - getEntry(UUID) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Retrieves the tab list entry associated with the given uuid.
- getEventManager() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
EventManager
instance. - getExecutorService() - Method in interface com.velocitypowered.api.plugin.PluginContainer
-
Returns an executor service for this plugin.
- getExpiryTemporal() - Method in interface com.velocitypowered.api.proxy.crypto.KeySigned
-
Returns the expiry time point of the key.
- getFavicon() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the proxy favicon shown in the tablist.
- getFavicon() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getFavicon() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- getForcedHosts() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get forced servers mapped to a given virtual host.
- getGameMode() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Gets the game mode
this
entry has been set to. - getGameProfile() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Returns the game profile that will be used to initialize the connection with.
- getGameProfile() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's game profile.
- getGameProfileProperties() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the player's profile properties.
- getGameVersion() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get game version which will be used to reply to the query.
- getHash() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the SHA-1 hash of the resource-pack See
ResourcePackInfo.Builder.setHash(byte[])
for more information. - getHints() - Method in interface com.velocitypowered.api.command.CommandMeta
-
Returns an immutable collection containing command nodes that provide additional argument metadata and tab-complete suggestions.
- getHostname() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get hostname which will be used to reply to the query.
- getId() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
-
Returns the plugin ID of this
PluginDependency
. - getId() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the qualified ID of the
Plugin
within this container. - getId() - Method in interface com.velocitypowered.api.proxy.messages.ChannelIdentifier
-
Returns the textual representation of this identifier.
- getId() - Method in class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
- getId() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- getId() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the id of this resource-pack.
- getId() - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
- getId() - Method in class com.velocitypowered.api.util.GameProfile
-
Returns the UUID associated with this game profile.
- getId() - Method in class com.velocitypowered.api.util.ModInfo.Mod
- getIdentifiedKey() - Method in interface com.velocitypowered.api.proxy.crypto.KeyIdentifiable
-
Returns the timed identified key of the object context.
- getIdentifiedKey() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
- getIdentifier() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- getIdentifier() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
- getInitialServer() - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
- getInstance() - Method in interface com.velocitypowered.api.plugin.PluginContainer
-
Returns the created plugin if it is available.
- getIntent() - Method in class com.velocitypowered.api.event.connection.ConnectionHandshakeEvent
- getKey() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
- getKey() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
- getKey() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
- getKeyRevision() - Method in interface com.velocitypowered.api.proxy.crypto.IdentifiedKey
-
Retrieves the key revision.
- getLatency() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns the latency for
this
entry. - getListenerType() - Method in class com.velocitypowered.api.event.proxy.ListenerBoundEvent
- getListenerType() - Method in class com.velocitypowered.api.event.proxy.ListenerCloseEvent
- getLocale() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns the locale of the Minecraft client.
- getLoginRatelimit() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the limit for how long a player must wait to log back in.
- getLoginStatus() - Method in class com.velocitypowered.api.event.connection.DisconnectEvent
- getMainHand() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns the primary hand of the client.
- getMap() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get map name which will be used to reply to the query.
- getMax() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Players
- getMaximumPlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getMaxPlayers() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get max player count which will be used to reply to the query.
- getMessage() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent.ChatResult
- getMessage() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
- getMessage() - Method in interface com.velocitypowered.api.proxy.crypto.SignedMessage
-
Returns the signed message.
- getMessageComponent() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.Notify
- getMessageComponent() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
- getModinfo() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- getModInfo() - Method in class com.velocitypowered.api.event.player.PlayerModInfoEvent
- getModInfo() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's mod info if they have a modded client.
- getMods() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getMods() - Method in class com.velocitypowered.api.util.ModInfo
- getModType() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getMostRecentSupportedVersion() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns the user-friendly name of the last version this protocol is valid for.
- getMotd() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the MOTD component shown in the tab list.
- getName() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Deprecated.A protocol may be shared by multiple versions. Use @link{#getVersionIntroducedIn()} or @link{#getVersionsSupportedBy()} to get more accurate version names.
- getName() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the name of the
Plugin
within this container. - getName() - Method in class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
- getName() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- getName() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
- getName() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- getName() - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
- getName() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Version
- getName() - Method in class com.velocitypowered.api.util.GameProfile
-
Returns the username associated with this profile.
- getName() - Method in class com.velocitypowered.api.util.GameProfile.Property
- getName() - Method in class com.velocitypowered.api.util.ProxyVersion
- getNamespace() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- getNode() - Method in class com.velocitypowered.api.command.BrigadierCommand
-
Returns the literal node for this command.
- getOnline() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Players
- getOnlinePlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getOrigin() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the
ResourcePackInfo.Origin
of this resource-pack. - getOriginalData() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
- getOriginalData() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
- getOriginalKey() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
- getOriginalKey() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
- getOriginalKey() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
- getOriginalOrigin() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the original
ResourcePackInfo.Origin
of the resource-pack. - getOriginalProfile() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
- getOriginalServer() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
-
Returns the server that the player originally tried to connect to.
- getPackId() - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Returns the id of the resource pack.
- getPackId() - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
-
Returns the id of the resource pack, if it's null all the resource packs from player will be cleared.
- getPackInfo() - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Returns the
ResourcePackInfo
this response is for. - getPartialMessage() - Method in class com.velocitypowered.api.event.player.TabCompleteEvent
-
Returns the message being partially completed.
- getPendingResourcePack() - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.
- getPendingResourcePacks() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the
ResourcePackInfo
of the resource packs the user is currently downloading or is currently prompted to install. - getPermissionChecker() - Method in interface com.velocitypowered.api.permission.PermissionSubject
-
Gets the permission checker for the subject.
- getPermissionValue(String) - Method in interface com.velocitypowered.api.permission.PermissionFunction
-
Gets the subjects setting for a particular permission.
- getPermissionValue(String) - Method in interface com.velocitypowered.api.permission.PermissionSubject
-
Gets the subjects setting for a particular permission.
- getPing() - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Get the ServerPing to send to the connection.
- getPing() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the player's estimated ping in milliseconds.
- getPlayer() - Method in class com.velocitypowered.api.event.command.PlayerAvailableCommandsEvent
- getPlayer() - Method in class com.velocitypowered.api.event.connection.DisconnectEvent
- getPlayer() - Method in class com.velocitypowered.api.event.connection.LoginEvent
- getPlayer() - Method in class com.velocitypowered.api.event.connection.PostLoginEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
-
The player who has been kicked out.
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerChannelRegisterEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerClientBrandEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerModInfoEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Returns the player affected by the change in resource pack status.
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerSettingsChangedEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
- getPlayer() - Method in class com.velocitypowered.api.event.player.ServerPostConnectEvent
-
Returns the player that has completed the connection to the server.
- getPlayer() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
-
Returns the player connecting to the server.
- getPlayer() - Method in class com.velocitypowered.api.event.player.TabCompleteEvent
-
Returns the player requesting the tab completion.
- getPlayer() - Method in interface com.velocitypowered.api.proxy.ServerConnection
-
Returns the player that this connection is associated with.
- getPlayer(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves the player currently connected to this proxy by their Minecraft username.
- getPlayer(UUID) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves the player currently connected to this proxy by their Minecraft UUID.
- getPlayerCount() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Returns the number of players currently connected to this proxy.
- getPlayerListFooter() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's player list footer.
- getPlayerListHeader() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's player list header.
- getPlayers() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get collection of players which will be used to reply to the query.
- getPlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- getPlayersConnected() - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Returns a list of all the players currently connected to this server on this proxy.
- getPlayerSettings() - Method in class com.velocitypowered.api.event.player.PlayerSettingsChangedEvent
- getPlayerSettings() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's client settings.
- getPlugin() - Method in interface com.velocitypowered.api.command.CommandMeta
-
Returns the plugin who registered the command.
- getPlugin(String) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Retrieves a
PluginContainer
based on its ID. - getPluginManager() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
PluginManager
instance. - getPlugins() - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Gets a
Collection
of allPluginContainer
s. - getPlugins() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get list of plugins which will be used to reply to the query.
- getPreviousServer() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
- getPreviousServer() - Method in class com.velocitypowered.api.event.player.ServerPostConnectEvent
-
Returns the previous server the player was connected to.
- getPreviousServer() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
-
Returns the server that the player is currently connected to.
- getPreviousServer() - Method in interface com.velocitypowered.api.proxy.ServerConnection
-
Returns the server that the player associated with this connection was connected to before switching to this connection.
- getProfile() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns the
GameProfile
of the entry, which uniquely identifies the entry with the containingUUID
, as well as deciding what is shown as the player head in the tab list. - getPrompt() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the
Component
that is displayed on the resource-pack prompt. - getProperties() - Method in class com.velocitypowered.api.util.GameProfile
-
Returns an immutable list of profile properties associated with this profile.
- getProtocol() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns the protocol as an int.
- getProtocol() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Version
- getProtocolState() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Returns the current protocol state of this connection.
- getProtocolVersion() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Returns the current protocol version this connection uses.
- getProtocolVersion() - Method in class com.velocitypowered.api.proxy.server.PingOptions
-
The protocol version used to ping the server.
- getProtocolVersion(int) - Static method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Gets the
ProtocolVersion
for the given protocol. - getProvidedResourcePack() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
- getProvider() - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
- getProxyHost() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get proxy (public facing) hostname.
- getProxyPort() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get proxy (public facing) port.
- getProxyVersion() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get server software (name and version) which will be used to reply to the query.
- getQuerierAddress() - Method in class com.velocitypowered.api.event.query.ProxyQueryEvent
-
Get the address of the client that sent this query.
- getQueryMap() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the map name reported to GameSpy 4 query services.
- getQueryPort() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the port GameSpy 4 queries are accepted on.
- getQueryType() - Method in class com.velocitypowered.api.event.query.ProxyQueryEvent
-
Returns the kind of query the remote client is performing.
- getReadTimeout() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get how long this proxy will wait until performing a read timeout.
- getReasonComponent() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
- getReasonComponent() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.DisconnectPlayer
- getReasonComponent() - Method in class com.velocitypowered.api.event.ResultedEvent.ComponentResult
- getReasonComponent() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder.Result
-
Returns an (optional) textual reason for the failure to connect to the server.
- getReceivedResourcePack() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
- getRemoteAddress() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Returns the player's IP address.
- getResponse() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
-
Returns the response to the message.
- getResponse() - Method in class com.velocitypowered.api.event.query.ProxyQueryEvent
-
Returns the current query response.
- getResult() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent
- getResult() - Method in class com.velocitypowered.api.event.command.PostCommandInvocationEvent
-
Returns the result of the command execution.
- getResult() - Method in class com.velocitypowered.api.event.connection.LoginEvent
- getResult() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- getResult() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
- getResult() - Method in class com.velocitypowered.api.event.connection.PreTransferEvent
- getResult() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
- getResult() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
- getResult() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
- getResult() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
- getResult() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
- getResult() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
- getResult() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
- getResult() - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
- getResult() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
- getResult() - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Gets whether to avoid sending a ping response to the connection.
- getResult() - Method in interface com.velocitypowered.api.event.ResultedEvent
-
Returns the result associated with this event.
- getRootNode() - Method in class com.velocitypowered.api.event.command.PlayerAvailableCommandsEvent
- getSalt() - Method in interface com.velocitypowered.api.proxy.crypto.KeySigned
-
Returns the signature salt or null if not salted.
- getSample() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Players
- getSamplePlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getScheduler() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
Scheduler
instance. - getSequenceId() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
- getServer() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
-
The server from which the player has been kicked.
- getServer() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
- getServer() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
- getServer() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult
- getServer() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder
-
Returns the server that this connection request represents.
- getServer() - Method in interface com.velocitypowered.api.proxy.ServerConnection
-
Returns the server that this connection is connected to.
- getServer(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves a registered
RegisteredServer
instance by its name. - getServerConnection() - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
-
Returns the server that tries to remove a resource pack from player or clear all of them.
- getServerConnection() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
- getServerInfo() - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Returns the
ServerInfo
for this server. - getServerInfo() - Method in interface com.velocitypowered.api.proxy.ServerConnection
-
Returns the server info for this connection.
- getServerKickReason() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
-
The reason why the player was kicked, the server may or may not provide this reason.
- getServers() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get a Map of all servers registered in
velocity.toml
. - getSessionId() - Method in interface com.velocitypowered.api.proxy.player.ChatSession
-
Returns the
UUID
of the session. - getShouldForce() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets whether or not the acceptance of the resource-pack is enforced.
- getShowMaxPlayers() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the maximum players shown in the tab list.
- getSignature() - Method in interface com.velocitypowered.api.proxy.crypto.KeySigned
-
Retrieves the signature of the signed object.
- getSignature() - Method in class com.velocitypowered.api.util.GameProfile.Property
- getSignatureHolder() - Method in interface com.velocitypowered.api.proxy.crypto.IdentifiedKey
-
Retrieves the signature holders UUID.
- getSignedPublicKey() - Method in interface com.velocitypowered.api.proxy.crypto.IdentifiedKey
-
Returns RSA public key.
- getSigner() - Method in interface com.velocitypowered.api.proxy.crypto.KeySigned
-
Returns the key used to sign the object.
- getSignerUuid() - Method in interface com.velocitypowered.api.proxy.crypto.SignedMessage
-
Returns the signers UUID.
- getSkinParts() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns the parts of player skins the client will show.
- getSource() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- getSource() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Returns the source the plugin was loaded from.
- getStatus() - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Returns the new status for the resource pack.
- getStatus() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder.Result
-
Returns the status associated with this result.
- getString() - Method in class com.velocitypowered.api.command.VelocityBrigadierMessage
-
Returns the message as a plain text.
- getSubject() - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
- getSuggestions() - Method in class com.velocitypowered.api.event.player.TabCompleteEvent
-
Returns all the suggestions provided to the user, as a mutable list.
- getTabList() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's tab list.
- getTabList() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
- getTarget() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- getTimeout() - Method in class com.velocitypowered.api.proxy.server.PingOptions
-
The maximum period of time to wait for a response from the remote server.
- getType() - Method in class com.velocitypowered.api.util.ModInfo
- getUndashedId() - Method in class com.velocitypowered.api.util.GameProfile
-
Returns the undashed, Mojang-style UUID.
- getUniqueId() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
-
Returns the UUID of the connecting player.
- getUniqueId() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's UUID.
- getUrl() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the url or website of the
Plugin
within this container. - getUrl() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the link the resource-pack can be found at.
- getUrl() - Method in class com.velocitypowered.api.util.ServerLink
-
Get the link
URI
. - getUsername() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
- getUsername() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
- getUsername() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's current username.
- getValue() - Method in class com.velocitypowered.api.util.GameProfile.Property
- getVendor() - Method in class com.velocitypowered.api.util.ProxyVersion
- getVersion() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
-
Returns the version this
PluginDependency
should match. - getVersion() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the version of the
Plugin
within this container. - getVersion() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Returns the version of the proxy.
- getVersion() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
- getVersion() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- getVersion() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- getVersion() - Method in class com.velocitypowered.api.util.ModInfo.Mod
- getVersion() - Method in class com.velocitypowered.api.util.ProxyVersion
- getVersionIntroducedIn() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns the user-friendly name of the version this protocol was introduced in.
- getVersionsSupportedBy() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns all versions this protocol is valid for.
- getViewDistance() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns the client's view distance.
- getVirtualHost() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Returns the hostname that the user entered into the client, if applicable.
- greaterThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
this
is greater thanthat
.
H
- handled() - Static method in class com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult
- handled() - Static method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
-
Prevents the cookie response from being forwarded to the backend server, the cookie response is handled by the proxy.
- handled() - Static method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
-
Prevents the cookie request from being forwarded to the client, the cookie request is handled by the proxy.
- handled() - Static method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
-
Prevents the cookie from being forwarded to the client, the cookie is handled by the proxy.
- HANDSHAKE - Enum constant in enum class com.velocitypowered.api.network.ProtocolState
-
Initial connection State.
- HandshakeIntent - Enum Class in com.velocitypowered.api.network
-
Represents the ClientIntent of a client in the Handshake state.
- hasCape() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hasChatColors() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns whether or not the client has chat colors disabled.
- hasCommand(String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Returns whether the given alias is registered on this manager.
- hasCommand(String, CommandSource) - Method in interface com.velocitypowered.api.command.CommandManager
-
Returns whether the given alias is registered on this manager and can be used by the given
CommandSource
. - hasExpired() - Method in interface com.velocitypowered.api.proxy.crypto.KeySigned
-
Check if the signature has expired.
- hasHat() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hashCode() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Returns a hash code value for this object.
- hashCode() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
- hashCode() - Method in record class com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent
-
Returns a hash code value for this object.
- hashCode() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
- hashCode() - Method in class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
- hashCode() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- hashCode() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hashCode() - Method in class com.velocitypowered.api.proxy.server.PingOptions
- hashCode() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
- hashCode() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
- hashCode() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- hashCode() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- hashCode() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Players
- hashCode() - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
- hashCode() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Version
- hashCode() - Method in class com.velocitypowered.api.util.Favicon
- hashCode() - Method in class com.velocitypowered.api.util.ModInfo
- hashCode() - Method in class com.velocitypowered.api.util.ModInfo.Mod
- hashCode() - Method in class com.velocitypowered.api.util.ProxyVersion
- hasJacket() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hasLeftPants() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hasLeftSleeve() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hasPermission(I) - Method in interface com.velocitypowered.api.command.InvocableCommand
-
Tests to check if the source has permission to perform the specified invocation.
- hasPermission(String) - Method in interface com.velocitypowered.api.permission.PermissionSubject
-
Determines whether or not the subject has a particular permission.
- hasRightPants() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hasRightSleeve() - Method in class com.velocitypowered.api.proxy.player.SkinParts
- hasSentPlayerSettings() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns whether the player has sent its client settings.
- HIDDEN - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
- hint(CommandNode<CommandSource>) - Method in interface com.velocitypowered.api.command.CommandMeta.Builder
-
Specifies a command node providing additional argument metadata and tab-complete suggestions.
- hostname(String) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the hostname for the response.
I
- id() - Method in enum class com.velocitypowered.api.network.HandshakeIntent
- id() - Element in annotation interface com.velocitypowered.api.plugin.Dependency
-
The plugin ID of the dependency.
- id() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The ID of the plugin.
- ID_PATTERN - Static variable in interface com.velocitypowered.api.plugin.PluginDescription
-
The pattern plugin IDs must match.
- ID_TO_PROTOCOL_CONSTANT - Static variable in enum class com.velocitypowered.api.network.ProtocolVersion
-
A map linking the protocol version number to its
ProtocolVersion
representation. - IdentifiedKey - Interface in com.velocitypowered.api.proxy.crypto
-
Represents session-server cross-signed dated RSA public key.
- IdentifiedKey.Revision - Enum Class in com.velocitypowered.api.proxy.crypto
-
The different versions of player keys, per Minecraft version.
- InboundConnection - Interface in com.velocitypowered.api.proxy
-
Represents an incoming connection to the proxy.
- INVALID_URL - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The URL of the resource pack failed to load.
- InvalidPluginException - Exception in com.velocitypowered.api.plugin
-
Thrown if a JAR in the plugin directory does not look valid.
- InvalidPluginException() - Constructor for exception com.velocitypowered.api.plugin.InvalidPluginException
- InvalidPluginException(String) - Constructor for exception com.velocitypowered.api.plugin.InvalidPluginException
- InvalidPluginException(String, Throwable) - Constructor for exception com.velocitypowered.api.plugin.InvalidPluginException
- InvalidPluginException(Throwable) - Constructor for exception com.velocitypowered.api.plugin.InvalidPluginException
- InvocableCommand<I extends CommandInvocation<?>> - Interface in com.velocitypowered.api.command
-
A command that can be executed with arbitrary arguments.
- isActive() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Determine whether or not the player remains online.
- isAllowed() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
- isAllowed() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult
- isAllowed() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
- isAllowed() - Method in class com.velocitypowered.api.event.connection.PreTransferEvent.TransferResult
- isAllowed() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
- isAllowed() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
- isAllowed() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
- isAllowed() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.DisconnectPlayer
- isAllowed() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.Notify
- isAllowed() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
- isAllowed() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent.ChatResult
- isAllowed() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
- isAllowed() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult
- isAllowed() - Method in class com.velocitypowered.api.event.ResultedEvent.ComponentResult
- isAllowed() - Method in class com.velocitypowered.api.event.ResultedEvent.GenericResult
- isAllowed() - Method in interface com.velocitypowered.api.event.ResultedEvent.Result
-
Returns whether or not the event is allowed to proceed.
- isAnnounceForge() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get whether this proxy displays that it supports Forge/FML.
- isClientListingAllowed() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns whether the client explicitly allows listing on the
TabList
or not in anonymous TabList mode. - isForceOfflineMode() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
- isForwardToServer() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
- isIntermediate() - Method in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
Returns true if the resource pack status is intermediate, indicating that the player has either accepted the resource pack and is currently downloading it or has successfully downloaded it.
- isLegacy() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether this
ProtocolVersion
is a legacy protocol. - isListed() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns whether or not this player will be visible to other players in the tab list.
- isLoaded(String) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Checks if a plugin is loaded based on its ID.
- isOnlineMode() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
- isOnlineMode() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get whether the proxy is online mode.
- isOnlineMode() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's connection status.
- isOnlineModeAllowed() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
- isOptional() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
-
Returns whether the dependency is optional for the plugin to work correctly.
- isOverwriteKick() - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Gets whether or not to override the kick resulting from
ResourcePackInfo.getShouldForce()
being true. - isPreviewSigned() - Method in interface com.velocitypowered.api.proxy.crypto.SignedMessage
-
If true the signature of this message applies to a stylized component instead.
- isQueryEnabled() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Whether GameSpy 4 queries are accepted by the proxy.
- isSignatureValid() - Method in interface com.velocitypowered.api.proxy.crypto.KeySigned
-
Validates the signature, expiry temporal and key against the signer public key.
- isSuccessful() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder.Result
-
Determines whether or not the connection request was successful.
- isSupported() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether this
ProtocolVersion
is supported. - isSupported(int) - Static method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether the protocol is supported.
- isSupported(ProtocolVersion) - Static method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether the
ProtocolVersion
is supported. - isUnknown() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether this
ProtocolVersion
is unknown to the proxy.
K
- key() - Method in interface com.velocitypowered.api.proxy.Player
- key(Key) - Static method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
-
Allows the cookie response to be forwarded to the backend server, but silently replaces the identifier of the cookie with another.
- key(Key) - Static method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
-
Allows the cookie request to be forwarded to the client, but silently replaces the identifier of the cookie with another.
- key(Key) - Static method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
-
Allows the cookie to be forwarded to the client so that it can store it, but silently replaces the identifier of the cookie with another.
- KeyIdentifiable - Interface in com.velocitypowered.api.proxy.crypto
-
Identifies a type with a public RSA signature.
- KeySigned - Interface in com.velocitypowered.api.proxy.crypto
-
Represents the signature of a signed object.
- kickedDuringLogin() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
-
Deprecated.
KickedFromServerEvent.kickedDuringServerConnect()
has a better name and reflects the actual result - kickedDuringServerConnect() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
-
Returns whether or not the player got kicked while connecting to another server.
- KickedFromServerEvent - Class in com.velocitypowered.api.event.player
-
Fired when a player is kicked from a server.
- KickedFromServerEvent(Player, RegisteredServer, Component, boolean, KickedFromServerEvent.ServerKickResult) - Constructor for class com.velocitypowered.api.event.player.KickedFromServerEvent
-
Creates a
KickedFromServerEvent
instance. - KickedFromServerEvent.DisconnectPlayer - Class in com.velocitypowered.api.event.player
-
Tells the proxy to disconnect the player with the specified reason.
- KickedFromServerEvent.Notify - Class in com.velocitypowered.api.event.player
-
Notifies the player with the specified message but does nothing else.
- KickedFromServerEvent.RedirectPlayer - Class in com.velocitypowered.api.event.player
-
Tells the proxy to redirect the player to another server.
- KickedFromServerEvent.ServerKickResult - Interface in com.velocitypowered.api.event.player
-
Represents the base interface for
KickedFromServerEvent
results.
L
- LAST - Enum constant in enum class com.velocitypowered.api.event.PostOrder
- LATE - Enum constant in enum class com.velocitypowered.api.event.PostOrder
- latency(int) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the latency of the
TabListEntry
. - LEFT - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.MainHand
- LEGACY - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- LegacyChannelIdentifier - Class in com.velocitypowered.api.proxy.messages
-
Represents a legacy channel identifier (for Minecraft 1.12 and below).
- LegacyChannelIdentifier(String) - Constructor for class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
-
Creates a new legacy channel identifier.
- lessThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
this
is less thanthat
. - LINKED_V2 - Enum constant in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
- listed(boolean) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets wether this entry should be visible.
- ListenerBoundEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired by the proxy after a listener starts accepting connections.
- ListenerBoundEvent(InetSocketAddress, ListenerType) - Constructor for class com.velocitypowered.api.event.proxy.ListenerBoundEvent
- ListenerCloseEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired by the proxy before the proxy stops accepting connections.
- ListenerCloseEvent(InetSocketAddress, ListenerType) - Constructor for class com.velocitypowered.api.event.proxy.ListenerCloseEvent
- ListenerType - Enum Class in com.velocitypowered.api.network
-
Represents each listener type.
- literalArgumentBuilder(String) - Static method in class com.velocitypowered.api.command.BrigadierCommand
-
Creates a new LiteralArgumentBuilder of the required name.
- LOGIN - Enum constant in enum class com.velocitypowered.api.network.HandshakeIntent
- LOGIN - Enum constant in enum class com.velocitypowered.api.network.ProtocolState
-
Authentication State of a connection.
- LoginEvent - Class in com.velocitypowered.api.event.connection
-
This event is fired once the player has been authenticated, but before they connect to a server.
- LoginEvent(Player) - Constructor for class com.velocitypowered.api.event.connection.LoginEvent
- LoginPhaseConnection - Interface in com.velocitypowered.api.proxy
-
Represents a connextion that is in the login phase.
- LoginPhaseConnection.MessageConsumer - Interface in com.velocitypowered.api.proxy
-
Consumes the message.
M
- map(String) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the map that will appear in the response.
- matchPlayer(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Matches all
Player
s whose names start with the provided partial name. - matchServer(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Matches all
RegisteredServer
s whose names start with the provided partial name. - MAXIMUM_VERSION - Static variable in enum class com.velocitypowered.api.network.ProtocolVersion
-
Represents the highest supported version.
- maximumPlayers(int) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- maxPlayers(int) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the maximum number of players this server purportedly can hold.
- message(String) - Static method in class com.velocitypowered.api.event.player.PlayerChatEvent.ChatResult
-
Allows the message to be sent, but silently replaces it with another.
- MessagePosition - Enum Class in com.velocitypowered.api.util
-
Represents where a chat message is going to be sent.
- metaBuilder(BrigadierCommand) - Method in interface com.velocitypowered.api.command.CommandManager
-
Returns a builder to create a
CommandMeta
for the given Brigadier command. - metaBuilder(String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Returns a builder to create a
CommandMeta
with the given alias. - MINECRAFT - Enum constant in enum class com.velocitypowered.api.network.ListenerType
- MINECRAFT_1_10 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_11 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_11_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_12 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_12_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_12_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_13 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_13_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_13_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_14 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_14_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_14_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_14_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_14_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_15 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_15_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_15_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_16 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_16_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_16_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_16_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_16_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_17 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_17_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_18 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_18_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_19 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_19_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_19_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_19_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_20 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_20_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_20_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_20_5 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_21 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_7_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_7_6 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_8 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_9 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_9_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_9_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MINECRAFT_1_9_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- MinecraftChannelIdentifier - Class in com.velocitypowered.api.proxy.messages
-
Represents a Minecraft 1.13+ channel identifier.
- MINIMUM_VERSION - Static variable in enum class com.velocitypowered.api.network.ProtocolVersion
-
Represents the lowest supported version.
- Mod(String, String) - Constructor for class com.velocitypowered.api.util.ModInfo.Mod
- ModInfo - Class in com.velocitypowered.api.util
-
Represents the information for a Forge mod list.
- ModInfo(String, List<ModInfo.Mod>) - Constructor for class com.velocitypowered.api.util.ModInfo
-
Constructs a new ModInfo instance.
- ModInfo.Mod - Class in com.velocitypowered.api.util
-
Represents a mod to send to the client.
- mods(ModInfo) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the modified
mods
list in the response. - mods(ModInfo.Mod...) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- modType(String) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
N
- name() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The human readable name of the plugin as to be used in descriptions and similar things.
- NEWS - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- noGreaterOrLessThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
this
is equal tothat
. - noGreaterThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
this
is less than or equal tothat
. - noLessThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
this
is greater than or equal tothat
. - NORMAL - Enum constant in enum class com.velocitypowered.api.event.PostOrder
- notModCompatible() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- nullPlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
O
- of(String, String) - Static method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
- onlinePlayers(int) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- onMessageResponse(byte[]) - Method in interface com.velocitypowered.api.proxy.LoginPhaseConnection.MessageConsumer
-
Consumes the message and responds to it.
- openBook(Book) - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- optional() - Element in annotation interface com.velocitypowered.api.plugin.Dependency
-
Whether or not the dependency is not required to enable this plugin.
- order() - Element in annotation interface com.velocitypowered.api.event.Subscribe
-
Deprecated.specify the order using
Subscribe.priority()
instead - Ordered<T> - Interface in com.velocitypowered.api.util
-
Something that is ordered.
- originalAddress() - Method in class com.velocitypowered.api.event.connection.PreTransferEvent
P
- PermissionFunction - Interface in com.velocitypowered.api.permission
-
Function that calculates the permission settings for a given
PermissionSubject
. - PermissionProvider - Interface in com.velocitypowered.api.permission
-
Provides
PermissionFunction
s forPermissionSubject
s. - PermissionsSetupEvent - Class in com.velocitypowered.api.event.permission
-
Called when a
PermissionSubject
's permissions are being setup. - PermissionsSetupEvent(PermissionSubject, PermissionProvider) - Constructor for class com.velocitypowered.api.event.permission.PermissionsSetupEvent
- PermissionSubject - Interface in com.velocitypowered.api.permission
-
Represents a object that has a set of queryable permissions.
- ping() - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Attempts to ping the remote server and return the server list ping result.
- ping(PingOptions) - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Attempts to ping the remote server and return the server list ping result according to the options provided.
- PingOptions - Class in com.velocitypowered.api.proxy.server
-
Contains the parameters used to ping a
RegisteredServer
. - PingOptions.Builder - Class in com.velocitypowered.api.proxy.server
-
A builder for
PingOptions
objects. - PLAY - Enum constant in enum class com.velocitypowered.api.network.ProtocolState
-
Game State of a connection.
- player() - Method in class com.velocitypowered.api.event.connection.PreTransferEvent
- player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Returns the value of the
player
record component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Returns the value of the
player
record component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Returns the value of the
player
record component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Returns the value of the
player
record component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Returns the value of the
player
record component. - Player - Interface in com.velocitypowered.api.proxy
-
Represents a player who is connected to the proxy.
- PlayerAvailableCommandsEvent - Class in com.velocitypowered.api.event.command
-
Allows plugins to modify the packet indicating commands available on the server to a Minecraft 1.13+ client.
- PlayerAvailableCommandsEvent(Player, RootCommandNode<?>) - Constructor for class com.velocitypowered.api.event.command.PlayerAvailableCommandsEvent
-
Constructs an available commands event.
- PlayerChannelRegisterEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when a client (
Player
) sends a plugin message through the register channel. - PlayerChannelRegisterEvent(Player, List<ChannelIdentifier>) - Constructor for class com.velocitypowered.api.event.player.PlayerChannelRegisterEvent
- PlayerChatEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when a player types in a chat message.
- PlayerChatEvent(Player, String) - Constructor for class com.velocitypowered.api.event.player.PlayerChatEvent
-
Constructs a PlayerChatEvent.
- PlayerChatEvent.ChatResult - Class in com.velocitypowered.api.event.player
-
Represents the result of the
PlayerChatEvent
. - PlayerChooseInitialServerEvent - Class in com.velocitypowered.api.event.player
-
Fired when a player has finished the login process, and we need to choose the first server to connect to.
- PlayerChooseInitialServerEvent(Player, RegisteredServer) - Constructor for class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
-
Constructs a PlayerChooseInitialServerEvent.
- PlayerClientBrandEvent - Class in com.velocitypowered.api.event.player
-
Fired when a
Player
sends theminecraft:brand
plugin message. - PlayerClientBrandEvent(Player, String) - Constructor for class com.velocitypowered.api.event.player.PlayerClientBrandEvent
-
Creates a new instance.
- PlayerConfigurationEvent - Record Class in com.velocitypowered.api.event.player.configuration
-
This event is executed when a player entered the configuration state and can be configured by Velocity.
- PlayerConfigurationEvent(Player, ServerConnection) - Constructor for record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Creates an instance of a
PlayerConfigurationEvent
record class. - PlayerEnterConfigurationEvent - Record Class in com.velocitypowered.api.event.player.configuration
-
This event is executed when a player is about to enter the configuration state.
- PlayerEnterConfigurationEvent(Player, ServerConnection) - Constructor for record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Creates an instance of a
PlayerEnterConfigurationEvent
record class. - PlayerEnteredConfigurationEvent - Record Class in com.velocitypowered.api.event.player.configuration
-
This event is executed when a player has entered the configuration state.
- PlayerEnteredConfigurationEvent(Player, ServerConnection) - Constructor for record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Creates an instance of a
PlayerEnteredConfigurationEvent
record class. - PlayerFinishConfigurationEvent - Record Class in com.velocitypowered.api.event.player.configuration
-
This event is executed when a player is about to finish the configuration state.
- PlayerFinishConfigurationEvent(Player, ServerConnection) - Constructor for record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Creates an instance of a
PlayerFinishConfigurationEvent
record class. - PlayerFinishedConfigurationEvent - Record Class in com.velocitypowered.api.event.player.configuration
-
This event is executed when a player has finished the configuration state.
- PlayerFinishedConfigurationEvent(Player, ServerConnection) - Constructor for record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Creates an instance of a
PlayerFinishedConfigurationEvent
record class. - PlayerModInfoEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when a Forge client sends its mods to the proxy while connecting to a server.
- PlayerModInfoEvent(Player, ModInfo) - Constructor for class com.velocitypowered.api.event.player.PlayerModInfoEvent
- PlayerResourcePackStatusEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when the status of a resource pack sent to the player by the server is changed.
- PlayerResourcePackStatusEvent(Player, PlayerResourcePackStatusEvent.Status) - Constructor for class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Deprecated.Use
(Player, UUID, Status, ResourcePackInfo)
instead. - PlayerResourcePackStatusEvent(Player, PlayerResourcePackStatusEvent.Status, ResourcePackInfo) - Constructor for class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Deprecated.Use
(Player, UUID, Status, ResourcePackInfo)
instead. - PlayerResourcePackStatusEvent(Player, UUID, PlayerResourcePackStatusEvent.Status, ResourcePackInfo) - Constructor for class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Instantiates this event.
- PlayerResourcePackStatusEvent.Status - Enum Class in com.velocitypowered.api.event.player
-
Represents the possible statuses for the resource pack.
- players(String...) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Adds the specified players to the player list.
- players(Collection<String>) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Adds the specified players to the player list.
- Players(int, int, List<ServerPing.SamplePlayer>) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing.Players
-
Creates a new instance.
- PlayerSettings - Interface in com.velocitypowered.api.proxy.player
-
Represents the client settings for the player.
- PlayerSettings.ChatMode - Enum Class in com.velocitypowered.api.proxy.player
-
The client's current chat display mode.
- PlayerSettings.MainHand - Enum Class in com.velocitypowered.api.proxy.player
-
The player's selected dominant hand.
- PlayerSettingsChangedEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when the client sends new client settings for the player.
- PlayerSettingsChangedEvent(Player, PlayerSettings) - Constructor for class com.velocitypowered.api.event.player.PlayerSettingsChangedEvent
- playSound(Sound) - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- playSound(Sound, double, double, double) - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- playSound(Sound, Sound.Emitter) - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- plugin() - Method in interface com.velocitypowered.api.scheduler.ScheduledTask
-
Returns the plugin that scheduled this task.
- plugin(Object) - Method in interface com.velocitypowered.api.command.CommandMeta.Builder
-
Specifies the plugin who registers the
Command
. - Plugin - Annotation Interface in com.velocitypowered.api.plugin
-
Annotation used to describe a Velocity plugin.
- PLUGIN_ON_PROXY - Enum constant in enum class com.velocitypowered.api.proxy.player.ResourcePackInfo.Origin
-
The resource-pack originated from a plugin on this proxy.
- PluginContainer - Interface in com.velocitypowered.api.plugin
-
A wrapper around a plugin loaded by the proxy.
- PluginDependency - Class in com.velocitypowered.api.plugin.meta
-
Represents a dependency on another plugin.
- PluginDependency(String, String, boolean) - Constructor for class com.velocitypowered.api.plugin.meta.PluginDependency
-
Creates a new instance.
- PluginDescription - Interface in com.velocitypowered.api.plugin
-
Represents metadata for a specific version of a plugin.
- PluginManager - Interface in com.velocitypowered.api.plugin
-
Manages plugins loaded on the proxy.
- PluginMessageEncoder - Interface in com.velocitypowered.api.proxy.messages
-
A data encoder to be sent via a plugin message.
- PluginMessageEvent - Class in com.velocitypowered.api.event.connection
-
This event is fired when a plugin message is sent to the proxy, either from a client (
Player
) or a server (ServerConnection
). - PluginMessageEvent(ChannelMessageSource, ChannelMessageSink, ChannelIdentifier, byte[]) - Constructor for class com.velocitypowered.api.event.connection.PluginMessageEvent
-
Creates a new instance.
- PluginMessageEvent.ForwardResult - Class in com.velocitypowered.api.event.connection
-
A result determining whether or not to forward this message on.
- plugins(QueryResponse.PluginInformation...) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Adds the specified plugins to the plugins list.
- plugins(Collection<QueryResponse.PluginInformation>) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Adds the specified plugins to the plugins list.
- PostCommandInvocationEvent - Class in com.velocitypowered.api.event.command
-
This event is fired when velocity executed a command.
- PostCommandInvocationEvent(CommandSource, String, CommandResult) - Constructor for class com.velocitypowered.api.event.command.PostCommandInvocationEvent
-
Constructs a PostCommandInvocationEvent.
- PostLoginEvent - Class in com.velocitypowered.api.event.connection
-
This event is fired once the player has been fully initialized and is about to connect to their first server.
- PostLoginEvent(Player) - Constructor for class com.velocitypowered.api.event.connection.PostLoginEvent
- PostOrder - Enum Class in com.velocitypowered.api.event
-
Represents the order an event will be posted to a listener method, relative to other listeners.
- PRE_SERVER_JOIN - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
- PreLoginEvent - Class in com.velocitypowered.api.event.connection
-
This 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(InboundConnection, String) - Constructor for class com.velocitypowered.api.event.connection.PreLoginEvent
-
Deprecated.
- PreLoginEvent(InboundConnection, String, UUID) - Constructor for class com.velocitypowered.api.event.connection.PreLoginEvent
-
Creates a new instance.
- PreLoginEvent.PreLoginComponentResult - Class in com.velocitypowered.api.event.connection
-
Represents an "allowed/allowed with forced online\offline mode/denied" result with a reason allowed for denial.
- PreTransferEvent - Class in com.velocitypowered.api.event.connection
-
This event is executed before sending a player to another host, either by the backend server or by a plugin using the
Player.transferToHost(InetSocketAddress)
method. - PreTransferEvent(Player, InetSocketAddress) - Constructor for class com.velocitypowered.api.event.connection.PreTransferEvent
- PreTransferEvent.TransferResult - Class in com.velocitypowered.api.event.connection
-
Transfer Result of a player to another host.
- priority() - Element in annotation interface com.velocitypowered.api.event.Subscribe
-
The priority of this event handler.
- profile(GameProfile) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the
GameProfile
of theTabListEntry
. - Property(String, String, String) - Constructor for class com.velocitypowered.api.util.GameProfile.Property
-
Creates a profile property entry.
- ProtocolState - Enum Class in com.velocitypowered.api.network
-
Representation of the state of the protocol in which a connection can be present.
- ProtocolVersion - Enum Class in com.velocitypowered.api.network
-
Represents each Minecraft protocol version.
- ProxyConfig - Interface in com.velocitypowered.api.proxy.config
-
Exposes certain proxy configuration information that plugins may use.
- proxyHost(String) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the host where this proxy is running.
- ProxyInitializeEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired by the proxy after plugins have been loaded but before the proxy starts accepting connections.
- ProxyInitializeEvent() - Constructor for class com.velocitypowered.api.event.proxy.ProxyInitializeEvent
- ProxyPingEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired when a request for server information is sent by a remote client, or when the server sends the MOTD and favicon to the client after a successful login.
- ProxyPingEvent(InboundConnection, ServerPing) - Constructor for class com.velocitypowered.api.event.proxy.ProxyPingEvent
- proxyPort(int) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the port where this proxy is running.
- ProxyQueryEvent - Class in com.velocitypowered.api.event.query
-
This event is fired if proxy is getting queried over GS4 Query protocol.
- ProxyQueryEvent(ProxyQueryEvent.QueryType, InetAddress, QueryResponse) - Constructor for class com.velocitypowered.api.event.query.ProxyQueryEvent
-
Creates a new event.
- ProxyQueryEvent.QueryType - Enum Class in com.velocitypowered.api.event.query
-
Represents the type of query the client is asking for.
- ProxyReloadEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired when the proxy is reloaded by the user using
/velocity reload
. - ProxyReloadEvent() - Constructor for class com.velocitypowered.api.event.proxy.ProxyReloadEvent
- ProxyServer - Interface in com.velocitypowered.api.proxy
-
Provides an interface to a Minecraft server proxy.
- ProxyShutdownEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired by the proxy after the proxy has stopped accepting connections but before the proxy process exits.
- ProxyShutdownEvent() - Constructor for class com.velocitypowered.api.event.proxy.ProxyShutdownEvent
- proxyVersion(String) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the proxy version.
- ProxyVersion - Class in com.velocitypowered.api.util
-
Provides a version object for the proxy.
- ProxyVersion(String, String, String) - Constructor for class com.velocitypowered.api.util.ProxyVersion
-
Creates a new
ProxyVersion
instance.
Q
- QUERY - Enum constant in enum class com.velocitypowered.api.network.ListenerType
- QueryResponse - Class in com.velocitypowered.api.proxy.server
-
GS4 query response.
- QueryResponse.Builder - Class in com.velocitypowered.api.proxy.server
-
A builder for
QueryResponse
objects. - QueryResponse.PluginInformation - Class in com.velocitypowered.api.proxy.server
-
Represents a plugin in the query response.
R
- RawCommand - Interface in com.velocitypowered.api.command
-
A specialized sub-interface of
Command
which indicates the proxy should pass the command and its arguments directly without further processing. - RawCommand.Invocation - Interface in com.velocitypowered.api.command
-
Contains the invocation data for a raw command.
- register(BrigadierCommand) - Method in interface com.velocitypowered.api.command.CommandManager
-
Deprecated.use
CommandManager.register(CommandMeta, Command)
instead with a plugin specified - register(CommandMeta, Command) - Method in interface com.velocitypowered.api.command.CommandManager
-
Registers the specified command with the given metadata.
- register(ChannelIdentifier...) - Method in interface com.velocitypowered.api.proxy.messages.ChannelRegistrar
-
Registers the specified message identifiers to listen on so you can intercept plugin messages on the channel using
PluginMessageEvent
. - register(Object, Class<E>, short, EventHandler<E>) - Method in interface com.velocitypowered.api.event.EventManager
-
Requests that the specified
handler
listen for events and associate it with theplugin
. - register(Object, Class<E>, EventHandler<E>) - Method in interface com.velocitypowered.api.event.EventManager
-
Requests that the specified
handler
listen for events and associate it with theplugin
. - register(Object, Class<E>, PostOrder, EventHandler<E>) - Method in interface com.velocitypowered.api.event.EventManager
-
Deprecated.
- register(Object, Object) - Method in interface com.velocitypowered.api.event.EventManager
-
Requests that the specified
listener
listen for events and associate it with theplugin
. - register(String, Command, String...) - Method in interface com.velocitypowered.api.command.CommandManager
-
Deprecated.use
CommandManager.register(CommandMeta, Command)
instead with a plugin specified - registeredServer() - Method in record class com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent
-
Returns the value of the
registeredServer
record component. - RegisteredServer - Interface in com.velocitypowered.api.proxy.server
-
Represents a server that has been registered with the proxy.
- registerServer(ServerInfo) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Registers a server with this proxy.
- removeCustomChatCompletions(Collection<String>) - Method in interface com.velocitypowered.api.proxy.Player
-
Remove custom chat completion suggestions shown to the player while typing a message.
- removeEntry(UUID) - Method in interface com.velocitypowered.api.proxy.player.TabList
- repeat(long, TimeUnit) - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Specifies that the task should continue running after waiting for the specified amount, until it is cancelled.
- repeat(Duration) - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Specifies that the task should continue running after waiting for the specified amount, until it is cancelled.
- reply(byte[]) - Static method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
- requestCookie(Key) - Method in interface com.velocitypowered.api.proxy.Player
-
Requests a previously stored cookie from the player's client.
- requiredArgumentBuilder(String, ArgumentType<T>) - Static method in class com.velocitypowered.api.command.BrigadierCommand
-
Creates a new RequiredArgumentBuilder of the required name and type.
- requiresAsync() - Method in interface com.velocitypowered.api.event.EventTask
-
Whether this
EventTask
is required to be called asynchronously. - ResourcePackInfo - Interface in com.velocitypowered.api.proxy.player
-
Represents the information for a resource pack to apply that can be sent to the client.
- ResourcePackInfo.Builder - Interface in com.velocitypowered.api.proxy.player
-
Builder for
ResourcePackInfo
instances. - ResourcePackInfo.Origin - Enum Class in com.velocitypowered.api.proxy.player
-
Represents the origin of the resource-pack.
- ResultedEvent<R extends ResultedEvent.Result> - Interface in com.velocitypowered.api.event
-
Indicates an event that has a result attached to it.
- ResultedEvent.ComponentResult - Class in com.velocitypowered.api.event
-
Represents an "allowed/denied" result with a reason allowed for denial.
- ResultedEvent.GenericResult - Class in com.velocitypowered.api.event
-
A generic "allowed/denied" result.
- ResultedEvent.Result - Interface in com.velocitypowered.api.event
-
Represents a result for an event.
- resume() - Method in interface com.velocitypowered.api.event.Continuation
-
Resumes the continuation.
- resumeWhenComplete(CompletableFuture<?>) - Static method in interface com.velocitypowered.api.event.EventTask
-
Creates a continuation based
EventTask
for the givenCompletableFuture
. - resumeWithException(Throwable) - Method in interface com.velocitypowered.api.event.Continuation
-
Resumes the continuation after the executed task failed.
- RIGHT - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.MainHand
S
- SamplePlayer(String, UUID) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
- samplePlayers(ServerPing.SamplePlayer...) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- schedule() - Method in interface com.velocitypowered.api.scheduler.Scheduler.TaskBuilder
-
Schedules this task for execution.
- SCHEDULED - Enum constant in enum class com.velocitypowered.api.scheduler.TaskStatus
-
The task is scheduled and is currently running.
- ScheduledTask - Interface in com.velocitypowered.api.scheduler
-
Represents a task that is scheduled to run on the proxy.
- Scheduler - Interface in com.velocitypowered.api.scheduler
-
Represents a scheduler to execute tasks on the proxy.
- Scheduler.TaskBuilder - Interface in com.velocitypowered.api.scheduler
-
Represents a fluent interface to schedule tasks on the proxy.
- sendLoginPluginMessage(ChannelIdentifier, byte[], LoginPhaseConnection.MessageConsumer) - Method in interface com.velocitypowered.api.proxy.LoginPhaseConnection
-
Sends a login plugin message to the client, and provides a consumer to react to the response to the client.
- sendPlainMessage(String) - Method in interface com.velocitypowered.api.command.CommandSource
-
Sends a plain message to this source.
- sendPluginMessage(ChannelIdentifier, byte[]) - Method in interface com.velocitypowered.api.proxy.messages.ChannelMessageSink
-
Sends a plugin message to this target.
- sendPluginMessage(ChannelIdentifier, byte[]) - Method in interface com.velocitypowered.api.proxy.Player
-
Sends a plugin message to this target.
- sendPluginMessage(ChannelIdentifier, PluginMessageEncoder) - Method in interface com.velocitypowered.api.proxy.messages.ChannelMessageSink
-
Sends a plugin message to this target.
- sendPluginMessage(ChannelIdentifier, PluginMessageEncoder) - Method in interface com.velocitypowered.api.proxy.Player
-
Sends a plugin message to this target.
- sendResourcePack(String) - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.Use
Player.sendResourcePackOffer(ResourcePackInfo)
instead - sendResourcePack(String, byte[]) - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.Use
Player.sendResourcePackOffer(ResourcePackInfo)
instead - sendResourcePackOffer(ResourcePackInfo) - Method in interface com.velocitypowered.api.proxy.Player
-
Queues and sends a new Resource-pack offer to the player.
- sendRichMessage(String) - Method in interface com.velocitypowered.api.command.CommandSource
-
Sends a message with the MiniMessage format to this source.
- sendRichMessage(String, TagResolver...) - Method in interface com.velocitypowered.api.command.CommandSource
-
Sends a message with the MiniMessage format to this source.
- server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Returns the value of the
server
record component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Returns the value of the
server
record component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Returns the value of the
server
record component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Returns the value of the
server
record component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Returns the value of the
server
record component. - SERVER_DISCONNECTED - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
The server disconnected the user.
- ServerConnectedEvent - Class in com.velocitypowered.api.event.player
-
This event is fired once the player has successfully connected to the target server and the connection to the previous server has been de-established.
- ServerConnectedEvent(Player, RegisteredServer, RegisteredServer) - Constructor for class com.velocitypowered.api.event.player.ServerConnectedEvent
-
Constructs a ServerConnectedEvent.
- ServerConnection - Interface in com.velocitypowered.api.proxy
-
Represents a connection to a backend server from the proxy for a client.
- ServerInfo - Class in com.velocitypowered.api.proxy.server
-
ServerInfo represents a server that a player can connect to.
- ServerInfo(String, InetSocketAddress) - Constructor for class com.velocitypowered.api.proxy.server.ServerInfo
-
Creates a new ServerInfo object.
- serverLink(ServerLink.Type, String) - Static method in class com.velocitypowered.api.util.ServerLink
-
Construct a server link with a built-in type.
- serverLink(Component, String) - Static method in class com.velocitypowered.api.util.ServerLink
-
Construct a server link with a custom component label.
- ServerLink - Class in com.velocitypowered.api.util
-
Represents a custom URL servers can show in player pause menus.
- ServerLink.Type - Enum Class in com.velocitypowered.api.util
-
Built-in types of server links.
- ServerLoginPluginMessageEvent - Class in com.velocitypowered.api.event.player
-
Fired when a server sends a login plugin message to the proxy.
- ServerLoginPluginMessageEvent(ServerConnection, ChannelIdentifier, byte[], int) - Constructor for class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Constructs a new
ServerLoginPluginMessageEvent
. - ServerLoginPluginMessageEvent.ResponseResult - Class in com.velocitypowered.api.event.player
-
The result class, containing a response to the login plugin message sent by the server.
- ServerPing - Class in com.velocitypowered.api.proxy.server
-
Represents a 1.7 and above server list ping response.
- ServerPing(ServerPing.Version, ServerPing.Players, Component, Favicon) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing
- ServerPing(ServerPing.Version, ServerPing.Players, Component, Favicon, ModInfo) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing
-
Constructs a ServerPing instance.
- ServerPing.Builder - Class in com.velocitypowered.api.proxy.server
-
A builder for
ServerPing
objects. - ServerPing.Players - Class in com.velocitypowered.api.proxy.server
-
Represents what the players the server purports to have online, its maximum capacity, and a sample of players on the server.
- ServerPing.SamplePlayer - Class in com.velocitypowered.api.proxy.server
-
A player returned in the sample field of the server ping players field.
- ServerPing.Version - Class in com.velocitypowered.api.proxy.server
-
Represents the version of the server sent to the client.
- ServerPostConnectEvent - Class in com.velocitypowered.api.event.player
-
Fired after the player has connected to a server.
- ServerPostConnectEvent(Player, RegisteredServer) - Constructor for class com.velocitypowered.api.event.player.ServerPostConnectEvent
- ServerPreConnectEvent - Class in com.velocitypowered.api.event.player
-
This event is fired before the player connects to a server.
- ServerPreConnectEvent(Player, RegisteredServer) - Constructor for class com.velocitypowered.api.event.player.ServerPreConnectEvent
-
Creates the ServerPreConnectEvent.
- ServerPreConnectEvent(Player, RegisteredServer, RegisteredServer) - Constructor for class com.velocitypowered.api.event.player.ServerPreConnectEvent
-
Creates the ServerPreConnectEvent.
- ServerPreConnectEvent.ServerResult - Class in com.velocitypowered.api.event.player
-
Represents the result of the
ServerPreConnectEvent
. - ServerRegisteredEvent - Record Class in com.velocitypowered.api.event.proxy.server
-
This event is fired by the proxy after a backend server is registered to the server map.
- ServerRegisteredEvent(RegisteredServer) - Constructor for record class com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent
-
Creates an instance of a
ServerRegisteredEvent
record class. - ServerResourcePackRemoveEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when the downstream server tries to remove a resource pack from player or clear all of them.
- ServerResourcePackRemoveEvent(UUID, ServerConnection) - Constructor for class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
-
Instantiates this event.
- ServerResourcePackSendEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when the downstream server tries to send a player a ResourcePack packet.
- ServerResourcePackSendEvent(ResourcePackInfo, ServerConnection) - Constructor for class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
-
Constructs a new ServerResourcePackSendEvent.
- ServerUnregisteredEvent - Record Class in com.velocitypowered.api.event.proxy.server
-
This event is fired by the proxy after a backend server is unregistered from the server map.
- ServerUnregisteredEvent(RegisteredServer) - Constructor for record class com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent
-
Creates an instance of a
ServerUnregisteredEvent
record class. - setCustomChatCompletions(Collection<String>) - Method in interface com.velocitypowered.api.proxy.Player
-
Set the list of chat completion suggestions shown to the player while typing a message.
- setDisplayName(Component) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
- setEffectiveLocale(Locale) - Method in interface com.velocitypowered.api.proxy.Player
-
Change the locale the proxy will be translating its messages to.
- setGameMode(int) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Sets the game mode for
this
entry to the specified value. - setGameProfile(GameProfile) - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Sets the game profile to use for this connection.
- setGameProfileProperties(List<GameProfile.Property>) - Method in interface com.velocitypowered.api.proxy.Player
-
Sets the player's profile properties.
- setHash(byte[]) - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Sets the SHA-1 hash of the provided resource pack.
- setHeaderAndFooter(Component, Component) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.
- setId(UUID) - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Sets the id of the resource pack.
- setInitialServer(RegisteredServer) - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
-
Sets the new initial server.
- setLatency(int) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Sets the latency for
this
entry to the specified value. - setListed(boolean) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Sets whether this entry is listed.
- setOverwriteKick(boolean) - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Set to true to prevent
ResourcePackInfo.getShouldForce()
from kicking the player. - setPing(ServerPing) - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Sets the ServerPing to send to the connection.
- setPrompt(Component) - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Sets a
Component
to display on the download prompt. - setProvidedResourcePack(ResourcePackInfo) - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
- setProvider(PermissionProvider) - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
-
Sets the
PermissionFunction
that should be used for the subject. - setResponse(QueryResponse) - Method in class com.velocitypowered.api.event.query.ProxyQueryEvent
-
Sets a new query response.
- setResult(CommandExecuteEvent.CommandResult) - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent
- setResult(PreLoginEvent.PreLoginComponentResult) - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
- setResult(KickedFromServerEvent.ServerKickResult) - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
- setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Sets whether to avoid sending a ping response to the connection.
- setResult(PluginMessageEvent.ForwardResult) - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- setResult(PreTransferEvent.TransferResult) - Method in class com.velocitypowered.api.event.connection.PreTransferEvent
- setResult(CookieReceiveEvent.ForwardResult) - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
- setResult(CookieRequestEvent.ForwardResult) - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
- setResult(CookieStoreEvent.ForwardResult) - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
- setResult(PlayerChatEvent.ChatResult) - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
- setResult(ServerLoginPluginMessageEvent.ResponseResult) - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
- setResult(ServerPreConnectEvent.ServerResult) - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
- setResult(ResultedEvent.ComponentResult) - Method in class com.velocitypowered.api.event.connection.LoginEvent
- setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
- setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
- setResult(R) - Method in interface com.velocitypowered.api.event.ResultedEvent
-
Sets the result of this event.
- setServerLinks(List<ServerLink>) - Method in interface com.velocitypowered.api.proxy.Player
-
Send the player a list of custom links to display in their client's pause menu.
- setShouldForce(boolean) - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Sets the resource-pack as required to play on the network.
- shouldPreventClientProxyConnections() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
If client's ISP/AS sent from this proxy is different from the one from Mojang's authentication server, the player is kicked.
- shouldQueryShowPlugins() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Whether GameSpy 4 queries should show plugins installed on Velocity by default.
- SHOWN - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
- shutdown() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Shuts down the proxy, kicking players with the default reason.
- shutdown(Component) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Shuts down the proxy, kicking players with the specified
reason
. - SignedMessage - Interface in com.velocitypowered.api.proxy.crypto
-
A signed message.
- SimpleCommand - Interface in com.velocitypowered.api.command
-
A simple command, modelled after the convention popularized by Bukkit and BungeeCord.
- SimpleCommand.Invocation - Interface in com.velocitypowered.api.command
-
Contains the invocation data for a simple command.
- SkinParts - Class in com.velocitypowered.api.proxy.player
-
Represents what, if any, extended parts of the skin this player has.
- SkinParts(byte) - Constructor for class com.velocitypowered.api.proxy.player.SkinParts
- source() - Method in interface com.velocitypowered.api.command.CommandInvocation
-
Returns the source to execute the command for.
- spoofChatInput(String) - Method in interface com.velocitypowered.api.proxy.Player
-
Sends chat input onto the players current server as if they typed it into the client chat box.
- status() - Method in interface com.velocitypowered.api.scheduler.ScheduledTask
-
Returns the current status of this task.
- STATUS - Enum constant in enum class com.velocitypowered.api.network.HandshakeIntent
- STATUS - Enum constant in enum class com.velocitypowered.api.network.ProtocolState
-
Ping State of a connection.
- STATUS - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- stopSound(SoundStop) - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- storeCookie(Key, byte[]) - Method in interface com.velocitypowered.api.proxy.Player
-
Stores a cookie with arbitrary data on the player's client.
- Subscribe - Annotation Interface in com.velocitypowered.api.event
-
An annotation that indicates that this method can be used to listen for an event from the proxy.
- SUCCESS - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
The player was successfully connected to the server.
- SUCCESSFUL - Enum constant in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
The resource pack was applied successfully.
- SUCCESSFUL_LOGIN - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
- suggest(I) - Method in interface com.velocitypowered.api.command.InvocableCommand
-
Provides tab complete suggestions for the specified invocation.
- suggestAsync(I) - Method in interface com.velocitypowered.api.command.InvocableCommand
-
Provides tab complete suggestions for the specified invocation.
- SUPPORT - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- SUPPORTED_VERSION_STRING - Static variable in enum class com.velocitypowered.api.network.ProtocolVersion
-
The user-friendly representation of the lowest and highest supported versions.
- SUPPORTED_VERSIONS - Static variable in enum class com.velocitypowered.api.network.ProtocolVersion
-
A set containing all the protocols that the proxy actually supports, excluding special-purpose "versions" like
ProtocolVersion.LEGACY
andProtocolVersion.UNKNOWN
. - SYNTAX_ERROR - Enum constant in enum class com.velocitypowered.api.command.CommandResult
-
The provided command input contained syntax errors.
- SYSTEM - Enum constant in enum class com.velocitypowered.api.util.MessagePosition
-
The chat message will appear in the client's HUD and can't be dismissed.
T
- TabCompleteEvent - Class in com.velocitypowered.api.event.player
-
This event is fired after a tab complete response is sent by the remote server, for clients on 1.12.2 and below.
- TabCompleteEvent(Player, String, List<String>) - Constructor for class com.velocitypowered.api.event.player.TabCompleteEvent
-
Constructs a new TabCompleteEvent instance.
- tabList(TabList) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
- TabList - Interface in com.velocitypowered.api.proxy.player
-
Represents the tab list of a
Player
. - TabListEntry - Interface in com.velocitypowered.api.proxy.player
-
Represents a single entry in a
TabList
. - TabListEntry.Builder - Class in com.velocitypowered.api.proxy.player
-
Represents a builder which creates
TabListEntry
s. - tasksByPlugin(Object) - Method in interface com.velocitypowered.api.scheduler.Scheduler
-
Get the
ScheduledTask
for a specific plugin. - TaskStatus - Enum Class in com.velocitypowered.api.scheduler
-
Enumerates all possible task statuses.
- timeout(long, TimeUnit) - Method in class com.velocitypowered.api.proxy.server.PingOptions.Builder
-
Sets the maximum time to wait to get the required
ServerPing
. - timeout(Duration) - Method in class com.velocitypowered.api.proxy.server.PingOptions.Builder
-
Sets the maximum time to wait to get the required
ServerPing
. - toAdventureTriState() - Method in enum class com.velocitypowered.api.permission.Tristate
-
Returns the equivalent Adventure
TriState
. - toBuilder() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Creates a new
QueryResponse.Builder
instance from data represented by this response, so that you may create a newQueryResponse
with new data. - tooltip(Component) - Static method in class com.velocitypowered.api.command.VelocityBrigadierMessage
- toString() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
- toString() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent
- toString() - Method in class com.velocitypowered.api.event.command.PostCommandInvocationEvent
- toString() - Method in class com.velocitypowered.api.event.connection.ConnectionHandshakeEvent
- toString() - Method in class com.velocitypowered.api.event.connection.DisconnectEvent
- toString() - Method in class com.velocitypowered.api.event.connection.LoginEvent
- toString() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult
- toString() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- toString() - Method in class com.velocitypowered.api.event.connection.PostLoginEvent
- toString() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
- toString() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
- toString() - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
- toString() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Returns a string representation of this record class.
- toString() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
- toString() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
- toString() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
- toString() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
- toString() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
- toString() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
- toString() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
- toString() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.DisconnectPlayer
- toString() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.Notify
- toString() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
- toString() - Method in class com.velocitypowered.api.event.player.PlayerChannelRegisterEvent
- toString() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent.ChatResult
- toString() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
- toString() - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
- toString() - Method in class com.velocitypowered.api.event.player.PlayerClientBrandEvent
- toString() - Method in class com.velocitypowered.api.event.player.PlayerModInfoEvent
- toString() - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
- toString() - Method in class com.velocitypowered.api.event.player.PlayerSettingsChangedEvent
- toString() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
- toString() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
- toString() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
- toString() - Method in class com.velocitypowered.api.event.player.ServerPostConnectEvent
- toString() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult
- toString() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
- toString() - Method in class com.velocitypowered.api.event.player.TabCompleteEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ListenerBoundEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ListenerCloseEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ProxyInitializeEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ProxyReloadEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ProxyShutdownEvent
- toString() - Method in record class com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent
-
Returns a string representation of this record class.
- toString() - Method in record class com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent
-
Returns a string representation of this record class.
- toString() - Method in class com.velocitypowered.api.event.query.ProxyQueryEvent
- toString() - Method in class com.velocitypowered.api.event.ResultedEvent.ComponentResult
- toString() - Method in class com.velocitypowered.api.event.ResultedEvent.GenericResult
- toString() - Method in enum class com.velocitypowered.api.network.ListenerType
- toString() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
- toString() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
- toString() - Method in class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
- toString() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
- toString() - Method in class com.velocitypowered.api.proxy.server.PingOptions
- toString() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
- toString() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
- toString() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- toString() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- toString() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Players
- toString() - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
- toString() - Method in class com.velocitypowered.api.proxy.server.ServerPing
- toString() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Version
- toString() - Method in class com.velocitypowered.api.util.Favicon
- toString() - Method in class com.velocitypowered.api.util.GameProfile.Property
- toString() - Method in class com.velocitypowered.api.util.GameProfile
- toString() - Method in class com.velocitypowered.api.util.ModInfo.Mod
- toString() - Method in class com.velocitypowered.api.util.ModInfo
- toString() - Method in class com.velocitypowered.api.util.ProxyVersion
- toUndashed(UUID) - Static method in class com.velocitypowered.api.util.UuidUtils
-
Converts from a Java
UUID
object into an undashed Mojang-style UUID. - TRANSFER - Enum constant in enum class com.velocitypowered.api.network.HandshakeIntent
- transferTo(InetSocketAddress) - Static method in class com.velocitypowered.api.event.connection.PreTransferEvent.TransferResult
-
Sets the result of transfer to a specific host.
- transferToHost(InetSocketAddress) - Method in interface com.velocitypowered.api.proxy.Player
-
Transfers a Player to a host.
- Tristate - Enum Class in com.velocitypowered.api.permission
-
Represents three different states of a setting.
- TRUE - Enum constant in enum class com.velocitypowered.api.permission.Tristate
-
A value indicating a positive setting.
U
- UNDEFINED - Enum constant in enum class com.velocitypowered.api.permission.Tristate
-
A value indicating a non-existent setting.
- unknown() - Static method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
- UNKNOWN - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
- unregister(CommandMeta) - Method in interface com.velocitypowered.api.command.CommandManager
-
Unregisters the specified command from the manager, if registered.
- unregister(ChannelIdentifier...) - Method in interface com.velocitypowered.api.proxy.messages.ChannelRegistrar
-
Removes the intent to listen for the specified channel.
- unregister(Object, EventHandler<E>) - Method in interface com.velocitypowered.api.event.EventManager
-
Unregisters a specific event handler for a specific plugin.
- unregister(String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Unregisters the specified command alias from the manager, if registered.
- unregisteredServer() - Method in record class com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent
-
Returns the value of the
unregisteredServer
record component. - unregisterListener(Object, Object) - Method in interface com.velocitypowered.api.event.EventManager
-
Unregisters a specific listener for a specific plugin.
- unregisterListeners(Object) - Method in interface com.velocitypowered.api.event.EventManager
-
Unregisters all listeners for the specified
plugin
. - unregisterServer(ServerInfo) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Unregisters this server from the proxy.
- url() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The URL or website of the plugin.
- UuidUtils - Class in com.velocitypowered.api.util
-
Provides a small, useful selection of utilities for working with Minecraft UUIDs.
V
- valueOf(String) - Static method in enum class com.velocitypowered.api.command.CommandResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.event.PostOrder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.event.query.ProxyQueryEvent.QueryType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.network.HandshakeIntent
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.network.ListenerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.network.ProtocolState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.permission.Tristate
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.proxy.player.PlayerSettings.MainHand
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.proxy.player.ResourcePackInfo.Origin
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.scheduler.TaskStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.util.MessagePosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.util.ServerLink.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.velocitypowered.api.command.CommandResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.event.PostOrder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.event.query.ProxyQueryEvent.QueryType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.network.HandshakeIntent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.network.ListenerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.network.ProtocolState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.permission.Tristate
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.proxy.player.PlayerSettings.MainHand
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.proxy.player.ResourcePackInfo.Origin
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.scheduler.TaskStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.util.MessagePosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.velocitypowered.api.util.ServerLink.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VelocityBrigadierMessage - Class in com.velocitypowered.api.command
-
Represents an implementation of brigadier's
Message
, providing support forComponent
messages. - verifyDataSignature(byte[], byte[]...) - Method in interface com.velocitypowered.api.proxy.crypto.IdentifiedKey
-
Validates a signature against this public key.
- version() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The version of the plugin.
- version(ProtocolVersion) - Method in class com.velocitypowered.api.proxy.server.PingOptions.Builder
-
Sets the protocol with which the server is to be pinged.
- version(ServerPing.Version) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
- Version(int, String) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing.Version
-
Creates a new instance.
W
- WEBSITE - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
- withContinuation(Consumer<Continuation>) - Static method in interface com.velocitypowered.api.event.EventTask
- withId(UUID) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfile
with the specified unique id. - withName(String) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfile
with the specified name. - withProperties(List<GameProfile.Property>) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfile
with the specified properties. - withUndashedId(String) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfile
with the specified undashed id.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
TabListEntry.Builder
instead.