Bukkit 1.5-R0.1-SNAPSHOT API

Bukkit, the plugin development framework.

See:
          Description

Packages
org.bukkit More generalized classes in the API.
org.bukkit.block Classes used to manipulate the voxels in a world, including special states.
org.bukkit.command Classes relating to handling specialized non-chat player input.
org.bukkit.command.defaults Commands for emulating the Minecraft commands and other necessary ones for use by a Bukkit implementation.
org.bukkit.configuration Classes dedicated to handling a plugin's runtime configuration.
org.bukkit.configuration.file Classes dedicated facilitating configurations to be read and stored on the filesystem.
org.bukkit.configuration.serialization Classes dedicated to being able to perform serialization specialized for the Bukkit configuration implementation.
org.bukkit.conversations Classes dedicated to facilitate direct player-to-plugin communication.
org.bukkit.enchantments Classes relating to the specialized enhancements to item stacks, as part of the meta data.
org.bukkit.entity Interfaces for non-voxel objects that can exist in a world, including all players, monsters, projectiles, etc.
org.bukkit.entity.minecart Interfaces for various Minecart types.
org.bukkit.event Classes dedicated to handling triggered code executions.
org.bukkit.event.block Events relating to when a block is changed or interacts with the world.
org.bukkit.event.enchantment Events triggered from an enchantment table.
org.bukkit.event.entity Events relating to entities, excluding some directly referencing some more specific entity types.
org.bukkit.event.hanging Events relating to entities that hang.
org.bukkit.event.inventory Events relating to inventory manipulation.
org.bukkit.event.painting Events relating to paintings, but deprecated for more general hanging events.
org.bukkit.event.player Events relating to players.
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 Events triggered by various world states or changes.
org.bukkit.generator Classes to facilitate world generation implementation.
org.bukkit.help Classes used to manipulate the default command and topic assistance system.
org.bukkit.inventory Classes involved in manipulating player inventories and item interactions.
org.bukkit.inventory.meta The interfaces used when manipulating extra data can can be stored inside item stacks.
org.bukkit.map Classes to facilitate plugin handling of map displays.
org.bukkit.material Classes that represents various voxel types and states.
org.bukkit.metadata Classes dedicated to providing a layer of plugin specified data on various Minecraft concepts.
org.bukkit.permissions Classes dedicated to providing binary state properties to players.
org.bukkit.plugin Classes specifically relating to loading software modules at runtime.
org.bukkit.plugin.java Classes for handling plugins written in java.
org.bukkit.plugin.messaging Classes dedicated to specialized plugin to client protocols.
org.bukkit.potion Classes to represent various potion properties and manipulation.
org.bukkit.scheduler Classes dedicated to letting plugins run code at specific time intervals, including thread safety.
org.bukkit.util Multi and single purpose classes to facilitate various programmatic concepts.
org.bukkit.util.noise Classes dedicated to facilitating deterministic noise.
org.bukkit.util.permissions Static methods for miscellaneous permission functionality.

 

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.



Copyright © 2013. All Rights Reserved.