Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-04-02 00:11:22 -04:00
parent 745a0d7683
commit 761a84cb1b
93 changed files with 539 additions and 505 deletions

View File

@@ -9,7 +9,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a creature is spawned into a world.
* <p />
* <p>
* If a Creature Spawn event is cancelled, the creature will not spawn.
*/
public class CreatureSpawnEvent extends EntityEvent implements Cancellable {

View File

@@ -7,7 +7,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a Creeper is struck by lightning.
* <p />
* <p>
* If a Creeper Power event is cancelled, the Creeper will not be powered.
*/
public class CreeperPowerEvent extends EntityEvent implements Cancellable {

View File

@@ -7,7 +7,7 @@ import org.bukkit.entity.LivingEntity;
/**
* Called when an {@link Entity} breaks a door
* <p />
* <p>
* Canceling the event will cause the event to be delayed
*/
public class EntityBreakDoorEvent extends EntityChangeBlockEvent {

View File

@@ -13,7 +13,7 @@ public class EntityCombustByBlockEvent extends EntityCombustEvent {
/**
* The combuster can be lava or a block that is on fire.
* <p />
* <p>
* WARNING: block may be null.
*
* @return the Block that set the combustee alight.

View File

@@ -11,7 +11,7 @@ public class EntityCombustByEntityEvent extends EntityCombustEvent {
}
/**
* The combuster can be a WeatherStorm a Blaze, or an Entity holding a FIRE_ASPECT enchanted item.
* Get the entity that caused the combustion event.
*
* @return the Entity that set the combustee alight.
*/

View File

@@ -6,7 +6,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when an entity combusts.
* <p />
* <p>
* If an Entity Combust event is cancelled, the entity will not combust.
*/
public class EntityCombustEvent extends EntityEvent implements Cancellable {
@@ -37,7 +37,7 @@ public class EntityCombustEvent extends EntityEvent implements Cancellable {
/**
* The number of seconds the combustee should be alight for.
* <p />
* <p>
* This value will only ever increase the combustion time, not decrease existing combustion times.
*
* @param duration the time in seconds to be alight for.

View File

@@ -70,109 +70,109 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
/**
* Damage caused when an entity contacts a block such as a Cactus.
* <p />
* <p>
* Damage: 1 (Cactus)
*/
CONTACT,
/**
* Damage caused when an entity attacks another entity.
* <p />
* <p>
* Damage: variable
*/
ENTITY_ATTACK,
/**
* Damage caused when attacked by a projectile.
* <p />
* <p>
* Damage: variable
*/
PROJECTILE,
/**
* Damage caused by being put in a block
* <p />
* <p>
* Damage: 1
*/
SUFFOCATION,
/**
* Damage caused when an entity falls a distance greater than 3 blocks
* <p />
* <p>
* Damage: fall height - 3.0
*/
FALL,
/**
* Damage caused by direct exposure to fire
* <p />
* <p>
* Damage: 1
*/
FIRE,
/**
* Damage caused due to burns caused by fire
* <p />
* <p>
* Damage: 1
*/
FIRE_TICK,
/**
* Damage caused due to a snowman melting
* <p />
* <p>
* Damage: 1
*/
MELTING,
/**
* Damage caused by direct exposure to lava
* <p />
* <p>
* Damage: 4
*/
LAVA,
/**
* Damage caused by running out of air while in water
* <p />
* <p>
* Damage: 2
*/
DROWNING,
/**
* Damage caused by being in the area when a block explodes.
* <p />
* <p>
* Damage: variable
*/
BLOCK_EXPLOSION,
/**
* Damage caused by being in the area when an entity, such as a Creeper, explodes.
* <p />
* <p>
* Damage: variable
*/
ENTITY_EXPLOSION,
/**
* Damage caused by falling into the void
* <p />
* <p>
* Damage: 4 for players
*/
VOID,
/**
* Damage caused by being struck by lightning
* <p />
* <p>
* Damage: 5
*/
LIGHTNING,
/**
* Damage caused by committing suicide using the command "/kill"
* <p />
* <p>
* Damage: 1000
*/
SUICIDE,
/**
* Damage caused by starving due to having an empty hunger bar
* <p />
* <p>
* Damage: 1
*/
STARVATION,
/**
* Damage caused due to an ongoing poison effect
* <p />
* <p>
* Damage: 1
*/
POISON,
/**
* Damage caused by being hit by a damage potion or spell
* <p />
* <p>
* Damage: variable
*/
MAGIC,
@@ -182,21 +182,21 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
WITHER,
/**
* Damage caused by being hit by a falling block which deals damage
* <p />
* <p>
* <b>Note:</b> Not every block deals damage
* <p />
* <p>
* Damage: variable
*/
FALLING_BLOCK,
/**
* Damage caused in retaliation to another attack by the Thorns enchantment.
* <p />
* <p>
* Damage: 1-4 (Thorns)
*/
THORNS,
/**
* Custom damage.
* <p />
* <p>
* Damage: variable
*/
CUSTOM

View File

@@ -30,7 +30,7 @@ public class EntityDeathEvent extends EntityEvent {
/**
* Gets how much EXP should be dropped from this death.
* <p />
* <p>
* This does not indicate how much EXP should be taken from the entity in question,
* merely how much should be created after its death.
*
@@ -42,7 +42,7 @@ public class EntityDeathEvent extends EntityEvent {
/**
* Sets how much EXP should be dropped from this death.
* <p />
* <p>
* This does not indicate how much EXP should be taken from the entity in question,
* merely how much should be created after its death.
*

View File

@@ -7,7 +7,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a non-player entity is about to teleport because it is in contact with a portal
* <p />
* <p>
* For players see {@link org.bukkit.event.player.PlayerPortalEvent PlayerPortalEvent}
*/
public class EntityPortalEvent extends EntityTeleportEvent {

View File

@@ -7,7 +7,7 @@ import org.bukkit.util.Vector;
/**
* Called before an entity exits a portal.
* <p />
* <p>
* This event allows you to modify the velocity of the entity after they
* have successfully exeted the portal.
*/

View File

@@ -51,7 +51,7 @@ public class EntityTargetEvent extends EntityEvent implements Cancellable {
* Set the entity that you want the mob to target instead.
* It is possible to be null, null will cause the entity to be
* target-less.
* <p />
* <p>
* This is different from cancelling the event. Cancelling the event
* will cause the entity to keep an original target, while setting to be
* null will cause the entity to be reset

View File

@@ -19,7 +19,7 @@ public class EntityTargetLivingEntityEvent extends EntityTargetEvent{
* Set the Entity that you want the mob to target.
* It is possible to be null, null will cause the entity to be
* target-less.
* <p />
* <p>
* Must be a LivingEntity, or null
*
* @param target The entity to target

View File

@@ -24,7 +24,7 @@ public class FoodLevelChangeEvent extends EntityEvent implements Cancellable {
/**
* Gets the resultant food level that the entity involved in this event should be set to.
* <p />
* <p>
* Where 20 is a full food bar and 0 is an empty one.
*
* @return The resultant food level

View File

@@ -56,7 +56,7 @@ public class PlayerDeathEvent extends EntityDeathEvent {
/**
* Gets how much EXP the Player should have at respawn.
* <p />
* <p>
* This does not indicate how much EXP should be dropped, please see
* {@link #getDroppedExp()} for that.
*
@@ -68,7 +68,7 @@ public class PlayerDeathEvent extends EntityDeathEvent {
/**
* Sets how much EXP the Player should have at respawn.
* <p />
* <p>
* This does not indicate how much EXP should be dropped, please see
* {@link #setDroppedExp(int)} for that.
*
@@ -116,7 +116,7 @@ public class PlayerDeathEvent extends EntityDeathEvent {
/**
* Gets if the Player should keep all EXP at respawn.
* <p />
* <p>
* This flag overrides other EXP settings
*
* @return True if Player should keep all pre-death exp
@@ -127,7 +127,7 @@ public class PlayerDeathEvent extends EntityDeathEvent {
/**
* Sets if the Player should keep all EXP at respawn.
* <p />
* <p>
* This overrides all other EXP settings
*
* @param keepLevel True to keep all current value levels