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.
- ACTIVE - Enum constant in enum class com.btcvelocity.api.queue.QueueState
-
The queue is active and will transfer players to the backend server when it is available.
- 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
TabListEntryto thePlayer's tab list. - addProperties(Iterable<GameProfile.Property>) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfilewith the properties of this object plus the specified properties. - addProperty(GameProfile.Property) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfilewith the properties of this object plus the specified property. - address() - Method in class com.velocitypowered.api.event.connection.PreTransferEvent.TransferResult
-
Returns the destination address for the transfer, if overridden.
- address() - Method in record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
Returns the value of the
addressrecord component. - addToClasspath(Object, Path) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Adds the specified
pathto 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.
- ALL - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ParticleStatus
-
All particles are shown.
- 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
-
Allows the transfer to proceed to the originally specified address.
- 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
-
Returns a result indicating the event is allowed to proceed.
- allowed() - Static method in class com.velocitypowered.api.event.ResultedEvent.GenericResult
-
Returns a result indicating the event is allowed to proceed.
- 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.btcvelocity.api.permission.PermissionResolver
-
A simple permission resolver adapter backed by
PermissionFunction.ALWAYS_FALSE. - 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.btcvelocity.api.permission.PermissionResolver
-
A simple permission resolver adapter backed by
PermissionFunction.ALWAYS_TRUE. - 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.btcvelocity.api.permission.PermissionResolver
-
A simple permission resolver adapter backed by
PermissionFunction.ALWAYS_UNDEFINED. - 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
-
A link to announcements from the server team.
- ANONYMOUS - Static variable in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
-
A constant representing an anonymous sample player with a null UUID and generic name.
- API - Enum constant in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.Source
-
Indicates that the command was invoked programmatically through an API call.
- applySkinToPlayerHeadContents(PlayerHeadObjectContents.Builder) - Method in interface com.velocitypowered.api.proxy.Player
- applySkinToPlayerHeadContents(PlayerHeadObjectContents.Builder) - Method in class com.velocitypowered.api.util.GameProfile
- 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
ResourcePackInfoinstance as a builder so that it can be modified. - asBuilder() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Returns a copy of this
ServerPinginstance 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
ResourcePackInfoinstance 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
-
Converts this channel identifier to a
Keyobject. - 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 complete(ly) fire (including any
EventTasks) before continuing handling it. - AwaitingEventExecutor<E> - Interface in com.velocitypowered.api.event
-
An event handler that returns an
EventTaskto await on.
B
- backendQueueSize() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
-
Returns the value of the
backendQueueSizerecord component. - BackendServerConfig - Record Class in com.velocitypowered.api.proxy.config
-
Exposes server configuration information that plugins may use.
- BackendServerConfig(String) - Constructor for record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
Creates a new
BackendServerConfigwith the given address, using the default. - BackendServerConfig(String, PlayerInfoForwarding) - Constructor for record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
Creates a new
BackendServerConfig. - 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
- BridgeChannel - Interface in com.btcvelocity.api.bridge
-
Service for sending and receiving
btc:bridgemessages between the proxy and its backend servers. - BridgeCodec - Class in com.btcvelocity.api.bridge
-
Handles JSON serialization and deserialization of
BridgeMessagerecords. - BridgeMessage - Interface in com.btcvelocity.api.bridge
-
Base interface for all
btc:bridgemessages. - BridgeMessage.ConnectRequest - Record Class in com.btcvelocity.api.bridge
-
Backend -> Proxy: move a single player (identified by UUID) to another backend server.
- BridgeMessage.Health - Record Class in com.btcvelocity.api.bridge
-
Backend -> Proxy: a periodic health report from a backend server.
- BridgeMessage.PartyWarp - Record Class in com.btcvelocity.api.bridge
-
Backend -> Proxy: move a group of players (for example a whole party) to a destination server in a single request.
- BridgeMessage.QueueJoin - Record Class in com.btcvelocity.api.bridge
-
Proxy -> Backend: a player joined the queue for a server.
- BridgeMessage.QueueLeave - Record Class in com.btcvelocity.api.bridge
-
Proxy -> Backend: a player left the queue.
- BridgeMessage.QueueStatusResponse - Record Class in com.btcvelocity.api.bridge
-
Backend -> Proxy: a response to a queue-status query, reporting the backend's own queue depth.
- BridgeMessage.RequestStatus - Record Class in com.btcvelocity.api.bridge
-
Proxy -> Backend: request that the backend report its current health status.
- BridgeMessage.WorldLoaded - Record Class in com.btcvelocity.api.bridge
-
Backend -> Proxy: a world has been loaded and is ready to accept players.
- BridgeMessage.WorldPreload - Record Class in com.btcvelocity.api.bridge
-
Proxy -> Backend: a player is about to be transferred, preload the given world.
- BridgeMessage.WorldUnloaded - Record Class in com.btcvelocity.api.bridge
-
Backend -> Proxy: a world has been unloaded.
- BridgeMessageListener - Interface in com.btcvelocity.api.bridge
-
A functional callback invoked when a
BridgeMessageis received by the proxy from a backend server. - 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
BrigadierCommandfrom the node returned by the given builder. - BrigadierCommand(LiteralCommandNode<CommandSource>) - Constructor for class com.velocitypowered.api.command.BrigadierCommand
-
Constructs a
BrigadierCommandfrom the given command node. - broadcastAlert(Component) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Broadcasts an alert message to all players on all proxies in the cluster.
- BUG_REPORT - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
-
A link to report bugs related to the server or gameplay.
- build() - Method in interface com.velocitypowered.api.command.CommandMeta.Builder
-
Returns a newly-created
CommandMetabased on the specified parameters. - build() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Builds the
ResourcePackInfofrom 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
PingOptionswith the values of this Builder. - build() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Builds a new
QueryResponsewith the supplied data. - build() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the information from this builder to create a new
ServerPinginstance. - 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.Builderinstead. - buildEntry(GameProfile, Component, int, int, ChatSession) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builderinstead. - buildEntry(GameProfile, Component, int, int, ChatSession, boolean) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builderinstead. - buildEntry(GameProfile, Component, int, int, ChatSession, boolean, int) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builderinstead. - buildEntry(GameProfile, Component, int, int, ChatSession, boolean, int, boolean) - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Deprecated.Internal usage. Use
TabListEntry.Builderinstead. - builder() - Static method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns a
TabListEntry.Builderto 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.Builderinstance. - builder() - Static method in class com.velocitypowered.api.proxy.server.ServerPing
-
Creates a new
ServerPing.Builderfor constructing aServerPing. - buildTask(Object, Runnable) - Method in interface com.velocitypowered.api.scheduler.Scheduler
-
Initializes a new
Scheduler.TaskBuilderfor creating a task on the proxy. - buildTask(Object, Consumer<ScheduledTask>) - Method in interface com.velocitypowered.api.scheduler.Scheduler
-
Initializes a new
Scheduler.TaskBuilderfor creating a task on the proxy. - BUNGEEGUARD - Enum constant in enum class com.velocitypowered.api.proxy.server.PlayerInfoForwarding
-
Uses BungeeGuard-style secure IP forwarding, which works by sending a shared secret token in the handshake.
- BUNGEEGUARD - Enum constant in enum class com.velocitypowered.api.proxy.server.ServerInfoForwardingMode
-
Use BungeeGuard-compatible forwarding.
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 canceled with
ScheduledTask.cancel(). - CANCELLED_BY_PROXY - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
-
The proxy disconnected the player before login completed.
- CANCELLED_BY_USER - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
-
The player voluntarily disconnected before completing the login.
- CANCELLED_BY_USER_BEFORE_COMPLETE - Enum constant in enum class com.velocitypowered.api.event.connection.DisconnectEvent.LoginStatus
-
The player disconnected on their own, but only after starting the login and before completing it.
- CHANNEL_ID - Static variable in interface com.btcvelocity.api.bridge.BridgeChannel
-
The channel identifier used for all bridge traffic.
- 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
ChannelIdentifiers 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
IdentifiedKeyof 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
-
Clears the current favicon used in the response.
- 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
-
Clears the current list of mods to use in the response.
- 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
-
Clears the current list of PlayerSamples to use in the response.
- closeDialog() - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- closeListeners() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Closes all listening endpoints for this server.
- ClusterPlayer - Interface in com.btcvelocity.api.cluster
-
Represents a player connected somewhere in the proxy cluster.
- ClusterPlayerService - Interface in com.btcvelocity.api.cluster
-
Service for tracking and querying players across all proxies in the cluster.
- ClusterProxyService - Interface in com.btcvelocity.api.cluster
-
Service for discovering proxies and performing cross-proxy operations within the cluster.
- com.btcvelocity.api.bridge - package com.btcvelocity.api.bridge
- com.btcvelocity.api.cluster - package com.btcvelocity.api.cluster
- com.btcvelocity.api.event.connection - package com.btcvelocity.api.event.connection
- com.btcvelocity.api.event.player - package com.btcvelocity.api.event.player
- com.btcvelocity.api.permission - package com.btcvelocity.api.permission
- com.btcvelocity.api.queue - package com.btcvelocity.api.queue
- com.btcvelocity.api.storage - package com.btcvelocity.api.storage
- 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.ap - package com.velocitypowered.api.plugin.ap
- 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
CommandSourcesuch as aPlayeror 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(CommandSource, String, CommandExecuteEvent.InvocationInfo) - 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. - CommandExecuteEvent.InvocationInfo - Record Class in com.velocitypowered.api.event.command
-
Represents information about a command invocation, including its signed state and source.
- CommandExecuteEvent.SignedState - Enum Class in com.velocitypowered.api.event.command
-
Represents the signed state of a command invocation.
- CommandExecuteEvent.Source - Enum Class in com.velocitypowered.api.event.command
-
Represents the source of a command invocation.
- 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
CommandMetas. - 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
-
Only command messages are shown.
- 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
-
A link to the server’s community hub or Discord.
- COMMUNITY_GUIDELINES - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
-
A link to the server's community guidelines or rules.
- compareTo(ServerInfo) - Method in class com.velocitypowered.api.proxy.server.ServerInfo
- 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
-
The player was disconnected because another login with the same UUID occurred.
- connect() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder
-
Initiates the connection to the remote server and emits a result on the
CompletableFutureafter the user has logged on. - CONNECTION_CANCELLED - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
A plugin has canceled this connection.
- CONNECTION_IN_PROGRESS - Enum constant in enum class com.velocitypowered.api.proxy.ConnectionRequestBuilder.Status
-
The connection is already in progress.
- ConnectionEstablishEvent - Class in com.btcvelocity.api.event.connection
-
This event is fired when a new connection is initially established with the proxy.
- ConnectionEstablishEvent - Class in com.velocitypowered.api.event.connection
-
This event is fired when a new connection is initially established with the proxy.
- ConnectionEstablishEvent(InboundConnection, HandshakeIntent) - Constructor for class com.btcvelocity.api.event.connection.ConnectionEstablishEvent
-
Constructs a new
ConnectionEstablishEvent. - ConnectionEstablishEvent(InboundConnection, HandshakeIntent) - Constructor for class com.velocitypowered.api.event.connection.ConnectionEstablishEvent
-
Constructs a new
ConnectionEstablishEvent. - 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
-
Constructs a new
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. - ConnectRequest(UUID, String) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
-
Creates an instance of a
ConnectRequestrecord class. - connectWithIndication() - Method in interface com.velocitypowered.api.proxy.ConnectionRequestBuilder
-
Initiates the connection to the remote server and emits a result on the
CompletableFutureafter the user has logged on. - ConsoleCommandSource - Interface in com.velocitypowered.api.proxy
-
Indicates that the executor of the command is the console.
- contains(Player) - Method in interface com.btcvelocity.api.queue.Queue
-
Returns
trueif the given player is currently in this queue. - contains(UUID) - Method in interface com.btcvelocity.api.queue.Queue
-
Returns
trueif the given UUID is currently in this queue. - 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 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 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 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(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
Faviconfrom 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
Faviconby reading the image from the specifiedpath. - 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(Component) - Static method in class com.velocitypowered.api.event.player.KickedFromServerEvent.DisconnectPlayer
-
Creates a new
KickedFromServerEvent.DisconnectPlayerwith 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
PermissionFunctionfor the subject. - createFunction(PermissionSubject) - Method in interface com.velocitypowered.api.permission.PermissionProvider
-
Creates a
PermissionFunctionfor the subject. - createRawRegisteredServer(ServerInfo) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Creates a raw
RegisteredServerwithout tying it into the internal server map. - createResolver(PermissionSubject) - Method in interface com.btcvelocity.api.permission.PermissionResolverProvider
-
Creates a
PermissionResolverfor the subject without a delegate. - createResolver(PermissionSubject, PermissionFunction) - Method in interface com.btcvelocity.api.permission.PermissionResolverProvider
-
Creates a
PermissionResolverfor the subject with an optionalPermissionFunctiondelegate. - createResourcePackBuilder(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Creates a builder to build a
ResourcePackInfoinstance 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
-
Deprecated.No longer required, you only need to specify
Subscribe.priority().
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
-
Returns the plugin message payload as a
ByteArrayDataInput. - dataAsInputStream() - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
-
Returns the plugin message payload as a
ByteArrayInputStream. - DataDirectory - Annotation Interface in com.velocitypowered.api.plugin.annotation
-
This annotation requests that Velocity inject a
Pathinstance 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.
- decode(byte[]) - Static method in class com.btcvelocity.api.bridge.BridgeCodec
-
Decodes a JSON byte array into a bridge message.
- DECREASED - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ParticleStatus
-
A reduced number of particles are shown.
- DEFAULT - Static variable in class com.velocitypowered.api.proxy.server.PingOptions
-
Default PingOptions.
- DEFAULT - Static variable in class com.velocitypowered.api.util.ModInfo
-
The default mod info used when no mods are present.
- DEGRADED - Enum constant in enum class com.btcvelocity.api.queue.ServerStatus
-
The server is online but under elevated load (mspt between 40 and 60).
- 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
-
Denies the transfer attempt.
- 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
-
Returns a result indicating the event is denied.
- 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
-
Returns a result indicating the event is denied, with the given reason component.
- 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
Plugindepends on another plugin to enable. - Dependency(String, boolean) - Constructor for class com.velocitypowered.api.plugin.ap.SerializedPluginDescription.Dependency
-
Constructs a new dependency class.
- dequeue(Player) - Method in interface com.btcvelocity.api.queue.Queue
-
Removes a player from the queue.
- dequeue(UUID) - Method in interface com.btcvelocity.api.queue.Queue
-
Removes a player from the queue by their UUID.
- 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
-
Uses the
descriptionComponent in the response. - 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
-
Creates a new
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. - doesPreventChatReports() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Whether the proxy should tell client that proxy prevents chat reports, useful in NoChatReports mod. (1.19+).
- 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
-
Indicates the listener should be invoked early, but after listeners with
PostOrder.FIRST. - encode(BridgeMessage) - Static method in class com.btcvelocity.api.bridge.BridgeCodec
-
Encodes a bridge message to a UTF-8 JSON byte array.
- encode(ByteArrayDataOutput) - Method in interface com.velocitypowered.api.proxy.messages.PluginMessageEncoder
-
Encodes data into a
ByteArrayDataOutputto be transmitted by plugin messages. - enqueue(QueueEntryData) - Method in interface com.btcvelocity.api.queue.Queue
-
Adds a player to this queue using explicit data.
- enqueue(Player) - Method in interface com.btcvelocity.api.queue.Queue
-
Adds the given online player to this queue using their current permissions and priority.
- 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.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueLeave
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.RequestStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.btcvelocity.api.storage.PlayerData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.velocitypowered.api.event.command.CommandExecuteEvent.InvocationInfo
-
Indicates whether some other object is "equal to" this one.
- 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.plugin.ap.SerializedPluginDescription.Dependency
- equals(Object) - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
- equals(Object) - Method in record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
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
EventHandlerwhich 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 given
Continuation. - execute(E) - Method in interface com.velocitypowered.api.event.AwaitingEventExecutor
-
This method is not supported for
AwaitingEventExecutorand will throw an exception if invoked. - execute(E) - Method in interface com.velocitypowered.api.event.EventHandler
-
Executes this handler synchronously with the given event.
- 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
-
Executes the event handler asynchronously.
- executeAsync(E) - Method in interface com.velocitypowered.api.event.EventHandler
-
Executes this handler asynchronously with the given event.
- EXECUTED - Enum constant in enum class com.velocitypowered.api.command.CommandResult
-
The proxy successfully executed the command.
- executeImmediatelyAsync(CommandSource, String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Attempts to asynchronously execute a command from the given
cmdLinewithout 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
-
Uses the
faviconin the response. - 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
-
A link to provide feedback to the server staff or developers.
- 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
-
Indicates the listener should be invoked first, before any other listener.
- firstJoin() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
firstJoinrecord component. - 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 if 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
-
A link to the server's forums.
- forward() - Static method in class com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult
-
Returns a result that forwards the plugin message to the target.
- 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
Commandto 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.
- forwardingMode() - Method in record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
Returns the value of the
forwardingModerecord component. - 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 a channel identifier from the specified Minecraft identifier.
- from(Key) - Static method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Creates a channel identifier from the specified Minecraft identifier.
- fromBoolean(boolean) - Static method in enum class com.velocitypowered.api.permission.Tristate
-
Returns a
Tristatefrom 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
Tristatefrom 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
UUIDobject. - FULL - Enum constant in enum class com.btcvelocity.api.queue.ServerStatus
-
The server is online but at capacity.
- 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).
- fullBypass() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns the value of the
fullBypassrecord component.
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
PreLoginEventin 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
-
Represents the original key revision introduced in Minecraft 1.19.
- getAddress() - Method in class com.velocitypowered.api.event.proxy.ListenerBoundEvent
-
Returns the socket address the listener is bound to.
- getAddress() - Method in class com.velocitypowered.api.event.proxy.ListenerCloseEvent
-
Returns the socket address the listener was bound to.
- getAddress() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
-
Gets the network address of the server.
- 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.btcvelocity.api.cluster.ClusterPlayerService
-
Gets all players connected anywhere in the cluster.
- getAllPlayers() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves all players currently connected to this proxy.
- getAllProxyIds() - Method in interface com.btcvelocity.api.cluster.ClusterProxyService
-
Gets the identifiers of all proxies currently active in the cluster.
- getAllServers() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves all
RegisteredServers registered with this proxy. - getApplicableTo() - Method in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
-
Returns the set of Minecraft protocol versions this revision applies to.
- getAppliedResourcePack() - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.
- getAppliedResourcePacks() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the
ResourcePackInfoof 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 class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the list of authors who contributed to the plugin.
- getAuthors() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the authors of the
Pluginwithin this container. - getBackendServers() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get a Map of all servers registered in
velocity.toml. - getBackwardsCompatibleTo() - Method in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
-
Returns the set of revisions that this revision is backwards-compatible with.
- 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
-
Gets the brand string sent by the client.
- getBridgeChannel() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
BridgeChannelused to exchangebtc:bridgemessages with the backend servers. - 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
-
Get the HandshakeIntent by ID.
- getChannelRegistrar() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
ChannelRegistrarinstance. - getChannels() - Method in class com.velocitypowered.api.event.player.PlayerChannelRegisterEvent
-
Gets the list of
ChannelIdentifiers that the player registered. - getChannels() - Method in class com.velocitypowered.api.event.player.PlayerChannelUnregisterEvent
-
Gets the list of
ChannelIdentifiers that the player has unregistered. - 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
ChatSessionassociated with this entry. - getClientBrand() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the player's client brand.
- getClusterPlayerService() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
ClusterPlayerService, used for multi-proxy setups. - getClusterProxyService() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
ClusterProxyService, used for multi-proxy setups. - getCommand() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Returns the command to be executed, if it was overridden.
- 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
CommandManagerinstance. - getCommandMeta(String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Retrieves the
CommandMetafrom the specified command alias, if registered. - getCommandRatelimit() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the rate limit for how fast a player can execute commands.
- 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.
- getComponentName() - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
-
Gets the name of the sample player as a
Component. - 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
ProxyConfiginstance. - getConnection() - Method in class com.btcvelocity.api.event.connection.ConnectionEstablishEvent
-
Gets the inbound connection that is in the process of being established.
- getConnection() - Method in class com.velocitypowered.api.event.connection.ConnectionEstablishEvent
-
Gets the inbound connection that is in the process of being established.
- getConnection() - Method in class com.velocitypowered.api.event.connection.ConnectionHandshakeEvent
-
Returns the inbound connection associated with this handshake.
- getConnection() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
-
Gets the inbound connection associated with this login attempt.
- getConnection() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Returns the inbound connection from the player attempting to log in.
- getConnection() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Gets the connection from which the login plugin message was received.
- getConnection() - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Obtain the connection to which the corresponding ServerPing will be sent.
- getConnectionAttempts() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns the number of connection attempts made for this player so far.
- 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
CommandSourcethat 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 contained in the login plugin message sent by the server.
- getCurrentPlayers() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get the 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
-
Gets the raw payload of the plugin message.
- getData() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
-
Returns the replacement data to forward, if any.
- getData() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
-
Returns the replacement data to use when forwarding the cookie, or
nullif the original data should be used. - getDependencies() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the list of declared dependencies for the plugin.
- getDependencies() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets a
Collectionof all dependencies of thePluginwithin this container. - getDependency(String) - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets a specific dependency of the
Pluginby its ID. - getDescription() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the plugin's description, typically a short summary of its functionality.
- 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
Pluginwithin this container. - getDescriptionComponent() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Gets the description component currently set in the builder.
- getDescriptionComponent() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Gets the description (MOTD) component shown in the ping response.
- getDisplayNameComponent() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns
OptionaltextComponent, which when present is the text displayed forthisentry 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.btcvelocity.api.queue.Queue
-
Returns an immutable snapshot of all entries currently in this queue, in order.
- getEntries() - Method in interface com.velocitypowered.api.proxy.player.TabList
-
Returns an immutable
Collectionof theTabListEntrys in the tab list. - getEntry(UUID) - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the
QueueEntryfor the given player UUID, ornullif not present. - 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
EventManagerinstance. - 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
-
Gets the favicon currently set in the builder.
- getFavicon() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Gets the favicon sent to the client.
- 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
thisentry 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 a game version which will be used to reply to the query.
- getHandshakeIntent() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Returns the initial intent for the connection.
- 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.ap.SerializedPluginDescription.Dependency
-
Gets the ID of the plugin this dependency refers to.
- getId() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the ID of the plugin.
- 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
Pluginwithin 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
-
Gets the UUID of the sample player.
- 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
-
Returns the mod ID (identifier string).
- 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
-
Gets the channel identifier this message was sent on.
- getIdentifier() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Gets the identifier of the channel this login plugin message was sent on.
- getInitialServer() - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
-
Gets the initial server the player will connect to.
- 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
-
Returns the
HandshakeIntentassociated with this connection handshake. - getIntention() - Method in class com.btcvelocity.api.event.connection.ConnectionEstablishEvent
-
Gets the handshake intention of the client.
- getIntention() - Method in class com.velocitypowered.api.event.connection.ConnectionEstablishEvent
-
Gets the handshake intention of the client.
- getInvocationInfo() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent
-
Returns the info of the command invocation.
- getIpAddress() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Gets the player's IP address.
- getKey() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent.ForwardResult
-
Returns the replacement key to forward, if any.
- getKey() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult
-
Returns the replacement key to use for the cookie request, if one was provided.
- getKey() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent.ForwardResult
-
Returns the replacement key to use when forwarding the cookie, or
nullif the original key should be used. - getKeyRevision() - Method in interface com.velocitypowered.api.proxy.crypto.IdentifiedKey
-
Retrieves the key revision.
- getKickAfterRateLimitedCommands() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the kick limit for commands that are rate limited.
- getKickAfterRateLimitedTabCompletes() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the kick limit for tab completes that are rate limited.
- getLatency() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns the latency for
thisentry. - getListenerType() - Method in class com.velocitypowered.api.event.proxy.ListenerBoundEvent
-
Returns the type of listener that was bound.
- getListenerType() - Method in class com.velocitypowered.api.event.proxy.ListenerCloseEvent
-
Returns the type of listener being closed.
- getListOrder() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns the order/priority of this entry in the tab list.
- 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
-
Returns the login status of the player at the time of disconnection.
- getMain() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the fully qualified name of the plugin's main class.
- 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
-
Gets the maximum number of players the server claims it can hold.
- getMaximumPlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Gets the maximum player capacity.
- 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
-
Gets the (possibly modified) chat message to be sent.
- getMessage() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
-
Gets the raw chat message the player sent.
- 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
-
Returns the message to be shown to the player.
- getMessageComponent() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.RedirectPlayer
-
Returns the message that will be sent to the player after redirection.
- getModinfo() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Gets the mod info sent to the client.
- getModInfo() - Method in class com.velocitypowered.api.event.player.PlayerModInfoEvent
-
Returns the mod information sent by the player.
- 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
-
Gets the list of mods reported in the ping.
- getMods() - Method in class com.velocitypowered.api.util.ModInfo
-
Returns an immutable list of all mods in this mod list.
- getModType() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Gets the type of mod loader (e.g., "FML").
- 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.
- getMotdHover() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the MOTD hover legacy component shown in the tab list.
- getName() - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the name of the backend server this queue targets.
- 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 class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the human-readable name of the plugin.
- getName() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the name of the
Pluginwithin this container. - getName() - Method in class com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier
-
Returns the name of this legacy plugin message channel.
- getName() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Returns the name of the channel within its namespace.
- getName() - Method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
-
Gets the name of the plugin.
- getName() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
-
Gets the name of the server.
- getName() - Method in class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
-
Gets the legacy string name of the sample player.
- getName() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Version
-
Gets the user-friendly name of the server 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
-
Returns the name of this property.
- getName() - Method in class com.velocitypowered.api.util.ProxyVersion
-
Gets the name of the proxy implementation.
- getNamespace() - Method in class com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier
-
Returns the namespace of this channel identifier.
- 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
-
Gets the number of online players.
- getOnlinePlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Gets the number of players online.
- getOrigin() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the
ResourcePackInfo.Originof this resource-pack. - getOriginalData() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
-
Returns the original cookie data received from the client, if present.
- getOriginalData() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
-
Returns the original data of the cookie to be stored.
- getOriginalKey() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
-
Returns the original cookie identifier received from the client.
- getOriginalKey() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
-
Returns the original identifier of the cookie being requested.
- getOriginalKey() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
-
Returns the original key identifying the cookie to be stored.
- getOriginalOrigin() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets the original
ResourcePackInfo.Originof the resource-pack. - getOriginalProfile() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Returns the original game profile before any plugin customization.
- 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
ResourcePackInfothis response is for. - getPartialMessage() - Method in class com.btcvelocity.api.event.player.TabCompleteRequestEvent
-
Returns the message being partially completed.
- getPartialMessage() - Method in class com.velocitypowered.api.event.player.TabCompleteEvent
-
Returns the message being partially completed.
- getPartialMessage() - Method in class com.velocitypowered.api.event.player.TabCompleteRequestEvent
-
Returns the message being partially completed.
- getParticleStatus() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns the selected "Particles" option state.
- getPendingResourcePack() - Method in interface com.velocitypowered.api.proxy.Player
-
Deprecated.
- getPendingResourcePacks() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the
ResourcePackInfoof 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.
- getPermissionMap() - Method in interface com.btcvelocity.api.permission.PermissionResolver
-
Gets the subjects permission map.
- getPermissionMap() - Method in class com.btcvelocity.api.permission.PermissionResolverFunctionAdapter
- getPermissionMap() - Method in interface com.velocitypowered.api.permission.PermissionSubject
-
Gets the subjects permission map.
- getPermissionValue(String) - Method in interface com.btcvelocity.api.permission.PermissionResolver
-
Gets the subjects setting for a particular permission.
- getPermissionValue(String) - Method in class com.btcvelocity.api.permission.PermissionResolverFunctionAdapter
- 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.btcvelocity.api.event.player.TabCompleteRequestEvent
-
Returns the player requesting the tab completion.
- getPlayer() - Method in class com.velocitypowered.api.event.command.PlayerAvailableCommandsEvent
-
Gets the player that the available commands are being sent to.
- getPlayer() - Method in class com.velocitypowered.api.event.connection.DisconnectEvent
-
Returns the player who disconnected.
- getPlayer() - Method in class com.velocitypowered.api.event.connection.LoginEvent
-
Returns the player who has completed authentication.
- getPlayer() - Method in class com.velocitypowered.api.event.connection.PostLoginEvent
-
Gets the player who has logged in and is about to connect to their first server.
- getPlayer() - Method in class com.velocitypowered.api.event.player.CookieReceiveEvent
-
Returns the player who sent the cookie response.
- getPlayer() - Method in class com.velocitypowered.api.event.player.CookieRequestEvent
-
Returns the player from whom the cookie is being requested.
- getPlayer() - Method in class com.velocitypowered.api.event.player.CookieStoreEvent
-
Returns the player who should store the cookie.
- 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
-
Gets the player who sent the plugin message to register channels.
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerChannelUnregisterEvent
-
Gets the
Playerwho sent the unregister message. - getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
-
Gets the player who sent the chat message.
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
-
Gets the player who is choosing the initial server.
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerClientBrandEvent
-
Gets the player who sent the client brand.
- getPlayer() - Method in class com.velocitypowered.api.event.player.PlayerModInfoEvent
-
Returns the player who sent their mod list.
- 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
-
Returns the player whose settings changed.
- getPlayer() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
-
Returns the player involved in this event.
- 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 class com.velocitypowered.api.event.player.TabCompleteRequestEvent
-
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.btcvelocity.api.cluster.ClusterPlayerService
-
Looks up a player by username across the cluster.
- 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.btcvelocity.api.cluster.ClusterPlayerService
-
Looks up a player by UUID across the cluster.
- getPlayer(UUID) - Method in interface com.btcvelocity.api.storage.StorageService
-
Retrieves the persisted data for the player with the given UUID.
- getPlayer(UUID) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Retrieves the player currently connected to this proxy by their Minecraft UUID.
- getPlayerByName(String) - Method in interface com.btcvelocity.api.storage.StorageService
-
Retrieves the persisted data for the player with the given username.
- getPlayerCount() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Returns the number of players currently connected to this proxy.
- getPlayerInfoForwardingMode() - Method in class com.velocitypowered.api.proxy.server.ServerInfo
-
Returns the forwarding mode used by the backend server to communicate with Velocity.
- 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.
- getPlayerNames() - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets the usernames of all players connected across the cluster.
- getPlayers() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get a collection of players which will be used to reply to the query.
- getPlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Gets the player information shown to the client.
- 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
-
Returns the new client settings sent by the player.
- getPlayerSettings() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's client settings.
- getPlayersOnProxy(String) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets all players connected to the specified proxy.
- getPlayersOnServer(RegisteredServer) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets all players currently on the specified backend server.
- getPlayersOnServer(String) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets all players currently on the specified backend server.
- getPlayersOnServerCount(RegisteredServer) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets the number of players currently on the specified backend server.
- getPlayersOnServerCount(String) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets the number of players currently on the specified backend server.
- 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
PluginContainerbased on its ID. - getPluginManager() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
PluginManagerinstance. - getPlugins() - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Gets a
Collectionof allPluginContainers. - getPlugins() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get a list of plugins which will be used to reply to the query.
- getPosition() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns the 1-based position of this entry in its owning queue.
- getPosition(Player) - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the one-based position of the given player in the queue, or
Optional.empty()if the player is not present. - getPosition(UUID) - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the one-based position of the given player in the queue, or
Optional.empty()if the player is not present. - getPreventsChatReports() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Whether the proxy should tell client that proxy prevents chat reports, useful in NoChatReports mod. (1.19+).
- getPreventsChatReports() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Whether the proxy should tell client that proxy prevents chat reports, useful in NoChatReports mod. (1.19+).
- getPreviousServer() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
-
Returns the server the player was previously connected to, if any.
- 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.
- getPriority() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns the priority of this player in the queue.
- getProfile() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns the
GameProfileof 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
Componentthat 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
-
Gets the protocol number associated with the server 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
ProtocolVersionfor the given protocol. - getProvidedResourcePack() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
-
Gets the resource pack that will be forwarded to the player.
- getProvider() - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
-
Gets the current
PermissionProviderin use for this subject. - getProxyHost() - Method in class com.velocitypowered.api.proxy.server.QueryResponse
-
Get proxy (public facing) hostname.
- getProxyId() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Gets the identifier of the proxy this player is connected to.
- getProxyId() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the identifier of this proxy.
- 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.
- getQueue() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns the
Queuethat this entry belongs to. - getQueue() - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Gets the queue for this server.
- getQueue(String) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns the
Queuefor the given server name, creating it if it does not yet exist. - getQueueFor(Player) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns the queue the given player is currently in, or
nullif the player is not queued in any queue. - getQueueFor(UUID) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns the queue the given player is currently in, or
nullif the player is not queued in any queue. - getQueueManager() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Returns the queue manager currently in use.
- getQueuePriorities() - Method in interface com.velocitypowered.api.proxy.Player
-
Gets all queue priorities for this player.
- getQueuePriority(String) - Method in interface com.velocitypowered.api.proxy.Player
-
Gets the custom queue priority in case they have one.
- getQueues() - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns an immutable snapshot of all managed queues.
- getRawVirtualHost() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Returns the raw hostname that the client sent, if applicable.
- getReadTimeout() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get how long this proxy will wait until performing a read timeout.
- getReason() - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
-
Returns the reason the player will be disconnected if no initial server is selected.
- getReasonComponent() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
-
Gets the reason component shown to the player if the connection is denied.
- getReasonComponent() - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent.DisconnectPlayer
-
Returns the reason shown to the player upon disconnection.
- getReasonComponent() - Method in class com.velocitypowered.api.event.ResultedEvent.ComponentResult
-
Returns the denial reason component, if present.
- 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
-
Gets the original resource pack provided by the server.
- 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.btcvelocity.api.event.connection.ConnectionEstablishEvent
-
Returns the current result of this event.
- 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.ConnectionEstablishEvent
-
Returns the current result of this event.
- 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
-
Gets the current
ServerLoginPluginMessageEvent.ResponseResultassociated with this plugin message event. - getResult() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
- getResult() - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
-
Returns the current
ResultedEvent.GenericResultthat determines whether the resource pack removal should proceed. - getResult() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
-
Gets the
ResultedEvent.GenericResultthat determines whether the resource pack will be forwarded to the player. - 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
-
Gets the root command node that represents the available commands.
- 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
-
Gets a sample list of online players.
- getSamplePlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Gets the sample players shown in the ping.
- getScheduler() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
Schedulerinstance. - getSelfProxyId() - Method in interface com.btcvelocity.api.cluster.ClusterProxyService
-
Gets the identifier of this proxy instance.
- getSequenceId() - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Gets the sequence ID of the plugin message sent by the server.
- getServer() - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the registered server instance this queue targets.
- 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
-
Returns the target server to which the player should be redirected.
- getServer() - Method in class com.velocitypowered.api.event.player.ServerConnectedEvent
-
Returns the server the player successfully connected to.
- getServer() - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult
-
Returns the server the player will be connected to if the result is allowed.
- 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
RegisteredServerinstance by its name. - getServerConnection() - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
-
Returns the server that tries to remove a resource pack from the player or clear all of them.
- getServerConnection() - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
-
Gets the server connection that attempted to send the resource pack.
- getServerIdHash() - Method in class com.velocitypowered.api.event.connection.LoginEvent
-
Returns the server ID hash that was sent to Mojang to authenticate the player.
- getServerInfo() - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Returns the
ServerInfofor 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.
- getServerName() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Gets the name of the backend server this player is currently on.
- getServers() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Deprecated, for removal: This API element is subject to removal in a future version.use
ProxyConfig.getBackendServers()instead. - getServerStatus() - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the current status of the backend server.
- getSessionId() - Method in interface com.velocitypowered.api.proxy.player.ChatSession
-
Returns the
UUIDof the session. - getShouldForce() - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo
-
Gets whether 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
-
Returns the Mojang-provided signature for this 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
-
Gets the source that sent this plugin message (a
PlayerorServerConnection). - getSource() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Returns the source the plugin was loaded from.
- getState() - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the current operational state of this queue.
- 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.
- getStorageService() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Gets the
StorageServiceused to persist player data and proxy state. - 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
-
Gets the subject whose permissions are being initialized.
- getSuggestions() - Method in class com.velocitypowered.api.event.player.TabCompleteEvent
-
Returns all the suggestions provided to the user, as a mutable list.
- getSupportedSourceVersion() - Method in class com.velocitypowered.api.plugin.ap.PluginAnnotationProcessor
-
Returns the latest source version supported by this annotation processor.
- getTabCompleteRatelimit() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get the rate limit for how fast a player can tab complete.
- 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
-
Gets the target recipient of this plugin message.
- getTimeout() - Method in class com.velocitypowered.api.proxy.server.PingOptions
-
The maximum period of time to wait for a response from the remote server.
- getTotalPlayerCount() - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Gets the total number of players connected across all proxies.
- getTotalPlayerCount() - Method in interface com.velocitypowered.api.proxy.server.RegisteredServer
-
Get the total player count of the server (redis support).
- getType() - Method in class com.velocitypowered.api.util.ModInfo
-
Returns the Forge mod list type (e.g., "FML").
- getUndashedId() - Method in class com.velocitypowered.api.util.GameProfile
-
Returns the undashed, Mojang-style UUID.
- getUniqueId() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Gets the player's unique identifier.
- getUniqueId() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns the unique identifier of the player.
- 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 class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the website URL for the plugin.
- getUrl() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the url or website of the
Pluginwithin 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 interface com.btcvelocity.api.cluster.ClusterPlayer
-
Gets the player's username.
- getUsername() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns the username of the player.
- getUsername() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
-
Gets the username of the player attempting to connect.
- getUsername() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Returns the username associated with the original game profile.
- getUsername() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns the player's current username.
- getUsername() - Method in class com.velocitypowered.api.proxy.player.PlayerInfo
-
Gets the username of the player.
- getUuid() - Method in class com.velocitypowered.api.proxy.player.PlayerInfo
-
Gets the UUID of the player.
- getValue() - Method in class com.velocitypowered.api.util.GameProfile.Property
-
Returns the value of this property.
- getVendor() - Method in class com.velocitypowered.api.util.ProxyVersion
-
Gets the vendor of the proxy implementation.
- getVersion() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
Gets the version string of the plugin.
- getVersion() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
-
Returns the version this
PluginDependencyshould match. - getVersion() - Method in interface com.velocitypowered.api.plugin.PluginDescription
-
Gets the version of the
Pluginwithin 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
-
Gets the version of the plugin, if available.
- getVersion() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Gets the version currently set in the builder.
- getVersion() - Method in class com.velocitypowered.api.proxy.server.ServerPing
-
Gets the version shown to the client during the ping.
- getVersion() - Method in class com.velocitypowered.api.util.ModInfo.Mod
-
Returns the mod version string.
- getVersion() - Method in class com.velocitypowered.api.util.ProxyVersion
-
Gets the version of the proxy implementation.
- getVersionByName(String) - Static method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Gets the
ProtocolVersionfor the given protocol. - 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.
- getVirtualHost() - Method in class com.velocitypowered.api.proxy.server.PingOptions
-
The virtual host to pass to the server for the ping.
- greaterThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
thisis greater thanthat.
H
- handled() - Static method in class com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult
-
Returns a result that marks the plugin message as handled at the proxy.
- 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
-
Returns whether the player has a cape enabled.
- hasChatColors() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns whether 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
-
Returns whether the player has a hat enabled.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueLeave
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.RequestStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.velocitypowered.api.event.command.CommandExecuteEvent.InvocationInfo
-
Returns a hash code value for this object.
- 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.ap.SerializedPluginDescription.Dependency
- hashCode() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
- hashCode() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
- hashCode() - Method in record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
Returns a hash code value for this object.
- 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
-
Returns whether the player has a jacket enabled.
- hasLeftPants() - Method in class com.velocitypowered.api.proxy.player.SkinParts
-
Returns whether the player has their left pants enabled.
- hasLeftSleeve() - Method in class com.velocitypowered.api.proxy.player.SkinParts
-
Returns whether the player has a left sleeve enabled.
- 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 the subject has a particular permission.
- hasRightPants() - Method in class com.velocitypowered.api.proxy.player.SkinParts
-
Returns whether the player has their right pants enabled.
- hasRightSleeve() - Method in class com.velocitypowered.api.proxy.player.SkinParts
-
Returns whether the player has a right sleeve enabled.
- hasSentPlayerSettings() - Method in interface com.velocitypowered.api.proxy.Player
-
Returns whether the player has sent its client settings.
- Health(String, double, double, int, List<String>) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Creates an instance of a
Healthrecord class. - HIDDEN - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
-
Chat is completely hidden.
- 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
-
Returns the numeric ID associated with this handshake intent.
- 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 class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
The compiled pattern used to validate plugin IDs.
- ID_PATTERN - Static variable in interface com.velocitypowered.api.plugin.PluginDescription
-
The pattern plugin IDs must match.
- ID_PATTERN_STRING - Static variable in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
-
The string pattern used to validate plugin IDs.
- ID_TO_PROTOCOL_CONSTANT - Static variable in enum class com.velocitypowered.api.network.ProtocolVersion
-
A map linking the protocol version number to its
ProtocolVersionrepresentation. - 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.
- INACTIVE - Enum constant in enum class com.btcvelocity.api.queue.QueueState
-
The queue is not active and does not process or accept players.
- InboundConnection - Interface in com.velocitypowered.api.proxy
-
Represents an incoming connection to the proxy.
- init(ProcessingEnvironment) - Method in class com.velocitypowered.api.plugin.ap.PluginAnnotationProcessor
-
Initializes the annotation processor with the provided processing environment.
- 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 Class in com.velocitypowered.api.plugin
-
Thrown if a JAR in the plugin directory does not look valid.
- InvalidPluginException() - Constructor for exception class com.velocitypowered.api.plugin.InvalidPluginException
-
Creates a new exception with no detail message.
- InvalidPluginException(String) - Constructor for exception class com.velocitypowered.api.plugin.InvalidPluginException
-
Creates a new exception with the specified detail message.
- InvalidPluginException(String, Throwable) - Constructor for exception class com.velocitypowered.api.plugin.InvalidPluginException
-
Creates a new exception with the specified detail message and cause.
- InvalidPluginException(Throwable) - Constructor for exception class com.velocitypowered.api.plugin.InvalidPluginException
-
Creates a new exception with the specified cause.
- InvocableCommand<I> - Interface in com.velocitypowered.api.command
-
A command that can be executed with arbitrary arguments.
- InvocationInfo(CommandExecuteEvent.SignedState, CommandExecuteEvent.Source) - Constructor for record class com.velocitypowered.api.event.command.CommandExecuteEvent.InvocationInfo
-
Creates an instance of a
InvocationInforecord class. - ipAddress() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
ipAddressrecord component. - isActive() - Method in enum class com.btcvelocity.api.queue.ServerStatus
-
Returns
trueif the server is reachable and eligible for player transfers. - isActive() - Method in interface com.velocitypowered.api.proxy.InboundConnection
-
Determine whether 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 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.
- isAvailable() - Method in interface com.btcvelocity.api.permission.PermissionResolverProvider
-
Should perform a check to see if this
PermissionResolverProvideris available or not. - isClientListingAllowed() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Checks whether this player allows themselves to be listed in the tab list for other players.
- isClientListingAllowed() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns whether the client explicitly allows listing on the
TabListor not in anonymous TabList mode. - isForcedHostAsFallback() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Whether to use the forced hosts list as the fallback servers, instead of servers-to-try (
getAttemptConnectionOrder), if a forced host is configured for the virtual host a player is connected to. - isForceOfflineMode() - Method in class com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
-
Checks if this result explicitly forces offline mode for the connection.
- isForwardCommandsIfRateLimited() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get whether we should forward commands to the backend if the player is rate limited.
- isForwardToServer() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
-
Indicates whether this command should be forwarded directly to the backend server instead of being processed by the proxy.
- isFullBypass() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns
trueif this player has the full-server bypass permission, allowing them to be transferred even when the backend server is full. - 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.
- isKickOnCommandRateLimit() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get whether the proxy should kick players who are command rate-limited.
- isKickOnTabCompleteRateLimit() - Method in interface com.velocitypowered.api.proxy.config.ProxyConfig
-
Get whether the proxy should kick players who are tab complete rate limited.
- isLegacy() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether this
ProtocolVersionis a legacy protocol. - isListed() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns whether this player will be visible to other players in the tab list.
- isLoaded() - Method in enum class com.btcvelocity.api.queue.ServerStatus
-
Returns
trueif this status indicates the server is under load and transfers should be throttled. - isLoaded(String) - Method in interface com.velocitypowered.api.plugin.PluginManager
-
Checks if a plugin is loaded based on its ID.
- isMasterProxy() - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns
trueif this proxy is currently the master proxy responsible for running transfer and server-ping tasks. - isMultiProxy() - Method in interface com.btcvelocity.api.cluster.ClusterProxyService
-
Checks whether the cluster consists of more than one proxy.
- isOnlineMode() - Method in class com.velocitypowered.api.event.player.GameProfileRequestEvent
-
Returns whether the player is connecting in online mode.
- 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
-
Checks if this result explicitly forces online mode for the connection.
- isOptional() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription.Dependency
-
Indicates whether this dependency is optional.
- 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 to override the kick resulting from
ResourcePackInfo.getShouldForce()being true. - isPlayerOnline(String) - Method in interface com.btcvelocity.api.cluster.ClusterPlayerService
-
Checks whether a player with the given username is online anywhere in the cluster.
- 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 the proxy accepts GameSpy 4 queries.
- isQueueBypass() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns
trueif this player has the queue-bypass permission, allowing them to connect directly without being queued. - isQueued(Player) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns
trueif the given player is present in any queue. - isQueued(UUID) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Returns
trueif the given player is present in any queue. - isQueueEnabled() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Check whether the queue system is enabled for the proxy.
- isShowHat() - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Returns whether this entry's hat layer is shown in the tab list.
- isShuttingDown() - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Returns whether the proxy is currently shutting down.
- 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 the connection request was successful.
- isSupported() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether this
ProtocolVersionis 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
ProtocolVersionis supported. - isTextFilteringEnabled() - Method in interface com.velocitypowered.api.proxy.player.PlayerSettings
-
Returns if the client has text filtering enabled.
- isUnknown() - Method in enum class com.velocitypowered.api.network.ProtocolVersion
-
Returns whether this
ProtocolVersionis unknown to the proxy. - isWaitingForConnection() - Method in interface com.btcvelocity.api.queue.QueueEntry
-
Returns
trueif the player is currently in the process of being transferred to the backend server.
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.
- kick(Component) - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Kicks the player from the proxy with the given reason.
- 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 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
KickedFromServerEventinstance. - 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
KickedFromServerEventresults.
L
- LAST - Enum constant in enum class com.velocitypowered.api.event.PostOrder
-
Indicates the listener should be invoked last, after all other listeners.
- lastSeen() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
lastSeenrecord component. - LATE - Enum constant in enum class com.velocitypowered.api.event.PostOrder
-
Indicates the listener should be invoked later in the execution order, after listeners with
PostOrder.NORMAL. - 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
-
This scope defines the left hand.
- LEGACY - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Represents legacy protocol versions before 1.7.
- LEGACY - Enum constant in enum class com.velocitypowered.api.proxy.server.PlayerInfoForwarding
-
Forwards player information using the legacy BungeeCord IP forwarding system.
- LEGACY - Enum constant in enum class com.velocitypowered.api.proxy.server.ServerInfoForwardingMode
-
Use legacy forwarding mode compatible with BungeeCord's IP forwarding.
- 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
thisis less thanthat. - LINKED_V2 - Enum constant in enum class com.velocitypowered.api.proxy.crypto.IdentifiedKey.Revision
-
Represents the key revision introduced in Minecraft 1.19.1.
- listed(boolean) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets whether this entry should be visible.
- ListenerBoundEvent - Class in com.velocitypowered.api.event.proxy
-
The proxy fires this event after a listener starts accepting connections.
- ListenerBoundEvent(InetSocketAddress, ListenerType) - Constructor for class com.velocitypowered.api.event.proxy.ListenerBoundEvent
-
Constructs a new
ListenerBoundEvent. - ListenerCloseEvent - Class in com.velocitypowered.api.event.proxy
-
The proxy fires this event before the proxy stops accepting connections.
- ListenerCloseEvent(InetSocketAddress, ListenerType) - Constructor for class com.velocitypowered.api.event.proxy.ListenerCloseEvent
-
Constructs a new
ListenerCloseEvent. - ListenerType - Enum Class in com.velocitypowered.api.network
-
Represents each listener type.
- listOrder(int) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the order/priority of this entry in the tab list.
- literalArgumentBuilder(String) - Static method in class com.velocitypowered.api.command.BrigadierCommand
-
Creates a new LiteralArgumentBuilder of the required name.
- loadedWorlds() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns the value of the
loadedWorldsrecord component. - loadTimeMs() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Returns the value of the
loadTimeMsrecord component. - LOGIN - Enum constant in enum class com.velocitypowered.api.network.HandshakeIntent
-
Indicates that the client intends to log in to the server.
- 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
-
Deprecated, for removal: This API element is subject to removal in a future version.
- LoginEvent(Player, String) - Constructor for class com.velocitypowered.api.event.connection.LoginEvent
-
Constructs a new
LoginEvent. - LoginPhaseConnection - Interface in com.velocitypowered.api.proxy
-
Represents a connection 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
Players whose names start with the provided partial name. - matchServer(String) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Matches all
RegisteredServers 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
-
Uses the modified
maximumPlayersnumber in the response. - maxPlayers(int) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the maximum number of players this server purportedly can hold.
- members() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
-
Returns the value of the
membersrecord component. - 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
CommandMetafor the given Brigadier command. - metaBuilder(String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Returns a builder to create a
CommandMetawith the given alias. - MINECRAFT - Enum constant in enum class com.velocitypowered.api.network.ListenerType
-
A standard Minecraft listener for player connections.
- MINECRAFT_1_10 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.10 to 1.10.2.
- MINECRAFT_1_11 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.11.
- MINECRAFT_1_11_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.11.1 to 1.11.2.
- MINECRAFT_1_12 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.12.
- MINECRAFT_1_12_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.12.1.
- MINECRAFT_1_12_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.12.2.
- MINECRAFT_1_13 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.13.
- MINECRAFT_1_13_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.13.1.
- MINECRAFT_1_13_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.13.2.
- MINECRAFT_1_14 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.14.
- MINECRAFT_1_14_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.14.1.
- MINECRAFT_1_14_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.14.2.
- MINECRAFT_1_14_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.14.3.
- MINECRAFT_1_14_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.14.4.
- MINECRAFT_1_15 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.15.
- MINECRAFT_1_15_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.15.1.
- MINECRAFT_1_15_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.15.2.
- MINECRAFT_1_16 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.16.
- MINECRAFT_1_16_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.16.1.
- MINECRAFT_1_16_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.16.2.
- MINECRAFT_1_16_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.16.3.
- MINECRAFT_1_16_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.16.4 to 1.16.5.
- MINECRAFT_1_17 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.17.
- MINECRAFT_1_17_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.17.1.
- MINECRAFT_1_18 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.18 to 1.18.1.
- MINECRAFT_1_18_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.18.2.
- MINECRAFT_1_19 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.19.
- MINECRAFT_1_19_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.19.1 to 1.19.2.
- MINECRAFT_1_19_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.19.3.
- MINECRAFT_1_19_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.19.4.
- MINECRAFT_1_20 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.20 to 1.20.1.
- MINECRAFT_1_20_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.20.2.
- MINECRAFT_1_20_3 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.20.3 to 1.20.4.
- MINECRAFT_1_20_5 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.20.5 to 1.20.6.
- MINECRAFT_1_21 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21 to 1.21.1.
- MINECRAFT_1_21_11 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.11.
- MINECRAFT_1_21_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.2 to 1.21.3.
- MINECRAFT_1_21_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.4.
- MINECRAFT_1_21_5 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.5.
- MINECRAFT_1_21_6 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.6.
- MINECRAFT_1_21_7 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.7 to 1.21.8.
- MINECRAFT_1_21_9 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.21.9 to 1.21.10.
- MINECRAFT_1_7_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.7.2 to 1.7.5.
- MINECRAFT_1_7_6 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.7.6 to 1.7.10.
- MINECRAFT_1_8 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.8 to 1.8.9.
- MINECRAFT_1_9 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.9.
- MINECRAFT_1_9_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.9.1.
- MINECRAFT_1_9_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.9.2.
- MINECRAFT_1_9_4 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 1.9.3 to 1.9.4.
- MINECRAFT_26_1 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 26.1 to 26.1.2.
- MINECRAFT_26_2 - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Minecraft 26.2.
- MinecraftChannelIdentifier - Class in com.velocitypowered.api.proxy.messages
-
Represents a Minecraft 1.13+ channel identifier.
- MINIMAL - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ParticleStatus
-
Minimal particle effects are shown.
- 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
-
Creates new mod info.
- MODERN - Enum constant in enum class com.velocitypowered.api.proxy.server.PlayerInfoForwarding
-
Forwards player information using Velocity's modern forwarding system, based on a signed public key and identity chain.
- MODERN - Enum constant in enum class com.velocitypowered.api.proxy.server.ServerInfoForwardingMode
-
Forward player information using Velocity's modern forwarding system, based on cryptographic signatures.
- 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
modslist in the response. - mods(ModInfo.Mod...) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the modified
modsarray in the response. - modType(String) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the modified
modTypein the response. - move(String) - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Moves the player to the specified backend server.
- mspt() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns the value of the
msptrecord component.
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
-
A link to server or game-related news.
- noGreaterOrLessThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
thisis equal tothat. - noGreaterThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
thisis less than or equal tothat. - noLessThan(T) - Method in interface com.velocitypowered.api.util.Ordered
-
Checks if
thisis greater than or equal tothat. - NONE - Enum constant in enum class com.velocitypowered.api.proxy.server.PlayerInfoForwarding
-
No player information is forwarded.
- NONE - Enum constant in enum class com.velocitypowered.api.proxy.server.ServerInfoForwardingMode
-
Do not forward any player information.
- NORMAL - Enum constant in enum class com.velocitypowered.api.event.PostOrder
-
Indicates the listener should be invoked in the normal order of execution.
- notModCompatible() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Defines the server as mod incompatible in the response.
- nullPlayers() - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Enables nullifying Players in the response.
O
- of(String, String) - Static method in class com.velocitypowered.api.proxy.server.QueryResponse.PluginInformation
-
Creates a new
QueryResponse.PluginInformationinstance with the given name and version. - offerBrigadierSuggestions(CommandSource, String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Asynchronously collects suggestions to fill in the given command
cmdLine. - offerSuggestions(CommandSource, String) - Method in interface com.velocitypowered.api.command.CommandManager
-
Asynchronously collects suggestions to fill in the given command
cmdLine. - OFFLINE - Enum constant in enum class com.btcvelocity.api.queue.ServerStatus
-
The server is unreachable or has failed to respond.
- ONLINE - Enum constant in enum class com.btcvelocity.api.queue.ServerStatus
-
The server is online and accepting player connections at full capacity.
- onlinePlayers(int) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the modified
onlinePlayersnumber in the response. - onMessage(String, BridgeMessage) - Method in interface com.btcvelocity.api.bridge.BridgeMessageListener
-
Called when a bridge message arrives from a backend.
- 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 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
-
Returns the original target address the player is attempting to connect to.
- OVERLOADED - Enum constant in enum class com.btcvelocity.api.queue.ServerStatus
-
The server is under heavy load (mspt above 60) and should not receive additional players until its health recovers.
P
- PartyWarp(List<UUID>, String) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
-
Creates an instance of a
PartyWarprecord class. - PAUSED - Enum constant in enum class com.btcvelocity.api.queue.QueueState
-
The queue is paused and will not transfer players until it is resumed.
- 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
PermissionFunctions forPermissionSubjects. - PermissionResolver - Interface in com.btcvelocity.api.permission
-
An extension of
PermissionFunctionthat allows the implementation of some more complex methods. - PermissionResolverFunctionAdapter - Class in com.btcvelocity.api.permission
-
Adapter implementation of
PermissionResolverbacked by aPermissionFunction. - PermissionResolverFunctionAdapter(PermissionFunction) - Constructor for class com.btcvelocity.api.permission.PermissionResolverFunctionAdapter
-
Instantiates a
PermissionResolverFunctionAdapterwhich delegatesPermissionResolver.getPermissionValue(String)topermissionFunction#getPermissionValue(String). - PermissionResolverProvider - Interface in com.btcvelocity.api.permission
-
Provides
PermissionResolvers forPermissionSubjects. - 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
-
Constructs a new
PermissionsSetupEvent. - PermissionSubject - Interface in com.velocitypowered.api.permission
-
Represents an 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
PingOptionsobjects. - 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
-
Returns the player attempting to transfer.
- player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Returns the value of the
playerrecord component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Returns the value of the
playerrecord component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Returns the value of the
playerrecord component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Returns the value of the
playerrecord component. - player() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Returns the value of the
playerrecord component. - Player - Interface in com.velocitypowered.api.proxy
-
Represents a player connected to the proxy.
- PLAYER - Enum constant in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.Source
-
Indicates that the command was invoked by a player.
- 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
-
Constructs a new PlayerChannelRegisterEvent.
- PlayerChannelUnregisterEvent - Class in com.velocitypowered.api.event.player
-
Fired when a
Playerunregisters one or more plugin channels from the proxy. - PlayerChannelUnregisterEvent(Player, List<ChannelIdentifier>) - Constructor for class com.velocitypowered.api.event.player.PlayerChannelUnregisterEvent
-
Constructs a new
PlayerChannelUnregisterEvent. - 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
Playersends theminecraft:brandplugin 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
PlayerConfigurationEventrecord class. - playerCount() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns the value of the
playerCountrecord component. - PlayerData - Record Class in com.btcvelocity.api.storage
-
Immutable record representing persisted player data stored in the PostgreSQL backend.
- PlayerData(UUID, String, String, String, String, long, long, long) - Constructor for record class com.btcvelocity.api.storage.PlayerData
-
Creates an instance of a
PlayerDatarecord 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
PlayerEnterConfigurationEventrecord 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
PlayerEnteredConfigurationEventrecord 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
PlayerFinishConfigurationEventrecord 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
PlayerFinishedConfigurationEventrecord class. - PlayerInfo - Class in com.velocitypowered.api.proxy.player
-
A class that represents the necessary information from all players connected to servers when Redis is enabled.
- PlayerInfo(String, UUID) - Constructor for class com.velocitypowered.api.proxy.player.PlayerInfo
-
Creates a Player Info holder.
- PlayerInfoForwarding - Enum Class in com.velocitypowered.api.proxy.server
-
Supported player info forwarding methods.
- 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
-
Constructs a new
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.
- PlayerSettings.ParticleStatus - Enum Class in com.velocitypowered.api.proxy.player
-
The client's current "Particles" option state.
- 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
-
Constructs a new PlayerSettingsChangedEvent.
- playSound(Sound) - Method in interface com.velocitypowered.api.proxy.Player
- playSound(Sound, double, double, double) - Method in interface com.velocitypowered.api.proxy.Player
- playSound(Sound, Sound.Emitter) - Method in interface com.velocitypowered.api.proxy.Player
- playtimeSeconds() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
playtimeSecondsrecord component. - 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.
- PluginAnnotationProcessor - Class in com.velocitypowered.api.plugin.ap
-
Annotation processor for Velocity.
- PluginAnnotationProcessor() - Constructor for class com.velocitypowered.api.plugin.ap.PluginAnnotationProcessor
-
Creates a new
PluginAnnotationProcessor. - 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 to forward this message on.
- plugins(QueryResponse.PluginInformation...) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Adds the specified plugins to the plugin list.
- plugins(Collection<QueryResponse.PluginInformation>) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Adds the specified plugins to the plugin 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
-
Constructs a new 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
-
The player disconnected before joining the initial backend server.
- 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
-
Constructs a new PreTransferEvent.
- PreTransferEvent.TransferResult - Class in com.velocitypowered.api.event.connection
-
Transfer Result of a player to another host.
- preventsChatReports(boolean) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Whether the proxy should tell client that proxy prevents chat reports, useful in NoChatReports mod. (1.19+).
- priority() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns the value of the
priorityrecord component. - priority() - Element in annotation interface com.velocitypowered.api.event.Subscribe
-
The priority of this event handler.
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.velocitypowered.api.plugin.ap.PluginAnnotationProcessor
-
Processes the
Pluginannotation to generate thevelocity-plugin.jsonmetadata file. - profile(GameProfile) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets the
GameProfileof 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.
- proxyId() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
proxyIdrecord component. - ProxyInitializeEvent - Class in com.velocitypowered.api.event.proxy
-
The proxy fires this event after plugins have been loaded but before the proxy starts accepting connections.
- ProxyInitializeEvent() - Constructor for class com.velocitypowered.api.event.proxy.ProxyInitializeEvent
-
Creates a new
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
-
Constructs a new
ProxyPingEvent. - proxyPort(int) - Method in class com.velocitypowered.api.proxy.server.QueryResponse.Builder
-
Sets the port where this proxy is running.
- ProxyPreShutdownEvent - Class in com.velocitypowered.api.event.proxy
-
This event is fired by the proxy after it has stopped accepting new connections, but before players are disconnected.
- ProxyPreShutdownEvent() - Constructor for class com.velocitypowered.api.event.proxy.ProxyPreShutdownEvent
-
Creates a new
ProxyPreShutdownEvent. - 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
-
Creates a new
ProxyReloadEvent. - ProxyServer - Interface in com.velocitypowered.api.proxy
-
Provides an interface to a Minecraft server proxy.
- ProxyShutdownEvent - Class in com.velocitypowered.api.event.proxy
-
The proxy fires this event after it has stopped accepting connections but before the proxy process exits.
- ProxyShutdownEvent() - Constructor for class com.velocitypowered.api.event.proxy.ProxyShutdownEvent
-
Creates a new
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
ProxyVersioninstance.
Q
- QUERY - Enum constant in enum class com.velocitypowered.api.network.ListenerType
-
A listener for the legacy server list ping protocol (Query).
- queryPing() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Queries the player's current ping latency.
- queryProxyUptime(String) - Method in interface com.btcvelocity.api.cluster.ClusterProxyService
-
Queries the uptime of the specified proxy.
- QueryResponse - Class in com.velocitypowered.api.proxy.server
-
GS4 query response.
- QueryResponse.Builder - Class in com.velocitypowered.api.proxy.server
-
A builder for
QueryResponseobjects. - QueryResponse.PluginInformation - Class in com.velocitypowered.api.proxy.server
-
Represents a plugin in the query response.
- queue(Player, RegisteredServer) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Validates eligibility and adds the given player to the queue for the specified server.
- Queue - Interface in com.btcvelocity.api.queue
-
Represents the queue for a single backend server.
- queueBypass() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns the value of the
queueBypassrecord component. - QueueEntry - Interface in com.btcvelocity.api.queue
-
Represents a player that is currently in a
Queue. - QueueEntryData - Record Class in com.btcvelocity.api.queue
-
Immutable data record used to create a new
QueueEntry. - QueueEntryData(UUID, String, int, boolean, boolean) - Constructor for record class com.btcvelocity.api.queue.QueueEntryData
-
Validates that the priority is non-negative.
- QueueJoin(UUID, String, String, String) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Creates an instance of a
QueueJoinrecord class. - QueueLeave(UUID) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.QueueLeave
-
Creates an instance of a
QueueLeaverecord class. - QueueManager - Interface in com.btcvelocity.api.queue
-
Manages the queue system for the proxy.
- QueueState - Enum Class in com.btcvelocity.api.queue
-
Represents the operational state of a
Queue. - QueueStatusResponse(String, int) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
-
Creates an instance of a
QueueStatusResponserecord class.
R
- RawCommand - Interface in com.velocitypowered.api.command
-
A specialized sub-interface of
Commandwhich 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
handlerlisten 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
handlerlisten 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
listenerlisten 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
registeredServerrecord component. - RegisteredServer - Interface in com.velocitypowered.api.proxy.server
-
Represents a server that has been registered with the proxy.
- registerListener(BridgeMessageListener) - Method in interface com.btcvelocity.api.bridge.BridgeChannel
-
Registers a listener that will be notified of every incoming bridge message.
- registerServer(ServerInfo) - Method in interface com.velocitypowered.api.proxy.ProxyServer
-
Registers a server with this proxy.
- reload() - Method in interface com.btcvelocity.api.queue.QueueManager
-
Reloads the queue manager, rescheduling internal tasks based on the latest configuration.
- reloadProxy(String) - Method in interface com.btcvelocity.api.cluster.ClusterProxyService
-
Requests a configuration reload on the specified 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
- removePlayerEntirely(Player) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Immediately removes the given player from all queues they are currently in.
- removePlayerEntirely(UUID) - Method in interface com.btcvelocity.api.queue.QueueManager
-
Immediately removes the given player from all queues they are currently in.
- 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 canceled.
- 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 canceled.
- reply(byte[]) - Static method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
-
Returns a result with a reply to the server's login plugin message.
- requestCookie(Key) - Method in interface com.velocitypowered.api.proxy.Player
-
Requests a previously stored cookie from the player's client.
- RequestStatus(String) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.RequestStatus
-
Creates an instance of a
RequestStatusrecord class. - 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
EventTaskis 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
ResourcePackInfoinstances. - ResourcePackInfo.Origin - Enum Class in com.velocitypowered.api.proxy.player
-
Represents the origin of the resource-pack.
- ResultedEvent<R> - 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
EventTaskfor 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
-
This scope defines the right hand.
S
- SamplePlayer(String, UUID) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
-
Constructs a SamplePlayer from a legacy string-based name.
- SamplePlayer(Component, UUID) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing.SamplePlayer
-
Constructs a SamplePlayer from a
Component-based name. - samplePlayers(ServerPing.SamplePlayer...) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the modified
playersarray in the response. - samplePlayers(Collection<ServerPing.SamplePlayer>) - Method in class com.velocitypowered.api.proxy.server.ServerPing.Builder
-
Uses the modified
playerscollection in the response. - 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.
- sendMessage(Component) - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Sends a chat message to the player.
- 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.
- sendToServer(RegisteredServer, BridgeMessage) - Method in interface com.btcvelocity.api.bridge.BridgeChannel
-
Sends a bridge message to the given backend server.
- sendToServer(String, BridgeMessage) - Method in interface com.btcvelocity.api.bridge.BridgeChannel
-
Sends a bridge message to the named backend server.
- SerializedPluginDescription - Class in com.velocitypowered.api.plugin.ap
-
Serialized version of
PluginDescription. - SerializedPluginDescription.Dependency - Class in com.velocitypowered.api.plugin.ap
-
Represents a dependency declared by a plugin.
- server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerConfigurationEvent
-
Returns the value of the
serverrecord component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
-
Returns the value of the
serverrecord component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerEnteredConfigurationEvent
-
Returns the value of the
serverrecord component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishConfigurationEvent
-
Returns the value of the
serverrecord component. - server() - Method in record class com.velocitypowered.api.event.player.configuration.PlayerFinishedConfigurationEvent
-
Returns the value of the
serverrecord 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.
- ServerInfo(String, InetSocketAddress, PlayerInfoForwarding) - Constructor for class com.velocitypowered.api.proxy.server.ServerInfo
-
Creates a new ServerInfo object.
- ServerInfoForwardingMode - Enum Class in com.velocitypowered.api.proxy.server
-
Supported per-server player info forwarding methods.
- serverLink(ServerLink.Type, String) - Static method in class com.velocitypowered.api.util.ServerLink
-
Creates a
ServerLinkwith a built-in type label. - serverLink(Component, String) - Static method in class com.velocitypowered.api.util.ServerLink
-
Creates a
ServerLinkwith 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.
- serverName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.RequestStatus
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
serverNamerecord component. - 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
-
Constructs an initial ServerPing instance.
- ServerPing(ServerPing.Version, ServerPing.Players, Component, Favicon, ModInfo) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing
-
Constructs a ServerPing instance.
- ServerPing(ServerPing.Version, ServerPing.Players, Component, Favicon, ModInfo, boolean) - 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
ServerPingobjects. - 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
-
Constructs a new
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
-
The proxy fires this event after a backend server is registered to the server map.
- ServerRegisteredEvent(RegisteredServer) - Constructor for record class com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent
-
Constructs a new
ServerRegisteredEvent. - ServerResourcePackRemoveEvent - Class in com.velocitypowered.api.event.player
-
This event is fired when the downstream server tries to remove a resource pack from the 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.
- ServerStatus - Enum Class in com.btcvelocity.api.queue
-
Enumerates the status of a backend server as seen by the queue system.
- 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
-
Constructs a
ServerUnregisteredEvent. - 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
thisentry 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
thisentry to the specified value. - setListed(boolean) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Sets whether this entry is listed.
- setListOrder(int) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Sets the order/priority of this entry in the tab list.
- setOverwriteKick(boolean) - Method in class com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent
-
Set to true to prevent
ResourcePackInfo.getShouldForce()from kicking the player. - setPartialMessage(String) - Method in class com.btcvelocity.api.event.player.TabCompleteRequestEvent
-
Updates the partial message to be used for tab completion.
- setPartialMessage(String) - Method in class com.velocitypowered.api.event.player.TabCompleteRequestEvent
-
Updates the partial message to be used for tab completion.
- 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
Componentto display on the download prompt. - setProvidedResourcePack(ResourcePackInfo) - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
-
Sets the resource pack that should be forwarded to the player.
- setProvider(PermissionProvider) - Method in class com.velocitypowered.api.event.permission.PermissionsSetupEvent
-
Sets the
PermissionProviderthat should provide thePermissionFunctionfor this subject. - setReason(Component) - Method in class com.velocitypowered.api.event.player.PlayerChooseInitialServerEvent
-
Sets a custom disconnect reason for the player.
- 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(PluginMessageEvent.ForwardResult) - Method in class com.velocitypowered.api.event.connection.PluginMessageEvent
- setResult(PreLoginEvent.PreLoginComponentResult) - Method in class com.velocitypowered.api.event.connection.PreLoginEvent
- 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(KickedFromServerEvent.ServerKickResult) - Method in class com.velocitypowered.api.event.player.KickedFromServerEvent
- setResult(PlayerChatEvent.ChatResult) - Method in class com.velocitypowered.api.event.player.PlayerChatEvent
-
Deprecated.for 1.19.1 and newer, set this as denied will kick users
- setResult(ServerLoginPluginMessageEvent.ResponseResult) - Method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent
-
Sets the
ServerLoginPluginMessageEvent.ResponseResultfor this plugin message event. - setResult(ServerPreConnectEvent.ServerResult) - Method in class com.velocitypowered.api.event.player.ServerPreConnectEvent
- setResult(ResultedEvent.GenericResult) - Method in class com.btcvelocity.api.event.connection.ConnectionEstablishEvent
-
Sets the result of this event.
- setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.connection.ConnectionEstablishEvent
-
Sets the result of this event.
- setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.proxy.ProxyPingEvent
-
Sets whether to avoid sending a ping response to the connection.
- setResult(ResultedEvent.ComponentResult) - Method in class com.velocitypowered.api.event.connection.LoginEvent
- setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent
-
Sets the
ResultedEvent.GenericResultto control whether the resource pack removal proceeds. - setResult(ResultedEvent.GenericResult) - Method in class com.velocitypowered.api.event.player.ServerResourcePackSendEvent
-
Sets the
ResultedEvent.GenericResultthat controls whether the resource pack is forwarded to the player. - 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.
- setServerStatus(ServerStatus) - Method in interface com.btcvelocity.api.queue.Queue
-
Updates the status of the backend server.
- setShouldForce(boolean) - Method in interface com.velocitypowered.api.proxy.player.ResourcePackInfo.Builder
-
Sets the resource-pack as required to play on the network.
- setShowHat(boolean) - Method in interface com.velocitypowered.api.proxy.player.TabListEntry
-
Sets whether to show this entry's hat layer in the tab list.
- setState(QueueState) - Method in interface com.btcvelocity.api.queue.Queue
-
Updates the operational state of this queue.
- 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.
- showDialog(DialogLike) - Method in interface com.velocitypowered.api.proxy.Player
-
This method is not currently implemented in Velocity and will not perform any actions.
- showHat(boolean) - Method in class com.velocitypowered.api.proxy.player.TabListEntry.Builder
-
Sets whether this entry's hat layer should be shown in the tab list.
- SHOWN - Enum constant in enum class com.velocitypowered.api.proxy.player.PlayerSettings.ChatMode
-
Chat is fully visible.
- 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. - SIGNED_WITH_ARGS - Enum constant in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.SignedState
-
Indicates that the command was executed from a signed source with signed message arguments, This is currently only possible by typing a command in chat with signed arguments.
- SIGNED_WITHOUT_ARGS - Enum constant in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.SignedState
-
Indicates that the command was executed from a signed source with no signed message arguments, This is currently only possible by typing a command in chat.
- SignedMessage - Interface in com.velocitypowered.api.proxy.crypto
-
A signed message.
- signedState() - Method in record class com.velocitypowered.api.event.command.CommandExecuteEvent.InvocationInfo
-
Returns the value of the
signedStaterecord component. - SimpleCommand - Interface in com.velocitypowered.api.command
-
A simple command, modeled after the convention popularized by Bukkit and BungeeCord.
- SimpleCommand.Invocation - Interface in com.velocitypowered.api.command
-
Contains the invocation data for a simple command.
- size() - Method in interface com.btcvelocity.api.queue.Queue
-
Returns the number of players currently in this queue.
- 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
-
Constructs a new SkinParts object with the provided bitmask.
- source() - Method in interface com.velocitypowered.api.command.CommandInvocation
-
Returns the source to execute the command for.
- source() - Method in record class com.velocitypowered.api.event.command.CommandExecuteEvent.InvocationInfo
-
Returns the value of the
sourcerecord component. - spoofChatInput(String) - Method in interface com.velocitypowered.api.proxy.Player
-
Sends chat input onto the player's 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
-
Indicates that the client is performing a status request (e.g., server list ping).
- 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
-
A link showing the current server or service status.
- stopSound(SoundStop) - Method in interface com.velocitypowered.api.proxy.Player
- StorageService - Interface in com.btcvelocity.api.storage
-
Asynchronous storage service for persisting player data and proxy state to a durable backend (PostgreSQL).
- 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
-
The player completed a successful login to the proxy.
- sudo(String) - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Forces the player to execute a command or send a chat message.
- 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
-
A link to the server’s support or help desk.
- 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.LEGACYandProtocolVersion.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.
- TabCompleteRequestEvent - Class in com.btcvelocity.api.event.player
-
This event is fired after a tab complete request is sent by a player, for clients on Minecraft 1.12.2 and below.
- TabCompleteRequestEvent - Class in com.velocitypowered.api.event.player
-
This event is fired after a tab complete request is sent by a player, for clients on Minecraft 1.12.2 and below.
- TabCompleteRequestEvent(Player, String) - Constructor for class com.btcvelocity.api.event.player.TabCompleteRequestEvent
-
Constructs a new
TabCompleteRequestEvent. - TabCompleteRequestEvent(Player, String) - Constructor for class com.velocitypowered.api.event.player.TabCompleteRequestEvent
-
Constructs a new
TabCompleteRequestEvent. - 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
TabListEntrys. - targetServer() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
-
Returns the value of the
targetServerrecord component. - targetServer() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
-
Returns the value of the
targetServerrecord component. - targetServer() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Returns the value of the
targetServerrecord component. - targetWorld() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Returns the value of the
targetWorldrecord component. - tasksByPlugin(Object) - Method in interface com.velocitypowered.api.scheduler.Scheduler
-
Get the
ScheduledTaskfor a specific plugin. - TaskStatus - Enum Class in com.velocitypowered.api.scheduler
-
Enumerates all possible task statuses.
- teardown() - Method in interface com.btcvelocity.api.queue.Queue
-
Clears all players from this queue and releases any held resources.
- teardown() - Method in interface com.btcvelocity.api.queue.QueueManager
-
Tears down the queue manager, cancelling all scheduled tasks and clearing all queues.
- 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.Builderinstance from data represented by this response, so that you may create a newQueryResponsewith new data. - toLocalPlayer() - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Attempts to resolve this cluster player to a local
Playerinstance on the current proxy. - tooltip(Component) - Static method in class com.velocitypowered.api.command.VelocityBrigadierMessage
-
Creates a new
VelocityBrigadierMessageusing the givenComponentas the message. - toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueLeave
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.RequestStatus
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
-
Returns a string representation of this record class.
- toString() - Method in class com.btcvelocity.api.event.player.TabCompleteRequestEvent
-
Returns a string representation of this event, useful for debugging.
- toString() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns a string representation of this record class.
- toString() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns a string representation of this record class.
- toString() - Method in class com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult
- toString() - Method in record class com.velocitypowered.api.event.command.CommandExecuteEvent.InvocationInfo
-
Returns a string representation of this record class.
- 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.PlayerChannelUnregisterEvent
-
Returns a string representation of this event, useful for debugging.
- 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
-
Returns a string representation of this
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
-
Returns a string representation of this
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
-
Returns a string representation of this
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
-
Returns a string representation of this
TabCompleteEvent. - toString() - Method in class com.velocitypowered.api.event.player.TabCompleteRequestEvent
-
Returns a string representation of this event, useful for debugging.
- 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.ProxyPreShutdownEvent
- toString() - Method in class com.velocitypowered.api.event.proxy.ProxyReloadEvent
-
Returns a string representation of this
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.ap.SerializedPluginDescription.Dependency
- toString() - Method in class com.velocitypowered.api.plugin.ap.SerializedPluginDescription
- toString() - Method in class com.velocitypowered.api.plugin.meta.PluginDependency
- toString() - Method in record class com.velocitypowered.api.proxy.config.BackendServerConfig
-
Returns a string representation of this record class.
- 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
UUIDobject into an undashed Mojang-style UUID. - tps() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
-
Returns the value of the
tpsrecord component. - transfer(String, int) - Method in interface com.btcvelocity.api.cluster.ClusterPlayer
-
Transfers the player to a different proxy at the given address.
- TRANSFER - Enum constant in enum class com.velocitypowered.api.network.HandshakeIntent
-
Indicates that the client is initiating a transfer (e.g., Velocity-native forwarding).
- 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.
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.Health
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.PartyWarp
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueLeave
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueStatusResponse
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.RequestStatus
- type() - Method in interface com.btcvelocity.api.bridge.BridgeMessage
-
Returns the string discriminator used to route this message during (de)serialization.
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
- type() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
U
- UNDEFINED - Enum constant in enum class com.velocitypowered.api.permission.Tristate
-
A value indicating a non-existent setting.
- uniqueId() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns the value of the
uniqueIdrecord component. - unknown() - Static method in class com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent.ResponseResult
-
Returns a result indicating that this login plugin message was not handled by the proxy.
- UNKNOWN - Enum constant in enum class com.velocitypowered.api.network.ProtocolVersion
-
Represents an unknown protocol version.
- 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
unregisteredServerrecord component. - unregisterListener(BridgeMessageListener) - Method in interface com.btcvelocity.api.bridge.BridgeChannel
-
Removes a previously registered listener.
- 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.
- UNSIGNED - Enum constant in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.SignedState
-
Indicates that the command was executed from an unsigned source, such as clicking on a component with a
ClickEvent.Action.RUN_COMMAND. - UNSUPPORTED - Enum constant in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.SignedState
-
Indicates that the command invocation does not support signing.
- updatePlayerLastSeen(UUID, String, long) - Method in interface com.btcvelocity.api.storage.StorageService
-
Updates the
last_seentimestamp and current server for the player with the given UUID. - updateProxyHeartbeat(String, int, long) - Method in interface com.btcvelocity.api.storage.StorageService
-
Updates the heartbeat row for the specified proxy, recording the current player count and uptime.
- upsertPlayer(PlayerData) - Method in interface com.btcvelocity.api.storage.StorageService
-
Inserts or updates the persisted record for the given player.
- url() - Element in annotation interface com.velocitypowered.api.plugin.Plugin
-
The URL or website of the plugin.
- username() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Returns the value of the
usernamerecord component. - username() - Method in record class com.btcvelocity.api.queue.QueueEntryData
-
Returns the value of the
usernamerecord component. - username() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
usernamerecord component. - uuid() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.ConnectRequest
-
Returns the value of the
uuidrecord component. - uuid() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueJoin
-
Returns the value of the
uuidrecord component. - uuid() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.QueueLeave
-
Returns the value of the
uuidrecord component. - uuid() - Method in record class com.btcvelocity.api.storage.PlayerData
-
Returns the value of the
uuidrecord component. - UuidUtils - Class in com.velocitypowered.api.util
-
Provides a small, useful set of utilities for working with Minecraft UUIDs.
V
- valueOf(String) - Static method in enum class com.btcvelocity.api.queue.QueueState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.btcvelocity.api.queue.ServerStatus
-
Returns the enum constant of this class with the specified name.
- 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.command.CommandExecuteEvent.SignedState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.event.command.CommandExecuteEvent.Source
-
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.PlayerSettings.ParticleStatus
-
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.proxy.server.PlayerInfoForwarding
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.velocitypowered.api.proxy.server.ServerInfoForwardingMode
-
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.btcvelocity.api.queue.QueueState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.btcvelocity.api.queue.ServerStatus
-
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.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.command.CommandExecuteEvent.SignedState
-
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.command.CommandExecuteEvent.Source
-
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.PlayerSettings.ParticleStatus
-
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.proxy.server.PlayerInfoForwarding
-
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.server.ServerInfoForwardingMode
-
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 forComponentmessages. - 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
-
Uses the modified
versioninfo in the response. - Version(int, String) - Constructor for class com.velocitypowered.api.proxy.server.ServerPing.Version
-
Creates a new instance.
- virtualHost(String) - Method in class com.velocitypowered.api.proxy.server.PingOptions.Builder
-
Sets the virtual host to pass to the server for the ping.
W
- WAITING - Enum constant in enum class com.btcvelocity.api.queue.ServerStatus
-
The server responded but is in a warmup period.
- WEBSITE - Enum constant in enum class com.velocitypowered.api.util.ServerLink.Type
-
A link to the server's main website.
- 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
GameProfilewith the specified unique id. - withName(String) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfilewith the specified name. - withProperties(List<GameProfile.Property>) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfilewith the specified properties. - withUndashedId(String) - Method in class com.velocitypowered.api.util.GameProfile
-
Creates a new
GameProfilewith the specified undashed id. - WorldLoaded(String, String, long) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Creates an instance of a
WorldLoadedrecord class. - worldName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded
-
Returns the value of the
worldNamerecord component. - worldName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
-
Returns the value of the
worldNamerecord component. - worldName() - Method in record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
-
Returns the value of the
worldNamerecord component. - WorldPreload(String, String) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
-
Creates an instance of a
WorldPreloadrecord class. - WorldUnloaded(String, String) - Constructor for record class com.btcvelocity.api.bridge.BridgeMessage.WorldUnloaded
-
Creates an instance of a
WorldUnloadedrecord class.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
TabListEntry.Builderinstead.