Uses of Interface
org.bukkit.plugin.Plugin
Package
Description
The root package of the Bukkit API, contains generalized API classes.
Classes relating to handling specialized non-chat player input.
Classes dedicated to facilitate direct player-to-plugin communication.
Interfaces for non-voxel objects that can exist in a
world
, including all players, monsters, projectiles, etc.Classes dedicated to handling triggered code executions.
Events
relating to programmatic state
changes on the server.Classes dedicated to providing a layer of plugin specified data on various
Minecraft concepts.
Classes dedicated to providing binary state properties to players.
Classes specifically relating to loading software modules at runtime.
Classes for handling
plugins
written in
java.Classes dedicated to specialized plugin to client protocols.
Classes dedicated to letting
plugins
run
code at specific time intervals, including thread safety.-
Uses of Plugin in org.bukkit
Modifier and TypeMethodDescriptionChunk.getPluginChunkTickets()
Retrieves a collection specifying which plugins have tickets for this chunk.World.getPluginChunkTickets()
Returns a map of which plugins have tickets for what chunks.World.getPluginChunkTickets
(int x, int z) Retrieves a collection specifying which plugins have tickets for the specified chunk.Modifier and TypeMethodDescriptionboolean
Chunk.addPluginChunkTicket
(Plugin plugin) Adds a plugin ticket for this chunk, loading this chunk if it is not already loaded.boolean
World.addPluginChunkTicket
(int x, int z, Plugin plugin) Adds a plugin ticket for the specified chunk, loading the chunk if it is not already loaded.static NamespacedKey
NamespacedKey.fromString
(String string, Plugin defaultNamespace) Get a NamespacedKey from the supplied string with a default namespace if a namespace is not defined.boolean
Chunk.removePluginChunkTicket
(Plugin plugin) Removes the specified plugin's ticket for this chunkboolean
World.removePluginChunkTicket
(int x, int z, Plugin plugin) Removes the specified plugin's ticket for the specified chunkvoid
World.removePluginChunkTickets
(Plugin plugin) Removes all plugin tickets for the specified pluginModifierConstructorDescriptionNamespacedKey
(Plugin plugin, String key) Create a key in the plugin's namespace. -
Uses of Plugin in org.bukkit.command
Modifier and TypeMethodDescriptionPluginCommand.getPlugin()
Gets the owner of this PluginCommandPluginIdentifiableCommand.getPlugin()
Gets the owner of this PluginIdentifiableCommand.Modifier and TypeMethodDescription -
Uses of Plugin in org.bukkit.conversations
Modifier and TypeFieldDescriptionprotected Plugin
ConversationFactory.plugin
protected Plugin
InactivityConversationCanceller.plugin
protected Plugin
PluginNameConversationPrefix.plugin
Modifier and TypeMethodDescriptionConversationContext.getPlugin()
Gets the plugin that owns this conversation.ModifierConstructorDescriptionConversation
(Plugin plugin, Conversable forWhom, Prompt firstPrompt) Initializes a new Conversation.Conversation
(Plugin plugin, Conversable forWhom, Prompt firstPrompt, Map<Object, Object> initialSessionData) Initializes a new Conversation.ConversationContext
(Plugin plugin, Conversable forWhom, Map<Object, Object> initialSessionData) ConversationFactory
(Plugin plugin) Constructs a ConversationFactory.InactivityConversationCanceller
(Plugin plugin, int timeoutSeconds) Creates an InactivityConversationCanceller.PlayerNamePrompt
(Plugin plugin) PluginNameConversationPrefix
(Plugin plugin) PluginNameConversationPrefix
(Plugin plugin, String separator, ChatColor prefixColor) -
Uses of Plugin in org.bukkit.entity
Modifier and TypeMethodDescriptionvoid
Player.hideEntity
(Plugin plugin, Entity entity) Deprecated.draft APIvoid
Player.hidePlayer
(Plugin plugin, Player player) Hides a player from this playervoid
Player.showEntity
(Plugin plugin, Entity entity) Deprecated.draft APIvoid
Player.showPlayer
(Plugin plugin, Player player) Allows this player to see a player that was previously hidden. -
Uses of Plugin in org.bukkit.event
Modifier and TypeMethodDescriptionstatic ArrayList<RegisteredListener>
HandlerList.getRegisteredListeners
(Plugin plugin) Get a specific plugin's registered listeners associated with this handler listvoid
HandlerList.unregister
(Plugin plugin) Remove a specific plugin's listeners from this handlerstatic void
HandlerList.unregisterAll
(Plugin plugin) Unregister a specific plugin's listeners from all handler lists. -
Uses of Plugin in org.bukkit.event.server
ModifierConstructorDescriptionPluginDisableEvent
(Plugin plugin) PluginEnableEvent
(Plugin plugin) PluginEvent
(Plugin plugin) -
Uses of Plugin in org.bukkit.metadata
Modifier and TypeFieldDescriptionprotected final WeakReference<Plugin>
MetadataValueAdapter.owningPlugin
Modifier and TypeMethodDescriptionMetadataValue.getOwningPlugin()
Returns thePlugin
that created this metadata item.MetadataValueAdapter.getOwningPlugin()
Modifier and TypeMethodDescriptionvoid
MetadataStore.invalidateAll
(Plugin owningPlugin) Invalidates all metadata in the metadata store that originates from the given plugin.void
MetadataStoreBase.invalidateAll
(Plugin owningPlugin) Invalidates all metadata in the metadata store that originates from the given plugin.void
Metadatable.removeMetadata
(String metadataKey, Plugin owningPlugin) Removes the given metadata value from the implementing object's metadata store.void
MetadataStore.removeMetadata
(T subject, String metadataKey, Plugin owningPlugin) Removes a metadata item owned by a plugin from a subject.void
MetadataStoreBase.removeMetadata
(T subject, String metadataKey, Plugin owningPlugin) Removes a metadata item owned by a plugin from a subject.ModifierConstructorDescriptionFixedMetadataValue
(Plugin owningPlugin, Object value) Initializes a FixedMetadataValue with an Objectprotected
LazyMetadataValue
(Plugin owningPlugin) Protected special constructor used by FixedMetadataValue to bypass standard setup.LazyMetadataValue
(Plugin owningPlugin, Callable<Object> lazyValue) Initialized a LazyMetadataValue object with the default CACHE_AFTER_FIRST_EVAL cache strategy.LazyMetadataValue
(Plugin owningPlugin, LazyMetadataValue.CacheStrategy cacheStrategy, Callable<Object> lazyValue) Initializes a LazyMetadataValue object with a specific cache strategy.protected
MetadataValueAdapter
(Plugin owningPlugin) -
Uses of Plugin in org.bukkit.permissions
Modifier and TypeMethodDescriptionPermissionAttachment.getPlugin()
Gets the plugin responsible for this attachmentModifier and TypeMethodDescriptionPermissible.addAttachment
(Plugin plugin) Adds a new emptyPermissionAttachment
to this objectPermissible.addAttachment
(Plugin plugin, int ticks) Temporarily adds a new emptyPermissionAttachment
to this objectPermissible.addAttachment
(Plugin plugin, String name, boolean value) Adds a newPermissionAttachment
with a single permission by name and valuePermissible.addAttachment
(Plugin plugin, String name, boolean value, int ticks) Temporarily adds a newPermissionAttachment
with a single permission by name and valuePermissibleBase.addAttachment
(Plugin plugin) PermissibleBase.addAttachment
(Plugin plugin, int ticks) PermissibleBase.addAttachment
(Plugin plugin, String name, boolean value) PermissibleBase.addAttachment
(Plugin plugin, String name, boolean value, int ticks) -
Uses of Plugin in org.bukkit.plugin
Modifier and TypeMethodDescriptionChecks if the given plugin is loaded and returns it when applicableRegisteredListener.getPlugin()
Gets the plugin for this registrationRegisteredServiceProvider.getPlugin()
Checks if the given plugin is loaded and returns it when applicablePlugin[]
PluginManager.getPlugins()
Gets a list of all currently loaded pluginsPlugin[]
SimplePluginManager.getPlugins()
PluginLoader.loadPlugin
(File file) Loads the plugin contained in the specified filePluginManager.loadPlugin
(File file) Loads the plugin in the specified fileSimplePluginManager.loadPlugin
(File file) Loads the plugin in the specified filePlugin[]
PluginManager.loadPlugins
(File directory) Loads the plugins contained within the specified directoryPlugin[]
SimplePluginManager.loadPlugins
(File directory) Loads the plugins contained within the specified directoryModifier and TypeMethodDescriptionMap<Class<? extends Event>,
Set<RegisteredListener>> PluginLoader.createRegisteredListeners
(Listener listener, Plugin plugin) Creates and returns registered listeners for the event classes used in this listenervoid
PluginLoader.disablePlugin
(Plugin plugin) Disables the specified pluginvoid
PluginManager.disablePlugin
(Plugin plugin) Disables the specified pluginvoid
SimplePluginManager.disablePlugin
(Plugin plugin) void
PluginLoader.enablePlugin
(Plugin plugin) Enables the specified pluginvoid
PluginManager.enablePlugin
(Plugin plugin) Enables the specified pluginvoid
SimplePluginManager.enablePlugin
(Plugin plugin) ServicesManager.getRegistrations
(Plugin plugin) Get registrations of providers for a plugin.SimpleServicesManager.getRegistrations
(Plugin plugin) Get registrations of providers for a plugin.boolean
PluginManager.isPluginEnabled
(Plugin plugin) Checks if the given plugin is enabled or notboolean
SimplePluginManager.isPluginEnabled
(Plugin plugin) Checks if the given plugin is enabled or not<T> void
ServicesManager.register
(Class<T> service, T provider, Plugin plugin, ServicePriority priority) Register a provider of a service.<T> void
SimpleServicesManager.register
(Class<T> service, T provider, Plugin plugin, ServicePriority priority) Register a provider of a service.void
PluginManager.registerEvent
(Class<? extends Event> event, Listener listener, EventPriority priority, EventExecutor executor, Plugin plugin) Registers the specified executor to the given event classvoid
PluginManager.registerEvent
(Class<? extends Event> event, Listener listener, EventPriority priority, EventExecutor executor, Plugin plugin, boolean ignoreCancelled) Registers the specified executor to the given event classvoid
SimplePluginManager.registerEvent
(Class<? extends Event> event, Listener listener, EventPriority priority, EventExecutor executor, Plugin plugin) void
SimplePluginManager.registerEvent
(Class<? extends Event> event, Listener listener, EventPriority priority, EventExecutor executor, Plugin plugin, boolean ignoreCancelled) Registers the given event to the specified listener using a directly passed EventExecutorvoid
PluginManager.registerEvents
(Listener listener, Plugin plugin) Registers all the events in the given listener classvoid
SimplePluginManager.registerEvents
(Listener listener, Plugin plugin) void
ServicesManager.unregisterAll
(Plugin plugin) Unregister all the providers registered by a particular plugin.void
SimpleServicesManager.unregisterAll
(Plugin plugin) Unregister all the providers registered by a particular plugin.ModifierConstructorDescriptionPluginLogger
(Plugin context) Creates a new PluginLogger that extracts the name from a plugin.RegisteredListener
(Listener listener, EventExecutor executor, EventPriority priority, Plugin plugin, boolean ignoreCancelled) RegisteredServiceProvider
(Class<T> service, T provider, ServicePriority priority, Plugin plugin) TimedRegisteredListener
(Listener pluginListener, EventExecutor eventExecutor, EventPriority eventPriority, Plugin registeredPlugin, boolean listenCancelled) -
Uses of Plugin in org.bukkit.plugin.java
Modifier and TypeMethodDescriptionMap<Class<? extends Event>,
Set<RegisteredListener>> JavaPluginLoader.createRegisteredListeners
(Listener listener, Plugin plugin) void
JavaPluginLoader.disablePlugin
(Plugin plugin) void
JavaPluginLoader.enablePlugin
(Plugin plugin) -
Uses of Plugin in org.bukkit.plugin.messaging
Modifier and TypeMethodDescriptionPluginMessageListenerRegistration.getPlugin()
Gets the plugin that this registration is for.Modifier and TypeMethodDescriptionMessenger.getIncomingChannelRegistrations
(Plugin plugin) Gets a set containing all the incoming plugin channel registrations that the specified plugin has.Messenger.getIncomingChannelRegistrations
(Plugin plugin, String channel) Gets a set containing all the incoming plugin channel registrations that the specified plugin has on the requested channel.StandardMessenger.getIncomingChannelRegistrations
(Plugin plugin) StandardMessenger.getIncomingChannelRegistrations
(Plugin plugin, String channel) Messenger.getIncomingChannels
(Plugin plugin) Gets a set containing all the incoming plugin channels that the specified plugin is registered for.StandardMessenger.getIncomingChannels
(Plugin plugin) Messenger.getOutgoingChannels
(Plugin plugin) Gets a set containing all the outgoing plugin channels that the specified plugin is registered to.StandardMessenger.getOutgoingChannels
(Plugin plugin) boolean
Messenger.isIncomingChannelRegistered
(Plugin plugin, String channel) Checks if the specified plugin has registered to receive incoming messages through the requested channel.boolean
StandardMessenger.isIncomingChannelRegistered
(Plugin plugin, String channel) boolean
Messenger.isOutgoingChannelRegistered
(Plugin plugin, String channel) Checks if the specified plugin has registered to send outgoing messages through the requested channel.boolean
StandardMessenger.isOutgoingChannelRegistered
(Plugin plugin, String channel) Messenger.registerIncomingPluginChannel
(Plugin plugin, String channel, PluginMessageListener listener) Registers the specific plugin for listening on the requested incoming plugin channel, allowing it to act upon any plugin messages.StandardMessenger.registerIncomingPluginChannel
(Plugin plugin, String channel, PluginMessageListener listener) void
Messenger.registerOutgoingPluginChannel
(Plugin plugin, String channel) Registers the specific plugin to the requested outgoing plugin channel, allowing it to send messages through that channel to any clients.void
StandardMessenger.registerOutgoingPluginChannel
(Plugin plugin, String channel) void
PluginMessageRecipient.sendPluginMessage
(Plugin source, String channel, byte[] message) Sends this recipient a Plugin Message on the specified outgoing channel.void
Messenger.unregisterIncomingPluginChannel
(Plugin plugin) Unregisters the specific plugin from listening on all plugin channels through all listeners.void
Messenger.unregisterIncomingPluginChannel
(Plugin plugin, String channel) Unregisters the specific plugin from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.void
Messenger.unregisterIncomingPluginChannel
(Plugin plugin, String channel, PluginMessageListener listener) Unregisters the specific plugin's listener from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.void
StandardMessenger.unregisterIncomingPluginChannel
(Plugin plugin) void
StandardMessenger.unregisterIncomingPluginChannel
(Plugin plugin, String channel) void
StandardMessenger.unregisterIncomingPluginChannel
(Plugin plugin, String channel, PluginMessageListener listener) void
Messenger.unregisterOutgoingPluginChannel
(Plugin plugin) Unregisters the specific plugin from all outgoing plugin channels, no longer allowing it to send any plugin messages.void
Messenger.unregisterOutgoingPluginChannel
(Plugin plugin, String channel) Unregisters the specific plugin from the requested outgoing plugin channel, no longer allowing it to send messages through that channel to any clients.void
StandardMessenger.unregisterOutgoingPluginChannel
(Plugin plugin) void
StandardMessenger.unregisterOutgoingPluginChannel
(Plugin plugin, String channel) static void
StandardMessenger.validatePluginMessage
(Messenger messenger, Plugin source, String channel, byte[] message) Validates the input of a Plugin Message, ensuring the arguments are all valid.ModifierConstructorDescriptionPluginMessageListenerRegistration
(Messenger messenger, Plugin plugin, String channel, PluginMessageListener listener) -
Uses of Plugin in org.bukkit.scheduler
Modifier and TypeMethodDescriptionBukkitTask.getOwner()
Returns the Plugin that owns this task.BukkitWorker.getOwner()
Returns the Plugin that owns this task.Modifier and TypeMethodDescription<T> Future<T>
BukkitScheduler.callSyncMethod
(Plugin plugin, Callable<T> task) Calls a method on the main thread and returns a Future object.void
BukkitScheduler.cancelTasks
(Plugin plugin) Removes all tasks associated with a particular plugin from the scheduler.Schedules this in the Bukkit scheduler to run on next tick.Returns a task that will run on the next server tick.void
BukkitScheduler.runTask
(Plugin plugin, Consumer<BukkitTask> task) Returns a task that will run on the next server tick.BukkitScheduler.runTask
(Plugin plugin, BukkitRunnable task) Deprecated.BukkitRunnable.runTaskAsynchronously
(Plugin plugin) Asynchronous tasks should never access any API in Bukkit.BukkitScheduler.runTaskAsynchronously
(Plugin plugin, Runnable task) Asynchronous tasks should never access any API in Bukkit. Great care should be taken to assure the thread-safety of asynchronous tasks.void
BukkitScheduler.runTaskAsynchronously
(Plugin plugin, Consumer<BukkitTask> task) Asynchronous tasks should never access any API in Bukkit. Great care should be taken to assure the thread-safety of asynchronous tasks.BukkitScheduler.runTaskAsynchronously
(Plugin plugin, BukkitRunnable task) Deprecated.BukkitRunnable.runTaskLater
(Plugin plugin, long delay) Schedules this to run after the specified number of server ticks.BukkitScheduler.runTaskLater
(Plugin plugin, Runnable task, long delay) Returns a task that will run after the specified number of server ticks.void
BukkitScheduler.runTaskLater
(Plugin plugin, Consumer<BukkitTask> task, long delay) Returns a task that will run after the specified number of server ticks.BukkitScheduler.runTaskLater
(Plugin plugin, BukkitRunnable task, long delay) Deprecated.BukkitRunnable.runTaskLaterAsynchronously
(Plugin plugin, long delay) Asynchronous tasks should never access any API in Bukkit.BukkitScheduler.runTaskLaterAsynchronously
(Plugin plugin, Runnable task, long delay) Asynchronous tasks should never access any API in Bukkit. Great care should be taken to assure the thread-safety of asynchronous tasks.void
BukkitScheduler.runTaskLaterAsynchronously
(Plugin plugin, Consumer<BukkitTask> task, long delay) Asynchronous tasks should never access any API in Bukkit. Great care should be taken to assure the thread-safety of asynchronous tasks.BukkitScheduler.runTaskLaterAsynchronously
(Plugin plugin, BukkitRunnable task, long delay) Deprecated.BukkitRunnable.runTaskTimer
(Plugin plugin, long delay, long period) Schedules this to repeatedly run until cancelled, starting after the specified number of server ticks.BukkitScheduler.runTaskTimer
(Plugin plugin, Runnable task, long delay, long period) Returns a task that will repeatedly run until cancelled, starting after the specified number of server ticks.void
BukkitScheduler.runTaskTimer
(Plugin plugin, Consumer<BukkitTask> task, long delay, long period) Returns a task that will repeatedly run until cancelled, starting after the specified number of server ticks.BukkitScheduler.runTaskTimer
(Plugin plugin, BukkitRunnable task, long delay, long period) Deprecated.BukkitRunnable.runTaskTimerAsynchronously
(Plugin plugin, long delay, long period) Asynchronous tasks should never access any API in Bukkit.BukkitScheduler.runTaskTimerAsynchronously
(Plugin plugin, Runnable task, long delay, long period) Asynchronous tasks should never access any API in Bukkit. Great care should be taken to assure the thread-safety of asynchronous tasks.void
BukkitScheduler.runTaskTimerAsynchronously
(Plugin plugin, Consumer<BukkitTask> task, long delay, long period) Asynchronous tasks should never access any API in Bukkit. Great care should be taken to assure the thread-safety of asynchronous tasks.BukkitScheduler.runTaskTimerAsynchronously
(Plugin plugin, BukkitRunnable task, long delay, long period) Deprecated.int
BukkitScheduler.scheduleAsyncDelayedTask
(Plugin plugin, Runnable task) Deprecated.This name is misleading, as it does not schedule "a sync" task, but rather, "an async" taskint
BukkitScheduler.scheduleAsyncDelayedTask
(Plugin plugin, Runnable task, long delay) Deprecated.This name is misleading, as it does not schedule "a sync" task, but rather, "an async" taskint
BukkitScheduler.scheduleAsyncRepeatingTask
(Plugin plugin, Runnable task, long delay, long period) Deprecated.This name is misleading, as it does not schedule "a sync" task, but rather, "an async" taskint
BukkitScheduler.scheduleSyncDelayedTask
(Plugin plugin, Runnable task) Schedules a once off task to occur as soon as possible.int
BukkitScheduler.scheduleSyncDelayedTask
(Plugin plugin, Runnable task, long delay) Schedules a once off task to occur after a delay.int
BukkitScheduler.scheduleSyncDelayedTask
(Plugin plugin, BukkitRunnable task) Deprecated.int
BukkitScheduler.scheduleSyncDelayedTask
(Plugin plugin, BukkitRunnable task, long delay) Deprecated.int
BukkitScheduler.scheduleSyncRepeatingTask
(Plugin plugin, Runnable task, long delay, long period) Schedules a repeating task.int
BukkitScheduler.scheduleSyncRepeatingTask
(Plugin plugin, BukkitRunnable task, long delay, long period) Deprecated.