Package | Description |
---|---|
org.bukkit.event.block | |
org.bukkit.event.enchantment |
Events triggered from an enchantment table . |
org.bukkit.event.entity | |
org.bukkit.event.hanging |
Events relating to entities that hang . |
org.bukkit.event.inventory | |
org.bukkit.event.player | |
org.bukkit.event.raid | |
org.bukkit.event.server |
Events relating to programmatic state
changes on the server. |
org.bukkit.event.vehicle |
Events relating to vehicular entities . |
org.bukkit.event.weather |
Events relating to weather. |
org.bukkit.event.world | |
org.bukkit.plugin |
Classes specifically relating to loading software modules at runtime.
|
org.bukkit.plugin.java |
Classes for handling
plugins written in
java. |
org.spigotmc.event.entity | |
org.spigotmc.event.player |
Modifier and Type | Class | Description |
---|---|---|
class |
BlockBreakEvent |
Called when a block is broken by a player.
|
class |
BlockBurnEvent |
Called when a block is destroyed as a result of being burnt by fire.
|
class |
BlockCanBuildEvent |
Called when we try to place a block, to see if we can build it here or not.
|
class |
BlockCookEvent |
Called when an ItemStack is successfully cooked in a block.
|
class |
BlockDamageEvent |
Called when a block is damaged by a player.
|
class |
BlockDispenseArmorEvent |
Called when an equippable item is dispensed from a block and equipped on a
nearby entity.
|
class |
BlockDispenseEvent |
Called when an item is dispensed from a block.
|
class |
BlockDropItemEvent |
Called if a block broken by a player drops an item.
|
class |
BlockEvent |
Represents a block related event.
|
class |
BlockExpEvent |
An event that's called when a block yields experience.
|
class |
BlockExplodeEvent |
Called when a block explodes
|
class |
BlockFadeEvent |
Called when a block fades, melts or disappears based on world conditions
|
class |
BlockFertilizeEvent |
Called with the block changes resulting from a player fertilizing a given
block with bonemeal.
|
class |
BlockFormEvent |
Called when a block is formed or spreads based on world conditions.
|
class |
BlockFromToEvent |
Represents events with a source block and a destination block, currently
only applies to liquid (lava and water) and teleporting dragon eggs.
|
class |
BlockGrowEvent |
Called when a block grows naturally in the world.
|
class |
BlockIgniteEvent |
Called when a block is ignited.
|
class |
BlockMultiPlaceEvent |
Fired when a single block placement action of a player triggers the
creation of multiple blocks(e.g.
|
class |
BlockPhysicsEvent |
Thrown when a block physics check is called.
|
class |
BlockPistonEvent |
Called when a piston block is triggered
|
class |
BlockPistonExtendEvent |
Called when a piston extends
|
class |
BlockPistonRetractEvent |
Called when a piston retracts
|
class |
BlockPlaceEvent |
Called when a block is placed by a player.
|
class |
BlockRedstoneEvent |
Called when a redstone current changes
|
class |
BlockShearEntityEvent |
Event fired when a dispenser shears a nearby sheep.
|
class |
BlockSpreadEvent |
Called when a block spreads based on world conditions.
|
class |
CauldronLevelChangeEvent |
|
class |
EntityBlockFormEvent |
Called when a block is formed by entities.
|
class |
FluidLevelChangeEvent |
Called when the fluid level of a block changes due to changes in adjacent
blocks.
|
class |
LeavesDecayEvent |
Called when leaves are decaying naturally.
|
class |
MoistureChangeEvent |
Called when the moisture level of a soil block changes.
|
class |
NotePlayEvent |
Called when a note block is being played through player interaction or a
redstone current.
|
class |
SignChangeEvent |
Called when a sign is changed by a player.
|
class |
SpongeAbsorbEvent |
Called when a sponge absorbs water from the world.
|
Modifier and Type | Class | Description |
---|---|---|
class |
EnchantItemEvent |
Called when an ItemStack is successfully enchanted (currently at
enchantment table)
|
class |
PrepareItemEnchantEvent |
Called when an ItemStack is inserted in an enchantment table - can be
called multiple times
|
Modifier and Type | Class | Description |
---|---|---|
class |
AreaEffectCloudApplyEvent |
Called when a lingering potion applies it's effects.
|
class |
BatToggleSleepEvent |
Called when a bat attempts to sleep or wake up from its slumber.
|
class |
CreatureSpawnEvent |
Called when a creature is spawned into a world.
|
class |
CreeperPowerEvent |
Called when a Creeper is struck by lightning.
|
class |
EnderDragonChangePhaseEvent |
Called when an EnderDragon switches controller phase.
|
class |
EntityAirChangeEvent |
Called when the amount of air an entity has remaining changes.
|
class |
EntityBreakDoorEvent |
Called when an
Entity breaks a door |
class |
EntityBreedEvent |
Called when one Entity breeds with another Entity.
|
class |
EntityChangeBlockEvent |
Called when any Entity, excluding players, changes a block.
|
class |
EntityCombustByBlockEvent |
Called when a block causes an entity to combust.
|
class |
EntityCombustByEntityEvent |
Called when an entity causes another entity to combust.
|
class |
EntityCombustEvent |
Called when an entity combusts.
|
class |
EntityCreatePortalEvent |
Deprecated.
|
class |
EntityDamageByBlockEvent |
Called when an entity is damaged by a block
|
class |
EntityDamageByEntityEvent |
Called when an entity is damaged by an entity
|
class |
EntityDamageEvent |
Stores data for damage events
|
class |
EntityDeathEvent |
Thrown whenever a LivingEntity dies
|
class |
EntityDropItemEvent |
Thrown when an entity creates an item drop.
|
class |
EntityEvent |
Represents an Entity-related event
|
class |
EntityExplodeEvent |
Called when an entity explodes
|
class |
EntityInteractEvent |
Called when an entity interacts with an object
|
class |
EntityPickupItemEvent |
Thrown when a entity picks an item up from the ground
|
class |
EntityPlaceEvent |
Deprecated.
draft API
|
class |
EntityPortalEnterEvent |
Called when an entity comes into contact with a portal
|
class |
EntityPortalEvent |
Called when a non-player entity is about to teleport because it is in
contact with a portal.
|
class |
EntityPortalExitEvent |
Called before an entity exits a portal.
|
class |
EntityPoseChangeEvent |
Called when an entity changes its pose.
|
class |
EntityPotionEffectEvent |
Called when a potion effect is modified on an entity.
|
class |
EntityRegainHealthEvent |
Stores data for health-regain events
|
class |
EntityResurrectEvent |
Called when an entity dies and may have the opportunity to be resurrected.
|
class |
EntityShootBowEvent |
Called when a LivingEntity shoots a bow firing an arrow
|
class |
EntitySpawnEvent |
Called when an entity is spawned into a world.
|
class |
EntityTameEvent |
Thrown when a LivingEntity is tamed
|
class |
EntityTargetEvent |
Called when a creature targets or untargets another entity
|
class |
EntityTargetLivingEntityEvent |
Called when an Entity targets a
LivingEntity and can only target
LivingEntity's. |
class |
EntityTeleportEvent |
Thrown when a non-player entity is teleported from one location to another.
|
class |
EntityToggleGlideEvent |
Sent when an entity's gliding status is toggled with an Elytra.
|
class |
EntityToggleSwimEvent |
Sent when an entity's swimming status is toggled.
|
class |
EntityTransformEvent |
Called when an entity is about to be replaced by another entity.
|
class |
EntityUnleashEvent |
Called immediately prior to an entity being unleashed.
|
class |
ExpBottleEvent |
Called when a ThrownExpBottle hits and releases experience.
|
class |
ExplosionPrimeEvent |
Called when an entity has made a decision to explode.
|
class |
FireworkExplodeEvent |
Called when a firework explodes.
|
class |
FoodLevelChangeEvent |
Called when a human entity's food level changes
|
class |
HorseJumpEvent |
Called when a horse jumps.
|
class |
ItemDespawnEvent |
This event is called when a
Item is removed from
the world because it has existed for 5 minutes. |
class |
ItemMergeEvent |
|
class |
ItemSpawnEvent |
Called when an item is spawned into a world
|
class |
LingeringPotionSplashEvent |
Called when a splash potion hits an area
|
class |
PigZapEvent |
Stores data for pigs being zapped
|
class |
PigZombieAngerEvent |
Called when a Pig Zombie is angered by another entity.
|
class |
PlayerDeathEvent |
Thrown whenever a
Player dies |
class |
PlayerLeashEntityEvent |
Called immediately prior to a creature being leashed by a player.
|
class |
PotionSplashEvent |
Called when a splash potion hits an area
|
class |
ProjectileHitEvent |
Called when a projectile hits an object
|
class |
ProjectileLaunchEvent |
Called when a projectile is launched.
|
class |
SheepDyeWoolEvent |
Called when a sheep's wool is dyed
|
class |
SheepRegrowWoolEvent |
Called when a sheep regrows its wool
|
class |
SlimeSplitEvent |
Called when a Slime splits into smaller Slimes upon death
|
class |
SpawnerSpawnEvent |
Called when an entity is spawned into a world by a spawner.
|
class |
VillagerAcquireTradeEvent |
Called whenever a villager acquires a new trade.
|
class |
VillagerCareerChangeEvent |
|
class |
VillagerReplenishTradeEvent |
Called when a villager's trade's maximum uses is increased, due to a player's
trade.
|
Modifier and Type | Class | Description |
---|---|---|
class |
HangingBreakByEntityEvent |
Triggered when a hanging entity is removed by an entity
|
class |
HangingBreakEvent |
Triggered when a hanging entity is removed
|
class |
HangingEvent |
Represents a hanging entity-related event.
|
class |
HangingPlaceEvent |
Triggered when a hanging entity is created in the world
|
Modifier and Type | Class | Description |
---|---|---|
class |
BrewEvent |
Called when the brewing of the contents inside the Brewing Stand is
complete.
|
class |
BrewingStandFuelEvent |
Called when an ItemStack is about to increase the fuel level of a brewing
stand.
|
class |
CraftItemEvent |
Called when the recipe of an Item is completed inside a crafting matrix.
|
class |
FurnaceBurnEvent |
Called when an ItemStack is successfully burned as fuel in a furnace.
|
class |
FurnaceExtractEvent |
This event is called when a player takes items out of the furnace
|
class |
FurnaceSmeltEvent |
Called when an ItemStack is successfully smelted in a furnace.
|
class |
InventoryClickEvent |
This event is called when a player clicks a slot in an inventory.
|
class |
InventoryCloseEvent |
Represents a player related inventory event
|
class |
InventoryCreativeEvent |
This event is called when a player in creative mode puts down or picks up
an item in their inventory / hotbar and when they drop items from their
Inventory while in creative mode.
|
class |
InventoryDragEvent |
This event is called when the player drags an item in their cursor across
the inventory.
|
class |
InventoryEvent |
Represents a player related inventory event
|
class |
InventoryInteractEvent |
An abstract base class for events that describe an interaction between a
HumanEntity and the contents of an Inventory.
|
class |
InventoryMoveItemEvent |
Called when some entity or block (e.g.
|
class |
InventoryOpenEvent |
Represents a player related inventory event
|
class |
InventoryPickupItemEvent |
Called when a hopper or hopper minecart picks up a dropped item.
|
class |
PrepareAnvilEvent |
Called when an item is put in a slot for repair by an anvil.
|
class |
PrepareItemCraftEvent |
|
class |
TradeSelectEvent |
This event is called whenever a player clicks a new trade on the trades
sidebar.
|
Modifier and Type | Class | Description |
---|---|---|
class |
AsyncPlayerChatEvent |
This event will sometimes fire synchronously, depending on how it was
triggered.
|
class |
AsyncPlayerPreLoginEvent |
Stores details for players attempting to log in.
|
class |
PlayerAdvancementDoneEvent |
Called when a player has completed all criteria in an advancement.
|
class |
PlayerAnimationEvent |
Represents a player animation event
|
class |
PlayerArmorStandManipulateEvent |
Called when a player interacts with an armor stand and will either swap, retrieve or place an item.
|
class |
PlayerBedEnterEvent |
This event is fired when the player is almost about to enter the bed.
|
class |
PlayerBedLeaveEvent |
This event is fired when the player is leaving a bed.
|
class |
PlayerBucketEmptyEvent |
Called when a player empties a bucket
|
class |
PlayerBucketEvent |
Called when a player interacts with a Bucket
|
class |
PlayerBucketFillEvent |
Called when a player fills a bucket
|
class |
PlayerChangedMainHandEvent |
Called when a player changes their main hand in the client settings.
|
class |
PlayerChangedWorldEvent |
Called when a player switches to another world.
|
class |
PlayerChannelEvent |
This event is called after a player registers or unregisters a new plugin
channel.
|
class |
PlayerChatEvent |
Deprecated.
This event will fire from the main thread and allows the use of
all of the Bukkit API, unlike the
AsyncPlayerChatEvent .
Listening to this event forces chat to wait for the main thread which
causes delays for chat. |
class |
PlayerChatTabCompleteEvent |
Deprecated.
This event is no longer fired due to client changes
|
class |
PlayerCommandPreprocessEvent |
This event is called whenever a player runs a command (by placing a slash
at the start of their message).
|
class |
PlayerCommandSendEvent |
This event is called when the list of available server commands is sent to
the player.
|
class |
PlayerDropItemEvent |
Thrown when a player drops an item from their inventory
|
class |
PlayerEditBookEvent |
Called when a player edits or signs a book and quill item.
|
class |
PlayerEggThrowEvent |
Called when a player throws an egg and it might hatch
|
class |
PlayerEvent |
Represents a player related event
|
class |
PlayerExpChangeEvent |
Called when a players experience changes naturally
|
class |
PlayerFishEvent |
Thrown when a player is fishing
|
class |
PlayerGameModeChangeEvent |
Called when the GameMode of the player is changed.
|
class |
PlayerInteractAtEntityEvent |
Represents an event that is called when a player right clicks an entity that
also contains the location where the entity was clicked.
|
class |
PlayerInteractEntityEvent |
Represents an event that is called when a player right clicks an entity.
|
class |
PlayerInteractEvent |
Represents an event that is called when a player interacts with an object or
air, potentially fired once for each hand.
|
class |
PlayerItemBreakEvent |
Fired when a player's item breaks (such as a shovel or flint and steel).
|
class |
PlayerItemConsumeEvent |
This event will fire when a player is finishing consuming an item (food,
potion, milk bucket).
|
class |
PlayerItemDamageEvent |
Called when an item used by the player takes durability damage as a result of
being used.
|
class |
PlayerItemHeldEvent |
Fired when a player changes their currently held item
|
class |
PlayerItemMendEvent |
Represents when a player has an item repaired via the Mending enchantment.
|
class |
PlayerJoinEvent |
Called when a player joins a server
|
class |
PlayerKickEvent |
Called when a player gets kicked from the server
|
class |
PlayerLevelChangeEvent |
Called when a players level changes
|
class |
PlayerLocaleChangeEvent |
Called when a player changes their locale in the client settings.
|
class |
PlayerLoginEvent |
Stores details for players attempting to log in.
|
class |
PlayerMoveEvent |
Holds information for player movement events
|
class |
PlayerPickupArrowEvent |
Thrown when a player picks up an arrow from the ground.
|
class |
PlayerPickupItemEvent |
Deprecated.
|
class |
PlayerPortalEvent |
Called when a player is about to teleport because it is in contact with a
portal.
|
class |
PlayerPreLoginEvent |
Deprecated.
This event causes synchronization from the login thread;
AsyncPlayerPreLoginEvent is preferred to keep the secondary threads
asynchronous. |
class |
PlayerQuitEvent |
Called when a player leaves a server
|
class |
PlayerRecipeDiscoverEvent |
Called when a player discovers a new recipe in the recipe book.
|
class |
PlayerRegisterChannelEvent |
This is called immediately after a player registers for a plugin channel.
|
class |
PlayerResourcePackStatusEvent |
Called when a player takes action on a resource pack request sent via
Player.setResourcePack(java.lang.String) . |
class |
PlayerRespawnEvent |
Called when a player respawns.
|
class |
PlayerRiptideEvent |
This event is fired when the player activates the riptide enchantment, using
their trident to propel them through the air.
|
class |
PlayerShearEntityEvent |
Called when a player shears an entity
|
class |
PlayerStatisticIncrementEvent |
Called when a player statistic is incremented.
|
class |
PlayerSwapHandItemsEvent |
Called when a player swap items between main hand and off hand using the
hotkey.
|
class |
PlayerTakeLecternBookEvent |
This event is called when a player clicks the button to take a book of a
Lectern.
|
class |
PlayerTeleportEvent |
Holds information for player teleport events
|
class |
PlayerToggleFlightEvent |
Called when a player toggles their flying state
|
class |
PlayerToggleSneakEvent |
Called when a player toggles their sneaking state
|
class |
PlayerToggleSprintEvent |
Called when a player toggles their sprinting state
|
class |
PlayerUnleashEntityEvent |
Called prior to an entity being unleashed due to a player's action.
|
class |
PlayerUnregisterChannelEvent |
This is called immediately after a player unregisters for a plugin channel.
|
class |
PlayerVelocityEvent |
Called when the velocity of a player changes.
|
Modifier and Type | Class | Description |
---|---|---|
class |
RaidEvent |
Represents events related to raids.
|
class |
RaidFinishEvent |
This event is called when a
Raid was complete with a clear result. |
class |
RaidSpawnWaveEvent |
Called when a raid wave spawns.
|
class |
RaidStopEvent |
Called when a
Raid is stopped. |
class |
RaidTriggerEvent |
Called when a
Raid is triggered (e.g: a player with Bad Omen effect
enters a village). |
Modifier and Type | Class | Description |
---|---|---|
class |
BroadcastMessageEvent |
Event triggered for server broadcast messages such as from
Server.broadcast(String, String) . |
class |
MapInitializeEvent |
Called when a map is initialized.
|
class |
PluginDisableEvent |
Called when a plugin is disabled.
|
class |
PluginEnableEvent |
Called when a plugin is enabled.
|
class |
PluginEvent |
Used for plugin enable and disable events
|
class |
RemoteServerCommandEvent |
This event is called when a command is received over RCON.
|
class |
ServerCommandEvent |
This event is called when a command is run by a non-player.
|
class |
ServerEvent |
Miscellaneous server events
|
class |
ServerListPingEvent |
Called when a server list ping is coming in.
|
class |
ServerLoadEvent |
This event is called when either the server startup or reload has completed.
|
class |
ServiceEvent |
An event relating to a registered service.
|
class |
ServiceRegisterEvent |
This event is called when a service is registered.
|
class |
ServiceUnregisterEvent |
This event is called when a service is unregistered.
|
class |
TabCompleteEvent |
Called when a
CommandSender of any description (ie: player or
console) attempts to tab complete. |
Modifier and Type | Class | Description |
---|---|---|
class |
VehicleBlockCollisionEvent |
Raised when a vehicle collides with a block.
|
class |
VehicleCollisionEvent |
Raised when a vehicle collides.
|
class |
VehicleCreateEvent |
Raised when a vehicle is created.
|
class |
VehicleDamageEvent |
Raised when a vehicle receives damage.
|
class |
VehicleDestroyEvent |
Raised when a vehicle is destroyed, which could be caused by either a
player or the environment.
|
class |
VehicleEnterEvent |
Raised when an entity enters a vehicle.
|
class |
VehicleEntityCollisionEvent |
Raised when a vehicle collides with an entity.
|
class |
VehicleEvent |
Represents a vehicle-related event.
|
class |
VehicleExitEvent |
Raised when a living entity exits a vehicle.
|
class |
VehicleMoveEvent |
Raised when a vehicle moves.
|
class |
VehicleUpdateEvent |
Called when a vehicle updates
|
Modifier and Type | Class | Description |
---|---|---|
class |
LightningStrikeEvent |
Stores data for lightning striking
|
class |
ThunderChangeEvent |
Stores data for thunder state changing in a world
|
class |
WeatherChangeEvent |
Stores data for weather changing in a world
|
class |
WeatherEvent |
Represents a Weather-related event
|
Modifier and Type | Class | Description |
---|---|---|
class |
ChunkEvent |
Represents a Chunk related event
|
class |
ChunkLoadEvent |
Called when a chunk is loaded
|
class |
ChunkPopulateEvent |
Thrown when a new chunk has finished being populated.
|
class |
ChunkUnloadEvent |
Called when a chunk is unloaded
|
class |
PortalCreateEvent |
Called when a portal is created
|
class |
SpawnChangeEvent |
An event that is called when a world's spawn changes.
|
class |
StructureGrowEvent |
Event that is called when an organic structure attempts to grow (Sapling ->
Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal.
|
class |
WorldEvent |
Represents events within a world
|
class |
WorldInitEvent |
Called when a World is initializing
|
class |
WorldLoadEvent |
Called when a World is loaded
|
class |
WorldSaveEvent |
Called when a World is saved.
|
class |
WorldUnloadEvent |
Called when a World is unloaded
|
Modifier and Type | Method | Description |
---|---|---|
Map<Class<? extends Event>,Set<RegisteredListener>> |
PluginLoader.createRegisteredListeners(Listener listener,
Plugin plugin) |
Creates and returns registered listeners for the event classes used in
this listener
|
Class<? extends Event> |
TimedRegisteredListener.getEventClass() |
Gets the class of the events this listener handled.
|
Modifier and Type | Method | Description |
---|---|---|
void |
PluginManager.callEvent(Event event) |
Calls an event with the given details
|
void |
RegisteredListener.callEvent(Event event) |
Calls the event executor
|
void |
SimplePluginManager.callEvent(Event event) |
Calls an event with the given details.
|
void |
TimedRegisteredListener.callEvent(Event event) |
|
void |
EventExecutor.execute(Listener listener,
Event event) |
Modifier and Type | Method | Description |
---|---|---|
void |
PluginManager.registerEvent(Class<? extends Event> event,
Listener listener,
EventPriority priority,
EventExecutor executor,
Plugin plugin) |
Registers the specified executor to the given event class
|
void |
PluginManager.registerEvent(Class<? extends Event> event,
Listener listener,
EventPriority priority,
EventExecutor executor,
Plugin plugin,
boolean ignoreCancelled) |
Registers the specified executor to the given event class
|
void |
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 EventExecutor
|
Modifier and Type | Method | Description |
---|---|---|
Map<Class<? extends Event>,Set<RegisteredListener>> |
JavaPluginLoader.createRegisteredListeners(Listener listener,
Plugin plugin) |
Modifier and Type | Class | Description |
---|---|---|
class |
EntityDismountEvent |
Called when an entity stops riding another entity.
|
class |
EntityMountEvent |
Called when an entity attempts to ride another entity.
|
Modifier and Type | Class | Description |
---|---|---|
class |
PlayerSpawnLocationEvent |
Called when player is about to spawn in a world after joining the server.
|
Copyright © 2019. All rights reserved.