paper-api 1.18.2-R0.1-SNAPSHOT API
Bukkit, the plugin development framework.
The documentation is for developing plugins and is split into the respective packages for each subject matter. This documentation does not cover running a server, contributing code back to the project, or setting up a workspace. Working knowledge of the Java language is a prerequisite for developing plugins.
For basic plugin development, see the plugin
package. It covers the basic requirements of a plugin jar.
For handling events and triggered code, see the event package.
Note: While the Bukkit API makes every effort to ensure stability, this is not guaranteed, especially across major versions. In particular the following is a (incomplete) list of things that are not API.
- Implementing interfaces. The Bukkit API is designed to only be
implemented by server software. Unless a class/interface is obviously
designed for extension (eg
BukkitRunnable), or explicitly marked as such, it should not be implemented by plugins. Although this can sometimes work, it is not guaranteed to do so and resulting bugs will be disregarded. - Constructing inbuilt events. Although backwards compatibility is attempted where possible, it is sometimes not possible to add new fields to events without breaking existing constructors. To ensure that the API continues to evolve, event constructors are therefore not plugin API.
- Implementation classes. Concrete implementation classes packaged with Bukkit (eg those beginning with Simple) are not API. You should access them via their interfaces instead.
Packages
Package
Description
The root package of the Bukkit API, contains generalized API classes.
Classes relevant to advancements.
Classes relevant to attributes.
Classes used to manipulate the voxels in a
world,
including special states.Classes relevant to banner blocks.
Generalized BlockData classes.
Specific BlockData classes relevant to only a given block or set of blocks.
Classes relevant to structure blocks.
Classes concerning the creation of boss bars that appear at the top of the
player's screen.
Classes relating to handling specialized non-chat player input.
Commands for emulating the Minecraft commands and other necessary ones for
use by a Bukkit implementation.
Classes dedicated to handling a plugin's runtime configuration.
Classes dedicated to facilitating
configurations to be read and
stored on the filesystem.Classes dedicated to being able to perform serialization specialized for
the Bukkit
configuration
implementation.Classes dedicated to facilitate direct player-to-plugin communication.
Classes relating to the specialized enhancements to
item stacks, as part of the meta data.Interfaces for non-voxel objects that can exist in a
world, including all players, monsters, projectiles, etc.Classes concerning an entity's persistent memory.
Interfaces for various
Minecart types.Classes dedicated to handling triggered code executions.
Events triggered from an enchantment table.Events relating to entities that hang.Events related to raids.Events relating to programmatic state
changes on the server.Events relating to vehicular entities.Events relating to weather.Classes to facilitate
world generation
implementation.Classes used to manipulate the default command and topic assistance system.
Classes involved in manipulating player inventories and item interactions.
The interfaces used when manipulating extra data can can be stored inside
item stacks.Classes that allow attaching custom data to items.
Classes relevant to loot table manipulation and generation.
Classes to facilitate plugin handling of
map displays.Classes that represents various voxel types and states.
Classes relevant to specific material types.
Classes dedicated to providing a layer of plugin specified data on various
Minecraft concepts.
Classes dedicated to providing binary state properties to players.
Classes that allow attaching persistent data to various objects.
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 to represent various
potion
properties and manipulation.Classes relevant to player profiles.
Classes to represent the source of a projectile
Classes dedicated to letting
plugins run
code at specific time intervals, including thread safety.Interfaces used to manage the client side score display system.
Classes related to creating or using
structures without creating Structure
blocks in the world.Multi and single purpose classes to facilitate various programmatic
concepts.
Classes used to facilitate stream processing for specific Bukkit concepts.
Classes dedicated to facilitating deterministic noise.
Static methods for miscellaneous
permission functionality.Spigot-specific classes.
Spigot-specific entity events.
Spigot-specific player events.