More JavaDoc improvements.
This commit is contained in:
@@ -4,6 +4,9 @@ import org.bukkit.entity.Entity;
|
||||
import org.bukkit.entity.Explosive;
|
||||
import org.bukkit.event.Cancellable;
|
||||
|
||||
/**
|
||||
* Called when an entity has made a decision to explode.
|
||||
*/
|
||||
public class ExplosionPrimeEvent extends EntityEvent implements Cancellable {
|
||||
private boolean cancel;
|
||||
private float radius;
|
||||
@@ -20,26 +23,58 @@ public class ExplosionPrimeEvent extends EntityEvent implements Cancellable {
|
||||
this(explosive, explosive.getYield(), explosive.isIncendiary());
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the cancellation state of this event. A cancelled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
*
|
||||
* @return true if this event is cancelled
|
||||
*/
|
||||
public boolean isCancelled() {
|
||||
return cancel;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the cancellation state of this event. A cancelled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
*
|
||||
* @param cancel true if you wish to cancel this event
|
||||
*/
|
||||
public void setCancelled(boolean cancel) {
|
||||
this.cancel = cancel;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the radius of the explosion
|
||||
*
|
||||
* @return returns the radius of the explosion
|
||||
*/
|
||||
public float getRadius() {
|
||||
return radius;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the radius of the explosion
|
||||
*
|
||||
* @param radius the radius of the explosion
|
||||
*/
|
||||
public void setRadius(float radius) {
|
||||
this.radius = radius;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets whether this explosion will create fire or not
|
||||
*
|
||||
* @return true if this explosion will create fire
|
||||
*/
|
||||
public boolean getFire() {
|
||||
return fire;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets whether this explosion will create fire or not
|
||||
*
|
||||
* @param fire true if you want this explosion to create fire
|
||||
*/
|
||||
public void setFire(boolean fire) {
|
||||
this.fire = fire;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user