| Package | Description | 
|---|---|
| com.destroystokyo.paper.block | |
| org.bukkit.block | 
 Classes used to manipulate the voxels in a  
world,
 including special states. | 
| org.bukkit.block.data | |
| org.bukkit.block.data.type | |
| org.bukkit.entity | 
 Interfaces for non-voxel objects that can exist in a  
world, including all players, monsters, projectiles, etc. | 
| org.bukkit.event.block | |
| org.bukkit.event.entity | |
| org.bukkit.event.hanging | 
Events relating to entities that hang. | 
| org.bukkit.event.player | |
| org.bukkit.material | 
 Classes that represents various voxel types and states. 
 | 
| org.bukkit.material.types | |
| org.bukkit.util | 
 Multi and single purpose classes to facilitate various programmatic
 concepts. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
TargetBlockInfo.getBlockFace()
Get the targeted BlockFace 
 | 
| Constructor and Description | 
|---|
TargetBlockInfo(Block block,
               BlockFace blockFace)  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
Block.getFace(Block block)
Gets the face relation of this block compared to the given block. 
 | 
BlockFace | 
BlockFace.getOppositeFace()  | 
BlockFace | 
Skull.getRotation()
Deprecated. 
 
use  
BlockData | 
static BlockFace | 
BlockFace.valueOf(String name)
Returns the enum constant of this type with the specified name. 
 | 
static BlockFace[] | 
BlockFace.values()
Returns an array containing the constants of this enum type, in
the order they are declared. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
int | 
Block.getBlockPower(BlockFace face)
Returns the redstone power being provided to this block face 
 | 
Block | 
Block.getRelative(BlockFace face)
Gets the block at the given face 
 | 
Block | 
Block.getRelative(BlockFace face,
           int distance)
Gets the block at the given distance of the given face 
 | 
boolean | 
Block.isBlockFaceIndirectlyPowered(BlockFace face)
Returns true if the block face is being indirectly powered by Redstone. 
 | 
boolean | 
Block.isBlockFacePowered(BlockFace face)
Returns true if the block face is being powered by Redstone. 
 | 
void | 
Skull.setRotation(BlockFace rotation)
Deprecated. 
 
use  
BlockData | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
Directional.getFacing()
Gets the value of the 'facing' property. 
 | 
BlockFace | 
Rotatable.getRotation()
Gets the value of the 'rotation' property. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Set<BlockFace> | 
MultipleFacing.getAllowedFaces()
Gets all of this faces which may be set on this block. 
 | 
Set<BlockFace> | 
MultipleFacing.getFaces()
Get all of the faces which are enabled on this block. 
 | 
Set<BlockFace> | 
Directional.getFaces()
Gets the faces which are applicable to this block. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
MultipleFacing.hasFace(BlockFace face)
Checks if this block has the specified face enabled. 
 | 
void | 
MultipleFacing.setFace(BlockFace face,
       boolean has)
Set whether this block has the specified face enabled. 
 | 
void | 
Directional.setFacing(BlockFace facing)
Sets the value of the 'facing' property. 
 | 
void | 
Rotatable.setRotation(BlockFace rotation)
Sets the value of the 'rotation' property. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Set<BlockFace> | 
RedstoneWire.getAllowedFaces()
Gets all of this faces which may be set on this block. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
RedstoneWire.Connection | 
RedstoneWire.getFace(BlockFace face)
Checks the type of connection on the specified face. 
 | 
void | 
RedstoneWire.setFace(BlockFace face,
       RedstoneWire.Connection connection)
Sets the type of connection on the specified face. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
Entity.getFacing()
Get the closest cardinal  
BlockFace direction an entity is
 currently facing. | 
default BlockFace | 
LivingEntity.getTargetBlockFace(int maxDistance)
Gets the blockface of that block that the living entity has targeted, ignoring fluids 
 | 
BlockFace | 
LivingEntity.getTargetBlockFace(int maxDistance,
                  TargetBlockInfo.FluidMode fluidMode)
Gets the blockface of that block that the living entity has targeted 
 | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
Hanging.setFacingDirection(BlockFace face,
                  boolean force)
Sets the direction of the hanging entity, potentially overriding rules
 of placement. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected BlockFace | 
BlockFromToEvent.face  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
BlockPistonEvent.getDirection()
Return the direction in which the piston will operate. 
 | 
BlockFace | 
BlockFromToEvent.getFace()
Gets the BlockFace that the block is moving to. 
 | 
| Constructor and Description | 
|---|
BlockFromToEvent(Block block,
                BlockFace face)  | 
BlockPistonEvent(Block block,
                BlockFace direction)  | 
BlockPistonExtendEvent(Block block,
                      int length,
                      BlockFace direction)
Deprecated.  
 | 
BlockPistonExtendEvent(Block block,
                      List<Block> blocks,
                      BlockFace direction)  | 
BlockPistonRetractEvent(Block block,
                       List<Block> blocks,
                       BlockFace direction)  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
EntityPlaceEvent.getBlockFace()
Deprecated.  
Returns the face of the block that the entity was placed on 
 | 
BlockFace | 
ProjectileHitEvent.getHitBlockFace()
Gets the block face that was hit, if it was a block that was hit and the
 face was provided in the vent. 
 | 
| Constructor and Description | 
|---|
EntityPlaceEvent(Entity entity,
                Player player,
                Block block,
                BlockFace blockFace)
Deprecated.  
  | 
ProjectileHitEvent(Projectile projectile,
                  Entity hitEntity,
                  Block hitBlock,
                  BlockFace hitFace)  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
HangingPlaceEvent.getBlockFace()
Returns the face of the block that the hanging entity was placed on 
 | 
| Constructor and Description | 
|---|
HangingPlaceEvent(Hanging hanging,
                 Player player,
                 Block block,
                 BlockFace blockFace)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected BlockFace | 
PlayerInteractEvent.blockFace  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
PlayerInteractEvent.getBlockFace()
Returns the face of the block that was clicked 
 | 
BlockFace | 
PlayerBucketEvent.getBlockFace()
Get the face on the clicked block 
 | 
| Constructor and Description | 
|---|
PlayerBucketEmptyEvent(Player who,
                      Block blockClicked,
                      BlockFace blockFace,
                      Material bucket,
                      ItemStack itemInHand)  | 
PlayerBucketEmptyEvent(Player who,
                      Block blockClicked,
                      BlockFace blockFace,
                      Material bucket,
                      ItemStack itemInHand,
                      EquipmentSlot hand)  | 
PlayerBucketEvent(Player who,
                 Block blockClicked,
                 BlockFace blockFace,
                 Material bucket,
                 ItemStack itemInHand)  | 
PlayerBucketEvent(Player who,
                 Block blockClicked,
                 BlockFace blockFace,
                 Material bucket,
                 ItemStack itemInHand,
                 EquipmentSlot hand)  | 
PlayerBucketFillEvent(Player who,
                     Block blockClicked,
                     BlockFace blockFace,
                     Material bucket,
                     ItemStack itemInHand)  | 
PlayerBucketFillEvent(Player who,
                     Block blockClicked,
                     BlockFace blockFace,
                     Material bucket,
                     ItemStack itemInHand,
                     EquipmentSlot hand)  | 
PlayerInteractEvent(Player who,
                   Action action,
                   ItemStack item,
                   Block clickedBlock,
                   BlockFace clickedFace)  | 
PlayerInteractEvent(Player who,
                   Action action,
                   ItemStack item,
                   Block clickedBlock,
                   BlockFace clickedFace,
                   EquipmentSlot hand)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected static BlockFace | 
Tree.DEFAULT_DIRECTION  | 
protected static BlockFace | 
Hopper.DEFAULT_DIRECTION  | 
protected static BlockFace | 
Diode.DEFAULT_DIRECTION  | 
protected static BlockFace | 
Comparator.DEFAULT_DIRECTION  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
Stairs.getAscendingDirection()  | 
BlockFace | 
TripwireHook.getAttachedFace()  | 
BlockFace | 
TrapDoor.getAttachedFace()  | 
BlockFace | 
Torch.getAttachedFace()
Gets the face that this block is attached on 
 | 
BlockFace | 
Sign.getAttachedFace()
Gets the face that this block is attached on 
 | 
BlockFace | 
PistonExtensionMaterial.getAttachedFace()  | 
BlockFace | 
Lever.getAttachedFace()
Gets the face that this block is attached on 
 | 
BlockFace | 
Ladder.getAttachedFace()
Gets the face that this block is attached on 
 | 
BlockFace | 
CocoaPlant.getAttachedFace()  | 
BlockFace | 
Button.getAttachedFace()
Gets the face that this block is attached on 
 | 
BlockFace | 
Banner.getAttachedFace()  | 
BlockFace | 
Attachable.getAttachedFace()
Gets the face that this block is attached on 
 | 
BlockFace | 
Stairs.getDescendingDirection()  | 
BlockFace | 
Tree.getDirection()
Get direction of the log 
 | 
BlockFace | 
Rails.getDirection()  | 
BlockFace | 
Stairs.getFacing()  | 
BlockFace | 
Skull.getFacing()  | 
BlockFace | 
SimpleAttachableMaterialData.getFacing()  | 
BlockFace | 
Sign.getFacing()
Gets the direction that this sign is currently facing 
 | 
BlockFace | 
Pumpkin.getFacing()  | 
BlockFace | 
PistonExtensionMaterial.getFacing()  | 
BlockFace | 
PistonBaseMaterial.getFacing()  | 
BlockFace | 
Observer.getFacing()  | 
BlockFace | 
Hopper.getFacing()
Gets the direction this hopper is facing 
 | 
BlockFace | 
Gate.getFacing()  | 
BlockFace | 
Door.getFacing()
Get the direction that this door is facing. 
 | 
BlockFace | 
Dispenser.getFacing()  | 
BlockFace | 
DirectionalContainer.getFacing()  | 
BlockFace | 
Directional.getFacing()
Gets the direction this block is facing 
 | 
BlockFace | 
Diode.getFacing()
Gets the direction this diode is facing 
 | 
BlockFace | 
Comparator.getFacing()
Gets the direction this comparator is facing 
 | 
BlockFace | 
CocoaPlant.getFacing()  | 
BlockFace | 
Bed.getFacing()
Get the direction that this bed's head is facing toward 
 | 
BlockFace | 
Banner.getFacing()  | 
BlockFace | 
Door.getHingeCorner()
Deprecated. 
 
This method should not be used; use hinge and facing accessors instead. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Set<BlockFace> | 
Mushroom.getPaintedFaces()  | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
Mushroom.isFacePainted(BlockFace face)
Checks whether a face of the block is painted with cap texture. 
 | 
boolean | 
Vine.isOnFace(BlockFace face)
Check if the vine is attached to the specified face of an adjacent
 block. 
 | 
void | 
Vine.putOnFace(BlockFace face)
Attach the vine to the specified face of an adjacent block. 
 | 
void | 
Vine.removeFromFace(BlockFace face)
Detach the vine from the specified face of an adjacent block. 
 | 
void | 
Tree.setDirection(BlockFace dir)
Set direction of the log 
 | 
void | 
Rails.setDirection(BlockFace face,
            boolean isOnSlope)
Set the direction of these tracks 
 | 
void | 
ExtendedRails.setDirection(BlockFace face,
            boolean isOnSlope)  | 
void | 
Mushroom.setFacePainted(BlockFace face,
              boolean painted)
Deprecated. 
 
Use MushroomBlockType cap options 
 | 
void | 
TripwireHook.setFacingDirection(BlockFace face)  | 
void | 
TrapDoor.setFacingDirection(BlockFace face)  | 
void | 
Torch.setFacingDirection(BlockFace face)  | 
void | 
Stairs.setFacingDirection(BlockFace face)
Set the direction the stair part of the block is facing 
 | 
void | 
Skull.setFacingDirection(BlockFace face)  | 
void | 
Sign.setFacingDirection(BlockFace face)  | 
void | 
Pumpkin.setFacingDirection(BlockFace face)  | 
void | 
PistonExtensionMaterial.setFacingDirection(BlockFace face)  | 
void | 
PistonBaseMaterial.setFacingDirection(BlockFace face)  | 
void | 
Observer.setFacingDirection(BlockFace face)  | 
void | 
Lever.setFacingDirection(BlockFace face)
Sets the direction this lever is pointing in 
 | 
void | 
Ladder.setFacingDirection(BlockFace face)
Sets the direction this ladder is facing 
 | 
void | 
Hopper.setFacingDirection(BlockFace face)
Sets the direction this hopper is facing 
 | 
void | 
Gate.setFacingDirection(BlockFace face)  | 
void | 
Door.setFacingDirection(BlockFace face)
Set the direction that this door should is facing. 
 | 
void | 
Dispenser.setFacingDirection(BlockFace face)  | 
void | 
DirectionalContainer.setFacingDirection(BlockFace face)  | 
void | 
Directional.setFacingDirection(BlockFace face)
Sets the direction that this block is facing in 
 | 
void | 
Diode.setFacingDirection(BlockFace face)
Sets the direction this diode is facing. 
 | 
void | 
Comparator.setFacingDirection(BlockFace face)
Sets the direction this comparator is facing 
 | 
void | 
CocoaPlant.setFacingDirection(BlockFace face)  | 
void | 
Button.setFacingDirection(BlockFace face)
Sets the direction this button is pointing toward 
 | 
void | 
Bed.setFacingDirection(BlockFace face)
Set which direction the head of the bed is facing. 
 | 
void | 
Banner.setFacingDirection(BlockFace face)  | 
| Constructor and Description | 
|---|
Bed(BlockFace direction)
Instantiate a bed facing in a particular direction. 
 | 
Chest(BlockFace direction)
Instantiate a chest facing in a particular direction. 
 | 
CocoaPlant(CocoaPlant.CocoaPlantSize sz,
          BlockFace dir)  | 
Comparator(BlockFace facingDirection)
Constructs a comparator switched off, with the default mode (normal) and facing the specified direction. 
 | 
Comparator(BlockFace facingDirection,
          boolean isSubtraction)
Constructs a comparator switched off, with the specified mode and facing the specified direction. 
 | 
Comparator(BlockFace facingDirection,
          boolean isSubtraction,
          boolean state)
Constructs a comparator switched on or off, with the specified mode and facing the specified direction. 
 | 
Diode(BlockFace facingDirection)
Constructs a diode switched off, with a delay of 1 and facing the
 specified direction. 
 | 
Diode(BlockFace facingDirection,
     int delay)
Constructs a diode switched off, with the specified delay and facing the
 specified direction. 
 | 
Diode(BlockFace facingDirection,
     int delay,
     boolean state)
Constructs a diode switched on or off, with the specified delay and
 facing the specified direction. 
 | 
Dispenser(BlockFace direction)  | 
Door(Material type,
    BlockFace face)
Constructs the bottom half of a door of the given material type, facing the specified direction and set to closed 
 | 
Door(Material type,
    BlockFace face,
    boolean isOpen)
Constructs the bottom half of a door of the given material type, facing the specified direction and set to open
 or closed 
 | 
Door(TreeSpecies species,
    BlockFace face)
Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to
 closed 
 | 
Door(TreeSpecies species,
    BlockFace face,
    boolean isOpen)
Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to open
 or closed 
 | 
EnderChest(BlockFace direction)
Instantiate an ender chest facing in a particular direction. 
 | 
Furnace(BlockFace direction)
Instantiate a furnace facing in a particular direction. 
 | 
Hopper(BlockFace facingDirection)
Constructs a hopper facing the specified direction and initially active. 
 | 
Hopper(BlockFace facingDirection,
      boolean isActive)
Constructs a hopper facing the specified direction and either active or
 not. 
 | 
Mushroom(Material shroom,
        BlockFace capFace)
Constructs a brown/red mushroom cap block with the specified face or
 faces set to cap texture. 
 | 
Observer(BlockFace direction)  | 
Pumpkin(BlockFace direction)
Instantiate a pumpkin facing in a particular direction. 
 | 
SimpleAttachableMaterialData(Material type,
                            BlockFace direction)  | 
Skull(BlockFace direction)
Instantiate a skull facing in a particular direction. 
 | 
Tree(Material type,
    TreeSpecies species,
    BlockFace dir)
Constructs a tree block of the given type and tree species, and facing
 the given direction. 
 | 
Tree(TreeSpecies species,
    BlockFace dir)
Constructs a tree block of the given tree species, and facing the given
 direction. 
 | 
TripwireHook(BlockFace dir)  | 
Vine(BlockFace... faces)  | 
| Constructor and Description | 
|---|
Vine(EnumSet<BlockFace> faces)  | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
MushroomBlockTexture.getCapFace()
Gets the face that has cap texture. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static MushroomBlockTexture | 
MushroomBlockTexture.getCapByFace(BlockFace face)
Gets the MushroomBlockType with cap texture on the given block face. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BlockFace | 
RayTraceResult.getHitBlockFace()
Gets the hit block face. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BoundingBox | 
BoundingBox.expand(BlockFace blockFace,
      double expansion)
Expands this bounding box in the direction specified by the given block
 face. 
 | 
| Constructor and Description | 
|---|
RayTraceResult(Vector hitPosition,
              Block hitBlock,
              BlockFace hitBlockFace)
Creates a RayTraceResult. 
 | 
RayTraceResult(Vector hitPosition,
              BlockFace hitBlockFace)
Creates a RayTraceResult. 
 | 
RayTraceResult(Vector hitPosition,
              Entity hitEntity,
              BlockFace hitBlockFace)
Creates a RayTraceResult. 
 | 
Copyright © 2022. All rights reserved.