Package org.bukkit

The root package of the Bukkit API, contains generalized API classes. 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.

Interface Summary

Interface	Description
BanEntry	A single entry from a ban list.
BanList	A ban list, containing bans of some BanList.Type.
BlockChangeDelegate	A delegate for handling block changes.
Chunk	Represents a chunk of blocks
ChunkSnapshot	Represents a static, thread-safe snapshot of chunk of blocks.
Keyed	Represents an object which has a NamespacedKey attached to it.
Nameable
OfflinePlayer
Raid	Represents a raid event.
Registry<T extends Keyed>	Represents a registry of Bukkit objects that may be retrieved by NamespacedKey.
Server	Represents a server implementation.
Tag<T extends Keyed>	Represents a tag that may be defined by the server or a resource pack to group like things together.
UnsafeValues	Deprecated.
World	Represents a world, which may contain entities, chunks and blocks
WorldBorder

Class Summary

Class	Description
Bukkit	Represents the Bukkit core, for version and Server singleton handling
Color	A container for a color palette.
FireworkEffect	Represents a single firework effect.
FireworkEffect.Builder	This is a builder for FireworkEffects.
GameRule<T>	GameRules dictate certain behavior within Minecraft itself For more information please visit the Minecraft Wiki
Location	Represents a 3-dimensional position in a world.
NamespacedKey	Represents a String based key which consists of two components - a namespace and a key.
Note	A note class to store a specific note.
Particle.DustOptions	Options which can be applied to redstone dust particles - a particle color and size.
Registry.SimpleRegistry<T extends Enum<T> & Keyed>
Server.Spigot
StructureType	This class handles the creation and storage of all structure types for Bukkit.
World.Spigot
WorldCreator	Represents various types of options that may be used to create a world.

Enum Summary

Enum	Description
Art	Represents the art on a painting
Axis	Represents a mutually perpendicular axis in 3D Cartesian coordinates.
BanList.Type	Represents a ban-type that a BanList may track.
ChatColor	All supported color values for chat
CoalType	Represents the two types of coal
CropState	Represents the different growth states of crops
Difficulty	Represents the various difficulty levels that are available.
DyeColor	All supported color values for dyes and cloth
Effect	A list of effects that the server is able to send to players.
Effect.Type	Represents the type of an effect.
EntityEffect	A list of all Effects that can happen to entities.
FireworkEffect.Type	The type or shape of the effect.
FluidCollisionMode	Determines the collision behavior when fluids get hit during ray tracing.
GameMode	Represents the various type of game modes that HumanEntitys may have
GrassSpecies	Represents the different types of grass.
HeightMap	Further information regarding heightmaps.
Instrument
Material	An enum of all material IDs accepted by the official server and client
NetherWartsState
Note.Tone	An enum holding tones.
Particle
PortalType	Represents various types of portals that can be made in a world.
Raid.RaidStatus	Represents the status of a Raid.
Rotation	An enum to specify a rotation based orientation, like that on a clock.
SandstoneType	Represents the three different types of Sandstone
SkullType	Deprecated. check Material instead
Sound	An Enum of Sounds the server is able to send to players.
SoundCategory	An Enum of categories for sounds.
Statistic	Represents a countable statistic, which is tracked by the server.
Statistic.Type	The type of statistic.
TreeSpecies	Represents the different species of trees regardless of size.
TreeType	Tree and organic structure types.
Warning.WarningState	This represents the states that server verbose for warnings may be.
WeatherType	An enum of all current weather types
World.Environment	Represents various map environment types that a world may be
WorldType	Represents various types of worlds that may exist

Annotation Types Summary

Annotation Type	Description
UndefinedNullability	Deprecated. This should generally not be used in any new API code as it suggests a bad API design.
Utility	This annotation indicates a method (and sometimes constructor) will chain its internal operations.
Warning	This designates the warning state for a specific item.