Package net.minecraft.world.level.block.state

Class BlockBehaviour

java.lang.Object

net.minecraft.world.level.block.state.BlockBehaviour

All Implemented Interfaces:

FeatureElement

Direct Known Subclasses:

Block

public abstract class BlockBehaviour
extends Object
implements FeatureElement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlockBehaviour.BlockStateBase
static interface	BlockBehaviour.OffsetFunction
static enum	BlockBehaviour.OffsetType
static class	BlockBehaviour.Properties
static interface	BlockBehaviour.StateArgumentPredicate<A>
static interface	BlockBehaviour.StatePredicate

Field Summary

Fields

Modifier and Type	Field	Description
protected ResourceKey<LootTable>	drops
protected final boolean	dynamicShape
protected final float	explosionResistance
protected final float	friction	Determines how much velocity is maintained while moving on top of this block
protected final boolean	hasCollision
protected final boolean	isRandomlyTicking	Whether this blocks receives random ticks
protected final float	jumpFactor
private final Supplier<ResourceKey<LootTable>>	lootTableSupplier
protected final BlockBehaviour.Properties	properties
protected final FeatureFlagSet	requiredFeatures
protected final SoundType	soundType
protected final float	speedFactor
protected static final Direction[]	UPDATE_SHAPE_ORDER

Fields inherited from interface net.minecraft.world.flag.FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
BlockBehaviour(BlockBehaviour.Properties pProperties)

Method Summary

Modifier and Type	Method	Description
protected abstract Block	asBlock()
abstract Item	asItem()
protected void	attack(BlockState pState, Level pLevel, BlockPos pPos, Player pPlayer)
protected boolean	canBeReplaced(BlockState pState, BlockPlaceContext pUseContext)
protected boolean	canBeReplaced(BlockState pState, Fluid pFluid)
protected boolean	canSurvive(BlockState pState, LevelReader pLevel, BlockPos pPos)
protected abstract com.mojang.serialization.MapCodec<? extends Block>	codec()
float	defaultDestroyTime()
MapColor	defaultMapColor()
protected void	entityInside(BlockState pState, Level pLevel, BlockPos pPos, Entity pEntity)
protected int	getAnalogOutputSignal(BlockState pState, Level pLevel, BlockPos pPos)	Returns the analog signal this block emits.
protected VoxelShape	getBlockSupportShape(BlockState pState, BlockGetter pLevel, BlockPos pPos)
protected VoxelShape	getCollisionShape(BlockState pState, BlockGetter pLevel, BlockPos pPos, CollisionContext pContext)
protected float	getDestroyProgress(BlockState pState, Player pPlayer, BlockGetter pLevel, BlockPos pPos)	Get the hardness of this Block relative to the ability of the given player
protected int	getDirectSignal(BlockState pState, BlockGetter pLevel, BlockPos pPos, Direction pDirection)	Returns the direct signal this block emits in the given direction.
protected List<ItemStack>	getDrops(BlockState pState, LootParams.Builder pParams)
protected FluidState	getFluidState(BlockState pState)
protected VoxelShape	getInteractionShape(BlockState pState, BlockGetter pLevel, BlockPos pPos)
protected int	getLightBlock(BlockState pState, BlockGetter pLevel, BlockPos pPos)
final ResourceKey<LootTable>	getLootTable()
protected float	getMaxHorizontalOffset()
protected float	getMaxVerticalOffset()
protected MenuProvider	getMenuProvider(BlockState pState, Level pLevel, BlockPos pPos)
protected VoxelShape	getOcclusionShape(BlockState pState, BlockGetter pLevel, BlockPos pPos)
protected RenderShape	getRenderShape(BlockState pState)	The type of render function called.
protected long	getSeed(BlockState pState, BlockPos pPos)	Return a random long to be passed to BakedModel.getQuads(net.minecraft.world.level.block.state.BlockState, net.minecraft.core.Direction, net.minecraft.util.RandomSource), used for random model rotations
protected float	getShadeBrightness(BlockState pState, BlockGetter pLevel, BlockPos pPos)
protected VoxelShape	getShape(BlockState pState, BlockGetter pLevel, BlockPos pPos, CollisionContext pContext)
protected int	getSignal(BlockState pState, BlockGetter pLevel, BlockPos pPos, Direction pDirection)	Returns the signal this block emits in the given direction.
protected SoundType	getSoundType(BlockState pState)	Deprecated.
protected VoxelShape	getVisualShape(BlockState pState, BlockGetter pLevel, BlockPos pPos, CollisionContext pContext)
protected boolean	hasAnalogOutputSignal(BlockState pState)
protected boolean	isAir(BlockState state)
protected boolean	isCollisionShapeFullBlock(BlockState pState, BlockGetter pLevel, BlockPos pPos)
protected boolean	isOcclusionShapeFullBlock(BlockState pState, BlockGetter pLevel, BlockPos pPos)
protected boolean	isPathfindable(BlockState pState, PathComputationType pPathComputationType)
protected boolean	isRandomlyTicking(BlockState pState)
protected boolean	isSignalSource(BlockState pState)	Returns whether this block is capable of emitting redstone signals.
protected BlockState	mirror(BlockState pState, Mirror pMirror)	Returns the blockstate with the given mirror of the passed blockstate.
protected void	neighborChanged(BlockState pState, Level pLevel, BlockPos pPos, Block pNeighborBlock, BlockPos pNeighborPos, boolean pMovedByPiston)
protected void	onExplosionHit(BlockState pState, Level pLevel, BlockPos pPos, Explosion pExplosion, BiConsumer<ItemStack,BlockPos> pDropConsumer)
protected void	onPlace(BlockState pState, Level pLevel, BlockPos pPos, BlockState pOldState, boolean pMovedByPiston)
protected void	onProjectileHit(Level pLevel, BlockState pState, BlockHitResult pHit, Projectile pProjectile)
protected void	onRemove(BlockState pState, Level pLevel, BlockPos pPos, BlockState pNewState, boolean pMovedByPiston)
protected boolean	propagatesSkylightDown(BlockState pState, BlockGetter pLevel, BlockPos pPos)
BlockBehaviour.Properties	properties()
static <B extends Block> com.mojang.serialization.codecs.RecordCodecBuilder<B,BlockBehaviour.Properties>	propertiesCodec()
protected void	randomTick(BlockState pState, ServerLevel pLevel, BlockPos pPos, RandomSource pRandom)	Performs a random tick on a block.
FeatureFlagSet	requiredFeatures()
protected BlockState	rotate(BlockState pState, Rotation pRotation)	Returns the blockstate with the given rotation from the passed blockstate.
static <B extends Block> com.mojang.serialization.MapCodec<B>	simpleCodec(Function<BlockBehaviour.Properties,B> pFactory)
protected boolean	skipRendering(BlockState pState, BlockState pAdjacentState, Direction pDirection)
protected void	spawnAfterBreak(BlockState pState, ServerLevel pLevel, BlockPos pPos, ItemStack pStack, boolean pDropExperience)	Perform side-effects from block dropping, such as creating silverfish
protected void	tick(BlockState pState, ServerLevel pLevel, BlockPos pPos, RandomSource pRandom)
protected boolean	triggerEvent(BlockState pState, Level pLevel, BlockPos pPos, int pId, int pParam)	Called on server when Level.blockEvent(net.minecraft.core.BlockPos, net.minecraft.world.level.block.Block, int, int) is called.
protected void	updateIndirectNeighbourShapes(BlockState pState, LevelAccessor pLevel, BlockPos pPos, int pFlags, int pRecursionLeft)	Updates the shapes of indirect neighbors of this block.
protected BlockState	updateShape(BlockState pState, Direction pDirection, BlockState pNeighborState, LevelAccessor pLevel, BlockPos pPos, BlockPos pNeighborPos)	Update the provided state given the provided neighbor direction and neighbor state, returning a new state.
protected ItemInteractionResult	useItemOn(ItemStack pStack, BlockState pState, Level pLevel, BlockPos pPos, Player pPlayer, InteractionHand pHand, BlockHitResult pHitResult)
protected boolean	useShapeForLightOcclusion(BlockState pState)
protected InteractionResult	useWithoutItem(BlockState pState, Level pLevel, BlockPos pPos, Player pPlayer, BlockHitResult pHitResult)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.world.flag.FeatureElement

isEnabled

Field Details

UPDATE_SHAPE_ORDER

protected static final Direction[] UPDATE_SHAPE_ORDER

hasCollision

protected final boolean hasCollision

explosionResistance

protected final float explosionResistance

isRandomlyTicking

protected final boolean isRandomlyTicking

Whether this blocks receives random ticks

soundType

protected final SoundType soundType

friction

protected final float friction

Determines how much velocity is maintained while moving on top of this block

speedFactor

protected final float speedFactor

jumpFactor

protected final float jumpFactor

dynamicShape

protected final boolean dynamicShape

requiredFeatures

protected final FeatureFlagSet requiredFeatures

properties

protected final BlockBehaviour.Properties properties

drops

@Nullable
protected ResourceKey<LootTable> drops

lootTableSupplier

private final Supplier<ResourceKey<LootTable>> lootTableSupplier

Constructor Details

BlockBehaviour

public BlockBehaviour(BlockBehaviour.Properties pProperties)

Method Details

properties

public BlockBehaviour.Properties properties()

codec

protected abstract com.mojang.serialization.MapCodec<? extends Block> codec()

propertiesCodec

public static <B extends Block>
com.mojang.serialization.codecs.RecordCodecBuilder<B,BlockBehaviour.Properties> propertiesCodec()

simpleCodec

public static <B extends Block>
com.mojang.serialization.MapCodec<B> simpleCodec(Function<BlockBehaviour.Properties,B> pFactory)

updateIndirectNeighbourShapes

protected void updateIndirectNeighbourShapes(BlockState pState,
 LevelAccessor pLevel,
 BlockPos pPos,
 int pFlags,
 int pRecursionLeft)

Updates the shapes of indirect neighbors of this block. This method is analogous to

invalid reference

net.minecraft.world.level.block.state.BlockBehaviour$BlockStateBase#updateNeighbourShapes

but where that method affects the 6 direct neighbors of this block, this method affects the indirect neighbors, if any.

Currently the only implementation of this method is RedStoneWireBlock.updateIndirectNeighbourShapes(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.level.LevelAccessor, net.minecraft.core.BlockPos, int, int) where it is used to validate diagonal connections of redstone wire blocks.

isPathfindable

protected boolean isPathfindable(BlockState pState,
 PathComputationType pPathComputationType)

updateShape

protected BlockState updateShape(BlockState pState,
 Direction pDirection,
 BlockState pNeighborState,
 LevelAccessor pLevel,
 BlockPos pPos,
 BlockPos pNeighborPos)

Update the provided state given the provided neighbor direction and neighbor state, returning a new state. For example, fences make their connections to the passed in state if possible, and wet concrete powder immediately returns its solidified counterpart. Note that this method should ideally consider only the specific direction passed in.

skipRendering

protected boolean skipRendering(BlockState pState,
 BlockState pAdjacentState,
 Direction pDirection)

neighborChanged

protected void neighborChanged(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 Block pNeighborBlock,
 BlockPos pNeighborPos,
 boolean pMovedByPiston)

onPlace

protected void onPlace(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 BlockState pOldState,
 boolean pMovedByPiston)

onRemove

protected void onRemove(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 BlockState pNewState,
 boolean pMovedByPiston)

onExplosionHit

protected void onExplosionHit(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 Explosion pExplosion,
 BiConsumer<ItemStack,BlockPos> pDropConsumer)

useWithoutItem

protected InteractionResult useWithoutItem(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 Player pPlayer,
 BlockHitResult pHitResult)

useItemOn

protected ItemInteractionResult useItemOn(ItemStack pStack,
 BlockState pState,
 Level pLevel,
 BlockPos pPos,
 Player pPlayer,
 InteractionHand pHand,
 BlockHitResult pHitResult)

triggerEvent

protected boolean triggerEvent(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 int pId,
 int pParam)

Called on server when Level.blockEvent(net.minecraft.core.BlockPos, net.minecraft.world.level.block.Block, int, int) is called. If server returns true, then also called on the client. On the Server, this may perform additional changes to the world, like pistons replacing the block with an extended base. On the client, the update may involve replacing block entities or effects such as sounds or particles

getRenderShape

protected RenderShape getRenderShape(BlockState pState)

The type of render function called. MODEL for mixed tesr and static model, MODELBLOCK_ANIMATED for TESR-only, LIQUID for vanilla liquids, INVISIBLE to skip all rendering

useShapeForLightOcclusion

protected boolean useShapeForLightOcclusion(BlockState pState)

isSignalSource

protected boolean isSignalSource(BlockState pState)

Returns whether this block is capable of emitting redstone signals.

getFluidState

protected FluidState getFluidState(BlockState pState)

hasAnalogOutputSignal

protected boolean hasAnalogOutputSignal(BlockState pState)

getMaxHorizontalOffset

protected float getMaxHorizontalOffset()

getMaxVerticalOffset

protected float getMaxVerticalOffset()

requiredFeatures

public FeatureFlagSet requiredFeatures()

Specified by:

requiredFeatures in interface FeatureElement

rotate

protected BlockState rotate(BlockState pState,
 Rotation pRotation)

Returns the blockstate with the given rotation from the passed blockstate. If inapplicable, returns the passed blockstate.

mirror

protected BlockState mirror(BlockState pState,
 Mirror pMirror)

Returns the blockstate with the given mirror of the passed blockstate. If inapplicable, returns the passed blockstate.

canBeReplaced

protected boolean canBeReplaced(BlockState pState,
 BlockPlaceContext pUseContext)

canBeReplaced

protected boolean canBeReplaced(BlockState pState,
 Fluid pFluid)

getDrops

protected List<ItemStack> getDrops(BlockState pState,
 LootParams.Builder pParams)

getSeed

protected long getSeed(BlockState pState,
 BlockPos pPos)

Return a random long to be passed to BakedModel.getQuads(net.minecraft.world.level.block.state.BlockState, net.minecraft.core.Direction, net.minecraft.util.RandomSource), used for random model rotations

getOcclusionShape

protected VoxelShape getOcclusionShape(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getBlockSupportShape

protected VoxelShape getBlockSupportShape(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getInteractionShape

protected VoxelShape getInteractionShape(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getLightBlock

protected int getLightBlock(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getMenuProvider

@Nullable
protected MenuProvider getMenuProvider(BlockState pState,
 Level pLevel,
 BlockPos pPos)

canSurvive

protected boolean canSurvive(BlockState pState,
 LevelReader pLevel,
 BlockPos pPos)

getShadeBrightness

protected float getShadeBrightness(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getAnalogOutputSignal

protected int getAnalogOutputSignal(BlockState pState,
 Level pLevel,
 BlockPos pPos)

Returns the analog signal this block emits. This is the signal a comparator can read from it.

getShape

protected VoxelShape getShape(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos,
 CollisionContext pContext)

getCollisionShape

protected VoxelShape getCollisionShape(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos,
 CollisionContext pContext)

isCollisionShapeFullBlock

protected boolean isCollisionShapeFullBlock(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

isOcclusionShapeFullBlock

protected boolean isOcclusionShapeFullBlock(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getVisualShape

protected VoxelShape getVisualShape(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos,
 CollisionContext pContext)

randomTick

protected void randomTick(BlockState pState,
 ServerLevel pLevel,
 BlockPos pPos,
 RandomSource pRandom)

Performs a random tick on a block.

tick

protected void tick(BlockState pState,
 ServerLevel pLevel,
 BlockPos pPos,
 RandomSource pRandom)

getDestroyProgress

protected float getDestroyProgress(BlockState pState,
 Player pPlayer,
 BlockGetter pLevel,
 BlockPos pPos)

Get the hardness of this Block relative to the ability of the given player

spawnAfterBreak

protected void spawnAfterBreak(BlockState pState,
 ServerLevel pLevel,
 BlockPos pPos,
 ItemStack pStack,
 boolean pDropExperience)

Perform side-effects from block dropping, such as creating silverfish

attack

protected void attack(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 Player pPlayer)

getSignal

protected int getSignal(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos,
 Direction pDirection)

Returns the signal this block emits in the given direction.

NOTE: directions in redstone signal related methods are backwards, so this method checks for the signal emitted in the opposite direction of the one given.

entityInside

protected void entityInside(BlockState pState,
 Level pLevel,
 BlockPos pPos,
 Entity pEntity)

getDirectSignal

protected int getDirectSignal(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos,
 Direction pDirection)

Returns the direct signal this block emits in the given direction.

NOTE: directions in redstone signal related methods are backwards, so this method checks for the signal emitted in the opposite direction of the one given.

getLootTable

public final ResourceKey<LootTable> getLootTable()

onProjectileHit

protected void onProjectileHit(Level pLevel,
 BlockState pState,
 BlockHitResult pHit,
 Projectile pProjectile)

propagatesSkylightDown

protected boolean propagatesSkylightDown(BlockState pState,
 BlockGetter pLevel,
 BlockPos pPos)

isRandomlyTicking

protected boolean isRandomlyTicking(BlockState pState)

getSoundType

@Deprecated
protected SoundType getSoundType(BlockState pState)

Deprecated.

asItem

public abstract Item asItem()

asBlock

protected abstract Block asBlock()

defaultMapColor

public MapColor defaultMapColor()

defaultDestroyTime

public float defaultDestroyTime()

isAir

protected boolean isAir(BlockState state)