Index (api 2.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

action() - Method in record class dev.plex.network.VanishBridgeMessage: Returns the value of the action record component.
ActionBroadcast - Interface in dev.plex.api.message: An administrative announcement whose recipient policy was captured when the action started.
active() - Method in interface dev.plex.api.punishment.PunishmentView: Returns whether the punishment is currently active.
add(UUID, String, UUID) - Method in interface dev.plex.api.note.NotesApi: Adds a note to a player.
addPrefix(Component) - Method in class dev.plex.api.event.PlayerPrefixEvent: Adds a prefix after prefixes from earlier listeners, before the tag.
aliases() - Method in record class dev.plex.command.CommandSpec: Returns the value of the aliases record component.
aliases(String) - Method in class dev.plex.command.CommandSpec.Builder: Sets comma-separated command aliases.
aliases(List) - Method in class dev.plex.command.CommandSpec.Builder: Sets command aliases.
ALL_TARGETS - Static variable in class dev.plex.command.SimplePlexCommand: Target token that selects every online player.
AmbiguousPlayerException - Exception Class in dev.plex.command.exception
AmbiguousPlayerException(List) - Constructor for exception class dev.plex.command.exception.AmbiguousPlayerException
ANY - Enum constant in enum class dev.plex.command.source.RequiredCommandSource: Allows both player and console sources.
api() - Method in class dev.plex.command.SimplePlexCommand: Returns the bound Plex API.
api() - Method in class dev.plex.module.PlexModule: Returns the Plex API.
API - Enum constant in enum class dev.plex.api.event.StaffChatMessageEvent.Source: A message was sent via API
apiCompatibilityVersion() - Method in interface dev.plex.api.PlexApi: Returns the API version for this Plex build.
author() - Method in record class dev.plex.api.note.PlayerNote: Returns the value of the author record component.

B

BAN - Enum constant in enum class dev.plex.api.punishment.PunishmentType: Bans a player for the standard 24-hour duration.
bindApi(PlexApi) - Method in interface dev.plex.command.PlexCommand: Supplies the running Plex API to commands that need API helpers.
bindApi(PlexApi) - Method in class dev.plex.command.SimplePlexCommand
bindModule(PlexModule) - Method in interface dev.plex.command.PlexCommand: Supplies the owning module to commands that need module-owned resources.
bindModule(PlexModule) - Method in class dev.plex.command.SimplePlexCommand
broadcast(String) - Method in interface dev.plex.api.message.MessageApi: Broadcasts a MiniMessage string to online players.
broadcast(String) - Method in class dev.plex.command.SimplePlexCommand: Broadcasts a MiniMessage-formatted message.
broadcast(Component) - Method in interface dev.plex.api.message.MessageApi: Broadcasts a component to online players.
broadcast(Component) - Method in class dev.plex.command.SimplePlexCommand: Broadcasts a component.
build() - Method in class dev.plex.command.CommandSpec.Builder: Builds the command spec.
buildCommand() - Method in interface dev.plex.command.PlexCommand: Builds the Brigadier command tree for this command.
buildCommand() - Method in class dev.plex.command.SimplePlexCommand
builder(String) - Static method in record class dev.plex.command.CommandSpec: Creates a command spec builder for the given primary name.
byName(String) - Method in interface dev.plex.api.player.PlayersApi: Looks up a player by exact, case-insensitive name.

C

call(UUID, String, Supplier) - Static method in class dev.plex.api.command.CommandExecutionIdentity: Runs an action with a temporary command identity.
captureActionBroadcast(CommandSender) - Method in interface dev.plex.api.message.MessageApi: Captures recipient policy for an administrative action on the sender's command thread, before starting asynchronous work or scheduling work on another entity or region.
CHANNEL - Static variable in record class dev.plex.network.VanishBridgeMessage: Plugin message channel used for vanish messages.
CHAT - Enum constant in enum class dev.plex.api.event.PlayerPrefixEvent.Target: A public chat line.
chatLine(Player, Component) - Method in interface dev.plex.api.message.MessageApi: Renders a message as the public chat line of a player.
checkPermission(CommandSender, String) - Method in class dev.plex.command.SimplePlexCommand: Checks whether a sender has a permission node.
clear(UUID) - Method in interface dev.plex.api.note.NotesApi: Removes every note from a player.
clearTag(UUID) - Method in interface dev.plex.api.player.PlayersApi: Removes a known player's saved custom tag from chat and the tab list.
command(String) - Static method in class dev.plex.command.SimplePlexCommand: Starts a command spec builder for the given command name.
COMMAND - Enum constant in enum class dev.plex.api.event.StaffChatMessageEvent.Source: A sender used /adminchat <message> or one of its aliases.
CommandApi - Interface in dev.plex.api.command: Registers and unregisters Plex commands.
CommandExecutionIdentity - Class in dev.plex.api.command: Carries an attributed command name through a synchronous Plex command dispatch.
CommandFailException - Exception Class in dev.plex.command.exception: Signals that command execution failed with a user-facing message.
CommandFailException() - Constructor for exception class dev.plex.command.exception.CommandFailException: Creates an exception with the default command failure marker message.
CommandFailException(String) - Constructor for exception class dev.plex.command.exception.CommandFailException: Creates an exception with a custom user-facing failure message.
commands() - Method in interface dev.plex.api.PlexApi: Returns the command service.
commandSpec() - Method in interface dev.plex.command.PlexCommand: Returns the command definition.
commandSpec() - Method in class dev.plex.command.SimplePlexCommand
CommandSpec - Record Class in dev.plex.command: Defines a Plex command.
CommandSpec(String, String, String, List, String, RequiredCommandSource) - Constructor for record class dev.plex.command.CommandSpec: Creates and validates command data.
CommandSpec.Builder - Class in dev.plex.command: Builder for command specs.
completeShutdownBeforeClose(CompletableFuture) - Method in class dev.plex.module.PlexModule: Keeps this module's classloader open until its bounded asynchronous shutdown work finishes.
componentFromString(String) - Method in class dev.plex.command.SimplePlexCommand: Converts text with legacy ampersand color codes to a component.
configuration() - Method in interface dev.plex.api.PlexApi: Returns the shared Plex configuration files.
ConfigurationApi - Interface in dev.plex.api.config: Provides read-only access to shared Plex configuration files.
configureCommand(LiteralArgumentBuilder) - Method in class dev.plex.command.SimplePlexCommand: Configures this command's typed Brigadier tree.
CONSOLE - Enum constant in enum class dev.plex.api.punishment.PunishmentSource: Punishment issued by the server console.
CONSOLE - Enum constant in enum class dev.plex.command.source.RequiredCommandSource: Allows only console sources.
ConsoleMustDefinePlayerException - Exception Class in dev.plex.command.exception: Signals that the console must supply a target player for a command.
ConsoleMustDefinePlayerException() - Constructor for exception class dev.plex.command.exception.ConsoleMustDefinePlayerException: Creates an exception with the default console target marker message.
ConsoleMustDefinePlayerException(String) - Constructor for exception class dev.plex.command.exception.ConsoleMustDefinePlayerException: Creates an exception with a custom user-facing message.
ConsoleOnlyException - Exception Class in dev.plex.command.exception: Signals that a command can only be run from the console.
ConsoleOnlyException() - Constructor for exception class dev.plex.command.exception.ConsoleOnlyException: Creates an exception with the default console-only marker message.
ConsoleOnlyException(String) - Constructor for exception class dev.plex.command.exception.ConsoleOnlyException: Creates an exception with a custom user-facing message.
content() - Method in record class dev.plex.api.note.PlayerNote: Returns the value of the content record component.
create(PlexModule, String) - Method in interface dev.plex.api.config.ModuleConfigApi: Creates or opens a module configuration.
currentName(String) - Static method in class dev.plex.api.command.CommandExecutionIdentity: Returns the current actor name.
currentUniqueId() - Static method in class dev.plex.api.command.CommandExecutionIdentity: Returns the current actor UUID.

D

debug(String, Object...) - Method in interface dev.plex.api.logging.LoggingApi: Writes a debug log message.
decode(byte[]) - Static method in record class dev.plex.network.VanishBridgeMessage: Decodes a message from the plugin message channel.
description() - Method in record class dev.plex.command.CommandSpec: Returns the value of the description record component.
description(String) - Method in class dev.plex.command.CommandSpec.Builder: Sets the command description.
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class dev.plex.util.adapter.ZonedDateTimeAdapter
dev.plex.api - package dev.plex.api
dev.plex.api.command - package dev.plex.api.command
dev.plex.api.config - package dev.plex.api.config
dev.plex.api.event - package dev.plex.api.event
dev.plex.api.logging - package dev.plex.api.logging
dev.plex.api.message - package dev.plex.api.message
dev.plex.api.module - package dev.plex.api.module
dev.plex.api.note - package dev.plex.api.note
dev.plex.api.player - package dev.plex.api.player
dev.plex.api.punishment - package dev.plex.api.punishment
dev.plex.api.rollback - package dev.plex.api.rollback
dev.plex.api.storage - package dev.plex.api.storage
dev.plex.command - package dev.plex.command
dev.plex.command.exception - package dev.plex.command.exception
dev.plex.command.source - package dev.plex.command.source
dev.plex.module - package dev.plex.module
dev.plex.network - package dev.plex.network
dev.plex.util.adapter - package dev.plex.util.adapter
dialect() - Method in interface dev.plex.api.storage.StorageApi: Returns the configured SQL dialect.
disable() - Method in class dev.plex.module.PlexModule: Called when the module is disabled.
dispatchAsConsole(UUID, String, String, Consumer) - Method in interface dev.plex.api.command.CommandApi: Runs a command as the console and records the given actor.

E

enable() - Method in class dev.plex.module.PlexModule: Called when the module is enabled.
encode() - Method in record class dev.plex.network.VanishBridgeMessage: Encodes this message for the plugin message channel.
endDate() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the endDate record component.
endDate() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the punishment end date.
equals(Object) - Method in record class dev.plex.api.note.PlayerNote: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.plex.api.punishment.PunishmentRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.plex.command.CommandSpec: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.plex.network.VanishBridgeMessage: Indicates whether some other object is "equal to" this one.
error(String, Object...) - Method in interface dev.plex.api.logging.LoggingApi: Writes an error log message.
executeCommand(CommandContext, BiFunction) - Method in class dev.plex.command.SimplePlexCommand

F

fixedDuration() - Method in enum class dev.plex.api.punishment.PunishmentType: A duration enforced for this type, regardless of a caller-supplied end date.
forModule(PlexModule) - Method in interface dev.plex.api.storage.StorageApi: Returns storage for a module.
FREEZE - Enum constant in enum class dev.plex.api.punishment.PunishmentType: Freezes player movement.
frozen() - Method in interface dev.plex.api.player.PlexPlayerView: Returns whether the player is currently frozen.

G

get(String) - Method in interface dev.plex.api.player.PlayerModuleData: Gets a raw JSON value.
get(String, Class) - Method in interface dev.plex.api.player.PlayerModuleData: Gets and maps a JSON value to a Java type.
getAliases() - Method in interface dev.plex.command.PlexCommand: Returns command aliases as a trimmed list.
getApiCompatibility() - Method in class dev.plex.module.PlexModuleFile: Returns the required Plex API compatibility version.
getBoolean(String) - Method in interface dev.plex.api.config.PlexConfiguration: Reads a boolean value.
getBoolean(String, boolean) - Method in interface dev.plex.api.config.PlexConfiguration: Reads a boolean value with a fallback.
getBoolean(String, boolean) - Method in interface dev.plex.api.player.PlayerModuleData: Gets a boolean value.
getCommand(String) - Method in class dev.plex.module.PlexModule: Looks up a tracked command by name or alias.
getDataFolder() - Method in class dev.plex.module.PlexModule: Returns the module data folder.
getDescription() - Method in interface dev.plex.command.PlexCommand: Returns the command description.
getDescription() - Method in class dev.plex.module.PlexModuleFile: Returns the module description.
getHandlerList() - Static method in class dev.plex.api.event.PlayerPrefixEvent: Returns the handler list for this event.
getHandlerList() - Static method in class dev.plex.api.event.StaffChatMessageEvent: Returns this event's handler list.
getHandlers() - Method in class dev.plex.api.event.PlayerPrefixEvent
getHandlers() - Method in class dev.plex.api.event.StaffChatMessageEvent
getInt(String) - Method in interface dev.plex.api.config.PlexConfiguration: Reads an integer value.
getInt(String, int) - Method in interface dev.plex.api.config.PlexConfiguration: Reads an integer value with a fallback.
getLibraries() - Method in class dev.plex.module.PlexModuleFile: Returns dependency libraries declared by the module.
getLogger() - Method in class dev.plex.module.PlexModule: Returns the module logger.
getLong(String, long) - Method in interface dev.plex.api.player.PlayerModuleData: Gets a long value.
getMain() - Method in class dev.plex.module.PlexModuleFile: Returns the main module class.
getMatchingNames() - Method in exception class dev.plex.command.exception.AmbiguousPlayerException
getMessage() - Method in class dev.plex.api.event.StaffChatMessageEvent: Returns the message that Plex will send.
getName() - Method in class dev.plex.api.event.PlayerPrefixEvent: Returns the base name.
getName() - Method in interface dev.plex.command.PlexCommand: Returns the primary command name.
getName() - Method in class dev.plex.module.PlexModuleFile: Returns the module name.
getNonNullPlayer(String) - Method in class dev.plex.command.SimplePlexCommand: Returns an online player by UUID string or name.
getPermission() - Method in interface dev.plex.command.PlexCommand: Returns the permission node required to use the command.
getPlexModuleFile() - Method in class dev.plex.module.PlexModule: Returns information read from this module's module.yml.
getPrefixes() - Method in class dev.plex.api.event.PlayerPrefixEvent: Returns the prefixes contributed so far.
getRepositories() - Method in class dev.plex.module.PlexModuleFile: Returns Maven repositories declared by the module.
getRequiredSource() - Method in interface dev.plex.command.PlexCommand: Returns the command source required to run the command.
getResource(String) - Method in class dev.plex.module.PlexModule: Opens a resource owned by this module.
getSender() - Method in class dev.plex.api.event.StaffChatMessageEvent: Returns the player or console that sent the message.
getSource() - Method in class dev.plex.api.event.StaffChatMessageEvent: Returns how the message entered staff chat.
getString(String) - Method in interface dev.plex.api.config.PlexConfiguration: Reads a string value.
getString(String, String) - Method in interface dev.plex.api.config.PlexConfiguration: Reads a string value with a fallback.
getString(String, String) - Method in interface dev.plex.api.player.PlayerModuleData: Gets a string value.
getStringList(String) - Method in interface dev.plex.api.config.PlexConfiguration: Reads a string list.
getStringList(String, List) - Method in interface dev.plex.api.config.PlexConfiguration: Reads a string list with a fallback.
getTag() - Method in class dev.plex.api.event.PlayerPrefixEvent: Returns the base tag.
getTarget() - Method in class dev.plex.api.event.PlayerPrefixEvent: Returns the output that Plex will render.
getUpdateUrls() - Method in class dev.plex.module.PlexModuleFile: Returns custom updater base URLs declared by the module.
getUsage() - Method in interface dev.plex.command.PlexCommand: Returns command usage text.
getUUID(CommandSender) - Method in class dev.plex.command.SimplePlexCommand: Returns a sender's UUID when the sender is a player.
getVersion() - Method in class dev.plex.module.PlexModuleFile: Returns the module version.
greedyString(String) - Method in class dev.plex.command.SimplePlexCommand

H

hashCode() - Method in record class dev.plex.api.note.PlayerNote: Returns a hash code value for this object.
hashCode() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns a hash code value for this object.
hashCode() - Method in record class dev.plex.command.CommandSpec: Returns a hash code value for this object.
hashCode() - Method in record class dev.plex.network.VanishBridgeMessage: Returns a hash code value for this object.
HIDDEN - Enum constant in enum class dev.plex.network.VanishBridgeMessage.Action: Reports that the player is hidden.
hide(UUID, boolean) - Static method in record class dev.plex.network.VanishBridgeMessage: Creates a request to hide a player.
HIDE - Enum constant in enum class dev.plex.network.VanishBridgeMessage.Action: Requests that the player be hidden.

I

id() - Method in record class dev.plex.api.note.PlayerNote: Returns the value of the id record component.
IN_GAME - Enum constant in enum class dev.plex.command.source.RequiredCommandSource: Allows only in-game player sources.
indefiniteBanByIp(String) - Method in interface dev.plex.api.punishment.PunishmentsApi: Finds an indefinite ban by IP address.
indefiniteBanByName(String) - Method in interface dev.plex.api.punishment.PunishmentsApi: Finds an indefinite ban by player name.
indefiniteBanByUuid(UUID) - Method in interface dev.plex.api.punishment.PunishmentsApi: Looks up an indefinite ban by UUID.
indefiniteBans() - Method in interface dev.plex.api.config.ConfigurationApi: Returns the indefinite ban configuration.
indefiniteBans() - Method in interface dev.plex.api.punishment.PunishmentsApi: Returns current indefinite bans.
IndefiniteBanView - Interface in dev.plex.api.punishment: Read-only view of an indefinite ban entry.
info(String, Object...) - Method in interface dev.plex.api.logging.LoggingApi: Writes an informational log message.
ip() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the ip record component.
ip() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the IP address associated with the punished player.
ips() - Method in interface dev.plex.api.player.PlexPlayerView: Returns known IP addresses.
ips() - Method in interface dev.plex.api.punishment.IndefiniteBanView: Returns IP addresses covered by the ban.
isAvailable() - Method in interface dev.plex.api.rollback.RollbackApi: Checks if Plex has an active rollback integration.
isBan() - Method in enum class dev.plex.api.punishment.PunishmentType: Whether this is a finite ban punishment.
isBanned(UUID) - Method in interface dev.plex.api.punishment.PunishmentsApi: Checks if a player has an active ban.
isBanned(UUID, String) - Method in interface dev.plex.api.punishment.PunishmentsApi: Checks whether a player has an active UUID or current IP ban.
isCancelled() - Method in class dev.plex.api.event.StaffChatMessageEvent
isConsole(CommandSender) - Method in class dev.plex.command.SimplePlexCommand: Returns whether a sender is not a player.
issueDate() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the date and time when the punishment was issued.
isUpdaterEnabled() - Method in class dev.plex.module.PlexModuleFile: Returns whether Plex should include this module in module update commands.

J

jdbi() - Method in interface dev.plex.api.storage.ModuleStorage: Returns the shared Jdbi instance.

K

KICK - Enum constant in enum class dev.plex.api.punishment.PunishmentType: Kicks a player from the server.
kickPlayerOnShutdown(Player, Component) - Method in class dev.plex.module.PlexModule: Disconnects a player during module shutdown.

L

list(UUID) - Method in interface dev.plex.api.note.NotesApi: Returns a player's notes in ID order.
load() - Method in class dev.plex.api.config.ModuleConfiguration: Loads the configuration from disk, merging defaults when supported.
load() - Method in class dev.plex.module.PlexModule: Called when the module is loaded.
loadedModules() - Method in interface dev.plex.api.module.ModulesApi: Returns information about all loaded modules.
loadMessages(String) - Method in class dev.plex.module.PlexModule: Loads this module's message file.
lockedUp() - Method in interface dev.plex.api.player.PlexPlayerView: Returns whether the player is currently locked up.
logging() - Method in interface dev.plex.api.PlexApi: Returns the logging service.
LoggingApi - Interface in dev.plex.api.logging: Writes messages to the Plex log.

M

mainConfig() - Method in interface dev.plex.api.config.ConfigurationApi: Returns the main Plex configuration.
MARIADB - Enum constant in enum class dev.plex.api.storage.SqlDialect: MariaDB or MySQL-compatible storage.
maximumDuration() - Method in enum class dev.plex.api.punishment.PunishmentType: The longest permitted duration for this type, if it has a limit.
maximumLength() - Method in exception class dev.plex.api.player.TagTooLongException: Returns the limit used to validate the tag.
MessageApi - Interface in dev.plex.api.message: Formats configured messages and broadcasts Adventure components.
messageComponent(String, TagResolver...) - Method in interface dev.plex.api.message.MessageApi: Resolves a configured message entry into a component.
messageComponent(String, TagResolver...) - Method in class dev.plex.command.SimplePlexCommand: Resolves a configured message as a component.
messageComponent(String, TagResolver...) - Method in class dev.plex.module.PlexModule: Resolves a module message into a component, falling back to Plex messages.
messages() - Method in interface dev.plex.api.config.ConfigurationApi: Returns the shared message configuration.
messages() - Method in interface dev.plex.api.PlexApi: Returns the message service.
messages() - Method in class dev.plex.module.PlexModule: Returns this module's loaded messages, if any.
messageString(String) - Method in interface dev.plex.api.message.MessageApi: Gets the raw configured MiniMessage template without resolving tags.
messageString(String) - Method in class dev.plex.command.SimplePlexCommand: Gets a raw configured MiniMessage template.
messageString(String) - Method in class dev.plex.module.PlexModule: Gets a raw MiniMessage template, falling back to Plex messages.
migrationDirectory() - Method in enum class dev.plex.api.storage.SqlDialect: Returns the resource directory name used for dialect-specific migrations.
migrations() - Method in interface dev.plex.api.storage.ModuleStorage: Returns module migration operations.
miniMessage(String, TagResolver...) - Method in interface dev.plex.api.message.MessageApi: Converts MiniMessage text to a component.
mmString(String) - Method in class dev.plex.command.SimplePlexCommand: Converts MiniMessage-formatted text to a component.
module(String) - Method in interface dev.plex.api.module.ModulesApi: Looks up a module by name.
ModuleConfigApi - Interface in dev.plex.api.config: Creates configuration files owned by Plex modules.
moduleConfigs() - Method in interface dev.plex.api.PlexApi: Returns the module configuration service.
ModuleConfiguration - Class in dev.plex.api.config: Mutable YAML configuration owned by a Plex module.
ModuleConfiguration() - Constructor for class dev.plex.api.config.ModuleConfiguration: Creates a module configuration.
moduleData(PlexModule, UUID) - Method in interface dev.plex.api.player.PlayersApi: Returns module-scoped data storage for a player.
ModuleMigrations - Interface in dev.plex.api.storage: Runs database migrations for a module.
modules() - Method in interface dev.plex.api.PlexApi: Returns information about loaded modules.
ModulesApi - Interface in dev.plex.api.module: Provides information about loaded modules.
ModuleStorage - Interface in dev.plex.api.storage: Provides SQL storage for one module.
MUTE - Enum constant in enum class dev.plex.api.punishment.PunishmentType: Prevents chat or other messaging actions.
muted() - Method in interface dev.plex.api.player.PlexPlayerView: Returns whether the player is currently muted.

N

name() - Method in interface dev.plex.api.player.PlexPlayerView: Returns the current or last known player name.
name() - Method in record class dev.plex.command.CommandSpec: Returns the value of the name record component.
noColorComponentFromString(String) - Method in class dev.plex.command.SimplePlexCommand: Converts text with legacy ampersand color codes to a component without adding a default color.
notes() - Method in interface dev.plex.api.PlexApi: Returns the player notes service.
NotesApi - Interface in dev.plex.api.note: Manages notes attached to Plex players.

O

onlineNames() - Method in interface dev.plex.api.player.PlayersApi: Returns the names of online players.
onlinePlayerNames() - Method in class dev.plex.command.SimplePlexCommand: Returns the names of online players.
ownTask(T) - Method in class dev.plex.command.SimplePlexCommand: Registers a native Paper task with this command's module lifetime.
ownTask(T) - Method in class dev.plex.module.PlexModule: Registers a native Paper task for cancellation when this module unloads.

P

permission() - Method in record class dev.plex.command.CommandSpec: Returns the value of the permission record component.
permission(String) - Method in class dev.plex.command.CommandSpec.Builder: Sets the required permission node.
permissionMessage() - Method in class dev.plex.command.SimplePlexCommand: Returns the standard no-permission message for this command's permission node.
permissionMessage(String) - Method in class dev.plex.command.SimplePlexCommand: Returns the standard no-permission message for a permission node.
player() - Method in record class dev.plex.api.note.PlayerNote: Returns the value of the player record component.
player(UUID) - Method in interface dev.plex.api.player.PlayersApi: Looks up a player by UUID.
PLAYER - Enum constant in enum class dev.plex.api.punishment.PunishmentSource: Punishment issued by an in-game player.
playerId() - Method in record class dev.plex.network.VanishBridgeMessage: Returns the value of the playerId record component.
PlayerModuleData - Interface in dev.plex.api.player: Stores JSON data for one player and one module.
PlayerNotBannedException - Exception Class in dev.plex.command.exception: Signals that a command expected a banned player but none was found.
PlayerNotBannedException() - Constructor for exception class dev.plex.command.exception.PlayerNotBannedException: Creates an exception with the default player-not-banned marker message.
PlayerNotBannedException(String) - Constructor for exception class dev.plex.command.exception.PlayerNotBannedException: Creates an exception with a custom user-facing message.
PlayerNote - Record Class in dev.plex.api.note: A note attached to a Plex player.
PlayerNote(int, UUID, String, UUID, ZonedDateTime) - Constructor for record class dev.plex.api.note.PlayerNote: Creates an instance of a PlayerNote record class.
PlayerNotFoundException - Exception Class in dev.plex.command.exception: Signals that a command could not find the requested player.
PlayerNotFoundException() - Constructor for exception class dev.plex.command.exception.PlayerNotFoundException: Creates an exception with the default player-not-found marker message.
PlayerNotFoundException(String) - Constructor for exception class dev.plex.command.exception.PlayerNotFoundException: Creates an exception with a custom user-facing message.
PlayerPrefixEvent - Class in dev.plex.api.event: Supplies additive prefixes before Plex renders a player's chat line or tab-list entry.
PlayerPrefixEvent(Player, PlayerPrefixEvent.Target, Component, Component, boolean) - Constructor for class dev.plex.api.event.PlayerPrefixEvent: Creates a fresh prefix request.
PlayerPrefixEvent.Target - Enum Class in dev.plex.api.event: Output that Plex renders with the prefixes.
players() - Method in interface dev.plex.api.PlexApi: Returns the player service.
PlayersApi - Interface in dev.plex.api.player: Looks up Plex players and manages their saved custom tags.
playerText(String) - Method in interface dev.plex.api.message.MessageApi: Parses player-written visual formatting without interactive or data tags.
PlexApi - Interface in dev.plex.api: Gives Plex modules access to supported services.
PlexCommand - Interface in dev.plex.command: Public Brigadier command contract for Plex and Plex modules.
PlexConfiguration - Interface in dev.plex.api.config: Read-only view of a Plex configuration file.
PlexModule - Class in dev.plex.module: Base class for Plex modules.
PlexModule() - Constructor for class dev.plex.module.PlexModule: Creates a Plex module.
PlexModuleFile - Class in dev.plex.module: Information read from a module's module.yml file.
PlexModuleFile(String, String, String, String, int) - Constructor for class dev.plex.module.PlexModuleFile: Creates module information.
PlexModuleFile(String, String, String, String, int, List, List, boolean, List) - Constructor for class dev.plex.module.PlexModuleFile: Creates module data.
PlexPlayerView - Interface in dev.plex.api.player: Read-only view of a Plex player.
plugin() - Method in class dev.plex.module.PlexModule: Returns the Paper plugin that owns this module's native scheduled tasks.
POSTGRES - Enum constant in enum class dev.plex.api.storage.SqlDialect: PostgreSQL storage.
prefix() - Method in interface dev.plex.api.storage.ModuleStorage: Returns the validated module table prefix.
punish(PunishmentRequest) - Method in interface dev.plex.api.punishment.PunishmentsApi: Applies a punishment to a player.
punished() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the punished record component.
punished() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the UUID of the punished player.
punisher() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the punisher record component.
punisher() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the UUID of the actor who issued the punishment.
punisherDisplayName() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the resolved display name for the punishment actor.
punisherReference() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the punisherReference record component.
punisherReference() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the source-specific punisher reference.
PunishmentRequest - Record Class in dev.plex.api.punishment: Request payload used to create a punishment for a player.
PunishmentRequest(UUID, UUID, PunishmentSource, String, String, PunishmentType, String, ZonedDateTime) - Constructor for record class dev.plex.api.punishment.PunishmentRequest: Creates and validates a punishment request.
punishments() - Method in interface dev.plex.api.player.PlexPlayerView: Returns the player's punishment history.
punishments() - Method in interface dev.plex.api.PlexApi: Returns the punishment service.
PunishmentsApi - Interface in dev.plex.api.punishment: Reads and creates Plex punishments.
PunishmentSource - Enum Class in dev.plex.api.punishment: Source that issued a punishment.
PunishmentType - Enum Class in dev.plex.api.punishment: Supported punishment types exposed through the API.
PunishmentView - Interface in dev.plex.api.punishment: Read-only view of a Plex punishment.

Q

query(UUID) - Static method in record class dev.plex.network.VanishBridgeMessage: Creates a request for the player's current vanish state.
QUERY - Enum constant in enum class dev.plex.network.VanishBridgeMessage.Action: Requests the player's current state.

R

reason() - Method in interface dev.plex.api.punishment.IndefiniteBanView: Returns the ban reason.
reason() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the reason record component.
reason() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the punishment reason.
register(PlexCommand) - Method in interface dev.plex.api.command.CommandApi: Registers a command with Plex.
registerCommand(PlexCommand) - Method in class dev.plex.module.PlexModule: Registers and tracks a command owned by this module.
registeredCommands() - Method in interface dev.plex.api.command.CommandApi: Returns the commands tracked by Plex.
registerListener(Listener) - Method in class dev.plex.module.PlexModule: Registers and tracks a listener owned by this module.
remove(String) - Method in interface dev.plex.api.player.PlayerModuleData: Removes a stored value.
remove(UUID, int) - Method in interface dev.plex.api.note.NotesApi: Removes a note from a player.
RequiredCommandSource - Enum Class in dev.plex.command.source: Source restrictions for command execution.
requiredSource() - Method in record class dev.plex.command.CommandSpec: Returns the value of the requiredSource record component.
requiresEndDate() - Method in enum class dev.plex.api.punishment.PunishmentType: Whether this punishment must have a future end date.
requiresLifecycleReload() - Method in interface dev.plex.api.command.CommandApi: Checks if command changes require Paper to rebuild its command list.
resolveCommandPlayer(String) - Method in interface dev.plex.api.player.PlayersApi: Resolves an exact name first, then a unique online name prefix, ignoring case.
resolvedUsage() - Method in record class dev.plex.command.CommandSpec: Returns usage text with the command placeholder expanded.
resolveOnlinePlayer(String) - Static method in interface dev.plex.command.PlexCommand
resolveTargets(CommandSender, String, String) - Method in class dev.plex.command.SimplePlexCommand: Resolves an optional target argument to online players.
rollback() - Method in interface dev.plex.api.PlexApi: Returns the rollback service.
rollback(CommandSender, String, int) - Method in interface dev.plex.api.rollback.RollbackApi: Rolls back changes made by a player.
RollbackApi - Interface in dev.plex.api.rollback: Provides player rollback functions.
rollbackLastDay(CommandSender, String) - Method in interface dev.plex.api.rollback.RollbackApi: Rolls back the last 24 hours of changes made by a player.
run() - Method in interface dev.plex.api.storage.ModuleMigrations: Runs this module's migrations.

S

save() - Method in class dev.plex.api.config.ModuleConfiguration: Saves the configuration to disk.
send(Audience, String) - Method in class dev.plex.command.SimplePlexCommand: Sends a message with legacy ampersand color codes to an audience.
send(Audience, Component) - Method in class dev.plex.command.SimplePlexCommand: Sends a component to an audience.
send(Component) - Method in interface dev.plex.api.message.ActionBroadcast: Sends an announcement using the captured policy.
sendAdminChat(String, Component, Component) - Method in interface dev.plex.api.message.MessageApi: Send a component message with chosen component prefix to admins
sendPlayerLookupFailure(CommandSender, Throwable) - Method in class dev.plex.command.SimplePlexCommand
serialize(ZonedDateTime, Type, JsonSerializationContext) - Method in class dev.plex.util.adapter.ZonedDateTimeAdapter
set(String, JsonElement) - Method in interface dev.plex.api.player.PlayerModuleData: Stores a raw JSON value.
set(String, Object) - Method in interface dev.plex.api.player.PlayerModuleData: Stores a Java value as JSON.
setCancelled(boolean) - Method in class dev.plex.api.event.StaffChatMessageEvent
setMessage(Component) - Method in class dev.plex.api.event.StaffChatMessageEvent: Replaces the message Plex will deliver.
setTag(UUID, Component) - Method in interface dev.plex.api.player.PlayersApi: Saves a player's custom tag for chat and the tab list.
show(UUID, boolean) - Static method in record class dev.plex.network.VanishBridgeMessage: Creates a request to show a player.
SHOW - Enum constant in enum class dev.plex.network.VanishBridgeMessage.Action: Requests that the player be shown.
silent() - Method in record class dev.plex.network.VanishBridgeMessage: Returns the value of the silent record component.
silentCheckPermission(CommandSender, String) - Method in class dev.plex.command.SimplePlexCommand: Checks whether a sender has a permission node without throwing an exception.
SimplePlexCommand - Class in dev.plex.command: Convenience base for module commands with typed Brigadier command trees.
SimplePlexCommand(CommandSpec) - Constructor for class dev.plex.command.SimplePlexCommand: Creates a command from a command definition.
SMITE - Enum constant in enum class dev.plex.api.punishment.PunishmentType: Applies the smite action to a player.
source() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the source record component.
source() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the source that issued the punishment.
source(RequiredCommandSource) - Method in class dev.plex.command.CommandSpec.Builder: Sets the required command source.
SqlDialect - Enum Class in dev.plex.api.storage: SQL dialects supported by Plex storage.
SQLITE - Enum constant in enum class dev.plex.api.storage.SqlDialect: SQLite storage.
staffChat() - Method in interface dev.plex.api.player.PlexPlayerView: Returns whether the player currently has staff-chat mode enabled.
StaffChatMessageEvent - Class in dev.plex.api.event: Fires before Plex sends a local staff chat message.
StaffChatMessageEvent(Component, StaffChatMessageEvent.Source, boolean) - Constructor for class dev.plex.api.event.StaffChatMessageEvent
StaffChatMessageEvent(CommandSender, Component, StaffChatMessageEvent.Source, boolean) - Constructor for class dev.plex.api.event.StaffChatMessageEvent: Creates a staff-chat message event.
StaffChatMessageEvent.Source - Enum Class in dev.plex.api.event: Identifies the source of a staff chat message.
STANDARD_BAN_DURATION - Static variable in enum class dev.plex.api.punishment.PunishmentType: Standard duration used by PunishmentType.BAN.
startsActive() - Method in enum class dev.plex.api.punishment.PunishmentType: Whether a newly-created punishment represents ongoing state.
state(UUID, boolean) - Static method in record class dev.plex.network.VanishBridgeMessage: Creates a message that reports the player's vanish state.
storage() - Method in interface dev.plex.api.PlexApi: Returns the SQL storage service.
StorageApi - Interface in dev.plex.api.storage: Provides SQL storage for modules.
string(CommandContext, String) - Method in class dev.plex.command.SimplePlexCommand
suggestMatching(SuggestionsBuilder, Collection) - Method in class dev.plex.command.SimplePlexCommand: Suggests matching values using Brigadier's current argument prefix.

T

TAB - Enum constant in enum class dev.plex.api.event.PlayerPrefixEvent.Target: The player's tab-list entry.
table(String) - Method in interface dev.plex.api.storage.ModuleStorage: Adds the module prefix to a local table name.
tag() - Method in interface dev.plex.api.player.PlexPlayerView: Returns the saved custom tag using Plex's visual formatting rules.
TagTooLongException - Exception Class in dev.plex.api.player: Identifies a tag that exceeds the configured visible-text limit.
TagTooLongException(int) - Constructor for exception class dev.plex.api.player.TagTooLongException: Creates a tag length failure.
targetArgument(String, String) - Method in class dev.plex.command.SimplePlexCommand: Creates an optional target argument.
taskOwner() - Method in class dev.plex.command.SimplePlexCommand: Returns the Paper plugin that owns native tasks scheduled by this command.
TEMPBAN - Enum constant in enum class dev.plex.api.punishment.PunishmentType: Temporarily bans a player until an end date.
timestamp() - Method in record class dev.plex.api.note.PlayerNote: Returns the value of the timestamp record component.
TOGGLED_CHAT - Enum constant in enum class dev.plex.api.event.StaffChatMessageEvent.Source: A player spoke while staff-chat mode was enabled.
toggles() - Method in interface dev.plex.api.config.ConfigurationApi: Returns the toggle configuration.
toString() - Method in record class dev.plex.api.note.PlayerNote: Returns a string representation of this record class.
toString() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns a string representation of this record class.
toString() - Method in record class dev.plex.command.CommandSpec: Returns a string representation of this record class.
toString() - Method in record class dev.plex.network.VanishBridgeMessage: Returns a string representation of this record class.
type() - Method in record class dev.plex.api.punishment.PunishmentRequest: Returns the value of the type record component.
type() - Method in interface dev.plex.api.punishment.PunishmentView: Returns the punishment type.

U

unban(UUID) - Method in interface dev.plex.api.punishment.PunishmentsApi: Removes active bans for a player.
unregister(PlexCommand) - Method in interface dev.plex.api.command.CommandApi: Unregisters a command from Plex.
unregisterCommand(PlexCommand) - Method in class dev.plex.module.PlexModule: Unregisters and stops tracking a command owned by this module.
unregisterListener(Listener) - Method in class dev.plex.module.PlexModule: Unregisters and stops tracking a listener owned by this module.
usage() - Method in record class dev.plex.command.CommandSpec: Returns the value of the usage record component.
usage() - Method in class dev.plex.command.SimplePlexCommand: Returns this command's formatted usage component.
usage(String) - Method in class dev.plex.command.CommandSpec.Builder: Sets the command usage text.
usage(String) - Method in class dev.plex.command.SimplePlexCommand: Formats command usage text with the standard usage prefix.
usernames() - Method in interface dev.plex.api.punishment.IndefiniteBanView: Returns usernames covered by the ban.
uuid() - Method in interface dev.plex.api.player.PlexPlayerView: Returns the player's UUID.
uuids() - Method in interface dev.plex.api.punishment.IndefiniteBanView: Returns UUIDs covered by the ban.

V

valueOf(String) - Static method in enum class dev.plex.api.event.PlayerPrefixEvent.Target: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.plex.api.event.StaffChatMessageEvent.Source: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.plex.api.punishment.PunishmentSource: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.plex.api.punishment.PunishmentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.plex.api.storage.SqlDialect: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.plex.command.source.RequiredCommandSource: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.plex.network.VanishBridgeMessage.Action: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.plex.api.event.PlayerPrefixEvent.Target: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.plex.api.event.StaffChatMessageEvent.Source: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.plex.api.punishment.PunishmentSource: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.plex.api.punishment.PunishmentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.plex.api.storage.SqlDialect: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.plex.command.source.RequiredCommandSource: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.plex.network.VanishBridgeMessage.Action: Returns an array containing the constants of this enum class, in the order they are declared.
VanishBridgeMessage - Record Class in dev.plex.network: A vanish message sent between Plex servers and proxies.
VanishBridgeMessage(VanishBridgeMessage.Action, UUID, boolean) - Constructor for record class dev.plex.network.VanishBridgeMessage: Creates and validates a vanish message.
VanishBridgeMessage.Action - Enum Class in dev.plex.network: Actions supported by the vanish message protocol.
VISIBLE - Enum constant in enum class dev.plex.network.VanishBridgeMessage.Action: Reports that the player is visible.

W

warn(String, Object...) - Method in interface dev.plex.api.logging.LoggingApi: Writes a warning log message.
WEB - Enum constant in enum class dev.plex.api.punishment.PunishmentSource: Punishment issued by a web or external integration.
word(String) - Method in class dev.plex.command.SimplePlexCommand

Z

ZonedDateTimeAdapter - Class in dev.plex.util.adapter: Gson adapter that stores ZonedDateTime values as epoch milliseconds in UTC.
ZonedDateTimeAdapter() - Constructor for class dev.plex.util.adapter.ZonedDateTimeAdapter: Creates a Gson adapter for ZonedDateTime.

A B C D E F G H I J K L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form