Chronika/Bukkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More JavaDoc improvements.

Browse Source
This commit is contained in:
EvilSeph
2011-07-15 01:15:05 -04:00
parent 7968683662
commit 9789918954
28 changed files with 335 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/main/java/org/bukkit/event/block/BlockFromToEvent.java
View File

@@ -5,7 +5,9 @@ import org.bukkit.block.BlockFace;
import org.bukkit.event.Cancellable;
/**
* Holds information for events with a source block and a destination block
* Represents events with a source block and a destination block, currently only applies to liquid (lava and water).
*<p />
* If a Block From To event is cancelled, the block will not move (the liquid will not flow).
*/
public class BlockFromToEvent extends BlockEvent implements Cancellable {
protected Block to;
@@ -19,18 +21,18 @@ public class BlockFromToEvent extends BlockEvent implements Cancellable {
}
/**
* Gets the location this player moved to
* Gets the BlockFace that the block is moving to.
*
* @return Block the block is event originated from
* @return The BlockFace that the block is moving to
*/
public BlockFace getFace() {
return face;
}
/**
* Convenience method for getting the faced block
* Convenience method for getting the faced Block.
*
* @return Block the faced block
* @return The faced Block
*/
public Block getToBlock() {
if (to == null) {
@@ -41,7 +43,9 @@ public class BlockFromToEvent extends BlockEvent implements Cancellable {
/**
* Gets the cancellation state of this event. A cancelled event will not
* be executed in the server, but will still pass to other plugins
* be executed in the server, but will still pass to other plugins.
*<p />
* If a Block From To event is cancelled, the block will not move.
*
* @return true if this event is cancelled
*/
@@ -51,7 +55,9 @@ public class BlockFromToEvent extends BlockEvent implements Cancellable {
/**
* Sets the cancellation state of this event. A cancelled event will not
* be executed in the server, but will still pass to other plugins
* be executed in the server, but will still pass to other plugins.
*<p />
* If a Block From To event is cancelled, the block will not move.
*
* @param cancel true if you wish to cancel this event
*/