Oops... looks like the spiders padded through here
Add products to your cart and remove them from here Lets buyPhoenix SDK API Documentation
This page provides an overview of all public classes, interfaces, enums, and annotations in this project.
Packages
| Package | Contents |
|---|---|
| com.phoenixplugins.sdk.api | 1 interface |
| com.phoenixplugins.sdk.api.config | 5 interface |
| com.phoenixplugins.sdk.api.database | 1 interface, 1 annotation |
| com.phoenixplugins.sdk.api.exceptions | 6 class |
| com.phoenixplugins.sdk.api.internal | 3 interface |
| com.phoenixplugins.sdk.api.locales | 1 class |
| com.phoenixplugins.sdk.api.locales.providers | 2 interface |
| com.phoenixplugins.sdk.api.locales.translatable | 2 interface |
| com.phoenixplugins.sdk.api.logger | 1 interface |
| com.phoenixplugins.sdk.api.plugin | 2 interface |
| com.phoenixplugins.sdk.api.plugin.addons | 1 class, 2 interface |
| com.phoenixplugins.sdk.api.plugin.commands | 1 class, 4 interface |
| com.phoenixplugins.sdk.api.plugin.commands.components | 4 interface |
| com.phoenixplugins.sdk.api.plugin.commands.contexts | 3 interface |
| com.phoenixplugins.sdk.api.plugin.commands.parameters | 1 class, 1 interface |
| com.phoenixplugins.sdk.api.plugin.eventbus | 2 interface |
| com.phoenixplugins.sdk.api.plugin.extensions | 1 class, 1 interface |
| com.phoenixplugins.sdk.api.plugin.hooks | 3 interface |
| com.phoenixplugins.sdk.api.scheduler | 2 interface |
| com.phoenixplugins.sdk.api.text | 3 class, 1 interface |
| com.phoenixplugins.sdk.api.utilities | 2 class |
All Classes
| Class | Package | Description |
|---|---|---|
Interface
Platform
|
com.phoenixplugins.sdk.api |
Represents the underlying platform on which a plugin is running. |
Interface
ConfigurationProvider
|
com.phoenixplugins.sdk.api.config |
Provides methods for loading configuration files in YAML format. |
Interface
ConfigurationSection
|
com.phoenixplugins.sdk.api.config |
Represents a section of a configuration file, providing methods to retrieve and manipulate configuration values. |
Interface
DatabaseConfiguration
|
com.phoenixplugins.sdk.api.config |
Represents the configuration for a database connection, including both basic database settings and HikariCP connectio... |
Interface
PluginConfiguration
|
com.phoenixplugins.sdk.api.config |
Represents the configuration for a plugin, including database settings and internal thread pool settings. |
Interface
YamlConfiguration
|
com.phoenixplugins.sdk.api.config |
Represents a configuration file within any environment, providing methods for file management and manipulation. |
Interface
DbModel
|
com.phoenixplugins.sdk.api.database |
|
Annotation
DbTable
|
com.phoenixplugins.sdk.api.database |
|
Class
ActionExecutionArgumentException
|
com.phoenixplugins.sdk.api.exceptions |
|
Class
ActionExecutionException
|
com.phoenixplugins.sdk.api.exceptions |
|
Class
CommandContextException
|
com.phoenixplugins.sdk.api.exceptions |
Exception thrown when an invalid command argument is encountered. This exception supports translatable messages with ... |
Class
NotImplementedException
|
com.phoenixplugins.sdk.api.exceptions |
|
Class
ParameterParsingException
|
com.phoenixplugins.sdk.api.exceptions |
Exception thrown when an invalid command argument is encountered. This exception supports translatable messages with ... |
Class
ParameterValidationException
|
com.phoenixplugins.sdk.api.exceptions |
Exception thrown when an invalid command argument is encountered. This exception supports translatable messages with ... |
Interface
Actor
|
com.phoenixplugins.sdk.api.internal |
|
Interface
LifecycleObject
|
com.phoenixplugins.sdk.api.internal |
|
Interface
Wrappable
|
com.phoenixplugins.sdk.api.internal |
Represents an object that can be unwrapped to its original or underlying form. |
Class
Locale
|
com.phoenixplugins.sdk.api.locales |
Represents a locale with a language prefix and name. Uses Lombok annotations to generate boilerplate code automatically. |
Interface
TranslationFetcher
|
com.phoenixplugins.sdk.api.locales.providers |
Interface for fetching translations for supported locales. Implementations should return a NavigableMap where each ke... |
Interface
TranslationsProvider
|
com.phoenixplugins.sdk.api.locales.providers |
Provides translations for different locales and manages language resources. |
Interface
Translation
|
com.phoenixplugins.sdk.api.locales.translatable |
|
Interface
TranslationProvider
|
com.phoenixplugins.sdk.api.locales.translatable |
Defines a provider for translation keys. Classes implementing this interface must provide a translation key. |
Interface
Logger
|
com.phoenixplugins.sdk.api.logger |
Represents a logger for a platform, providing methods for different levels of logging. |
Interface
Plugin
|
com.phoenixplugins.sdk.api.plugin |
Represents a PhoenixPlugin that provides access to an EventBus. This allows plugins to manage events dynamically. |
Interface
PluginDescription
|
com.phoenixplugins.sdk.api.plugin |
Represents the description of a plugin, containing metadata and configuration details. |
Class
Addon
|
com.phoenixplugins.sdk.api.plugin.addons |
Represents an addon that can be loaded, enabled, and disabled within the plugin system. Addons are modular components... |
Interface
AddonDescription
|
com.phoenixplugins.sdk.api.plugin.addons |
Represents the description of an addon, including metadata such as its name, dependencies, and authors. This interfac... |
Interface
AddonRegistry
|
com.phoenixplugins.sdk.api.plugin.addons |
Manages the lifecycle of addons, including loading, enabling, disabling, and unloading addons. |
Class
ArgumentStack
|
com.phoenixplugins.sdk.api.plugin.commands |
|
Interface
Command
|
com.phoenixplugins.sdk.api.plugin.commands |
Represents a command that can be executed by an actor. |
Interface
CommandManager
|
com.phoenixplugins.sdk.api.plugin.commands |
|
Interface
CommandResolvers
|
com.phoenixplugins.sdk.api.plugin.commands |
|
Interface
Node
|
com.phoenixplugins.sdk.api.plugin.commands |
Represents a subcommand of a main command that can be executed separately. |
Interface
Executable
|
com.phoenixplugins.sdk.api.plugin.commands.components |
Represents an executable command interface. |
Interface
ObjectResolver
|
com.phoenixplugins.sdk.api.plugin.commands.components |
|
Interface
ParameterValidation
|
com.phoenixplugins.sdk.api.plugin.commands.components |
|
Interface
TabCompletion
|
com.phoenixplugins.sdk.api.plugin.commands.components |
|
Interface
FlagHandler
|
com.phoenixplugins.sdk.api.plugin.commands.contexts |
|
Interface
InvocationContext
|
com.phoenixplugins.sdk.api.plugin.commands.contexts |
Represents the execution context for a command, providing access to command-related data. |
Interface
ResolveContext
|
com.phoenixplugins.sdk.api.plugin.commands.contexts |
|
Class
ExecutionParameters
|
com.phoenixplugins.sdk.api.plugin.commands.parameters |
|
Interface
Parameter
|
com.phoenixplugins.sdk.api.plugin.commands.parameters |
|
Interface
EventBus
|
com.phoenixplugins.sdk.api.plugin.eventbus |
Interface for an EventBus system that supports both Spigot events and custom events. |
Interface
EventWrapper
|
com.phoenixplugins.sdk.api.plugin.eventbus |
|
Class
Extension
|
com.phoenixplugins.sdk.api.plugin.extensions |
Represents an extension that can be loaded, enabled, and disabled within the plugin system. Extensions are modularize... |
Interface
ExtensionRegistry
|
com.phoenixplugins.sdk.api.plugin.extensions |
Manages the lifecycle of extensions, including loading, enabling, disabling, and unloading extensions. |
Interface
Hook
|
com.phoenixplugins.sdk.api.plugin.hooks |
The Hook interface represents a lifecycle-managed hook that is responsible for interacting with the HookRegistry and ... |
Interface
HookProvider
|
com.phoenixplugins.sdk.api.plugin.hooks |
The HookProvider interface defines the contract for creating hooks to integrate with other plugins. |
Interface
HookRegistry
|
com.phoenixplugins.sdk.api.plugin.hooks |
Manages the lifecycle of hooks, including loading and unload hooks. |
Interface
Scheduler
|
com.phoenixplugins.sdk.api.scheduler |
Manages the scheduling and execution of tasks. |
Interface
Task
|
com.phoenixplugins.sdk.api.scheduler |
Represents a task that can be scheduled and later canceled. |
Class
PlainText
|
com.phoenixplugins.sdk.api.text |
A simple implementation of Text that represents plain, unformatted text. This class is mutable and supports appending... |
Class
ReplacementText
|
com.phoenixplugins.sdk.api.text |
|
Interface
Text
|
com.phoenixplugins.sdk.api.text |
Represents a text component that can be used for various purposes such as messages, inventories, etc. Provides method... |
Class
TextCompound
|
com.phoenixplugins.sdk.api.text |
|
Class
Lists
|
com.phoenixplugins.sdk.api.utilities |
|
Class
Validate
|
com.phoenixplugins.sdk.api.utilities |