summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDinnerbone <dinnerbone@dinnerbone.com>2011-01-04 22:05:53 +0000
committerDinnerbone <dinnerbone@dinnerbone.com>2011-01-04 22:05:53 +0000
commitf2533d1fd7458f4af3618d4d181c7303e4fcb516 (patch)
tree59bae742f3c67f5e1cd301dac4f42be445b94baf /src
parenta210fcc0ef584e66127fb3ddd3b653ac1ea0bb2b (diff)
downloadbukkit-f2533d1fd7458f4af3618d4d181c7303e4fcb516.tar
bukkit-f2533d1fd7458f4af3618d4d181c7303e4fcb516.tar.gz
bukkit-f2533d1fd7458f4af3618d4d181c7303e4fcb516.tar.lz
bukkit-f2533d1fd7458f4af3618d4d181c7303e4fcb516.tar.xz
bukkit-f2533d1fd7458f4af3618d4d181c7303e4fcb516.zip
Javadoc
Diffstat (limited to 'src')
-rw-r--r--src/main/java/org/bukkit/event/block/BlockPlacedEvent.java24
-rw-r--r--src/main/java/org/bukkit/event/world/ChunkUnloadedEvent.java13
2 files changed, 30 insertions, 7 deletions
diff --git a/src/main/java/org/bukkit/event/block/BlockPlacedEvent.java b/src/main/java/org/bukkit/event/block/BlockPlacedEvent.java
index 030a2dd9..6bc18968 100644
--- a/src/main/java/org/bukkit/event/block/BlockPlacedEvent.java
+++ b/src/main/java/org/bukkit/event/block/BlockPlacedEvent.java
@@ -11,24 +11,36 @@ public class BlockPlacedEvent extends BlockEvent implements Cancellable {
private boolean cancel;
private Player player;
- /**
- * @param type
- * @param theBlock
- */
public BlockPlacedEvent(Type type, Block theBlock) {
super(type, theBlock);
cancel = false;
}
-
+
+ /**
+ * Gets the player who placed this block
+ *
+ * @return Player who placed the block
+ */
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
+ *
+ * @return true if this event is cancelled
+ */
public boolean isCancelled() {
- // TODO Auto-generated method stub
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;
}
diff --git a/src/main/java/org/bukkit/event/world/ChunkUnloadedEvent.java b/src/main/java/org/bukkit/event/world/ChunkUnloadedEvent.java
index 3aa89221..fc9d57b1 100644
--- a/src/main/java/org/bukkit/event/world/ChunkUnloadedEvent.java
+++ b/src/main/java/org/bukkit/event/world/ChunkUnloadedEvent.java
@@ -14,12 +14,23 @@ public class ChunkUnloadedEvent extends ChunkLoadedEvent implements Cancellable
super(type, chunk);
}
+ /**
+ * 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;
}
-
}