Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-04-02 00:11:22 -04:00
parent 745a0d7683
commit 761a84cb1b
93 changed files with 539 additions and 505 deletions

View File

@@ -7,7 +7,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block is broken by a player.
* <p />
* <p>
* If you wish to have the block drop experience, you must set the experience value above 0.
* By default, experience will be set in the event if:
* <ol>
@@ -16,11 +16,11 @@ import org.bukkit.event.HandlerList;
* <li />The player does not have silk touch
* <li />The block drops experience in vanilla MineCraft
* </ol>
* <p />
* <p>
* Note:
* Plugins wanting to simulate a traditional block drop should set the block to air and utilize their own methods for determining
* what the default drop for the block being broken is and what to do about it, if anything.
* <p />
* <p>
* If a Block Break event is cancelled, the block will not break and experience will not drop.
*/
public class BlockBreakEvent extends BlockExpEvent implements Cancellable {

View File

@@ -6,7 +6,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block is destroyed as a result of being burnt by fire.
* <p />
* <p>
* If a Block Burn event is cancelled, the block will not be destroyed as a result of being burnt by fire.
*/
public class BlockBurnEvent extends BlockEvent implements Cancellable {

View File

@@ -6,7 +6,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when we try to place a block, to see if we can build it here or not.
* <p />
* <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>

View File

@@ -8,7 +8,7 @@ import org.bukkit.inventory.ItemStack;
/**
* Called when a block is damaged by a player.
* <p />
* <p>
* If a Block Damage event is cancelled, the block will not be damaged.
*/
public class BlockDamageEvent extends BlockEvent implements Cancellable {

View File

@@ -8,7 +8,7 @@ import org.bukkit.util.Vector;
/**
* Called when an item is dispensed from a block.
* <p />
* <p>
* If a Block Dispense event is cancelled, the block will not dispense the item.
*/
public class BlockDispenseEvent extends BlockEvent implements Cancellable {
@@ -44,7 +44,7 @@ public class BlockDispenseEvent extends BlockEvent implements Cancellable {
/**
* Gets the velocity.
* <p />
* <p>
* Note: Modifying the returned Vector will not change the velocity, you must use {@link #setVelocity(org.bukkit.util.Vector)} instead.
*
* @return A Vector for the dispensed item's velocity

View File

@@ -7,13 +7,13 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block fades, melts or disappears based on world conditions
* <p />
* <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 />
* <p>
* If a Block Fade event is cancelled, the block will not fade, melt or disappear.
*/
public class BlockFadeEvent extends BlockEvent implements Cancellable {

View File

@@ -8,13 +8,13 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block is formed or spreads based on world conditions.
* Use {@link BlockSpreadEvent} to catch blocks that actually spread and don't just "randomly" form.
* <p />
* <p>
* Examples:
* <ul>
* <li>Snow forming due to a snow storm.</li>
* <li>Ice forming in a snowy Biome like Taiga or Tundra.</li>
* </ul>
* <p />
* <p>
* If a Block Form event is cancelled, the block will not be formed.
*
* @see BlockSpreadEvent

View File

@@ -8,7 +8,7 @@ import org.bukkit.event.HandlerList;
/**
* Represents events with a source block and a destination block, currently only applies to liquid (lava and water)
* and teleporting dragon eggs.
* <p />
* <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 {

View File

@@ -7,7 +7,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block grows naturally in the world.
* <p />
* <p>
* Examples:
* <ul>
* <li>Wheat</li>
@@ -16,7 +16,7 @@ import org.bukkit.event.HandlerList;
* <li>Watermelon</li>
* <li>Pumpkin</li>
* </ul>
* <p />
* <p>
* If a Block Grow event is cancelled, the block will not grow.
*/
public class BlockGrowEvent extends BlockEvent implements Cancellable {

View File

@@ -8,7 +8,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block is ignited. If you want to catch when a Player places fire, you need to use {@link BlockPlaceEvent}.
* <p />
* <p>
* If a Block Ignite event is cancelled, the block will not be ignited.
*/
public class BlockIgniteEvent extends BlockEvent implements Cancellable {

View File

@@ -9,7 +9,7 @@ import org.bukkit.inventory.ItemStack;
/**
* Called when a block is placed by a player.
* <p />
* <p>
* If a Block Place event is cancelled, the block will not be placed.
*/
public class BlockPlaceEvent extends BlockEvent implements Cancellable {

View File

@@ -7,13 +7,13 @@ import org.bukkit.event.HandlerList;
/**
* Called when a block spreads based on world conditions.
* Use {@link BlockFormEvent} to catch blocks that "randomly" form instead of actually spread.
* <p />
* <p>
* Examples:
* <ul>
* <li>Mushrooms spreading.</li>
* <li>Fire spreading.</li>
* </ul>
* <p />
* <p>
* If a Block Spread event is cancelled, the block will not spread.
*
* @see BlockFormEvent

View File

@@ -6,7 +6,7 @@ import org.bukkit.entity.Entity;
/**
* Called when a block is formed by entities.
* <p />
* <p>
* Examples:
* <ul>
* <li>Snow formed by a {@link org.bukkit.entity.Snowman}.</li>

View File

@@ -6,7 +6,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when leaves are decaying naturally.
* <p />
* <p>
* If a Leaves Decay event is cancelled, the leaves will not decay.
*/
public class LeavesDecayEvent extends BlockEvent implements Cancellable {

View File

@@ -7,7 +7,7 @@ import org.bukkit.event.HandlerList;
/**
* Called when a sign is changed by a player.
* <p />
* <p>
* If a Sign Change event is cancelled, the sign will not be changed.
*/
public class SignChangeEvent extends BlockEvent implements Cancellable {