All Classes and Interfaces
Class
Description
Represents an arrow.
Represents the pickup status of this arrow.
Represents a Horse-like creature.
An interface to the inventory of an
AbstractHorse
.This interface defines or represents the abstract concept of skeleton-like
entities on the server.
Represents a villager NPC
Represents an advancement that may be awarded to a player.
Holds information about how the advancement is displayed by the game.
Advancements are displayed in different ways depending on their display type.
The individual status of an advancement for a player.
'age' represents the different growth stages that a crop-like block can go
through.
Represents an entity that can age.
An Allay.
Represents an ambient mob
'power' represents the redstone power level currently being emitted or
transmitted via this block.
Represents an Animal.
Interface to the inventory of an Anvil.
Represents an area effect cloud which will imbue a potion effect onto
entities which enter it.
Called when a lingering potion applies it's effects.
Represents types of locking mechanisms for ArmorStand equipment.
Called when an arrow enters or exists an entity's body.
Represents the art on a painting
This event will sometimes fire synchronously, depending on how it was
triggered.
Deprecated.
draft API
Stores details for players attempting to log in.
Basic kick reasons for communicating to plugins
'attached' denotes whether a tripwire hook or string forms a complete
tripwire circuit and is ready to trigger.
Indicates that a block can be attached to another block
Represents an object which may contain attributes.
Types of attributes which may be present on an
Attributable
.Represents a mutable instance of an attribute and its associated modifiers
and values.
Concrete implementation of an attribute modifier.
Enumerable operation to be applied.
Represents a mutually perpendicular axis in 3D Cartesian coordinates.
An Axolotl.
Represents the variant of a axolotl - ie its color.
Represents a bucket of axolotl.
'leaves' represents the size of the leaves on this bamboo block.
Bamboo leaf size.
A single entry from a ban list.
A ban list, containing bans of some
BanList.Type
.Represents a ban-type that a
BanList
may track.Represents a captured state of a banner.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a captured state of a Barrel.
Represents a Bat
Called when a bat attempts to sleep or wake up from its slumber.
Represents a captured state of a beacon.
Interface to the inventory of a Beacon.
Deprecated.
does not provide useful information beyond the material itself
Similar to
Bisected
, 'part' denotes which half of the bed this block
corresponds to.Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Horizontal half of a bed.
Represents a Bee.
Represents a captured state of a bee hive.
'honey_level' represents the amount of honey stored in the hive.
Represents a captured state of Bell.
'attachment' denotes how the bell is attached to its block.
What the bell is attached to.
'tilt' indicates how far the leaf is tilted.
The tilt of a leaf.
Holds all accepted Biomes in the default server
Class for providing biomes.
'half' denotes which half of a two block tall material this block is.
The half of a vertically bisected block.
Represents a captured state of a blast furnace.
Represents a campfire recipe.
Represents a Blaze monster
Represents a block.
Called when a block is broken by a player.
Called when a block is destroyed as a result of being burnt by fire.
Called when we try to place a block, to see if we can build it here or not.
A delegate for handling block changes.
Called when an ItemStack is successfully cooked in a block.
Called when a player stops damaging a Block.
Called when a block is damaged by a player.
Called when an equippable item is dispensed from a block and equipped on a
nearby entity.
Called when an item is dispensed from a block.
Called if a block broken by a player drops an item.
Represents a block related event.
An event that's called when a block yields experience.
Called when a block explodes
Represents the face of a block
Called when a block fades, melts or disappears based on world conditions
Called with the block changes resulting from a player fertilizing a given
block with bonemeal.
Called when a block is formed or spreads based on world conditions.
Represents events with a source block and a destination block, currently
only applies to liquid (lava and water) and teleporting dragon eggs.
Called when a block grows naturally in the world.
Called when a block is ignited.
An enum to specify the cause of the ignite
Represents a block inventory holder - either a BlockState, or a regular
Block.
This class performs ray tracing and iterates along blocks on a line
Fired when a single block placement action of a player triggers the
creation of multiple blocks(e.g.
Thrown when a block physics check is called.
Called when a piston block is triggered
Called when a piston extends
Called when a piston retracts
Called when a block is placed by a player.
A block populator is responsible for generating a small area of blocks.
Called when a Sculk sensor receives a game event and hence might activate.
Called when a redstone current changes
Event fired when a dispenser shears a nearby sheep.
Called when a block spreads based on world conditions.
Represents a captured state of a block, which will not change
automatically.
Represents a level of support a block can give on one of its faces.
A vector with a hash function that floors the X, Y, Z components, a la
BlockVector in WorldEdit.
Represents a boat entity.
Represents the status of the boat.
Represents the type of boats.
Represents a book (
Material.WRITABLE_BOOK
or Material.WRITTEN_BOOK
) that can have a title, an author, and pages.Represents the generation (or level of copying) of a written book
BooleanPrompt is the base class for any prompt that requires a boolean
response from the user.
Represents the Boss Entity.
A mutable axis aligned bounding box (AABB).
Represents an entity that can age and breed.
Interface to the inventory of a Brewing Stand.
Called when the brewing of the contents inside the Brewing Stand is
complete.
Represents a captured state of a brewing stand.
Interface to the 'has_bottle_0', 'has_bottle_1', 'has_bottle_2' flags on a
brewing stand which indicate which bottles are rendered on the outside.
Called when an ItemStack is about to increase the fuel level of a brewing
stand.
Event triggered for server broadcast messages such as from
Server.broadcast(String, String)
.'drag' indicates whether a force will be applied on entities moving through
this block.
Represents the Bukkit core, for version and Server singleton handling
This class is designed to be used in conjunction with the
ConfigurationSerializable
API.This class is designed to be used in conjunction with the
ConfigurationSerializable
API.This class is provided as an easy way to handle scheduling tasks.
Represents a task being executed by the scheduler
Represents a worker thread for the scheduler.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
This is a cached version of a server-icon.
'bites' represents the amount of bites which have been taken from this slice
of cake.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a captured state of a campfire.
'signal_fire' denotes whether the fire is extra smokey due to having a hay
bale placed beneath it.
Represents a campfire recipe.
'candles' represents the number of candles which are present.
Interface to the inventory of a Cartography table.
Meow.
Represents the various different cat types there are.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a Spider.
'berries' indicates whether the block has berries.
Thrown if a Plugin Channel is too long.
Thrown if a Plugin attempts to send a message on an unregistered channel.
All supported color values for chat
The ChatPaginator takes a raw string of arbitrary length and breaks it down
into an array of strings appropriate for displaying on the Minecraft player
console.
Represents a captured state of a chest.
'type' represents which part of a double chest this block is, or if it is a
single chest.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Type of this chest block.
A
Boat
with a chest.Represents Horse-like creatures which can carry an inventory.
Represents a Chicken.
Represents a chunk of blocks
Represents a Chunk related event
A chunk generator is responsible for the initial shaping of an entire
chunk.
Deprecated.
Biomes are now set with
BiomeProvider
Data for a Chunk.
Called when a chunk is loaded
Thrown when a newly generated chunk has finished being populated.
Represents a static, thread-safe snapshot of chunk of blocks.
Called when a chunk is unloaded
What the client did to trigger this action (not the result).
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents the two types of coal
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a cod fish.
A container for a color palette.
An object that can be colored.
Represents a Command, which executes various tasks upon user input
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a captured state of a command block.
'conditional' denotes whether this command block is conditional or not, i.e.
Thrown when an unhandled exception occurs during the execution of a Command
Represents a class which contains a single method for executing commands
Represents a captured state of an on / off comparator.
'mode' indicates what mode this comparator will operate in.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
The mode in which a comparator will operate in.
Represents a compass that can track a specific location.
Represents a single part of a
ComplexLivingEntity
Represents a complex living entity - one that is made up of various smaller
parts
Represents a complex recipe which has imperative server-defined behavior, eg
armor dyeing.
Represents a captured state of a conduit.
Represents a source of configurable options and settings
Various settings for controlling the input and output of a
Configuration
Represents a section of a
Configuration
Represents an object that may be serialized.
Utility class for storing and retrieving classes for
Configuration
.Represents an operation that accepts a single input argument and returns no
result.
Represents a captured state of a container block.
The Conversable interface is used to indicate objects that can have
conversations.
The Conversation class is responsible for tracking the current state of a
conversation, displaying prompts to the user, and dispatching the user's
response to the appropriate place.
ConversationAbandonedEvent contains information about an abandoned
conversation.
A ConversationCanceller is a class that cancels an active
Conversation
.A ConversationContext provides continuity between nodes in the prompt graph
by giving the developer access to the subject of the conversation and a
generic map for storing values that are shared between all
Prompt
invocations.A ConversationFactory is responsible for creating a
Conversation
from a predefined template.A ConversationPrefix implementation prepends all output from the
conversation to the player.
Represents a cooking recipe.
Represents a Cow.
Interface to the crafting inventories
Called when the recipe of an Item is completed inside a crafting matrix.
Represents a category in the creative inventory.
Represents a Creature.
Represents a captured state of a creature spawner.
Called when a creature is spawned into a world.
An enum to specify the type of spawning
Represents a Creeper
Called when a Creeper is struck by lightning.
An enum to specify the cause of the change in power
Criteria names which trigger an objective to be modified by actions in-game
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents the different growth states of crops
Deprecated.
this API part has been replaced by the
PersistentDataHolder
API.Provides custom timing sections for /timings merged.
Represents an
Entity
that has health and can take damage.Represents an item that has durability and can take damage.
'inverted' denotes whether this daylight detector is in the inverted mode,
i.e.
Represents a captured state of a (possibly inverted) daylight detector.
Applies to a
ConfigurationSerializable
that will delegate all
deserialization to another ConfigurationSerializable
.Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents the various difficulty levels that are available.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'facing' represents the face towards which the block is pointing.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Similar to
Powerable
, 'triggered' indicates whether or not the
dispenser is currently activated.Represents a captured state of a dispenser.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Locations for displaying objectives to the player
Represents a Donkey - variant of
ChestedHorse
.'hinge' indicates which hinge this door is attached to and will rotate around
when opened.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
The hinge of a door.
Represents a double chest.
Interface to the inventory of a Double Chest.
Represents a dragon battle state for a world with an end environment.
Represents a phase in the dragon respawn process.
Represents the effect of a drag that will be applied to an Inventory in an
InventoryDragEvent.
Represents a captured state of a dropper.
Drowned zombie.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
All supported color values for dyes and cloth
A list of effects that the server is able to send to players.
Represents the type of an effect.
Represents a thrown egg.
Represents an ElderGuardian - variant of
Guardian
.Interface to the inventory of an Enchantment Table.
Represents a captured state of an enchanting table.
Called when an ItemStack is successfully enchanted (currently at
enchantment table)
The various type of enchantments that may be added to armour or weapons
A class for the available enchantment offers in the enchantment table.
EnchantmentMeta is specific to items that can store enchantments, as
opposed to being enchanted.
Represents the applicable target for a
Enchantment
A simple wrapper for ease of selecting
Enchantment
sRepresents a captured state of an ender chest.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
A crystal that heals nearby EnderDragons
Represents an Ender Dragon
Represents a phase or action that an Ender Dragon can perform.
Called when an EnderDragon switches controller phase.
Represents an ender dragon part
Represents an Enderman.
Represents a thrown Ender Pearl entity
Represents an EnderSignal, which is created upon throwing an ender eye.
Represents a captured state of an end gateway.
'eye' denotes whether this end portal frame has been activated by having an
eye of ender placed in it.
Called when entities are loaded.
Called when entities are unloaded.
Represents a base entity in the world
Called when the amount of air an entity has remaining changes.
Called when a block is formed by entities.
Represents a captured state of a block which stores entities.
Called when an
Entity
breaks a doorCalled when one Entity breeds with another Entity.
A classification of entities which may behave differently than others or be
affected uniquely by enchantments and potion effects among other things.
Called when any Entity changes a block and a more specific event is not available.
Called when a block causes an entity to combust.
Called when an entity causes another entity to combust.
Called when an entity combusts.
Deprecated.
Called when an entity is damaged by a block
Called when an entity is damaged by an entity
Stores data for damage events
An enum to specify the cause of the damage
Deprecated.
This API is responsible for a large number of implementation
problems and is in general unsustainable to maintain.
Thrown whenever a LivingEntity dies
Called when an entity stops riding another entity.
Thrown when an entity creates an item drop.
A list of all Effects that can happen to entities.
Called when an
Entity
enters a block and is stored in that block.Called when an entity enters love mode.
An interface to a creatures inventory
Represents an Entity-related event
Called when a human entity experiences exhaustion.
The reason for why a PlayerExhaustionEvent takes place
Called when an entity explodes
Called when an entity interacts with an object
Called when an entity attempts to ride another entity.
Thrown when a entity picks an item up from the ground
Triggered when a entity is created in the world by a player "placing" an item
on a block.
Called when an entity comes into contact with a portal
Called when a non-player entity is about to teleport because it is in
contact with a portal.
Called before an entity exits a portal.
Called when an entity changes its pose.
Called when a potion effect is modified on an entity.
An enum to specify the action to be performed.
An enum to specify the cause why an effect was changed.
Stores data for health-regain events
An enum to specify the type of health regaining that is occurring
Called when an entity dies and may have the opportunity to be resurrected.
Called when a LivingEntity shoots a bow firing an arrow
Called when an entity is spawned into a world.
Called when a
Spellcaster
casts a spell.Thrown when a LivingEntity is tamed
Called when a creature targets or untargets another entity
An enum to specify the reason for the targeting
Called when an Entity targets a
LivingEntity
and can only target
LivingEntity's.Thrown when a non-player entity is teleported from one location to another.
Sent when an entity's gliding status is toggled with an Elytra.
Sent when an entity's swimming status is toggled.
Called when an entity is about to be replaced by another entity.
Called immediately prior to an entity being unleashed.
EulerAngle is used to represent 3 angles, one for each
axis (x, y, z).
Represents an event.
Interface which defines the class for event call backs to plugins
An annotation to mark methods as being event handler methods
Represents an event's priority in execution.
Represents an Evoker "Illager".
Deprecated.
future versions of Minecraft have additional spell casting
entities.
Represents Evoker Fangs.
An ExactMatchConversationCanceller cancels a conversation if the user
enters an exact input string
Called when a ThrownExpBottle hits and releases experience.
Represents an Experience Orb.
Called when an entity has made a decision to explode.
A representation of an explosive entity
Represents a Minecart with TNT inside it that can explode when triggered.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'face' represents the face to which a lever or button is stuck.
The face to which a switch type block is stuck.
Represents a falling block
The 'moisture' level of farmland indicates how close it is to a water source
(if any).
This is a base class for all File based implementations of
Configuration
Various settings for controlling the input and output of a
FileConfiguration
Class containing file utilities
md_5's mixtape.
Represents a Fireball.
Represents a single firework effect.
This is a builder for FireworkEffects.
The type or shape of the effect.
Represents a meta that can store a single FireworkEffect.
Called when a firework explodes.
Represents a
Material.FIREWORK_ROCKET
and its effects.Represents a fish entity.
Represents a fishing hook.
Represents a state in which a fishing hook may be.
A FixedMetadataValue is a special case metadata item that contains the same
value forever after initialization.
FixedSetPrompt is the base class for any prompt that requires a fixed set
response from the user.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Determines the collision behavior when fluids get hit during ray tracing.
Called when the fluid level of a block changes due to changes in adjacent
blocks.
Represents a Flying Entity.
Called when a human entity's food level changes
What does the fox say?
Represents the various different fox types there are.
A Frog.
Represents the variant of a frog - ie its color.
Represents a captured state of a furnace.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Called when an ItemStack is successfully burned as fuel in a furnace.
This event is called when a player takes items out of the furnace
Interface to the inventory of a Furnace.
Represents a furnace recipe.
Called when an ItemStack is successfully smelted in a furnace.
Represents a generic Mojang game event.
Represents the various type of game modes that
HumanEntity
s may
haveGameRules dictate certain behavior within Minecraft itself
For more information please visit the Minecraft Wiki
For more information please visit the Minecraft Wiki
'in_wall" indicates if the fence gate is attached to a wall, and if true the
texture is lowered by a small amount to blend in better.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Lacking an alternative, the help system will create instances of
GenericCommandHelpTopic for each command in the server's CommandMap.
Represents a generic Mojang game event.
Represents a Ghast.
Represents a Giant.
A Glow Item Frame.
A Glow Squid.
A Goat.
A mechanical creature that may harm enemies.
Represents the different types of grass.
Interface to the inventory of a Grindstone.
A list of event handlers, stored per-event.
'hanging' denotes whether the lantern is hanging from a block.
Represents a Hanging entity
Triggered when a hanging entity is removed by an entity
Triggered when a hanging entity is removed
An enum to specify the cause of the removal
Represents a hanging entity-related event.
Triggered when a hanging entity is created in the world
Further information regarding heightmaps.
The HelpMap tracks all help topics registered in a Bukkit server.
HelpTopic implementations are displayed to the user when the user uses the
/help command.
Used to impose a custom total ordering on help topics.
A HelpTopicFactory is used to create custom
HelpTopic
objects from
commands that inherit from a common base class or have executors that
inherit from a common base class.Represents a Hoglin.
Similar to
Powerable
, 'enabled' indicates whether or not the hopper
is currently activated.Represents a captured state of a hopper.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a Minecart with a Hopper inside it
Represents a Horse.
Represents the base color that the horse has.
Represents the style, or markings, that the horse has.
Deprecated.
different variants are differing classes
An interface to the inventory of a Horse.
Called when a horse jumps.
Represents a human entity, such as an NPC or a player
Represents a Husk - variant of
Zombie
.Represents a type of "Illager".
Thrown when a plugin attempts to interact with the server when it is not
enabled
Represents an Illusioner "Illager".
An InactivityConversationCanceller will cancel a
Conversation
after
a period of inactivity by the user.This help topic generates a list of other help topics.
Exception thrown when attempting to load an invalid
Configuration
Thrown when attempting to load an invalid PluginDescriptionFile
Thrown when attempting to load an invalid Plugin file
Interface to the various inventories.
An estimation of what the result will be.
This event is called when a player clicks in an inventory.
Represents a player related inventory event
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.
This event is called when the player drags an item in their cursor across
the inventory.
Represents a player related inventory event
An abstract base class for events that describe an interaction between a
HumanEntity and the contents of an Inventory.
Called when some entity or block (e.g.
Represents a player related inventory event
Called when a hopper or hopper minecart picks up a dropped item.
Represents the different kinds of inventories available in Bukkit.
Represents a view linking two inventories and a single player (whose
inventory may or may not be one of the two).
Represents various extra properties of certain inventory windows.
An iron Golem that protects Villages.
Represents a dropped item.
This event is called when a
Item
is removed from
the world because it has existed for 5 minutes.An instance of the ItemFactory can be obtained with
Server.getItemFactory()
.A ItemFlag can hide some Attributes from ItemStacks
Represents an Item Frame
This type represents the storage mechanism for auxiliary item data.
Called when an item is spawned into a world
Represents a stack of items.
Deprecated.
this API part has been replaced by
PersistentDataHolder
.Deprecated.
please use
PersistentDataType
as this part of the api is being replacedA default implementation that simply exists to pass on the retrieved or
inserted value to the next layer.
Represents a Java plugin
Represents a Java plugin loader, allowing plugins in the form of .jar
'orientation' is the direction the block is facing.
Represents a captured state of a jigsaw.
The directions the Jigsaw can be oriented.
'has_record' is a quick flag to check whether this jukebox has a record
inside it.
Represents a captured state of a jukebox.
Represents an object which has a
NamespacedKey
attached to it.Represents a custom
BossBar
that has a
NamespacedKey
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a large
Fireball
The LazyMetadataValue class implements a type of metadata that is not
computed until another plugin asks for it.
Describes possible caching strategies for metadata.
Represents a Leash Hitch on a fence
Represents leather armor (
Material.LEATHER_BOOTS
, Material.LEATHER_CHESTPLATE
, Material.LEATHER_HELMET
, or Material.LEATHER_LEGGINGS
) that can be colored.'persistent' indicates whether or not leaves will be checked by the server to
see if they are subject to decay or not.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Called when leaves are decaying naturally.
'has_book' is a quick flag to check whether this lectern has a book inside
it.
Represents a captured state of a lectern.
Interface to the inventory of a Lectern.
'level' represents the amount of fluid contained within this block, either by
itself or inside a cauldron.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'lit' denotes whether this block (either a redstone torch or furnace) is
currently lit - that is not burned out.
Represents an instance of a lightning strike.
Stores data for lightning striking
A limited region is used in world generation for features which are
going over a chunk.
Deprecated.
lingering status depends on only on the potion item.
Called when a splash potion hits an area
Simple interface for tagging all EventListeners
Represents a living entity, such as a monster or player
Represents a Llama.
Represents the base color that the llama has.
An interface to the inventory of a
Llama
.Represents Llama spit.
Represents a 3-dimensional position in a world.
Represents a block (usually a container) that may be locked.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Interface to the inventory of a Loom.
Represents additional information a
LootTable
can use to modify it's
generated loot.Utility class to make building
LootContext
easier.Called when a
LootTable
is generated in the world for an
InventoryHolder
.LootTables are technical files that represent what items should be in
naturally generated containers, what items should be dropped when killing a
mob, or what items can be fished.
This enum holds a list of all known
LootTable
s offered by Mojang.Represents a MagmaCube.
Represents the chosen main hand of a player
The ManuallyAbandonedConversationCanceller is only used as part of a
ConversationAbandonedEvent
to indicate that the conversation was manually
abandoned by programmatically calling the abandon() method on it.Represents a canvas for drawing to a map.
Represents a cursor on a map.
Represents the standard types of map cursors.
Represents all the map cursors on a
MapCanvas
.Represents a bitmap font drawable to a map.
Represents the graphics for a single character in a MapFont.
Called when a map is initialized.
Represents a map that can be scalable.
Represents the palette that map items use.
Holds cached information for matching map colors of a given RBG color.
Represents a renderer for a map.
Represents a map item.
An enum representing all possible scales a map can be set to.
A Marker entity, exists only on the server.
An enum of all material IDs accepted by the official server and client
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
This is a
Configuration
implementation that does not save or load
from any source, and stores all values in memory only.Various settings for controlling the input and output of a
MemoryConfiguration
Represents a key used for accessing memory values of a
LivingEntity
.A type of
ConfigurationSection
that is stored in memory.Represents a merchant.
Represents a trading inventory between a player and a merchant.
Represents a merchant's trade.
MessagePrompt is the base class for any prompt that only displays a message
to the user and requires no input.
Thrown if a Plugin Message is sent that is too large to be sent.
A class responsible for managing the registrations of plugin channels and
their listeners.
This interface is implemented by all objects that can provide metadata
about themselves.
A MetadataConversionException is thrown any time a
LazyMetadataValue
attempts to convert a metadata value to an inappropriate
data type.A MetadataEvaluationException is thrown any time a
LazyMetadataValue
fails to evaluate its value due to an exception.Optional base class for facilitating MetadataValue implementations.
Represents a minecart entity.
Represents the built-in Minecraft font.
Represents how a
Structure
can be mirrored upon
being loaded.Represents a Mob.
Called when the moisture level of a soil block changes.
Represents a Monster.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a Mule - variant of
ChestedHorse
.Represents a command that delegates to one or more other commands
This class encompasses the 'north', 'east', 'south', 'west', 'up', 'down'
boolean flags which are used to set which faces of the block textures are
displayed on.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents the different textured blocks of mushroom.
Represents a mushroom
Cow
Represents the variant of a cow - ie its color.
Represents a String based key which consists of two components - a namespace
and a key.
Deprecated.
replaced by
Team.OptionStatus
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Base class for all noise generators
A note class to store a specific note.
An enum holding tones.
'instrument' is the type of sound made when this note block is activated.
Called when a note block is being played through player interaction or a
redstone current.
Represents a non-player character
NullConversationPrefix is a
ConversationPrefix
implementation that
displays nothing in front of conversation output.Utils for casting number types to other number types
NumericPrompt is the base class for any prompt that requires a
Number
response from the user.An objective on a scoreboard that can show scores specific to entries.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
A wild tameable cat
Deprecated.
Cats are now a separate entity.
Creates noise using unbiased octaves
'open' denotes whether this block is currently opened.
'axis' represents the axis along whilst this block is oriented.
Represents a Painting.
Represent a variation of a structure.
Panda entity.
Represents a Parrot.
Represents the variant of a parrot - ie its color.
Options which can be applied to redstone dust particles - a particle
color and size.
Options which can be applied to a color transitioning dust particles.
Generates noise using the "classic" perlin generator
Creates perlin noise through unbiased octaves
Represents an object that may be assigned permissions
Base Permissible for use in any Permissible object via proxy or extension
Represents a unique permission that may be attached to a
Permissible
Holds information about a permission attachment on a
Permissible
objectHolds information on a permission and which
PermissionAttachment
provides itRepresents the possible default values for permissions
Represents a class which is to be notified when a
PermissionAttachment
is removed from a Permissible
This interface represents the context in which the
PersistentDataType
can
serialize and deserialize the passed values.This interface represents a map like object, capable of storing custom tags
in it.
The
PersistentDataHolder
interface defines an object that can store
custom persistent meta data on it.This class represents an enum with a generic content type.
A default implementation that simply exists to pass on the retrieved or
inserted value to the next layer.
Represents a phantom.
Represents a Pig.
Represents a Piglin.
Piglin / Piglin Brute.
Stores all data related to the bartering interaction with a piglin.
Represents a Piglin Brute.
Stores data for pigs being zapped
Represents a Pig Zombie.
Called when a Pig Zombie is angered by another entity.
Illager entity.
'extended' denotes whether the piston head is currently extended or not.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'short' denotes this piston head is shorter than the usual amount because it
is currently retracting.
Represents how a block or entity will react when interacting with a piston
when it is extending or retracting.
Represents a player, connected or not
Called when a player has completed all criteria in an advancement.
Represents a player animation event
Different types of player animations
Called when a player interacts with an armor stand and will either swap, retrieve or place an item.
This event is fired when the player is almost about to enter the bed.
Represents the default possible outcomes of this event.
This event is fired when the player is leaving a bed.
Called when a player empties a bucket
This event is called whenever a player captures an entity in a bucket.
Called when a player interacts with a Bucket
Called when a player fills a bucket
Deprecated.
Use the more generic
PlayerBucketEntityEvent
Called when a player changes their main hand in the client settings.
Called when a player switches to another world.
This event is called after a player registers or unregisters a new plugin
channel.
Deprecated.
This event will fire from the main thread and allows the use of
all of the Bukkit API, unlike the
AsyncPlayerChatEvent
.Deprecated.
This event is no longer fired due to client changes
This event is called whenever a player runs a command (by placing a slash
at the start of their message).
This event is called when the list of available server commands is sent to
the player.
Thrown whenever a
Player
diesThrown when a player drops an item from their inventory
Called when a player edits or signs a book and quill item.
Called when a player throws an egg and it might hatch
Represents a player related event
Called when a players experience changes naturally
Thrown when a player is fishing
An enum to specify the state of the fishing
Called when the GameMode of the player is changed.
This event is called whenever a player harvests a block.
Deprecated.
draft API
Represents an event that is called when a player right clicks an entity that
also contains the location where the entity was clicked.
Represents an event that is called when a player right clicks an entity.
Represents an event that is called when a player interacts with an object or
air, potentially fired once for each hand.
Interface to the inventory of a Player, including the four armor slots and any extra slots.
Fired when a player's item breaks (such as a shovel or flint and steel).
This event will fire when a player is finishing consuming an item (food,
potion, milk bucket).
Called when an item used by the player takes durability damage as a result of
being used.
Fired when a player changes their currently held item
Represents when a player has an item repaired via the Mending enchantment.
Called when a player joins a server
Called when a player gets kicked from the server
Called immediately prior to a creature being leashed by a player.
Called when a players level changes
Called when a player changes their locale in the client settings.
Stores details for players attempting to log in.
Basic kick reasons for communicating to plugins
Holds information for player movement events
PlayerNamePrompt is the base class for any prompt that requires the player
to enter another player's name.
Thrown when a player picks up an arrow from the ground.
Deprecated.
Called when a player is about to teleport because it is in contact with a
portal which will generate an exit portal.
Deprecated.
This event causes synchronization from the login thread;
AsyncPlayerPreLoginEvent
is preferred to keep the secondary threads
asynchronous.Basic kick reasons for communicating to plugins
A player profile.
Called when a player leaves a server
Called when a player discovers a new recipe in the recipe book.
This is called immediately after a player registers for a plugin channel.
Called when a player takes action on a resource pack request sent via
Player.setResourcePack(java.lang.String)
.Status of the resource pack.
Called when a player respawns.
This event is fired when the player activates the riptide enchantment, using
their trident to propel them through the air.
Called when a player shears an entity
Deprecated.
draft API
Called when player is about to spawn in a world after joining the server.
Called when a player statistic is incremented.
Called when a player swap items between main hand and off hand using the
hotkey.
This event is called when a player clicks the button to take a book of a
Lectern.
Holds information for player teleport events
Provides access to the textures stored inside a
PlayerProfile
.The different Minecraft skin models.
Called when a player toggles their flying state
Called when a player toggles their sneaking state
Called when a player toggles their sprinting state
Called prior to an entity being unleashed due to a player's action.
This is called immediately after a player unregisters for a plugin channel.
Called when the velocity of a player changes.
Represents a Plugin
Represents a concept that a plugin is aware of.
Each entry here represents a particular plugin's awareness.
Represents a base
Plugin
Represents the different directions a plugin channel may go.
Represents a
Command
belonging to a pluginThis type is the runtime-container for the information in the plugin.yml.
Called when a plugin is disabled.
Called when a plugin is enabled.
Used for plugin enable and disable events
This interface is used by the help system to group commands into
sub-indexes based on the
Plugin
they are a part of.Represents a plugin loader, which handles direct access to specific types
of plugins
Represents the order in which a plugin should be initialized and enabled
The PluginLogger class is a modified
Logger
that prepends all
logging calls with the name of the plugin doing the logging.Handles all plugin management from the Server
A listener for a specific Plugin Channel, which will receive notifications
of messages sent from a client.
Contains information about a
Plugin
s registration to a plugin
channel.Represents a possible recipient for a Plugin Message.
PluginNameConversationPrefix is a
ConversationPrefix
implementation
that displays the plugin name in front of conversation output.'thickness' represents the dripstone thickness.
Represents the thickness of the dripstone, corresponding to its position
within a multi-block dripstone formation.
Represents a polar bear.
Called when a portal is created
An enum to specify the various reasons for a portal's creation
Represents various types of portals that can be made in a world.
Represents an entity body pose.
Deprecated.
Represents a brewer that can create
PotionEffect
s.Represents a potion effect, that can be added to a
LivingEntity
.Represents a type of potion and its effect on an entity.
Represents a potion or item that can have custom effects.
Called when a splash potion hits an area
This enum reflects and matches each potion state that can be obtained from
the Creative mode inventory
'powered' indicates whether this block is in the powered state or not, i.e.
Represents a powered minecart.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Called when an item is put in a slot for repair by an anvil.
Called when an ItemStack is inserted in an enchantment table - can be
called multiple times
Called when an item is put in a slot for upgrade by a Smithing Table.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a shootable entity.
Called when a projectile hits an object
Called when a projectile is launched.
Represents a valid source of a projectile.
A Prompt is the main constituent of a
Conversation
.Represents a puffer fish.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents the various types a Rabbit might be.
Represents a raid event.
Represents the status of a
Raid
.Represents events related to raids.
This event is called when a
Raid
was complete with a clear result.Called when a raid wave spawns.
Called when a
Raid
is stopped.Called when a
Raid
is triggered (e.g: a player with Bad Omen effect
enters a village).'shape' represents the current layout of a minecart rail.
The different types of shapes a rail block can occupy.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Illager beast.
The hit result of a ray trace.
Represents some type of crafting recipe.
Represents a potential item match within a recipe.
Represents a choice that will be valid only one of the stacks is exactly
matched (aside from stack size).
Represents a choice of multiple matching Materials.
Indicated a Material that may carry or create a Redstone current
A type of minecart rail which interacts with redstone in one way or another.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'north', 'east', 'south', 'west' represent the types of connections this
redstone wire has to adjacent blocks.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
The way in which a redstone wire can connect to an adjacent block face.
RegexPrompt is the base class for any prompt that requires an input
validated by a regular expression.
A RegionAccessor gives access to getting, modifying and spawning
Biome
, BlockState
and Entity
,
as well as generating some basic structures.Stores relevant information for plugin listeners
A registered service provider.
Represents a registry of Bukkit objects that may be retrieved by
NamespacedKey
.This event is called when a command is received over RCON.
Controls the way in which an
Objective
is rendered client side.Represents an item that can be repaired at an anvil.
'delay' is the propagation delay of a repeater, i.e.
Thrown if a plugin attempts to register for a reserved channel (such as
"REGISTER")
'charges' represents the amount of times the anchor may still be used.
Represents a minecart that can have certain
entities
as passengers.'rotation' represents the current rotation of this block.
An enum to specify a rotation based orientation, like that on a clock.
Represents a salmon fish.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents the three different types of Sandstone
'stage' represents the growth stage of a sapling.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'bottom' indicates whether the scaffolding is floating or not.
A scoreboard
Manager of Scoreboards
'bloom' indicates whether the sculk catalyst is actively spreading the sculk
or not.
Represents a captured state of a sculk catalyst.
'sculk_sensor_phase' indicates the current operational phase of the sensor.
Represents a captured state of a sculk sensor
The Phase of the sensor.
'can_summon' indicates whether the sculk shrieker can summon the warden.
Represents a captured state of a sculk shrieker.
'pickles' indicates the number of pickles in this block.
Represents an "alias" that a
ConfigurationSerializable
may be
stored as.Represents a server implementation.
This event is called when a command is run by a non-player.
Miscellaneous server events
Called when a server list ping is coming in.
This event is called when either the server startup or reload has completed.
Represents the context in which the enclosing event has been completed.
Represents an object that may become a server operator, such as a
Player
An event relating to a registered service.
Represents various priorities of a provider.
This event is called when a service is registered.
Manages services and service providers.
This event is called when a service is unregistered.
Represents a shaped (ie normal) crafting recipe.
Represents a shapeless recipe, where the arrangement of the ingredients on
the crafting grid does not matter.
Represents a Sheep.
Called when a sheep's wool is dyed
Called when a sheep regrows its wool
Represents a captured state of a ShulkerBox.
Represents a captured state of either a SignPost or a WallSign.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Called when a sign is changed by a player.
Represents a Silverfish.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Handles all plugin management from the Server
A simple services manager.
Generates simplex-based noise.
Creates simplex noise through unbiased octaves
An animal that can sit still.
Represents a sized fireball.
Represents a Skeleton.
Deprecated.
classes are different types.
Represents a SkeletonHorse - variant of
AbstractHorse
.Represents a captured state of a skull block.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a skull that can have an owner.
Deprecated.
check
Material
instead'type' represents what state the slab is in - either top, bottom, or a double
slab occupying the full block.
The type of the slab.
Represents a Slime.
Called when a Slime splits into smaller Slimes upon death
Represents a small
Fireball
Interface to the inventory of a Smithing table.
Represents a smithing recipe.
Called when the recipe of an Item is completed inside a smithing table.
Represents a captured state of a smoker.
Represents a campfire recipe.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
'layers' represents the amount of layers of snow which are present in this
block.
'snowy' denotes whether this block has a snow covered side and top texture
(normally because the block above is snow).
Represents a snowball.
Represents a snowman entity
An Enum of Sounds the server is able to send to players.
An Enum of categories for sounds.
Represents a group of sounds for blocks that are played when various actions
happen (ie stepping, breaking, hitting, etc).
Represents groups of entities with shared spawn behaviors and mob caps.
An event that is called when a world's spawn changes.
Deprecated.
use
SpawnEggMeta
Represents a spawn egg and it's spawned type.
Represents a Minecart with an
entity spawner
inside it.Called when an entity is spawned into a world by a spawner.
Represents a spectral arrow.
Represents a spell casting "Illager".
Represents the current spell the entity is using.
Represents a Spider.
Deprecated.
splash status depends on only on the potion item.
Called when a sponge absorbs water from the world.
Represents a Squid.
'shape' represents the texture and bounding box shape of these stairs.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
The shape of a stair block - used for constructing corners.
Standard implementation to
Messenger
Represents a countable statistic, which is tracked by the server.
The type of statistic.
Represents an entity which may be saddled, ridden and steered using an item.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Interface to the inventory of a Stonecutter.
Represents a Stonecutting recipe.
Represents a minecart with a chest.
Represents a Stray - variant of
AbstractSkeleton
.Represents a Strider.
Called when a
Strider
's temperature has changed as a result of
entering or exiting blocks it considers warm.StringPrompt is the base class for any prompt that accepts an arbitrary
string from the user.
Represents a structure block that can save and load blocks from a file.
Represent a Structure from the world.
Represents a structure.
'mode' represents the different modes in which this structure block may
operate.
Operating mode of a structure block.
Event that is called when an organic structure attempts to grow (Sapling ->
Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal.
Represents how a
Structure
can be rotated.Holds the result of searching for a structure.
Represent a StructureType of a
Structure
.Deprecated.
This class does not represent the structures of a world well.
Represents a suspicious stew that can have custom effects.
Deprecated.
Called when a
CommandSender
of any description (ie: player or
console) attempts to tab complete.Represents a class which can suggest tab completions for commands.
This class is provided as a convenience to implement both TabCompleter and
CommandExecutor.
A baby
Frog
.Represents a tag that may be defined by the server or a resource pack to
group like things together.
A team on a scoreboard that has a common display theme and other
properties.
Represents an option which may be applied to this team.
How an option may be applied to members of this team.
'type' represents the type of piston which this (technical) block corresponds
to.
Different piston variants.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a thrown Experience bottle.
Represents a thrown potion bottle
Stores data for thunder state changing in a world
Represents a block state that also hosts a tile entity at the given location.
Extends RegisteredListener to include timing information
Called when the time skips in a world.
An enum specifying the reason the time skipped.
Deprecated.
tipped status depends only on base potion type not being
UNCRAFTABLE and effects being empty.
'unstable' indicates whether this TNT will explode on punching.
Represents a Primed TNT.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a trader Llama.
This event is called whenever a player clicks a new trade on the trades
sidebar.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
Deprecated, see usage methods for replacement(s)
Tree and organic structure types.
Represents a thrown trident.
'disarmed' denotes that the tripwire was broken with shears and will not
subsequently produce a current when destroyed.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Tropical fish.
Enumeration of all different fish patterns.
Represents a bucket of tropical fish.
Represents a turtle.
'hatch' is the number of turtles which may hatch from these eggs.
Deprecated.
This should generally not be used in any new API code as it
suggests a bad API design.
Thrown when attempting to load an invalid Plugin file
Deprecated.
Represents how a
Structure
can be used.This annotation indicates a method (and sometimes constructor) will chain
its internal operations.
ValidatingPrompt is the base class for any prompt that requires validation.
Represents a mutable vector.
Represents a vehicle entity.
Raised when a vehicle collides with a block.
Raised when a vehicle collides.
Raised when a vehicle is created.
Raised when a vehicle receives damage.
Raised when a vehicle is destroyed, which could be caused by either a
player or the environment.
Raised when an entity enters a vehicle.
Raised when a vehicle collides with an entity.
Represents a vehicle-related event.
Raised when a living entity exits a vehicle.
Raised when a vehicle moves.
Called when a vehicle updates
Represents a Vex.
Represents a vibration from a Skulk sensor.
Represents a villager NPC
Represents the various different Villager professions there may be.
Represents Villager type, usually corresponding to what biome they spawn
in.
Called whenever a villager acquires a new trade.
Reasons for the villager's profession changing.
Called when a
Villager
is about to restock one of its trades.Represents a Vindicator.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
A shape made out of voxels.
This class encompasses the 'north', 'east', 'south', 'west', height flags
which are used to set the height of a wall.
The different heights a face of a wall may have.
Represents a wandering trader NPC
A Warden.
This designates the warning state for a specific item.
This represents the states that server verbose for warnings may be.
'waterlogged' denotes whether this block has fluid in it.
Represents a Water Mob
Stores data for weather changing in a world
Represents a Weather-related event
An enum of all current weather types
Represents a Witch
Represents a Wither boss
Represents one of the Wither's heads.
Represents a WitherSkeleton - variant of
AbstractSkeleton
.Represents a wither skull
Fireball
.Represents a Wolf
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Deprecated.
all usage of MaterialData is deprecated and subject to removal.
Represents a world, which may contain entities, chunks and blocks
Represents various map environment types that a world may be
Represents various types of options that may be used to create a world.
Represents events within a world
Holds various information of a World
Called when a World is initializing.
Called when a World is loaded
Called when a World is saved.
Represents various types of worlds that may exist
Called when a World is unloaded
An implementation of
Configuration
which saves all files in Yaml.Various settings for controlling the input and output of a
YamlConfiguration
Represents a Zoglin.
Represents a Zombie.
Represents a ZombieHorse - variant of
AbstractHorse
.