| Package | Description | 
|---|---|
| com.destroystokyo.paper.block | |
| io.papermc.paper.event.block | |
| org.bukkit.block | Classes used to manipulate the voxels in a  world,
 including special states. | 
| org.bukkit.block.data | Generalized BlockData classes. | 
| org.bukkit.block.data.type | Specific BlockData classes relevant to only a given block or set of blocks. | 
| 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 | Eventsrelating toentities that hang. | 
| org.bukkit.event.player | |
| org.bukkit.material | Classes that represents various voxel types and states. | 
| org.bukkit.material.types | Classes relevant to specific material types. | 
| org.bukkit.util | Multi and single purpose classes to facilitate various programmatic
 concepts. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | TargetBlockInfo. getBlockFace() | Get the targeted BlockFace | 
| Constructor | Description | 
|---|---|
| TargetBlockInfo(Block block,
               BlockFace blockFace) | 
| Constructor | Description | 
|---|---|
| TargetHitEvent(Projectile projectile,
              Block block,
              BlockFace blockFace,
              int signalStrength) | 
| Modifier and Type | Method | 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 | Description | 
|---|---|---|
| boolean | Block. applyBoneMeal(BlockFace face) | Simulate bone meal application to this block (if possible). | 
| 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 | 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 | Description | 
|---|---|---|
| Set<BlockFace> | MultipleFacing. getAllowedFaces() | Gets all of this faces which may be set on this block. | 
| Set<BlockFace> | Directional. getFaces() | Gets the faces which are applicable to this block. | 
| Set<BlockFace> | MultipleFacing. getFaces() | Get all of the faces which are enabled on this block. | 
| Modifier and Type | Method | 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 | Description | 
|---|---|---|
| Set<BlockFace> | RedstoneWire. getAllowedFaces() | Gets all of this faces which may be set on this block. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| RedstoneWire.Connection | RedstoneWire. getFace(BlockFace face) | Checks the type of connection on the specified face. | 
| Wall.Height | Wall. getHeight(BlockFace face) | Gets the height of the specified face. | 
| void | RedstoneWire. setFace(BlockFace face,
       RedstoneWire.Connection connection) | Sets the type of connection on the specified face. | 
| void | Wall. setHeight(BlockFace face,
         Wall.Height height) | Set the height of the specified face. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | Entity. getFacing() | Get the closest cardinal  BlockFacedirection 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 | Description | 
|---|---|---|
| boolean | Hanging. setFacingDirection(BlockFace face,
                  boolean force) | Sets the direction of the hanging entity, potentially overriding rules
 of placement. | 
| Modifier and Type | Field | Description | 
|---|---|---|
| protected BlockFace | BlockFromToEvent. face | 
| Modifier and Type | Method | 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 | 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 | 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 | Description | 
|---|---|
| EntityPlaceEvent(Entity entity,
                Player player,
                Block block,
                BlockFace blockFace) | Deprecated. | 
| ProjectileHitEvent(Projectile projectile,
                  Entity hitEntity,
                  Block hitBlock,
                  BlockFace hitFace) | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | HangingPlaceEvent. getBlockFace() | Returns the face of the block that the hanging entity was placed on | 
| Constructor | Description | 
|---|---|
| HangingPlaceEvent(Hanging hanging,
                 Player player,
                 Block block,
                 BlockFace blockFace) | 
| Modifier and Type | Field | Description | 
|---|---|---|
| protected BlockFace | PlayerInteractEvent. blockFace | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | PlayerBucketEvent. getBlockFace() | Get the face on the clicked block | 
| BlockFace | PlayerInteractEvent. getBlockFace() | Returns the face of the block that was clicked | 
| Constructor | Description | 
|---|---|
| PlayerBucketEmptyEvent(Player who,
                      Block blockClicked,
                      BlockFace blockFace,
                      Material bucket,
                      ItemStack itemInHand) | Deprecated. | 
| PlayerBucketEmptyEvent(Player who,
                      Block blockClicked,
                      BlockFace blockFace,
                      Material bucket,
                      ItemStack itemInHand,
                      EquipmentSlot hand) | Deprecated. | 
| PlayerBucketEmptyEvent(Player who,
                      Block block,
                      Block blockClicked,
                      BlockFace blockFace,
                      Material bucket,
                      ItemStack itemInHand) | |
| PlayerBucketEmptyEvent(Player who,
                      Block block,
                      Block blockClicked,
                      BlockFace blockFace,
                      Material bucket,
                      ItemStack itemInHand,
                      EquipmentSlot hand) | |
| PlayerBucketEvent(Player who,
                 Block blockClicked,
                 BlockFace blockFace,
                 Material bucket,
                 ItemStack itemInHand) | Deprecated. | 
| PlayerBucketEvent(Player who,
                 Block blockClicked,
                 BlockFace blockFace,
                 Material bucket,
                 ItemStack itemInHand,
                 EquipmentSlot hand) | Deprecated. | 
| PlayerBucketEvent(Player who,
                 Block block,
                 Block blockClicked,
                 BlockFace blockFace,
                 Material bucket,
                 ItemStack itemInHand) | |
| PlayerBucketEvent(Player who,
                 Block block,
                 Block blockClicked,
                 BlockFace blockFace,
                 Material bucket,
                 ItemStack itemInHand,
                 EquipmentSlot hand) | |
| PlayerBucketFillEvent(Player who,
                     Block blockClicked,
                     BlockFace blockFace,
                     Material bucket,
                     ItemStack itemInHand) | Deprecated. | 
| PlayerBucketFillEvent(Player who,
                     Block blockClicked,
                     BlockFace blockFace,
                     Material bucket,
                     ItemStack itemInHand,
                     EquipmentSlot hand) | Deprecated. | 
| PlayerBucketFillEvent(Player who,
                     Block block,
                     Block blockClicked,
                     BlockFace blockFace,
                     Material bucket,
                     ItemStack itemInHand) | |
| PlayerBucketFillEvent(Player who,
                     Block block,
                     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) | |
| PlayerInteractEvent(Player who,
                   Action action,
                   ItemStack item,
                   Block clickedBlock,
                   BlockFace clickedFace,
                   EquipmentSlot hand,
                   Location interactionPoint) | 
| Modifier and Type | Field | Description | 
|---|---|---|
| protected static BlockFace | Comparator. DEFAULT_DIRECTION | Deprecated. | 
| protected static BlockFace | Diode. DEFAULT_DIRECTION | Deprecated. | 
| protected static BlockFace | Hopper. DEFAULT_DIRECTION | Deprecated. | 
| protected static BlockFace | Tree. DEFAULT_DIRECTION | Deprecated. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | Stairs. getAscendingDirection() | Deprecated. | 
| BlockFace | Attachable. getAttachedFace() | Gets the face that this block is attached on | 
| BlockFace | Banner. getAttachedFace() | Deprecated. | 
| BlockFace | Button. getAttachedFace() | Deprecated. Gets the face that this block is attached on | 
| BlockFace | CocoaPlant. getAttachedFace() | Deprecated. | 
| BlockFace | Ladder. getAttachedFace() | Deprecated. Gets the face that this block is attached on | 
| BlockFace | Lever. getAttachedFace() | Deprecated. Gets the face that this block is attached on | 
| BlockFace | PistonExtensionMaterial. getAttachedFace() | Deprecated. | 
| BlockFace | Sign. getAttachedFace() | Deprecated. Gets the face that this block is attached on | 
| BlockFace | Torch. getAttachedFace() | Deprecated. Gets the face that this block is attached on | 
| BlockFace | TrapDoor. getAttachedFace() | Deprecated. | 
| BlockFace | TripwireHook. getAttachedFace() | Deprecated. | 
| BlockFace | Stairs. getDescendingDirection() | Deprecated. | 
| BlockFace | Rails. getDirection() | Deprecated. | 
| BlockFace | Tree. getDirection() | Deprecated. Get direction of the log | 
| BlockFace | Banner. getFacing() | Deprecated. | 
| BlockFace | Bed. getFacing() | Deprecated. Get the direction that this bed's head is facing toward | 
| BlockFace | CocoaPlant. getFacing() | Deprecated. | 
| BlockFace | Comparator. getFacing() | Deprecated. Gets the direction this comparator is facing | 
| BlockFace | Diode. getFacing() | Deprecated. Gets the direction this diode is facing | 
| BlockFace | Directional. getFacing() | Gets the direction this block is facing | 
| BlockFace | DirectionalContainer. getFacing() | Deprecated. | 
| BlockFace | Dispenser. getFacing() | Deprecated. | 
| BlockFace | Door. getFacing() | Deprecated. Get the direction that this door is facing. | 
| BlockFace | Gate. getFacing() | Deprecated. | 
| BlockFace | Hopper. getFacing() | Deprecated. Gets the direction this hopper is facing | 
| BlockFace | Observer. getFacing() | Deprecated. | 
| BlockFace | PistonBaseMaterial. getFacing() | Deprecated. | 
| BlockFace | PistonExtensionMaterial. getFacing() | Deprecated. | 
| BlockFace | Pumpkin. getFacing() | Deprecated. | 
| BlockFace | Sign. getFacing() | Deprecated. Gets the direction that this sign is currently facing | 
| BlockFace | SimpleAttachableMaterialData. getFacing() | Deprecated. | 
| BlockFace | Skull. getFacing() | Deprecated. | 
| BlockFace | Stairs. getFacing() | Deprecated. | 
| BlockFace | Door. getHingeCorner() | Deprecated.
 This method should not be used; use hinge and facing accessors instead. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| Set<BlockFace> | Mushroom. getPaintedFaces() | Deprecated. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| boolean | Mushroom. isFacePainted(BlockFace face) | Deprecated. Checks whether a face of the block is painted with cap texture. | 
| boolean | Vine. isOnFace(BlockFace face) | Deprecated. Check if the vine is attached to the specified face of an adjacent
 block. | 
| void | Vine. putOnFace(BlockFace face) | Deprecated. Attach the vine to the specified face of an adjacent block. | 
| void | Vine. removeFromFace(BlockFace face) | Deprecated. Detach the vine from the specified face of an adjacent block. | 
| void | ExtendedRails. setDirection(BlockFace face,
            boolean isOnSlope) | Deprecated. | 
| void | Rails. setDirection(BlockFace face,
            boolean isOnSlope) | Deprecated. Set the direction of these tracks | 
| void | Tree. setDirection(BlockFace dir) | Deprecated. Set direction of the log | 
| void | Mushroom. setFacePainted(BlockFace face,
              boolean painted) | Deprecated.
 Use MushroomBlockType cap options | 
| void | Banner. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Bed. setFacingDirection(BlockFace face) | Deprecated. Set which direction the head of the bed is facing. | 
| void | Button. setFacingDirection(BlockFace face) | Deprecated. Sets the direction this button is pointing toward | 
| void | CocoaPlant. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Comparator. setFacingDirection(BlockFace face) | Deprecated. Sets the direction this comparator is facing | 
| void | Diode. setFacingDirection(BlockFace face) | Deprecated. Sets the direction this diode is facing. | 
| void | Directional. setFacingDirection(BlockFace face) | Sets the direction that this block is facing in | 
| void | DirectionalContainer. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Dispenser. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Door. setFacingDirection(BlockFace face) | Deprecated. Set the direction that this door should is facing. | 
| void | Gate. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Hopper. setFacingDirection(BlockFace face) | Deprecated. Sets the direction this hopper is facing | 
| void | Ladder. setFacingDirection(BlockFace face) | Deprecated. Sets the direction this ladder is facing | 
| void | Lever. setFacingDirection(BlockFace face) | Deprecated. Sets the direction this lever is pointing in | 
| void | Observer. setFacingDirection(BlockFace face) | Deprecated. | 
| void | PistonBaseMaterial. setFacingDirection(BlockFace face) | Deprecated. | 
| void | PistonExtensionMaterial. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Pumpkin. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Sign. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Skull. setFacingDirection(BlockFace face) | Deprecated. | 
| void | Stairs. setFacingDirection(BlockFace face) | Deprecated. Set the direction the stair part of the block is facing | 
| void | Torch. setFacingDirection(BlockFace face) | Deprecated. | 
| void | TrapDoor. setFacingDirection(BlockFace face) | Deprecated. | 
| void | TripwireHook. setFacingDirection(BlockFace face) | Deprecated. | 
| Constructor | Description | 
|---|---|
| Bed(BlockFace direction) | Deprecated. Instantiate a bed facing in a particular direction. | 
| Chest(BlockFace direction) | Deprecated. Instantiate a chest facing in a particular direction. | 
| CocoaPlant(CocoaPlant.CocoaPlantSize sz,
          BlockFace dir) | Deprecated. | 
| Comparator(BlockFace facingDirection) | Deprecated. Constructs a comparator switched off, with the default mode (normal) and facing the specified direction. | 
| Comparator(BlockFace facingDirection,
          boolean isSubtraction) | Deprecated. Constructs a comparator switched off, with the specified mode and facing the specified direction. | 
| Comparator(BlockFace facingDirection,
          boolean isSubtraction,
          boolean state) | Deprecated. Constructs a comparator switched on or off, with the specified mode and facing the specified direction. | 
| Diode(BlockFace facingDirection) | Deprecated. Constructs a diode switched off, with a delay of 1 and facing the
 specified direction. | 
| Diode(BlockFace facingDirection,
     int delay) | Deprecated. Constructs a diode switched off, with the specified delay and facing the
 specified direction. | 
| Diode(BlockFace facingDirection,
     int delay,
     boolean state) | Deprecated. Constructs a diode switched on or off, with the specified delay and
 facing the specified direction. | 
| Dispenser(BlockFace direction) | Deprecated. | 
| Door(Material type,
    BlockFace face) | Deprecated. 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) | Deprecated. 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) | Deprecated. 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) | Deprecated. 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) | Deprecated. Instantiate an ender chest facing in a particular direction. | 
| Furnace(BlockFace direction) | Deprecated. Instantiate a furnace facing in a particular direction. | 
| Hopper(BlockFace facingDirection) | Deprecated. Constructs a hopper facing the specified direction and initially active. | 
| Hopper(BlockFace facingDirection,
      boolean isActive) | Deprecated. Constructs a hopper facing the specified direction and either active or
 not. | 
| Mushroom(Material shroom,
        BlockFace capFace) | Deprecated. Constructs a brown/red mushroom cap block with the specified face or
 faces set to cap texture. | 
| Observer(BlockFace direction) | Deprecated. | 
| Pumpkin(BlockFace direction) | Deprecated. Instantiate a pumpkin facing in a particular direction. | 
| SimpleAttachableMaterialData(Material type,
                            BlockFace direction) | Deprecated. | 
| Skull(BlockFace direction) | Deprecated. Instantiate a skull facing in a particular direction. | 
| Tree(Material type,
    TreeSpecies species,
    BlockFace dir) | Deprecated. Constructs a tree block of the given type and tree species, and facing
 the given direction. | 
| Tree(TreeSpecies species,
    BlockFace dir) | Deprecated. Constructs a tree block of the given tree species, and facing the given
 direction. | 
| TripwireHook(BlockFace dir) | Deprecated. | 
| Vine(BlockFace... faces) | Deprecated. | 
| Constructor | Description | 
|---|---|
| Vine(EnumSet<BlockFace> faces) | Deprecated. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | MushroomBlockTexture. getCapFace() | Gets the face that has cap texture. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| static MushroomBlockTexture | MushroomBlockTexture. getCapByFace(BlockFace face) | Gets the MushroomBlockType with cap texture on the given block face. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BlockFace | RayTraceResult. getHitBlockFace() | Gets the hit block face. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| BoundingBox | BoundingBox. expand(BlockFace blockFace,
      double expansion) | Expands this bounding box in the direction specified by the given block
 face. | 
| Constructor | Description | 
|---|---|
| RayTraceResult(Vector hitPosition,
              BlockFace hitBlockFace) | Creates a RayTraceResult. | 
| RayTraceResult(Vector hitPosition,
              Block hitBlock,
              BlockFace hitBlockFace) | Creates a RayTraceResult. | 
| RayTraceResult(Vector hitPosition,
              Entity hitEntity,
              BlockFace hitBlockFace) | Creates a RayTraceResult. | 
Copyright © 2021. All rights reserved.