Fix upstream javadocs

This commit is contained in:
Zach Brown
2017-06-10 16:59:40 -05:00
parent f7eff332be
commit 0c37d20354
75 changed files with 403 additions and 173 deletions

View File

@@ -10,15 +10,19 @@ import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* Called if a block broken by a player drops an item.
* Called after a block is broken by a player and potential drops are computed, even if said blocks loot table
* does not define any drops at the point the event is constructed.
*
* If the block break is cancelled, this event won't be called.
*
* If isDropItems in BlockBreakEvent is set to false, this event won't be
* If isDropItems in {@link org.bukkit.event.block.BlockBreakEvent} is set to false, this event won't be
* called.
*
* If a block is broken and isDropItems is set to true, this event will be called even if the block does
* not drop any items, for example glass broken by hand. In this case, #getItems() will be empty.
*
* This event will also be called if the player breaks a multi block structure,
* for example a torch on top of a stone. Both items will have an event call.
* for example a torch on top of a stone. Both items will be included in the #getItems() list.
*
* The Block is already broken as this event is called, so #getBlock() will be
* AIR in most cases. Use #getBlockState() for more Information about the broken

View File

@@ -14,6 +14,9 @@ import org.jetbrains.annotations.NotNull;
* Note that due to the nature of explosions, {@link #getBlock()} will always be
* an air block. {@link #getExplodedBlockState()} should be used to get
* information about the block state that exploded.
* <p>
* The event isn't called if the {@link org.bukkit.GameRule#MOB_GRIEFING}
* is disabled as no block interaction will occur.
*/
public class BlockExplodeEvent extends BlockEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();

View File

@@ -34,7 +34,7 @@ public class BlockPistonRetractEvent extends BlockPistonEvent {
/**
* Get an immutable list of the blocks which will be moved by the
* extending.
* retracting.
*
* @return Immutable list of the moved blocks.
*/

View File

@@ -114,7 +114,7 @@ public class BlockPlaceEvent extends BlockEvent implements Cancellable {
/**
* Gets the value whether the player would be allowed to build here.
* Defaults to spawn if the server was going to stop them (such as, the
* Defaults to false if the server was going to stop them (such as, the
* player is in Spawn). Note that this is an entirely different check
* than BLOCK_CANBUILD, as this refers to a player, not universe-physics
* rule like cactus on dirt.