Package org.bukkit.plugin
Interface PluginLoader
- All Known Implementing Classes:
JavaPluginLoader
Deprecated, for removal: This API element is subject to removal in a future version.
Represents a plugin loader, which handles direct access to specific types
of plugins
-
Method Summary
Modifier and TypeMethodDescriptioncreateRegisteredListeners
(@NotNull Listener listener, @NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Creates and returns registered listeners for the event classes used in this listenervoid
disablePlugin
(@NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Disables the specified pluginvoid
enablePlugin
(@NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Enables the specified plugingetPluginDescription
(@NotNull File file) Deprecated, for removal: This API element is subject to removal in a future version.Loads a PluginDescriptionFile from the specified fileDeprecated, for removal: This API element is subject to removal in a future version.Returns a list of all filename filters expected by this PluginLoaderloadPlugin
(@NotNull File file) Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugin contained in the specified file
-
Method Details
-
loadPlugin
@NotNull @NotNull Plugin loadPlugin(@NotNull @NotNull File file) throws InvalidPluginException, UnknownDependencyException Deprecated, for removal: This API element is subject to removal in a future version.Loads the plugin contained in the specified file- Parameters:
file
- File to attempt to load- Returns:
- Plugin that was contained in the specified file, or null if unsuccessful
- Throws:
InvalidPluginException
- Thrown when the specified file is not a pluginUnknownDependencyException
- If a required dependency could not be found
-
getPluginDescription
@NotNull @NotNull PluginDescriptionFile getPluginDescription(@NotNull @NotNull File file) throws InvalidDescriptionException Deprecated, for removal: This API element is subject to removal in a future version.Loads a PluginDescriptionFile from the specified file- Parameters:
file
- File to attempt to load from- Returns:
- A new PluginDescriptionFile loaded from the plugin.yml in the specified file
- Throws:
InvalidDescriptionException
- If the plugin description file could not be created
-
getPluginFileFilters
Deprecated, for removal: This API element is subject to removal in a future version.Returns a list of all filename filters expected by this PluginLoader- Returns:
- The filters
-
createRegisteredListeners
@NotNull @NotNull Map<Class<? extends Event>,Set<RegisteredListener>> createRegisteredListeners(@NotNull @NotNull Listener listener, @NotNull @NotNull Plugin plugin) Deprecated, for removal: This API element is subject to removal in a future version.Creates and returns registered listeners for the event classes used in this listener- Parameters:
listener
- The object that will handle the eventual call backplugin
- The plugin to use when creating registered listeners- Returns:
- The registered listeners.
-
enablePlugin
Deprecated, for removal: This API element is subject to removal in a future version.Enables the specified pluginAttempting to enable a plugin that is already enabled will have no effect
- Parameters:
plugin
- Plugin to enable
-
disablePlugin
Deprecated, for removal: This API element is subject to removal in a future version.Disables the specified pluginAttempting to disable a plugin that is not enabled will have no effect
- Parameters:
plugin
- Plugin to disable
-