More JavaDoc improvements.

This commit is contained in:
EvilSeph
2011-06-24 02:32:04 -04:00
parent b76de1ee24
commit a0c1f68109
56 changed files with 435 additions and 139 deletions

View File

@@ -4,8 +4,7 @@ import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* The event when a skeleton or zombie catch on fire due to the sun.
* If the event is cancelled, the fire is stopped.
* Called when an entity combusts due to the sun
*/
public class EntityCombustEvent extends EntityEvent implements Cancellable {
private boolean cancel;
@@ -15,10 +14,22 @@ public class EntityCombustEvent extends EntityEvent implements Cancellable {
this.cancel = false;
}
/**
* 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;
}