SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More JavaDoc improvements.

Browse Source 
By: EvilSeph <evilseph@unaligned.org>
This commit is contained in:
Bukkit/Spigot
2011-06-24 02:32:04 -04:00
parent 0630db640b
commit c54128077a
56 changed files with 435 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
paper-api/src/main/java/org/bukkit/event/Event.java
View File

@@ -26,6 +26,7 @@ public abstract class Event implements Serializable {
/**
* Gets the Type of this event
*
* @return Event type that this object represents
*/
public final Type getType() {
@@ -89,6 +90,7 @@ public abstract class Event implements Serializable {
/**
* Represents Player-based events
*
* @see Category.LIVING_ENTITY
*/
PLAYER,
@@ -109,7 +111,7 @@ public abstract class Event implements Serializable {
*/
WEATHER,
/**
* Vehicle-based events
* Represents Vehicle-based events
*/
VEHICLE,
/**
@@ -125,7 +127,7 @@ public abstract class Event implements Serializable {
*/
INVENTORY,
/**
* Any miscellaneous events
* Represents any miscellaneous events
*/
MISCELLANEOUS;
}
@@ -144,7 +146,7 @@ public abstract class Event implements Serializable {
/**
* Called when a player enters the world on a server
*
* @see org.bukkit.event.player.PlayerEvent
* @see org.bukkit.event.player.PlayerJoinEvent
*/
PLAYER_JOIN (Category.PLAYER),
/**
@@ -162,13 +164,13 @@ public abstract class Event implements Serializable {
/**
* Called when a player respawns
*
* @see org.bukkit.event.player.PlayerEvent
* @see org.bukkit.event.player.PlayerRespawnEvent
*/
PLAYER_RESPAWN (Category.PLAYER),
/**
* Called when a player gets kicked a server
* Called when a player gets kicked from the server
*
* @see org.bukkit.event.player.PlayerEvent
* @see org.bukkit.event.player.PlayerKickEvent
*/
PLAYER_KICK (Category.PLAYER),
/**
@@ -178,15 +180,15 @@ public abstract class Event implements Serializable {
*/
PLAYER_CHAT (Category.PLAYER),
/**
* Called when a player early in the command handling process
* Called when a player uses a command (early in the command handling process)
*
* @see org.bukkit.event.player.PlayerChatEvent
* @see org.bukkit.event.player.PlayerCommandPreprocessEvent
*/
PLAYER_COMMAND_PREPROCESS (Category.PLAYER),
/**
* Called when a player leaves a server
* Called when a player leaves the server
*
* @see org.bukkit.event.player.PlayerEvent
* @see org.bukkit.event.player.PlayerQuitEvent
*/
PLAYER_QUIT (Category.PLAYER),
/**
@@ -196,7 +198,7 @@ public abstract class Event implements Serializable {
*/
PLAYER_MOVE (Category.PLAYER),
/**
* Called when a player undergoes an animation, such as arm swinging
* Called when a player undergoes an animation (Arm Swing is the only animation currently supported)
*
* @see org.bukkit.event.player.PlayerAnimationEvent
*/
@@ -204,13 +206,13 @@ public abstract class Event implements Serializable {
/**
* Called when a player toggles sneak mode
*
* @todo: add javadoc see comment
* @see org.bukkit.event.player.PlayerToggleSneakEvent
*/
PLAYER_TOGGLE_SNEAK (Category.PLAYER),
/**
* Called when a player uses an item
* Called when a player interacts with an object or air
*
* @see org.bukkit.event.player.PlayerItemEvent
* @see org.bukkit.event.player.PlayerInteractEvent
*/
PLAYER_INTERACT (Category.PLAYER),
/**
@@ -220,7 +222,7 @@ public abstract class Event implements Serializable {
*/
PLAYER_INTERACT_ENTITY (Category.PLAYER),
/**
* Called when a player throws an egg and it might hatch
* Called when a player throws an egg
*
* @see org.bukkit.event.player.PlayerEggThrowEvent
*/
@@ -228,7 +230,7 @@ public abstract class Event implements Serializable {
/**
* Called when a player teleports from one position to another
*
* @see org.bukkit.event.player.PlayerMoveEvent
* @see org.bukkit.event.player.PlayerTeleportEvent
*/
PLAYER_TELEPORT (Category.PLAYER),
/**
@@ -282,7 +284,7 @@ public abstract class Event implements Serializable {
/**
* Called when a player leaves a bed
*
* @see org.bukkit.event.player.PlayerBedEnterEvent
* @see org.bukkit.event.player.PlayerBedLeaveEvent
*/
PLAYER_BED_LEAVE(Category.PLAYER),
@@ -337,7 +339,7 @@ public abstract class Event implements Serializable {
/**
* Called when a block dispenses something
*
* @see org.bukkit.event.block.BlockPlaceEvent
* @see org.bukkit.event.block.BlockDispenseEvent
*/
BLOCK_DISPENSE (Category.BLOCK),
/**
@@ -363,11 +365,11 @@ public abstract class Event implements Serializable {
* that are actually capable of transmitting or carrying a redstone
* current
*
* @see org.bukkit.event.block.BlockFromToEvent
* @see org.bukkit.event.block.BlockRedstoneEvent
*/
REDSTONE_CHANGE (Category.BLOCK),
/**
* Called when a block is destroyed by a player.
* Called when a block is broken by a player
*
* @see org.bukkit.event.block.BlockBreakEvent
*/
@@ -431,14 +433,12 @@ public abstract class Event implements Serializable {
* @todo: add javadoc see comment
*/
INVENTORY_TRANSACTION (Category.INVENTORY),
/**
* Called when an ItemStack is successfully smelted in a furnace.
*
* @see org.bukkit.event.inventory.FurnaceSmeltEvent
*/
FURNACE_SMELT (Category.INVENTORY),
/**
* Called when an ItemStack is successfully burned as fuel in a furnace.
*
@@ -453,19 +453,19 @@ public abstract class Event implements Serializable {
/**
* Called when a plugin is enabled
*
* @see org.bukkit.event.server.PluginEvent
* @see org.bukkit.event.server.PluginEnableEvent
*/
PLUGIN_ENABLE (Category.SERVER),
/**
* Called when a plugin is disabled
*
* @see org.bukkit.event.server.PluginEvent
* @see org.bukkit.event.server.PluginDisableEvent
*/
PLUGIN_DISABLE (Category.SERVER),
/**
* Called when a server command is called
*
* @see org.bukkit.event.server.PluginEvent
* @see org.bukkit.event.server.ServerCommandEvent
*/
SERVER_COMMAND (Category.SERVER),
@@ -511,18 +511,25 @@ public abstract class Event implements Serializable {
/**
* Called when a world is saved
*
* @see org.bukkit.event.world.WorldSaveEvent
*/
WORLD_SAVE (Category.WORLD),
/**
* Called when a World is initializing
*
* @see org.bukkit.event.world.WorldInitEvent
*/
WORLD_INIT (Category.WORLD),
/**
* Called when a World is loaded
*
* @see org.bukkit.event.world.WorldLoadEvent
*/
WORLD_LOAD (Category.WORLD),
/**
* Called when a World is unloaded
*
* @see org.bukkit.event.world.WorldUnloadEvent
*/
WORLD_UNLOAD (Category.WORLD),
/**
@@ -539,13 +546,13 @@ public abstract class Event implements Serializable {
/**
* Called when a painting is placed by player
*
* @see org.bukkit.event.painting.PaintingCreateEvent
* @see org.bukkit.event.painting.PaintingPlaceEvent
*/
PAINTING_PLACE (Category.ENTITY),
/**
* Called when a painting is removed
*
* @see org.bukkit.event.painting.PaintingRemoveEvent
* @see org.bukkit.event.painting.PaintingBreakEvent
*/
PAINTING_BREAK (Category.ENTITY),
/**
@@ -563,7 +570,7 @@ public abstract class Event implements Serializable {
* Called when a creature, either hostile or neutral, attempts to spawn
* in the world "naturally"
*
* @todo: add javadoc see comment
* @see org.bukkit.event.entity.CreatureSpawnEvent
*/
CREATURE_SPAWN (Category.LIVING_ENTITY),
/**
@@ -575,19 +582,19 @@ public abstract class Event implements Serializable {
/**
* Called when a LivingEntity dies
*
* @todo: add javadoc see comment
* @see org.bukkit.event.entity.EntityDeathEvent
*/
ENTITY_DEATH (Category.LIVING_ENTITY),
/**
* Called when a Skeleton or Zombie catch fire due to the sun
*
* @todo: add javadoc see comment
* @see org.bukkit.event.entity.EntityCombustEvent
*/
ENTITY_COMBUST (Category.LIVING_ENTITY),
/**
* Called when an entity explodes, either TNT, Creeper, or Ghast Fireball
*
* @todo: add javadoc see comment
* @see org.bukkit.event.entity.EntityExplodeEvent
*/
ENTITY_EXPLODE (Category.LIVING_ENTITY),
/**
@@ -600,7 +607,7 @@ public abstract class Event implements Serializable {
* For EntityCreeper, this resets the fuse but does not kill the Entity.
* For EntityFireball and EntityTNTPrimed....?
*
* @see org.bukkit.event.entity.EntityExplodeTriggerEvent
* @see org.bukkit.event.entity.ExplosionPrimeEvent
*/
EXPLOSION_PRIME (Category.LIVING_ENTITY),
/**