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

23
src/main/java/org/bukkit/event/block/BlockFadeEvent.java
View File

@@ -1,11 +1,18 @@
package org.bukkit.event.block;
import org.bukkit.Material;
import org.bukkit.block.Block;
import org.bukkit.block.BlockState;
import org.bukkit.event.Cancellable;
/**
*Called when a block fades, melts or disappears based on world conditions
* Called when a block fades, melts or disappears based on world conditions
* <p />
* Examples:
* <ul>
* <li>Snow melting due to being near a light source.</li>
* <li>Ice melting due to being near a light source.</li>
* </ul>
* <p />
* If a Block Fade event is cancelled, the block will not fade, melt or disappear.
*/
public class BlockFadeEvent extends BlockEvent implements Cancellable {
private boolean cancelled;
@@ -18,9 +25,9 @@ public class BlockFadeEvent extends BlockEvent implements Cancellable {
}
/**
* Gets the state of the block that will be fading
* Gets the state of the block that will be fading, melting or disappearing.
*
* @return the block state
* @return The block state of the block that will be fading, melting or disappearing
*/
public BlockState getNewState() {
return newState;
@@ -28,7 +35,9 @@ public class BlockFadeEvent 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 Fade event is cancelled, the block will not fade, melt or disappear.
*
* @return true if this event is cancelled
*/
@@ -38,7 +47,9 @@ public class BlockFadeEvent 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 Fade event is cancelled, the block will not fade, melt or disappear.
*
* @param cancel true if you wish to cancel blocks like snow or ice from melting or fading
*/