Many javadoc fixes thanks to Celtic Minstrel

This commit is contained in:
Dinnerbone
2011-09-25 02:56:40 +01:00
parent 9a5665137d
commit e6c273e8b0
78 changed files with 380 additions and 335 deletions

View File

@@ -11,20 +11,17 @@ import org.bukkit.event.Cancellable;
public class CreeperPowerEvent extends EntityEvent implements Cancellable {
private boolean canceled;
private Entity creeper;
private PowerCause cause;
private Entity bolt;
public CreeperPowerEvent(Entity creeper, Entity bolt, PowerCause cause) {
super(Type.CREEPER_POWER, creeper);
this.creeper = creeper;
this.bolt = bolt;
this.cause = cause;
}
public CreeperPowerEvent(Entity creeper, PowerCause cause) {
super(Type.CREEPER_POWER, creeper);
this.creeper = creeper;
this.cause = cause;
this.bolt = null;
}

View File

@@ -2,12 +2,11 @@ package org.bukkit.event.entity;
import org.bukkit.block.Block;
import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* Called when an entity is damaged by a block
*/
public class EntityDamageByBlockEvent extends EntityDamageEvent implements Cancellable {
public class EntityDamageByBlockEvent extends EntityDamageEvent {
private Block damager;

View File

@@ -1,12 +1,11 @@
package org.bukkit.event.entity;
import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* Called when an entity is damaged by an entity
*/
public class EntityDamageByEntityEvent extends EntityDamageEvent implements Cancellable {
public class EntityDamageByEntityEvent extends EntityDamageEvent {
private Entity damager;

View File

@@ -33,6 +33,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
/**
* Returns the list of blocks that would have been removed or were
* removed from the explosion event.
* @return All blown-up blocks
*/
public List<Block> blockList() {
return blocks;
@@ -42,6 +43,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
* Returns the location where the explosion happened.
* It is not possible to get this value from the Entity as
* the Entity no longer exists in the world.
* @return The location of the explosion
*/
public Location getLocation() {
return location;
@@ -50,7 +52,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
/**
* Returns the percentage of blocks to drop from this explosion
*
* @return
* @return The yield.
*/
public float getYield() {
return yield;
@@ -58,6 +60,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
/**
* Sets the percentage of blocks to drop from this explosion
* @param yield The new yield percentage
*/
public void setYield(float yield) {
this.yield = yield;

View File

@@ -3,7 +3,6 @@ package org.bukkit.event.entity;
import org.bukkit.entity.Entity;
import org.bukkit.Location;
import org.bukkit.event.Cancellable;
/**
* Stores data for entities standing inside a portal block

View File

@@ -4,7 +4,7 @@ import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* Called when a creature targets another entity
* Called when a creature targets or untargets another entity
*/
public class EntityTargetEvent extends EntityEvent implements Cancellable {
private boolean cancel;
@@ -28,15 +28,17 @@ public class EntityTargetEvent extends EntityEvent implements Cancellable {
/**
* Returns the reason for the targeting
* @return The reason
*/
public TargetReason getReason() {
return reason;
}
/**
* Get the entity that this is target.
* This is possible to be null in the case that the event is called when
* Get the entity that this is targeting.
* This will be null in the case that the event is called when
* the mob forgets its target.
* @return The entity
*/
public Entity getTarget() {
return target;

View File

@@ -9,13 +9,11 @@ import org.bukkit.event.Cancellable;
public class PigZapEvent extends EntityEvent implements Cancellable {
private boolean canceled;
private Entity pig;
private Entity pigzombie;
private Entity bolt;
public PigZapEvent(Entity pig, Entity bolt, Entity pigzombie) {
super(Type.PIG_ZAP, pig);
this.pig = pig;
this.bolt = bolt;
this.pigzombie = pigzombie;
}