* This method is equal to getRelative(face, 1) * * @param face Face of this block to return * @return Block at the given face * @see #getRelative(BlockFace, int) */ @NotNull Block getRelative(@NotNull BlockFace face); /** * Gets the block at the given distance of the given face *
* For example, the following method places water at 100,102,100; two * blocks above 100,100,100. * *
* Block block = world.getBlockAt(100, 100, 100);
* Block shower = block.getRelative(BlockFace.UP, 2);
* shower.setType(Material.WATER);
*
*
* @param face Face of this block to return
* @param distance Distance to get the block at
* @return Block at the given face
*/
@NotNull
Block getRelative(@NotNull BlockFace face, int distance);
/**
* Gets the type of this block
*
* @return block type
*/
@NotNull
Material getType();
/**
* Gets the light level between 0-15
*
* @return light level
*/
byte getLightLevel();
/**
* Get the amount of light at this block from the sky.
* * Any light given from other sources (such as blocks like torches) will * be ignored. * * @return Sky light level */ byte getLightFromSky(); /** * Get the amount of light at this block from nearby blocks. *
* Any light given from other sources (such as the sun) will be ignored. * * @return Block light level */ byte getLightFromBlocks(); /** * Gets the world which contains this Block * * @return World containing this block */ @NotNull World getWorld(); /** * Gets the x-coordinate of this block * * @return x-coordinate */ int getX(); /** * Gets the y-coordinate of this block * * @return y-coordinate */ int getY(); /** * Gets the z-coordinate of this block * * @return z-coordinate */ int getZ(); /** * Gets the Location of the block * * @return Location of block */ @NotNull Location getLocation(); /** * Stores the location of the block in the provided Location object. *
* If the provided Location is null this method does nothing and returns
* null.
*
* @param loc the location to copy into
* @return The Location object provided or null
*/
@Contract("null -> null; !null -> !null")
@Nullable
Location getLocation(@Nullable Location loc);
/**
* Gets the chunk which contains this block
*
* @return Containing Chunk
*/
@NotNull
Chunk getChunk();
/**
* Sets the complete data for this block
*
* @param data new block specific data
*/
void setBlockData(@NotNull BlockData data);
/**
* Sets the complete data for this block
*
*
* Note that applyPhysics = false is not in general safe. It should only be
* used when you need to avoid triggering a physics update of neighboring
* blocks, for example when creating a {@link Bisected} block. If you are
* using a custom populator, then this parameter may also be required to
* prevent triggering infinite chunk loads on border blocks. This method
* should NOT be used to "hack" physics by placing blocks in impossible
* locations. Such blocks are liable to be removed on various events such as
* world upgrades. Furthermore setting large amounts of such blocks in close
* proximity may overload the server physics engine if an update is
* triggered at a later point. If this occurs, the resulting behavior is
* undefined.
*
* @param data new block specific data
* @param applyPhysics false to cancel physics from the changed block
*/
void setBlockData(@NotNull BlockData data, boolean applyPhysics);
/**
* Sets the type of this block
*
* @param type Material to change this block to
*/
void setType(@NotNull Material type);
/**
* Sets the type of this block
*
*
* Note that applyPhysics = false is not in general safe. It should only be
* used when you need to avoid triggering a physics update of neighboring
* blocks, for example when creating a {@link Bisected} block. If you are
* using a custom populator, then this parameter may also be required to
* prevent triggering infinite chunk loads on border blocks. This method
* should NOT be used to "hack" physics by placing blocks in impossible
* locations. Such blocks are liable to be removed on various events such as
* world upgrades. Furthermore setting large amounts of such blocks in close
* proximity may overload the server physics engine if an update is
* triggered at a later point. If this occurs, the resulting behavior is
* undefined.
*
* @param type Material to change this block to
* @param applyPhysics False to cancel physics on the changed block.
*/
void setType(@NotNull Material type, boolean applyPhysics);
/**
* Gets the face relation of this block compared to the given block.
*
* For example: *
{@code
* Block current = world.getBlockAt(100, 100, 100);
* Block target = world.getBlockAt(100, 101, 100);
*
* current.getFace(target) == BlockFace.Up;
* }
* * The returned object will never be updated, and you are not guaranteed * that (for example) a sign is still a sign after you capture its state. * * @return BlockState with the current state of this block. */ @NotNull BlockState getState(); /** * Returns the biome that this block resides in * * @return Biome type containing this block */ @NotNull Biome getBiome(); /** * Sets the biome that this block resides in * * @param bio new Biome type for this block */ void setBiome(@NotNull Biome bio); /** * Returns true if the block is being powered by Redstone. * * @return True if the block is powered. */ boolean isBlockPowered(); /** * Returns true if the block is being indirectly powered by Redstone. * * @return True if the block is indirectly powered. */ boolean isBlockIndirectlyPowered(); /** * Returns true if the block face is being powered by Redstone. * * @param face The block face * @return True if the block face is powered. */ boolean isBlockFacePowered(@NotNull BlockFace face); /** * Returns true if the block face is being indirectly powered by Redstone. * * @param face The block face * @return True if the block face is indirectly powered. */ boolean isBlockFaceIndirectlyPowered(@NotNull BlockFace face); /** * Returns the redstone power being provided to this block face * * @param face the face of the block to query or BlockFace.SELF for the * block itself * @return The power level. */ int getBlockPower(@NotNull BlockFace face); /** * Returns the redstone power being provided to this block * * @return The power level. */ int getBlockPower(); /** * Checks if this block is empty. *
* A block is considered empty when {@link #getType()} returns {@link * Material#AIR}. * * @return true if this block is empty */ boolean isEmpty(); /** * Checks if this block is liquid. *
* A block is considered liquid when {@link #getType()} returns {@link * Material#WATER} or {@link Material#LAVA}. * * @return true if this block is liquid */ boolean isLiquid(); /** * Gets the temperature of this block. *
* If the raw biome temperature without adjusting for height effects is
* required then please use {@link World#getTemperature(int, int)}.
*
* @return Temperature of this block
*/
double getTemperature();
/**
* Gets the humidity of the biome of this block
*
* @return Humidity of this block
*/
double getHumidity();
/**
* Returns the reaction of the block when moved by a piston
*
* @return reaction
*/
@NotNull
PistonMoveReaction getPistonMoveReaction();
/**
* Breaks the block and spawns items as if a player had digged it regardless
* of the tool.
*
* @return true if the block was destroyed
*/
boolean breakNaturally();
/**
* Breaks the block and spawns items as if a player had digged it with a
* specific tool
*
* @param tool The tool or item in hand used for digging
* @return true if the block was destroyed
*/
boolean breakNaturally(@Nullable ItemStack tool);
/**
* Simulate bone meal application to this block (if possible).
*
* @param face the face on which bonemeal should be applied
*
* @return true if the block was bonemealed, false otherwise
*/
boolean applyBoneMeal(@NotNull BlockFace face);
/**
* Returns a list of items which would drop by destroying this block
*
* @return a list of dropped items for this type of block
*/
@NotNull
Collection
* A block is passable if it has no colliding parts that would prevent
* players from moving through it.
*
* Examples: Tall grass, flowers, signs, etc. are passable, but open doors,
* fence gates, trap doors, etc. are not because they still have parts that
* can be collided with.
*
* @return
* This isn't exact as some blocks {@link org.bukkit.block.data.type.Stairs}
* contain many bounding boxes to establish their complete form.
*
* Also, the box may not be exactly the same as the collision shape (such as
* cactus, which is 16/16 of a block with 15/16 collisional bounds).
*
* This method will return an empty bounding box if the geometric shape of
* the block is empty (such as air blocks).
*
* @return the approximate bounding box of the block
*/
@NotNull
BoundingBox getBoundingBox();
/**
* Gets the collision shape of this block.
*
* @return a {@link VoxelShape} representing the collision shape of this
* block.
*/
@NotNull
VoxelShape getCollisionShape();
/**
* Checks if this block is a valid placement location for the specified
* block data.
*
* @param data the block data to check
* @return true if passable
*/
boolean isPassable();
/**
* Performs a ray trace that checks for collision with this specific block
* in its current state using its precise collision shape.
*
* @param start the start location
* @param direction the ray direction
* @param maxDistance the maximum distance
* @param fluidCollisionMode the fluid collision mode
* @return the ray trace hit result, or null if there is no hit
*/
@Nullable
RayTraceResult rayTrace(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode);
/**
* Gets the approximate bounding box for this block.
* true if the block data can be placed here
*/
boolean canPlace(@NotNull BlockData data);
}