Package org.bukkit.event.block
Class BlockCanBuildEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.BlockCanBuildEvent
Called when we try to place a block, to see if we can build it here or not.
Note:
- The Block returned by getBlock() is the block we are trying to place on, not the block we are trying to place.
- If you want to figure out what is being placed, use
getMaterial()
instead.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.block.BlockEvent
block
-
Constructor Summary
ConstructorDescriptionBlockCanBuildEvent
(@NotNull Block block, @NotNull BlockData type, boolean canBuild) Deprecated.BlockCanBuildEvent
(@NotNull Block block, @Nullable Player player, @NotNull BlockData type, boolean canBuild) Deprecated.BlockCanBuildEvent
(@NotNull Block block, @Nullable Player player, @NotNull BlockData type, boolean canBuild, EquipmentSlot hand) -
Method Summary
Modifier and TypeMethodDescriptionGets the BlockData that we are trying to place.getHand()
Gets the hand the player will use to place the blockstatic @NotNull HandlerList
Gets the Material that we are trying to place.Gets the player who placed the block involved in this event.boolean
Gets whether or not the block can be built here.void
setBuildable
(boolean cancel) Sets whether the block can be built here or not.Methods inherited from class org.bukkit.event.block.BlockEvent
getBlock
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Field Details
-
buildable
protected boolean buildable -
blockData
-
-
Constructor Details
-
BlockCanBuildEvent
@Deprecated public BlockCanBuildEvent(@NotNull @NotNull Block block, @NotNull @NotNull BlockData type, boolean canBuild) Deprecated. -
BlockCanBuildEvent
@Deprecated public BlockCanBuildEvent(@NotNull @NotNull Block block, @Nullable @Nullable Player player, @NotNull @NotNull BlockData type, boolean canBuild) Deprecated.- Parameters:
block
- the block involved in this eventplayer
- the player placing the blocktype
- the id of the block to placecanBuild
- whether we can build
-
BlockCanBuildEvent
-
-
Method Details
-
getHand
Gets the hand the player will use to place the block- Returns:
- the EquipmentSlot representing the players hand.
-
isBuildable
public boolean isBuildable()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.
- Returns:
- boolean whether or not the block can be built
-
setBuildable
public void setBuildable(boolean cancel) Sets whether the block can be built here or not.- Parameters:
cancel
- true if you want to allow the block to be built here despite Minecraft's default behaviour
-
getMaterial
Gets the Material that we are trying to place.- Returns:
- The Material that we are trying to place
-
getBlockData
Gets the BlockData that we are trying to place.- Returns:
- The BlockData that we are trying to place
-
getPlayer
Gets the player who placed the block involved in this event.
May be null for legacy calls of the event.- Returns:
- The Player who placed the block involved in this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-