Azimkin/Bukkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added JavaDoc @see comments and @todo notes for those that aren't specified in the listener

Browse Source
This commit is contained in:
Luke GB 2011-01-09 13:14:28 +00:00
parent 154cae99a8
commit 7c93a16862
1 changed files with 87 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
src/main/java/org/bukkit/event/Event.java
View File

@ -129,6 +129,8 @@ public abstract class Event {
/** /**
* Provides a lookup for all core events * Provides a lookup for all core events
*
* @see org.bukkit.event.
*/ */
public enum Type { public enum Type {
/** /**
@ -137,46 +139,64 @@ public abstract class Event {
/** /**
* Called when a player joins a server * Called when a player joins a server
*
* @see org.bukkit.event.player.PlayerEvent
*/ */
PLAYER_JOIN (Category.PLAYER), PLAYER_JOIN (Category.PLAYER),
/** /**
* Called when a player is attempting to join a server * Called when a player is attempting to join a server
*
* @see org.bukkit.event.player.PlayerLoginEvent
*/ */
PLAYER_LOGIN (Category.PLAYER), PLAYER_LOGIN (Category.PLAYER),
/** /**
* Called when a player sends a chat message * Called when a player sends a chat message
*
* @see org.bukkit.event.player.PlayerChatEvent
*/ */
PLAYER_CHAT (Category.PLAYER), PLAYER_CHAT (Category.PLAYER),
/** /**
* Called when a player attempts to use a command * Called when a player attempts to use a command
*
* @see org.bukkit.event.player.PlayerChatEvent
*/ */
PLAYER_COMMAND (Category.PLAYER), PLAYER_COMMAND (Category.PLAYER),
/** /**
* Called when a player leaves a server * Called when a player leaves a server
*
* @see org.bukkit.event.player.PlayerEvent
*/ */
PLAYER_QUIT (Category.PLAYER), PLAYER_QUIT (Category.PLAYER),
/** /**
* Called when a player moves position in the world * Called when a player moves position in the world
*
* @see org.bukkit.event.player.PlayerMoveEvent
*/ */
PLAYER_MOVE (Category.PLAYER), PLAYER_MOVE (Category.PLAYER),
/** /**
* Called when a player undergoes an animation, such as arm swinging * Called when a player undergoes an animation, such as arm swinging
*
* @todo: add javadoc see comment
*/ */
PLAYER_ANIMATION (Category.PLAYER), PLAYER_ANIMATION (Category.PLAYER),
/** /**
* Called when a player uses an item * Called when a player uses an item
*
* @see org.bukkit.event.player.PlayerItemEvent
*/ */
PLAYER_ITEM (Category.PLAYER), PLAYER_ITEM (Category.PLAYER),
/** /**
* Called when a player teleports from one position to another * Called when a player teleports from one position to another
*
* @see org.bukkit.event.player.PlayerMoveEvent
*/ */
PLAYER_TELEPORT (Category.PLAYER), PLAYER_TELEPORT (Category.PLAYER),
@ -186,6 +206,7 @@ public abstract class Event {
/** /**
* Called when a block is damaged (hit by a player) * Called when a block is damaged (hit by a player)
* @todo: Add Javadoc see note here.
*/ */
BLOCK_DAMAGED (Category.BLOCK), BLOCK_DAMAGED (Category.BLOCK),
@ -194,18 +215,24 @@ public abstract class Event {
* check on whether it can be built * check on whether it can be built
* *
* For example, cacti cannot be built on grass unless overridden here * For example, cacti cannot be built on grass unless overridden here
*
* @see org.bukkit.event.block.BlockCanBuildEvent
*/ */
BLOCK_CANBUILD (Category.BLOCK), BLOCK_CANBUILD (Category.BLOCK),
/** /**
* Called when a block of water or lava attempts to flow into another * Called when a block of water or lava attempts to flow into another
* block * block
*
* @see org.bukkit.event.block.BlockFromToEvent
*/ */
BLOCK_FLOW (Category.BLOCK), BLOCK_FLOW (Category.BLOCK),
/** /**
* Called when a block is being set on fire from another block, such as * Called when a block is being set on fire from another block, such as
* an adjacent block of fire attempting to set fire to wood * an adjacent block of fire attempting to set fire to wood
*
* @see org.bukkit.event.block.BlockIgniteEvent
*/ */
BLOCK_IGNITE (Category.BLOCK), BLOCK_IGNITE (Category.BLOCK),
@ -214,32 +241,44 @@ public abstract class Event {
* *
* A physics check is commonly called when an adjacent block changes * A physics check is commonly called when an adjacent block changes
* type * type
*
* @see org.bukkit.event.block.BlockPhysicsEvent
*/ */
BLOCK_PHYSICS (Category.BLOCK), BLOCK_PHYSICS (Category.BLOCK),
/** /**
* Called when a player is attempting to place a block * Called when a player is attempting to place a block
*
* @see org.bukkit.event.block.BlockRightClickedEvent
*/ */
BLOCK_RIGHTCLICKED (Category.BLOCK), BLOCK_RIGHTCLICKED (Category.BLOCK),
/** /**
* Called when a player is attempting to place a block * Called when a player is attempting to place a block
*
* @see org.bukkit.event.block.BlockPlacedEvent
*/ */
BLOCK_PLACED (Category.BLOCK), BLOCK_PLACED (Category.BLOCK),
/** /**
* Called when an entity interacts with a block (lever, door, pressure plate, chest, furnace) * Called when an entity interacts with a block (lever, door, pressure plate, chest, furnace)
*
* @see org.bukkit.event.block.BlockInteractEvent
*/ */
BLOCK_INTERACT (Category.BLOCK), BLOCK_INTERACT (Category.BLOCK),
/** /**
* Called when leaves are decaying naturally * Called when leaves are decaying naturally
*
* @see org.bukkit.event.block.LeavesDecayEvent
*/ */
LEAVES_DECAY (Category.BLOCK), LEAVES_DECAY (Category.BLOCK),
/** /**
* Called when a liquid attempts to flow into a block which already * Called when a liquid attempts to flow into a block which already
* contains a "breakable" block, such as redstone wire * contains a "breakable" block, such as redstone wire
*
* @todo: add javadoc see comment
*/ */
LIQUID_DESTROY (Category.BLOCK), LIQUID_DESTROY (Category.BLOCK),
@ -247,6 +286,8 @@ public abstract class Event {
* Called when a block changes redstone current. Only triggered on blocks * Called when a block changes redstone current. Only triggered on blocks
* that are actually capable of transmitting or carrying a redstone * that are actually capable of transmitting or carrying a redstone
* current * current
*
* @see org.bukkit.event.block.BlockFromToEvent
*/ */
REDSTONE_CHANGE (Category.BLOCK), REDSTONE_CHANGE (Category.BLOCK),
@ -256,26 +297,36 @@ public abstract class Event {
/** /**
* Called when a player opens an inventory * Called when a player opens an inventory
*
* @todo: add javadoc see comment
*/ */
INVENTORY_OPEN (Category.INVENTORY), INVENTORY_OPEN (Category.INVENTORY),
/** /**
* Called when a player closes an inventory * Called when a player closes an inventory
*
* @todo: add javadoc see comment
*/ */
INVENTORY_CLOSE (Category.INVENTORY), INVENTORY_CLOSE (Category.INVENTORY),
/** /**
* Called when a player clicks on an inventory slot * Called when a player clicks on an inventory slot
*
* @todo: add javadoc see comment
*/ */
INVENTORY_CLICK (Category.INVENTORY), INVENTORY_CLICK (Category.INVENTORY),
/** /**
* Called when an inventory slot changes values or type * Called when an inventory slot changes values or type
*
* @todo: add javadoc see comment
*/ */
INVENTORY_CHANGE (Category.INVENTORY), INVENTORY_CHANGE (Category.INVENTORY),
/** /**
* Called when a player is attempting to perform an inventory transaction * Called when a player is attempting to perform an inventory transaction
*
* @todo: add javadoc see comment
*/ */
INVENTORY_TRANSACTION (Category.INVENTORY), INVENTORY_TRANSACTION (Category.INVENTORY),
@ -285,11 +336,15 @@ public abstract class Event {
/** /**
* Called when a plugin is enabled * Called when a plugin is enabled
*
* @see org.bukkit.event.server.PluginEvent
*/ */
PLUGIN_ENABLE (Category.SERVER), PLUGIN_ENABLE (Category.SERVER),
/** /**
* Called when a plugin is disabled * Called when a plugin is disabled
*
* @see org.bukkit.event.server.PluginEvent
*/ */
PLUGIN_DISABLE (Category.SERVER), PLUGIN_DISABLE (Category.SERVER),
@ -302,21 +357,29 @@ public abstract class Event {
* *
* If a new chunk is being generated for loading, it will call * If a new chunk is being generated for loading, it will call
* Type.CHUNK_GENERATION and then Type.CHUNK_LOADED upon completion * Type.CHUNK_GENERATION and then Type.CHUNK_LOADED upon completion
*
* @see org.bukkit.event.world.ChunkLoadedEvent
*/ */
CHUNK_LOADED (Category.WORLD), CHUNK_LOADED (Category.WORLD),
/** /**
* Called when a chunk is unloaded * Called when a chunk is unloaded
*
* @see org.bukkit.event.world.ChunkUnloadedEvent
*/ */
CHUNK_UNLOADED (Category.WORLD), CHUNK_UNLOADED (Category.WORLD),
/** /**
* Called when a chunk needs to be generated * Called when a chunk needs to be generated
*
* @todo: add javadoc see comment
*/ */
CHUNK_GENERATION (Category.WORLD), CHUNK_GENERATION (Category.WORLD),
/** /**
* Called when an ItemEntity spawns in the world * Called when an ItemEntity spawns in the world
*
* @todo: add javadoc see comment
*/ */
ITEM_SPAWN (Category.WORLD), ITEM_SPAWN (Category.WORLD),
@ -327,27 +390,37 @@ public abstract class Event {
/** /**
* Called when a creature, either hostile or neutral, attempts to spawn * Called when a creature, either hostile or neutral, attempts to spawn
* in the world "naturally" * in the world "naturally"
*
* @todo: add javadoc see comment
*/ */
CREATURE_SPAWN (Category.LIVING_ENTITY), CREATURE_SPAWN (Category.LIVING_ENTITY),
/** /**
* Called when a LivingEntity is damaged by the environment (for example, * Called when a LivingEntity is damaged by the environment (for example,
* falling or lava) * falling or lava)
*
* @see org.bukkit.event.entity.EntityDamagedByBlockEvent
*/ */
ENTITY_DAMAGEDBY_BLOCK (Category.LIVING_ENTITY), ENTITY_DAMAGEDBY_BLOCK (Category.LIVING_ENTITY),
/** /**
* Called when a LivingEntity is damaged by another LivingEntity * Called when a LivingEntity is damaged by another LivingEntity
*
* @see org.bukkit.event.entity.EntityDamagedByEntityEvent
*/ */
ENTITY_DAMAGEDBY_ENTITY (Category.LIVING_ENTITY), ENTITY_DAMAGEDBY_ENTITY (Category.LIVING_ENTITY),
/** /**
* Called when a LivingEntity is damaged with no source. * Called when a LivingEntity is damaged with no source.
*
* @see org.bukkit.event.entity.EntityDamagedEvent
*/ */
ENTITY_DAMAGED(Category.LIVING_ENTITY), ENTITY_DAMAGED(Category.LIVING_ENTITY),
/** /**
* Called when a LivingEntity dies * Called when a LivingEntity dies
*
* @todo: add javadoc see comment
*/ */
ENTITY_DEATH (Category.LIVING_ENTITY), ENTITY_DEATH (Category.LIVING_ENTITY),
@ -357,36 +430,50 @@ public abstract class Event {
/** /**
* Called when a vehicle is placed by a player * Called when a vehicle is placed by a player
*
* @see org.bukkit.event.vehicle.VehicleCreateEvent
*/ */
VEHICLE_CREATE (Category.VEHICLE), VEHICLE_CREATE (Category.VEHICLE),
/** /**
* Called when a vehicle is damaged by a LivingEntity * Called when a vehicle is damaged by a LivingEntity
*
* @see org.bukkit.event.vehicle.VehicleDamageEvent
*/ */
VEHICLE_DAMAGE (Category.VEHICLE), VEHICLE_DAMAGE (Category.VEHICLE),
/** /**
* Called when a vehicle collides with an Entity * Called when a vehicle collides with an Entity
*
* @see org.bukkit.event.vehicle.VehicleCollisionEvent
*/ */
VEHICLE_COLLISION_ENTITY (Category.VEHICLE), VEHICLE_COLLISION_ENTITY (Category.VEHICLE),
/** /**
* Called when a vehicle collides with a Block * Called when a vehicle collides with a Block
*
* @see org.bukkit.event.vehicle.VehicleBlockCollisionEvent
*/ */
VEHICLE_COLLISION_BLOCK (Category.VEHICLE), VEHICLE_COLLISION_BLOCK (Category.VEHICLE),
/** /**
* Called when a vehicle is entered by a LivingEntity * Called when a vehicle is entered by a LivingEntity
*
* @see org.bukkit.event.vehicle.VehicleEnterEvent
*/ */
VEHICLE_ENTER (Category.VEHICLE), VEHICLE_ENTER (Category.VEHICLE),
/** /**
* Called when a vehicle is exited by a LivingEntity * Called when a vehicle is exited by a LivingEntity
*
* @see org.bukkit.event.vehicle.VehicleExitEvent
*/ */
VEHICLE_EXIT (Category.VEHICLE), VEHICLE_EXIT (Category.VEHICLE),
/** /**
* Called when a vehicle moves position in the world * Called when a vehicle moves position in the world
*
* @see org.bukkit.event.vehicle.VehicleMoveEvent
*/ */
VEHICLE_MOVE (Category.VEHICLE), VEHICLE_MOVE (Category.VEHICLE),