JavaDoc cleanup.

This commit is contained in:
EvilSeph
2011-06-22 17:05:45 -04:00
parent 7524109bf0
commit f709af58e5
12 changed files with 87 additions and 38 deletions

View File

@@ -5,8 +5,7 @@ import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
/**
*
* @author Meaglin
* Called when a block is broken by a player
*/
public class BlockBreakEvent extends BlockEvent implements Cancellable {
@@ -22,16 +21,32 @@ public class BlockBreakEvent extends BlockEvent implements Cancellable {
/**
* Returns the player doing the damage
*
* @return
* @return the Player doing the damage
*/
public Player getPlayer() {
return player;
}
/**
* Gets the cancellation state of this event. A cancelled event will not
* be executed in the server, but will still pass to other plugins
*
* If a block break event is cancelled, the block will not break.
*
* @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
*
* If a block break event is cancelled, the block will not break.
*
* @param cancel true if you wish to cancel this event
*/
public void setCancelled(boolean cancel) {
this.cancel = cancel;
}