Package be.seeseemelk.mockbukkit.block

Class BlockMock

java.lang.Object

be.seeseemelk.mockbukkit.block.BlockMock

All Implemented Interfaces:

net.kyori.adventure.translation.Translatable, Block, Metadatable, Translatable

public class BlockMock
extends Object
implements Block

Mock implementation of a Block.

Constructor Summary

Constructors

Constructor	Description
BlockMock()	Creates a basic block made of air.
BlockMock(@NotNull Location location)	Creates a basic block made of air at a certain location.
BlockMock(@NotNull Material material)	Creates a basic block with a given material.
BlockMock(@NotNull Material material, @Nullable Location location)	Creates a basic block with a given material that is also linked to a specific location.

Method Summary

Modifier and Type	Method	Description
boolean	applyBoneMeal(@NotNull BlockFace face)
void	assertType(@NotNull Material material)	Assets that the material type of the block is equal to a given type.
boolean	breakNaturally()
boolean	breakNaturally(boolean triggerEffect)
boolean	breakNaturally(boolean triggerEffect, boolean dropExperience)
boolean	breakNaturally(@NotNull ItemStack tool, boolean triggerEffect)
boolean	breakNaturally(@NotNull ItemStack tool, boolean triggerEffect, boolean dropExperience)
boolean	breakNaturally(@Nullable ItemStack tool)
boolean	canPlace(@NotNull BlockData data)
@NotNull Biome	getBiome()
@NotNull BlockData	getBlockData()
long	getBlockKey()	Deprecated.
int	getBlockPower()
int	getBlockPower(@NotNull BlockFace face)
@NotNull SoundGroup	getBlockSoundGroup()
@NotNull BoundingBox	getBoundingBox()
float	getBreakSpeed(@NotNull Player player)
@NotNull Chunk	getChunk()
@NotNull VoxelShape	getCollisionShape()
@NotNull Biome	getComputedBiome()
byte	getData()	Deprecated.
@org.jetbrains.annotations.NotNull float	getDestroySpeed(@NotNull ItemStack itemStack)
@org.jetbrains.annotations.NotNull float	getDestroySpeed(@NotNull ItemStack itemStack, boolean considerEnchants)
@NotNull Collection<ItemStack>	getDrops()
@NotNull Collection<ItemStack>	getDrops(@NotNull ItemStack tool, Entity entity)
@NotNull Collection<ItemStack>	getDrops(@Nullable ItemStack tool)
BlockFace	getFace(@NotNull Block block)
double	getHumidity()
byte	getLightFromBlocks()
byte	getLightFromSky()
byte	getLightLevel()
@NotNull Location	getLocation()
Location	getLocation(@Nullable Location loc)
@NotNull List<MetadataValue>	getMetadata(String metadataKey)
@NotNull PistonMoveReaction	getPistonMoveReaction()
@NotNull Block	getRelative(int modX, int modY, int modZ)
@NotNull Block	getRelative(@NotNull BlockFace face)
@NotNull Block	getRelative(@NotNull BlockFace face, int distance)
@NotNull BlockSoundGroup	getSoundGroup()	Deprecated, for removal: This API element is subject to removal in a future version.
@NotNull BlockState	getState()
@NotNull BlockState	getState(boolean useSnapshot)
double	getTemperature()
@NotNull String	getTranslationKey()
@NotNull Material	getType()
@NotNull World	getWorld()
int	getX()
int	getY()
int	getZ()
boolean	hasMetadata(String metadataKey)
boolean	isBlockFaceIndirectlyPowered(@NotNull BlockFace face)
boolean	isBlockFacePowered(@NotNull BlockFace face)
boolean	isBlockIndirectlyPowered()
boolean	isBlockPowered()
boolean	isBuildable()
boolean	isBurnable()
boolean	isCollidable()
boolean	isEmpty()
boolean	isLiquid()
boolean	isPassable()
boolean	isPreferredTool(@NotNull ItemStack tool)
boolean	isReplaceable()
boolean	isSolid()
boolean	isValidTool(@NotNull ItemStack itemStack)
void	randomTick()
RayTraceResult	rayTrace(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode)
void	removeMetadata(String metadataKey, Plugin owningPlugin)
void	setBiome(@NotNull Biome bio)
void	setBlockData(@NotNull BlockData data)
void	setBlockData(@NotNull BlockData data, boolean applyPhysics)
void	setMetadata(String metadataKey, @NotNull MetadataValue newMetadataValue)
void	setState(@NotNull BlockStateMock state)	This method sets the current BlockState to the provided BlockStateMock.
void	setType(@NotNull Material type)
void	setType(@NotNull Material type, boolean applyPhysics)
void	tick()
@NotNull String	translationKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BlockMock

public BlockMock()

Creates a basic block made of air.

BlockMock

public BlockMock(@NotNull
 @NotNull Location location)

Creates a basic block made of air at a certain location.

Parameters:

location - The location of the block.

BlockMock

public BlockMock(@NotNull
 @NotNull Material material)

Creates a basic block with a given material.

Parameters:

material - The material to give the block.

BlockMock

public BlockMock(@NotNull
 @NotNull Material material,
 @Nullable
 @Nullable Location location)

Creates a basic block with a given material that is also linked to a specific location.

Parameters:

material - The material of the block.

location - The location of the block. Can be null if not needed.

Method Details

setMetadata

public void setMetadata(String metadataKey,
 @NotNull
 @NotNull MetadataValue newMetadataValue)

Specified by:

setMetadata in interface Metadatable

getMetadata

@NotNull
public @NotNull List<MetadataValue> getMetadata(String metadataKey)

Specified by:

getMetadata in interface Metadatable

hasMetadata

public boolean hasMetadata(String metadataKey)

Specified by:

hasMetadata in interface Metadatable

removeMetadata

public void removeMetadata(String metadataKey,
 Plugin owningPlugin)

Specified by:

removeMetadata in interface Metadatable

getData

@Deprecated
public byte getData()

Deprecated.

Specified by:

getData in interface Block

getRelative

@NotNull
public @NotNull Block getRelative(int modX,
 int modY,
 int modZ)

Specified by:

getRelative in interface Block

getRelative

@NotNull
public @NotNull Block getRelative(@NotNull
 @NotNull BlockFace face)

Specified by:

getRelative in interface Block

getRelative

@NotNull
public @NotNull Block getRelative(@NotNull
 @NotNull BlockFace face,
 int distance)

Specified by:

getRelative in interface Block

assertType

public void assertType(@NotNull
 @NotNull Material material)

Assets that the material type of the block is equal to a given type.

Parameters:

material - The material type that the block should have.

Throws:

AssertionError - Thrown if the material type of the block does not equal the given material type.

getType

@NotNull
public @NotNull Material getType()

Specified by:

getType in interface Block

getLightLevel

public byte getLightLevel()

Specified by:

getLightLevel in interface Block

getLightFromSky

public byte getLightFromSky()

Specified by:

getLightFromSky in interface Block

getLightFromBlocks

public byte getLightFromBlocks()

Specified by:

getLightFromBlocks in interface Block

getWorld

@NotNull
public @NotNull World getWorld()

Specified by:

getWorld in interface Block

getX

public int getX()

Specified by:

getX in interface Block

getY

public int getY()

Specified by:

getY in interface Block

getZ

public int getZ()

Specified by:

getZ in interface Block

getBlockKey

@Deprecated
public long getBlockKey()

Deprecated.

Specified by:

getBlockKey in interface Block

getLocation

@NotNull
public @NotNull Location getLocation()

Specified by:

getLocation in interface Block

getLocation

public Location getLocation(@Nullable
 @Nullable Location loc)

Specified by:

getLocation in interface Block

getChunk

@NotNull
public @NotNull Chunk getChunk()

Specified by:

getChunk in interface Block

setType

public void setType(@NotNull
 @NotNull Material type)

Specified by:

setType in interface Block

setType

public void setType(@NotNull
 @NotNull Material type,
 boolean applyPhysics)

Specified by:

setType in interface Block

getFace

public BlockFace getFace(@NotNull
 @NotNull Block block)

Specified by:

getFace in interface Block

getState

@NotNull
public @NotNull BlockState getState()

Specified by:

getState in interface Block

getBiome

@NotNull
public @NotNull Biome getBiome()

Specified by:

getBiome in interface Block

getComputedBiome

@NotNull
public @NotNull Biome getComputedBiome()

Specified by:

getComputedBiome in interface Block

getDestroySpeed

@NotNull
public @org.jetbrains.annotations.NotNull float getDestroySpeed(@NotNull
 @NotNull ItemStack itemStack)

Specified by:

getDestroySpeed in interface Block

getState

@NotNull
public @NotNull BlockState getState(boolean useSnapshot)

Specified by:

getState in interface Block

isValidTool

public boolean isValidTool(@NotNull
 @NotNull ItemStack itemStack)

Specified by:

isValidTool in interface Block

setBiome

public void setBiome(@NotNull
 @NotNull Biome bio)

Specified by:

setBiome in interface Block

isBlockPowered

public boolean isBlockPowered()

Specified by:

isBlockPowered in interface Block

isBlockIndirectlyPowered

public boolean isBlockIndirectlyPowered()

Specified by:

isBlockIndirectlyPowered in interface Block

isBlockFacePowered

public boolean isBlockFacePowered(@NotNull
 @NotNull BlockFace face)

Specified by:

isBlockFacePowered in interface Block

isBlockFaceIndirectlyPowered

public boolean isBlockFaceIndirectlyPowered(@NotNull
 @NotNull BlockFace face)

Specified by:

isBlockFaceIndirectlyPowered in interface Block

getBlockPower

public int getBlockPower(@NotNull
 @NotNull BlockFace face)

Specified by:

getBlockPower in interface Block

getBlockPower

public int getBlockPower()

Specified by:

getBlockPower in interface Block

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Block

isBurnable

public boolean isBurnable()

Specified by:

isBurnable in interface Block

isSolid

public boolean isSolid()

Specified by:

isSolid in interface Block

isCollidable

public boolean isCollidable()

Specified by:

isCollidable in interface Block

isReplaceable

public boolean isReplaceable()

Specified by:

isReplaceable in interface Block

isLiquid

public boolean isLiquid()

Specified by:

isLiquid in interface Block

isBuildable

public boolean isBuildable()

Specified by:

isBuildable in interface Block

getSoundGroup

@Deprecated(forRemoval=true)
@NotNull
public @NotNull BlockSoundGroup getSoundGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getSoundGroup in interface Block

getBlockSoundGroup

@NotNull
public @NotNull SoundGroup getBlockSoundGroup()

Specified by:

getBlockSoundGroup in interface Block

getTranslationKey

@NotNull
public @NotNull String getTranslationKey()

Specified by:

getTranslationKey in interface Block

Specified by:

getTranslationKey in interface Translatable

getDestroySpeed

@NotNull
public @org.jetbrains.annotations.NotNull float getDestroySpeed(@NotNull
 @NotNull ItemStack itemStack,
 boolean considerEnchants)

Specified by:

getDestroySpeed in interface Block

breakNaturally

public boolean breakNaturally(@NotNull
 @NotNull ItemStack tool,
 boolean triggerEffect)

Specified by:

breakNaturally in interface Block

tick

public void tick()

Specified by:

tick in interface Block

randomTick

public void randomTick()

Specified by:

randomTick in interface Block

breakNaturally

public boolean breakNaturally(boolean triggerEffect)

Specified by:

breakNaturally in interface Block

breakNaturally

public boolean breakNaturally(@NotNull
 @NotNull ItemStack tool,
 boolean triggerEffect,
 boolean dropExperience)

Specified by:

breakNaturally in interface Block

breakNaturally

public boolean breakNaturally(boolean triggerEffect,
 boolean dropExperience)

Specified by:

breakNaturally in interface Block

getTemperature

public double getTemperature()

Specified by:

getTemperature in interface Block

getHumidity

public double getHumidity()

Specified by:

getHumidity in interface Block

getPistonMoveReaction

@NotNull
public @NotNull PistonMoveReaction getPistonMoveReaction()

Specified by:

getPistonMoveReaction in interface Block

breakNaturally

public boolean breakNaturally()

Specified by:

breakNaturally in interface Block

breakNaturally

public boolean breakNaturally(@Nullable
 @Nullable ItemStack tool)

Specified by:

breakNaturally in interface Block

getDrops

@NotNull
public @NotNull Collection<ItemStack> getDrops()

Specified by:

getDrops in interface Block

getDrops

@NotNull
public @NotNull Collection<ItemStack> getDrops(@Nullable
 @Nullable ItemStack tool)

Specified by:

getDrops in interface Block

getBlockData

@NotNull
public @NotNull BlockData getBlockData()

Specified by:

getBlockData in interface Block

setBlockData

public void setBlockData(@NotNull
 @NotNull BlockData data)

Specified by:

setBlockData in interface Block

setBlockData

public void setBlockData(@NotNull
 @NotNull BlockData data,
 boolean applyPhysics)

Specified by:

setBlockData in interface Block

isPassable

public boolean isPassable()

Specified by:

isPassable in interface Block

rayTrace

public RayTraceResult rayTrace(@NotNull
 @NotNull Location start,
 @NotNull
 @NotNull Vector direction,
 double maxDistance,
 @NotNull
 @NotNull FluidCollisionMode fluidCollisionMode)

Specified by:

rayTrace in interface Block

getBoundingBox

@NotNull
public @NotNull BoundingBox getBoundingBox()

Specified by:

getBoundingBox in interface Block

getCollisionShape

@NotNull
public @NotNull VoxelShape getCollisionShape()

Specified by:

getCollisionShape in interface Block

getDrops

@NotNull
public @NotNull Collection<ItemStack> getDrops(@NotNull
 @NotNull ItemStack tool,
 Entity entity)

Specified by:

getDrops in interface Block

setState

public void setState(@NotNull
 @NotNull BlockStateMock state)

This method sets the current BlockState to the provided BlockStateMock. Do not call this method directly, use BlockState.update() instead.

Parameters:

state - The BlockState that should be set.

applyBoneMeal

public boolean applyBoneMeal(@NotNull
 @NotNull BlockFace face)

Specified by:

applyBoneMeal in interface Block

isPreferredTool

public boolean isPreferredTool(@NotNull
 @NotNull ItemStack tool)

Specified by:

isPreferredTool in interface Block

getBreakSpeed

public float getBreakSpeed(@NotNull
 @NotNull Player player)

Specified by:

getBreakSpeed in interface Block

canPlace

public boolean canPlace(@NotNull
 @NotNull BlockData data)

Specified by:

canPlace in interface Block

translationKey

@NotNull
public @NotNull String translationKey()

Specified by:

translationKey in interface net.kyori.adventure.translation.Translatable