Package net.neoforged.neoforge.common.extensions

Interface IBlockStateExtension

All Known Implementing Classes:
BlockState
public interface IBlockStateExtension

  • Method Details

    • self

      private BlockState self()

    • getFriction

      default float getFriction(LevelReader level, BlockPos pos, @Nullable @Nullable Entity entity)
      Gets the slipperiness at the given location at the given state. Normally between 0 and 1.

      Note that entities may reduce slipperiness by a certain factor of their own; for LivingEntity, this is .91. ItemEntity uses .98, and FishingHook uses .92.

      Parameters:
      level - the level
      pos - the position in the level
      entity - the entity in question
      Returns:
      the factor by which the entity's motion should be multiplied

    • hasDynamicLightEmission

      default boolean hasDynamicLightEmission()
      Whether this block state has dynamic light emission which is not solely based on its underlying block or its state properties and instead uses the BlockPos, the AuxiliaryLightManager or another external data source to determine its light value in getLightEmission(BlockGetter, BlockPos)
      Returns:
      true if this block state cannot determine its light emission solely based on its properties, false otherwise

    • getLightEmission

      default int getLightEmission(BlockGetter level, BlockPos pos)
      Get a light value for this block, taking into account the given state and coordinates, normal ranges are between 0 and 15

    • isLadder

      default boolean isLadder(LevelReader level, BlockPos pos, LivingEntity entity)
      Checks if a player or entity can use this block to 'climb' like a ladder.
      Parameters:
      level - The current level
      pos - Block position in level
      entity - The entity trying to use the ladder, CAN be null.
      Returns:
      True if the block should act like a ladder

    • canHarvestBlock

      default boolean canHarvestBlock(BlockGetter level, BlockPos pos, Player player)
      Determines if the player can harvest this block, obtaining it's drops when the block is destroyed.
      Parameters:
      level - The current level
      pos - The block's current position
      player - The player damaging the block
      Returns:
      True to spawn the drops

    • onDestroyedByPlayer

      default boolean onDestroyedByPlayer(Level level, BlockPos pos, Player player, boolean willHarvest, FluidState fluid)
      Called when a player removes a block. This is responsible for actually destroying the block, and the block is intact at time of call. This is called regardless of whether the player can harvest the block or not. Return true if the block is actually destroyed. This function is called on both the logical client and logical server.
      Parameters:
      level - The current level
      pos - Block position in level
      player - The player damaging the block, may be null
      willHarvest - The result of canHarvestBlock(net.minecraft.world.level.BlockGetter, net.minecraft.core.BlockPos, net.minecraft.world.entity.player.Player), if called on the server by a non-creative player, otherwise always false.
      fluid - The current fluid and block state for the position in the level.
      Returns:
      True if the block is actually destroyed.

    • onDestroyedByPushReaction

      default void onDestroyedByPushReaction(Level level, BlockPos pos, Direction pushDirection, FluidState fluid)
      Called when a block is removed by PushReaction.DESTROY. This is responsible for actually destroying the block, and the block is intact at time of call.

      Will only be called if BlockBehaviour.BlockStateBase.getPistonPushReaction() returns PushReaction.DESTROY.

      Note: When used in multiplayer, this is called on both client and server sides!

      Parameters:
      level - The current level
      pos - Block position in level
      pushDirection - The direction of block movement
      fluid - The current fluid state at current position

    • isBed

      default boolean isBed(BlockGetter level, BlockPos pos, LivingEntity sleeper)
      Determines if this block is classified as a bed, replacing instanceof BedBlock checks.

      If true, players may sleep in it, though the block must manually put the player to sleep by calling Player.startSleepInBed(net.minecraft.core.BlockPos) from BlockBehaviour.useWithoutItem(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.level.Level, net.minecraft.core.BlockPos, net.minecraft.world.entity.player.Player, net.minecraft.world.phys.BlockHitResult) or similar.

      Parameters:
      level - The current level
      pos - Block position in level
      sleeper - The sleeping entity
      Returns:
      True to treat this as a bed

    • getRespawnPosition

      default Optional<Vec3> getRespawnPosition(EntityType<?> type, LevelReader level, BlockPos pos, float orientation)
      Returns the position that the entity is moved to upon respawning at this block.
      Parameters:
      type - The entity type used when checking if a dismount blockstate is dangerous. Currently always PLAYER.
      level - The current level
      pos - Block position in level
      orientation - The angle the entity had when setting the respawn point
      Returns:
      The spawn position or the empty optional if respawning here is not possible

    • setBedOccupied

      default void setBedOccupied(Level level, BlockPos pos, LivingEntity sleeper, boolean occupied)
      Called when a user either starts or stops sleeping in the bed.
      Parameters:
      level - The current level
      pos - Block position in level
      sleeper - The sleeper or camera entity, null in some cases.
      occupied - True if we are occupying the bed, or false if they are stopping use of the bed

    • getBedDirection

      default Direction getBedDirection(LevelReader level, BlockPos pos)
      Returns the direction of the block. Same values that are returned by BlockDirectional
      Parameters:
      level - The current level
      pos - Block position in level
      Returns:
      Bed direction

    • getExplosionResistance

      default float getExplosionResistance(BlockGetter level, BlockPos pos, Explosion explosion)
      Location sensitive version of getExplosionResistance
      Parameters:
      level - The current level
      pos - Block position in level
      explosion - The explosion
      Returns:
      The amount of the explosion absorbed.

    • getCloneItemStack

      default ItemStack getCloneItemStack(HitResult target, LevelReader level, BlockPos pos, Player player)
      Called when A user uses the creative pick block button on this block
      Parameters:
      target - The full target the player is looking at
      Returns:
      A ItemStack to add to the player's inventory, empty itemstack if nothing should be added.

    • addLandingEffects

      default boolean addLandingEffects(ServerLevel level, BlockPos pos, BlockState state2, LivingEntity entity, int numberOfParticles)
      Allows a block to override the standard EntityLivingBase.updateFallState particles, this is a server side method that spawns particles with WorldServer.spawnParticle.
      Parameters:
      level - The current server level
      pos - The position of the block.
      state2 - The state at the specific world/pos
      entity - The entity that hit landed on the block
      numberOfParticles - That vanilla world have spawned
      Returns:
      True to prevent vanilla landing particles from spawning

    • addRunningEffects

      default boolean addRunningEffects(Level level, BlockPos pos, Entity entity)
      Allows a block to override the standard vanilla running particles. This is called from Entity#spawnSprintParticle() and is called both, Client and server side, it's up to the implementor to client check / server check. By default vanilla spawns particles only on the client and the server methods no-op.
      Parameters:
      level - The level.
      pos - The position at the entities feet.
      entity - The entity running on the block.
      Returns:
      True to prevent vanilla running particles from spawning.

    • canSustainPlant

      default boolean canSustainPlant(BlockGetter level, BlockPos pos, Direction facing, IPlantable plantable)
      Determines if this block can support the passed in plant, allowing it to be planted and grow. Some examples: Reeds check if its a reed, or if its sand/dirt/grass and adjacent to water Cacti checks if its a cacti, or if its sand Nether types check for soul sand Crops check for tilled soil Caves check if it's a solid surface Plains check if its grass or dirt Water check if its still water
      Parameters:
      level - The current level
      facing - The direction relative to the given position the plant wants to be, typically its UP
      plantable - The plant that wants to check
      Returns:
      True to allow the plant to be planted/stay.

    • onTreeGrow

      default boolean onTreeGrow(LevelReader level, BiConsumer<BlockPos,BlockState> placeFunction, RandomSource randomSource, BlockPos pos, TreeConfiguration config)
      Called when a tree grows on top of this block and tries to set it to dirt by the trunk placer. An override that returns true is responsible for using the place function to set blocks in the world properly during generation. A modded grass block might override this method to ensure it turns into the corresponding modded dirt instead of regular dirt when a tree grows on it. For modded grass blocks, returning true from this method is NOT a substitute for adding your block to the #minecraft:dirt tag, rather for changing the behaviour to something other than setting to dirt. NOTE: This happens DURING world generation, the generation may be incomplete when this is called. Use the placeFunction when modifying the level.
      Parameters:
      level - The current level
      placeFunction - Function to set blocks in the level for the tree, use this instead of the level directly
      randomSource - The random source
      pos - Position of the block to be set to dirt
      config - Configuration of the trunk placer. Consider azalea trees, which should place rooted dirt instead of regular dirt.
      Returns:
      True to ignore vanilla behaviour

    • isFertile

      default boolean isFertile(BlockGetter level, BlockPos pos)
      Checks if this soil is fertile, typically this means that growth rates of plants on this soil will be slightly sped up. Only vanilla case is tilledField when it is within range of water.
      Parameters:
      level - The current level
      pos - Block position in level
      Returns:
      True if the soil should be considered fertile.

    • isConduitFrame

      default boolean isConduitFrame(LevelReader level, BlockPos pos, BlockPos conduit)
      Determines if this block can be used as the frame of a conduit.
      Parameters:
      level - The current level
      pos - Block position in level
      conduit - Conduit position in level
      Returns:
      True, to support the conduit, and make it active with this block.

    • isPortalFrame

      default boolean isPortalFrame(BlockGetter level, BlockPos pos)
      Determines if this block can be used as part of a frame of a nether portal.
      Parameters:
      level - The current level
      pos - Block position in level
      Returns:
      True, to support being part of a nether portal frame, false otherwise.

    • getExpDrop

      default int getExpDrop(LevelReader level, RandomSource randomSource, BlockPos pos, int fortuneLevel, int silkTouchLevel)
      Gathers how much experience this block drops when broken.
      Parameters:
      level - The level
      randomSource - Random source to use for experience randomness
      pos - Block position
      fortuneLevel - fortune enchantment level of tool being used
      silkTouchLevel - silk touch enchantment level of tool being used
      Returns:
      Amount of XP from breaking this block.

    • rotate

      default BlockState rotate(LevelAccessor level, BlockPos pos, Rotation direction)

    • getEnchantPowerBonus

      default float getEnchantPowerBonus(LevelReader level, BlockPos pos)
      Determines the amount of enchanting power this block can provide to an enchanting table.
      Parameters:
      level - The level
      pos - Block position in level
      Returns:
      The amount of enchanting power this block produces.

    • onNeighborChange

      default void onNeighborChange(LevelReader level, BlockPos pos, BlockPos neighbor)
      Called when a block entity on a side of this block changes, is created, or is destroyed.

      This method is not suitable for listening to capability invalidations. For capability invalidations specifically, use BlockCapabilityCache instead.

      Parameters:
      level - The level
      pos - Block position in level
      neighbor - Block position of neighbor

    • shouldCheckWeakPower

      default boolean shouldCheckWeakPower(SignalGetter level, BlockPos pos, Direction side)
      Called to determine whether to allow the block to handle its own indirect power rather than using the default rules.
      Parameters:
      level - The level
      pos - Block position in level
      side - The INPUT side of the block to be powered - ie the opposite of this block's output side
      Returns:
      Whether Block#isProvidingWeakPower should be called when determining indirect power

    • getWeakChanges

      default boolean getWeakChanges(LevelReader level, BlockPos pos)
      If this block should be notified of weak changes. Weak changes are changes 1 block away through a solid block. Similar to comparators.
      Parameters:
      level - The current level
      pos - Block position in level
      Returns:
      true To be notified of changes

    • getSoundType

      default SoundType getSoundType(LevelReader level, BlockPos pos, @Nullable @Nullable Entity entity)
      Sensitive version of getSoundType
      Parameters:
      level - The level
      pos - The position. Note that the level may not necessarily have state here!
      entity - The entity that is breaking/stepping on/placing/hitting/falling on this block, or null if no entity is in this context
      Returns:
      A SoundType to use

    • getBeaconColorMultiplier

      @Nullable default @org.jetbrains.annotations.Nullable float[] getBeaconColorMultiplier(LevelReader level, BlockPos pos, BlockPos beacon)
      Parameters:
      level - The level
      pos - The position of this state
      beacon - The position of the beacon
      Returns:
      A float RGB [0.0, 1.0] array to be averaged with a beacon's existing beam color, or null to do nothing to the beam

    • getStateAtViewpoint

      default BlockState getStateAtViewpoint(BlockGetter level, BlockPos pos, Vec3 viewpoint)
      Used to determine the state 'viewed' by an entity (see Camera.getBlockAtCamera()). Can be used by fluid blocks to determine if the viewpoint is within the fluid or not.
      Parameters:
      level - the level
      pos - the position
      viewpoint - the viewpoint
      Returns:
      the block state that should be 'seen'

    • isSlimeBlock

      default boolean isSlimeBlock()
      Returns:
      true if the block is sticky block which used for pull or push adjacent blocks (use by piston)

    • isStickyBlock

      default boolean isStickyBlock()
      Returns:
      true if the block is sticky block which used for pull or push adjacent blocks (use by piston)

    • canStickTo

      default boolean canStickTo(BlockState other)
      Determines if this block can stick to another block when pushed by a piston.
      Parameters:
      other - Other block
      Returns:
      True to link blocks

    • getFlammability

      default int getFlammability(BlockGetter level, BlockPos pos, Direction face)
      Chance that fire will spread and consume this block. 300 being a 100% chance, 0, being a 0% chance.
      Parameters:
      level - The current level
      pos - Block position in level
      face - The face that the fire is coming from
      Returns:
      A number ranging from 0 to 300 relating used to determine if the block will be consumed by fire

    • isFlammable

      default boolean isFlammable(BlockGetter level, BlockPos pos, Direction face)
      Called when fire is updating, checks if a block face can catch fire.
      Parameters:
      level - The current level
      pos - Block position in level
      face - The face that the fire is coming from
      Returns:
      True if the face can be on fire, false otherwise.

    • onCaughtFire

      default void onCaughtFire(Level level, BlockPos pos, @Nullable @Nullable Direction face, @Nullable @Nullable LivingEntity igniter)
      If the block is flammable, this is called when it gets lit on fire.
      Parameters:
      level - The current level
      pos - Block position in level
      face - The face that the fire is coming from
      igniter - The entity that lit the fire

    • getFireSpreadSpeed

      default int getFireSpreadSpeed(BlockGetter level, BlockPos pos, Direction face)
      Called when fire is updating on a neighbor block. The higher the number returned, the faster fire will spread around this block.
      Parameters:
      level - The current level
      pos - Block position in level
      face - The face that the fire is coming from
      Returns:
      A number that is used to determine the speed of fire growth around the block

    • isFireSource

      default boolean isFireSource(LevelReader level, BlockPos pos, Direction side)
      Currently only called by fire when it is on top of this block. Returning true will prevent the fire from naturally dying during updating. Also prevents firing from dying from rain.
      Parameters:
      level - The current level
      pos - Block position in level
      side - The face that the fire is coming from
      Returns:
      True if this block sustains fire, meaning it will never go out.

    • canEntityDestroy

      default boolean canEntityDestroy(BlockGetter level, BlockPos pos, Entity entity)
      Determines if this block is can be destroyed by the specified entities normal behavior.
      Parameters:
      level - The current level
      pos - Block position in level
      Returns:
      True to allow the ender dragon to destroy this block

    • isBurning

      default boolean isBurning(BlockGetter level, BlockPos pos)
      Determines if this block should set fire and deal fire damage to entities coming into contact with it.
      Parameters:
      level - The current level
      pos - Block position in level
      Returns:
      True if the block should deal damage

    • getBlockPathType

      @Nullable default @Nullable PathType getBlockPathType(BlockGetter level, BlockPos pos, @Nullable @Nullable Mob mob)
      Gets the path type of this block when an entity is pathfinding. When null, uses vanilla behavior.
      Parameters:
      level - the level which contains this block
      pos - the position of the block
      mob - the mob currently pathfinding, may be null
      Returns:
      the path type of this block

    • getAdjacentBlockPathType

      @Nullable default @Nullable PathType getAdjacentBlockPathType(BlockGetter level, BlockPos pos, @Nullable @Nullable Mob mob, PathType originalType)
      Gets the path type of the adjacent block to a pathfinding entity. Path types with a negative malus are not traversable for the entity. Pathfinding entities will favor paths consisting of a lower malus. When null, uses vanilla behavior.
      Parameters:
      level - the level which contains this block
      pos - the position of the block
      mob - the mob currently pathfinding, may be null
      originalType - the path type of the source the entity is on
      Returns:
      the path type of this block

    • canDropFromExplosion

      default boolean canDropFromExplosion(BlockGetter level, BlockPos pos, Explosion explosion)
      Determines if this block should drop loot when exploded.

    • onBlockExploded

      default void onBlockExploded(Level level, BlockPos pos, Explosion explosion)
      Called when the block is destroyed by an explosion. Useful for allowing the block to take into account tile entities, state, etc. when exploded, before it is removed.
      Parameters:
      level - The current level
      pos - Block position in level
      explosion - The explosion instance affecting the block

    • collisionExtendsVertically

      default boolean collisionExtendsVertically(BlockGetter level, BlockPos pos, Entity collidingEntity)
      Determines if this block's collision box should be treated as though it can extend above its block space. This can be used to replicate fence and wall behavior.

    • shouldDisplayFluidOverlay

      default boolean shouldDisplayFluidOverlay(BlockAndTintGetter level, BlockPos pos, FluidState fluidState)
      Called to determine whether this block should use the fluid overlay texture or flowing texture when it is placed under the fluid.
      Parameters:
      level - The level
      pos - Block position in level
      fluidState - The state of the fluid
      Returns:
      Whether the fluid overlay texture should be used

    • getToolModifiedState

      @Nullable default @Nullable BlockState getToolModifiedState(UseOnContext context, ToolAction toolAction, boolean simulate)
      Returns the state that this block should transform into when right-clicked by a tool. For example: Used to determine if an axe can strip, a shovel can path, or a hoe can till. Returns null if nothing should happen.
      Parameters:
      context - The use on context that the action was performed in
      toolAction - The action being performed by the tool
      simulate - If true, no actions that modify the world in any way should be performed. If false, the world may be modified.
      Returns:
      The resulting state after the action has been performed

    • isScaffolding

      default boolean isScaffolding(LivingEntity entity)
      Checks if a player or entity handles movement on this block like scaffolding.
      Parameters:
      entity - The entity on the scaffolding
      Returns:
      True if the block should act like scaffolding

    • canRedstoneConnectTo

      default boolean canRedstoneConnectTo(BlockGetter level, BlockPos pos, @Nullable @Nullable Direction direction)
      Whether redstone dust should visually connect to this block on a side.

      Modded redstone wire blocks should call this function to determine visual connections.

      Parameters:
      level - The level
      pos - The block position in level
      direction - The coming direction of the redstone dust connection (with respect to the block at pos)
      Returns:
      True if redstone dust should visually connect on the side passed

    • hidesNeighborFace

      default boolean hidesNeighborFace(BlockGetter level, BlockPos pos, BlockState neighborState, Direction dir)
      Whether this block hides the neighbors face pointed towards by the given direction.

      This method should only be used for blocks you don't control, for your own blocks override BlockBehaviour.skipRendering(BlockState, BlockState, Direction) on the respective block instead

      Parameters:
      level - The world
      pos - The blocks position in the world
      neighborState - The neighboring blocks BlockState
      dir - The direction towards the neighboring block

    • supportsExternalFaceHiding

      default boolean supportsExternalFaceHiding()
      Whether this block allows a neighboring block to hide the face of this block it touches. If this returns true, hidesNeighborFace(BlockGetter, BlockPos, BlockState, Direction) will be called on the neighboring block.

    • onBlockStateChange

      default void onBlockStateChange(LevelReader level, BlockPos pos, BlockState oldState)
      Called after the BlockState at the given BlockPos was changed and neighbors were updated. This method is called on the server and client side. Modifying the level is disallowed in this method. Useful for calculating additional data based on the new state and the neighbor's reactions to the state change.
      Parameters:
      level - The level the state was modified in
      pos - The blocks position in the level
      oldState - The previous state of the block at the given position, may be a different block than this one

    • canBeHydrated

      default boolean canBeHydrated(BlockGetter getter, BlockPos pos, FluidState fluid, BlockPos fluidPos)
      Returns whether the block can be hydrated by a fluid.

      Hydration is an arbitrary word which depends on the block.

      • A farmland has moisture
      • A sponge can soak up the liquid
      • A coral can live
      Parameters:
      getter - the getter which can get the block
      pos - the position of the block being hydrated
      fluid - the state of the fluid
      fluidPos - the position of the fluid
      Returns:
      true if the block can be hydrated, false otherwise

    • getAppearance

      default BlockState getAppearance(BlockAndTintGetter level, BlockPos pos, Direction side, @Nullable @Nullable BlockState queryState, @Nullable @Nullable BlockPos queryPos)
      Returns the BlockState that this state reports to look like on the given side for querying by other mods.
      Parameters:
      level - The level this block is in
      pos - The block's position in the level
      side - The side of the block that is being queried
      queryState - The state of the block that is querying the appearance, or null if not applicable
      queryPos - The position of the block that is querying the appearance, or null if not applicable
      Returns:
      The appearance of this block from the given side
      See Also:

    • isEmpty

      default boolean isEmpty()
      Return true if the state is able to be replaced with Blocks.AIR in chunk sections that is entirely made of blocks that return true for isEmpty
      Returns:
      True if the block should be allowed to be optimized away into Blocks.AIR

    • getBubbleColumnDirection

      default BubbleColumnDirection getBubbleColumnDirection()
      Determines if this block can spawn Bubble Columns and if so, what direction the column flows.

      NOTE: The block itself will still need to call BubbleColumnBlock.updateColumn(LevelAccessor, BlockPos, BlockState) in their tick method and schedule a block tick in the block's onPlace. Also, schedule a fluid tick in updateShape method if update direction is up. Both are needed in order to get the Bubble Columns to function properly. See SoulSandBlock and MagmaBlock for example.
      Returns:
      BubbleColumnDirection.NONE for no Bubble Column. Otherwise, will spawn Bubble Column flowing with specified direction