All Superinterfaces:

LifecycleObject
```
public interface Plugin
extends LifecycleObject
```
Represents a PhoenixPlugin that provides access to an EventBus. This allows plugins to manage events dynamically.

Method Summary

Modifier and Type	Method and Description
`@NotNull AddonRegistry`	`getAddonRegistry()` Retrieves the AddonRegistry for this plugin.
`@NotNull CommandManager`	`getCommandManager()` Gets the command registry responsible for managing commands.
`PluginConfiguration`	`getConfiguration()`
`ConfigurationProvider`	`getConfigurationProvider()` Gets the configuration provider responsible for handling configurations.
`File`	`getDataFolder()` Gets the data folder associated with this plugin or proxy component.
`PluginDescription`	`getDescription()` Retrieves the plugin description
`@NotNull EventBus`	`getEventBus()` Retrieves the EventBus instance associated with this plugin.
`@NotNull ExtensionRegistry`	`getExtensionRegistry()` Retrieves the ExtensionRegistry for this plugin.
`@NotNull HookRegistry`	`getHookRegistry()` Retrieves the HookRegistry for this plugin.
`Logger`	`getLogger()` Gets the logger associated with this instance for logging messages.
`String`	`getName()` Retrieves the plugin name
`Platform`	`getPlatform()` Gets the underlying platform the proxy or plugin is running on.
`InputStream`	`getResource(String resourceName)` Retrieves a resource as an input stream.
`Scheduler`	`getScheduler()` Gets the scheduler associated with this plugin for managing tasks.
`@NotNull TranslationsProvider`	`getTranslationsProvider()` Retrieves the TranslationsProvider for this plugin.
`boolean`	`isEnabled()`

Methods inherited from interface com.phoenixplugins.sdk.api.internal.LifecycleObject
init, load, massInit, massLoad, massReload, massUnload, reload, unload

- Method Detail
  - getPlatform
```
Platform getPlatform()
```
    Gets the underlying platform the proxy or plugin is running on.
    
    Returns:
    
    the Platform instance, such as Spigot, Velocity, or BungeeCord
  - getLogger
```
Logger getLogger()
```
    Gets the logger associated with this instance for logging messages.
    
    Returns:
    
    the Logger instance
  - getScheduler
```
Scheduler getScheduler()
```
    Gets the scheduler associated with this plugin for managing tasks.
    
    Returns:
    
    the Scheduler instance
  - getEventBus
```
@NotNull
@NotNull EventBus getEventBus()
```
    Retrieves the EventBus instance associated with this plugin. The EventBus is responsible for handling event subscriptions and triggers.
    
    Returns:
    
    The EventBus instance.
  - getCommandManager
```
@NotNull
@NotNull CommandManager getCommandManager()
```
    Gets the command registry responsible for managing commands.
    
    Returns:
    
    the CommandManager instance
  - getAddonRegistry
```
@NotNull
@NotNull AddonRegistry getAddonRegistry()
```
    Retrieves the AddonRegistry for this plugin. The AddonRegistry is responsible for managing plugin addons dynamically. It allows for loading and unloading addons as needed.
    
    Returns:
    
    The AddonsRegistry instance.
  - getExtensionRegistry
```
@NotNull
@NotNull ExtensionRegistry getExtensionRegistry()
```
    Retrieves the ExtensionRegistry for this plugin. The ExtensionRegistry is responsible for managing plugin addons dynamically. It allows for loading and unloading addons as needed.
    
    Returns:
    
    The AddonsRegistry instance.
  - getHookRegistry
```
@NotNull
@NotNull HookRegistry getHookRegistry()
```
    Retrieves the HookRegistry for this plugin. The HookRegistry is responsible for handling integrations with external plugins and services. It allows registering and unregistering hooks dynamically.
    
    Returns:
    
    The HooksManager instance.
  - getTranslationsProvider
```
@NotNull
@NotNull TranslationsProvider getTranslationsProvider()
```
    Retrieves the TranslationsProvider for this plugin. TranslationsProvider is responsible for providing translations for different locales and manages language resources.
    
    Returns:
    
    The TranslationsProvider instance
  - getConfigurationProvider
```
ConfigurationProvider getConfigurationProvider()
```
    Gets the configuration provider responsible for handling configurations.
    
    Returns:
    
    the ConfigurationProvider instance
  - getName
```
String getName()
```
    Retrieves the plugin name
    
    Returns:
    
    The Plugin name.
  - getDescription
```
PluginDescription getDescription()
```
    Retrieves the plugin description
    
    Returns:
    
    The Plugin description.
  - getDataFolder
```
File getDataFolder()
```
    Gets the data folder associated with this plugin or proxy component.
    
    Returns:
    
    the File representing the data folder
  - getResource
```
InputStream getResource(String resourceName)
```
    Retrieves a resource as an input stream.
    
    Parameters:
    
    resourceName - the name of the resource to retrieve
    
    Returns:
    
    an InputStream for the resource, or null if not found
  - isEnabled
```
boolean isEnabled()
```
  - getConfiguration
```
PluginConfiguration getConfiguration()
```

Last updated about 4 hours ago

Interface Plugin

Method Summary

Methods inherited from interface com.phoenixplugins.sdk.api.internal.LifecycleObject

Method Detail

getPlatform

getLogger

getScheduler

getEventBus

getCommandManager

getAddonRegistry

getExtensionRegistry

getHookRegistry

getTranslationsProvider

getConfigurationProvider

getName

getDescription

getDataFolder

getResource

isEnabled

getConfiguration