More JavaDoc improvements.

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

View File

@@ -1,13 +1,16 @@
/**
*
*/
package org.bukkit.event.block;
import org.bukkit.block.Block;
import org.bukkit.Material;
/**
* @author durron597
* Called when we try to place a block, to see if we can build it here or not.
*<p />
* Note:
* <ul>
* <li>The Block returned by getBlock() is the block we are trying to place on, not the block we are trying to place.</li>
* <li>If you want to figure out what is being placed, use {@link #getMaterial()} or {@link #getMaterialId()} instead.</li>
* </ul>
*/
public class BlockCanBuildEvent extends BlockEvent {
protected boolean buildable;
@@ -20,8 +23,8 @@ public class BlockCanBuildEvent extends BlockEvent {
}
/**
* Returns whether or not the block can be built here. By default, returns
* Minecraft's answer on whether the block can be built
* Gets whether or not the block can be built here.
* By default, returns Minecraft's answer on whether the block can be built here or not.
*
* @return boolean whether or not the block can be built
*/
@@ -30,16 +33,28 @@ public class BlockCanBuildEvent extends BlockEvent {
}
/**
* Set whether the block can be built here.
* Sets whether the block can be built here or not.
*
* @param cancel true if you want to allow the block to be built here despite Minecraft's default behaviour
*/
public void setBuildable(boolean cancel) {
this.buildable = cancel;
}
/**
* Gets the Material that we are trying to place.
*
* @return The Material that we are trying to place
*/
public Material getMaterial() {
return Material.getMaterial(material);
}
/**
* Gets the Material ID for the Material that we are trying to place.
*
* @return The Material ID for the Material that we are trying to place
*/
public int getMaterialId() {
return material;
}