Spigot-API 1.19.3-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
package. It covers the basic requirements of a plugin jar.
For handling events and triggered code, see the
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.
world, including special states.
configurationsto be read and stored on the filesystem.
item stacks, as part of the
world, including all players, monsters, projectiles, etc.
Eventstriggered from an
entities that hang.
Eventsrelated to raids.
Eventsrelating to programmatic state changes on the server.
Eventsrelating to weather.
pluginswritten in java.
potionproperties and manipulation.
pluginsrun code at specific time intervals, including thread safety.
Structure blocksin the world.