IForgeBlock (forge 1.13.2-25.0.220 API)

All Known Implementing Classes:

Block, BlockAbstractBanner, BlockAbstractSkull, BlockAir, BlockAnvil, BlockAttachedStem, BlockBanner, BlockBannerWall, BlockBarrier, BlockBasePressurePlate, BlockBeacon, BlockBed, BlockBeetroot, BlockBlueIce, BlockBookshelf, BlockBreakable, BlockBrewingStand, BlockBubbleColumn, BlockBush, BlockButton, BlockButtonStone, BlockButtonWood, BlockCactus, BlockCake, BlockCarpet, BlockCarrot, BlockCarvedPumpkin, BlockCauldron, BlockChest, BlockChorusFlower, BlockChorusPlant, BlockClay, BlockCocoa, BlockCommandBlock, BlockConcretePowder, BlockConduit, BlockContainer, BlockCoral, BlockCoralFan, BlockCoralFin, BlockCoralPlant, BlockCoralPlantBase, BlockCoralPlantDead, BlockCoralWallFan, BlockCoralWallFanDead, BlockCrops, BlockDaylightDetector, BlockDeadBush, BlockDirectional, BlockDirtSnowy, BlockDirtSnowySpreadable, BlockDispenser, BlockDoor, BlockDoublePlant, BlockDragonEgg, BlockDropper, BlockEmptyDrops, BlockEnchantmentTable, BlockEnderChest, BlockEndGateway, BlockEndPortal, BlockEndPortalFrame, BlockEndRod, BlockFalling, BlockFarmland, BlockFence, BlockFenceGate, BlockFire, BlockFlower, BlockFlowerPot, BlockFlowingFluid, BlockFourWay, BlockFrostedIce, BlockFurnace, BlockGlass, BlockGlassPane, BlockGlazedTerracotta, BlockGlowstone, BlockGrass, BlockGrassPath, BlockGravel, BlockHay, BlockHopper, BlockHorizontal, BlockHorizontalFace, BlockHugeMushroom, BlockIce, BlockJukebox, BlockKelp, BlockKelpTop, BlockLadder, BlockLeaves, BlockLever, BlockLilyPad, BlockLog, BlockMagma, BlockMelon, BlockMobSpawner, BlockMushroom, BlockMycelium, BlockNetherWart, BlockNote, BlockObserver, BlockOre, BlockPackedIce, BlockPane, BlockPistonBase, BlockPistonExtension, BlockPistonMoving, BlockPortal, BlockPotato, BlockPressurePlate, BlockPressurePlateWeighted, BlockPumpkin, BlockRail, BlockRailBase, BlockRailDetector, BlockRailPowered, BlockRedstone, BlockRedstoneComparator, BlockRedstoneDiode, BlockRedstoneLamp, BlockRedstoneOre, BlockRedstoneRepeater, BlockRedstoneTorch, BlockRedstoneTorchWall, BlockRedstoneWire, BlockReed, BlockRotatedPillar, BlockSand, BlockSapling, BlockSeaGrass, BlockSeaGrassTall, BlockSeaLantern, BlockSeaPickle, BlockShearableDoublePlant, BlockShulkerBox, BlockSign, BlockSilverfish, BlockSixWay, BlockSkull, BlockSkullPlayer, BlockSkullWall, BlockSkullWallPlayer, BlockSkullWither, BlockSkullWitherWall, BlockSlab, BlockSlime, BlockSnow, BlockSnowLayer, BlockSoulSand, BlockSponge, BlockStainedGlass, BlockStainedGlassPane, BlockStairs, BlockStandingSign, BlockStem, BlockStemGrown, BlockStone, BlockStructure, BlockStructureVoid, BlockTallFlower, BlockTallGrass, BlockTNT, BlockTorch, BlockTorchWall, BlockTrapDoor, BlockTrappedChest, BlockTripWire, BlockTripWireHook, BlockTurtleEgg, BlockVine, BlockWall, BlockWallSign, BlockWeb, BlockWetSponge, BlockWorkbench
```
public interface IForgeBlock
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`addDestroyEffects(IBlockState state, World world, BlockPos pos, ParticleManager manager)` Spawn particles for when the block is destroyed.
`default boolean`	`addHitEffects(IBlockState state, World worldObj, RayTraceResult target, ParticleManager manager)` Spawn a digging particle effect in the world, this is a wrapper around EffectRenderer.addBlockHitEffects to allow the block more control over the particles.
`default boolean`	`addLandingEffects(IBlockState state1, WorldServer worldserver, BlockPos pos, IBlockState state2, EntityLivingBase 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.
`default boolean`	`addRunningEffects(IBlockState state, World world, BlockPos pos, Entity entity)` Allows a block to override the standard vanilla running particles.
`default void`	`beginLeaveDecay(IBlockState state, IWorldReader world, BlockPos pos)` Called when a leaf should start its decay process.
`default boolean`	`canBeConnectedTo(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing facing)` Determines if another block can connect to this block
`default boolean`	`canBeReplacedByLeaves(IBlockState state, IWorldReaderBase world, BlockPos pos)` Used during tree growth to determine if newly generated leaves can replace this block.
`default boolean`	`canConnectRedstone(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing side)` Determine if this block can make a redstone connection on the side provided, Useful to control which sides are inputs and outputs for redstone wires.
`default boolean`	`canCreatureSpawn(IBlockState state, IWorldReaderBase world, BlockPos pos, EntitySpawnPlacementRegistry.SpawnPlacementType type, EntityType<? extends EntityLiving> entityType)` Determines if a specified mob type can spawn on this block, returning false will prevent any mob from spawning on the block.
`default boolean`	`canEntityDestroy(IBlockState state, IBlockReader world, BlockPos pos, Entity entity)` Determines if this block is can be destroyed by the specified entities normal behavior.
`default boolean`	`canHarvestBlock(IBlockState state, IBlockReader world, BlockPos pos, EntityPlayer player)` Determines if the player can harvest this block, obtaining it's drops when the block is destroyed.
`default boolean`	`canPlaceTorchOnTop(IBlockState state, IWorldReaderBase world, BlockPos pos)` Determines if a torch can be placed on the top surface of this block.
`default boolean`	`canRenderInLayer(IBlockState state, BlockRenderLayer layer)` Queries if this block should render in a given layer.
`boolean`	`canSilkHarvest(IBlockState state, IWorldReader world, BlockPos pos, EntityPlayer player)` Return true from this function if the player with silk touch can harvest this block directly, and not it's normal drops.
`boolean`	`canSustainPlant(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing facing, IPlantable plantable)` Determines if this block can support the passed in plant, allowing it to be planted and grow.
`default TileEntity`	`createTileEntity(IBlockState state, IBlockReader world)` Called throughout the code as a replacement for ITileEntityProvider.createNewTileEntity Return the same thing you would from that function.
`default boolean`	`doesSideBlockChestOpening(IBlockState blockState, IBlockReader world, BlockPos pos, EnumFacing side)`
`default boolean`	`doesSideBlockRendering(IBlockState state, IWorldReader world, BlockPos pos, EnumFacing face)` Check if the face of a block should block rendering.
`default PathNodeType`	`getAiPathNodeType(IBlockState state, IBlockReader world, BlockPos pos, EntityLiving entity)` Get the `PathNodeType` for this block.
`default float[]`	`getBeaconColorMultiplier(IBlockState state, IWorldReader world, BlockPos pos, BlockPos beaconPos)`
`default EnumFacing`	`getBedDirection(IBlockState state, IWorldReader world, BlockPos pos)` Returns the direction of the block.
`default BlockPos`	`getBedSpawnPosition(IBlockState state, IBlockReader world, BlockPos pos, EntityPlayer player)` Returns the position that the player is moved to upon waking up, or respawning at the bed.
`default Block`	`getBlock()`
`default void`	`getDrops(IBlockState state, NonNullList<ItemStack> drops, World world, BlockPos pos, int fortune)` This gets a complete list of items dropped from this block.
`default float`	`getEnchantPowerBonus(IBlockState state, IWorldReader world, BlockPos pos)` Determines the amount of enchanting power this block can provide to an enchanting table.
`default int`	`getExpDrop(IBlockState state, IWorldReader world, BlockPos pos, int fortune)` Gathers how much experience this block drops when broken.
`default float`	`getExplosionResistance(IBlockState state, IWorldReader world, BlockPos pos, Entity exploder, Explosion explosion)` Location sensitive version of getExplosionResistance
`default IBlockState`	`getExtendedState(IBlockState state, IBlockReader world, BlockPos pos)` Can return IExtendedBlockState
`default int`	`getFireSpreadSpeed(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing face)` Called when fire is updating on a neighbor block.
`default int`	`getFlammability(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing face)` Chance that fire will spread and consume this block.
`default Vec3d`	`getFogColor(IBlockState state, IWorldReader world, BlockPos pos, Entity entity, Vec3d originalColor, float partialTicks)` Use this to change the fog color used when the entity is "inside" a material.
`int`	`getHarvestLevel(IBlockState state)` Queries the harvest level of this item stack for the specified tool class, Returns -1 if this tool is not of the specified type
`ToolType`	`getHarvestTool(IBlockState state)` Queries the class of tool required to harvest this block, if null is returned we assume that anything can harvest this block.
`default int`	`getLightValue(IBlockState state, IWorldReader world, BlockPos pos)` Get a light value for this block, taking into account the given state and coordinates, normal ranges are between 0 and 15
`default ItemStack`	`getPickBlock(IBlockState state, RayTraceResult target, IBlockReader world, BlockPos pos, EntityPlayer player)` Called when A user uses the creative pick block button on this block
`default RayTraceResult`	`getRayTraceResult(IBlockState state, World world, BlockPos pos, Vec3d start, Vec3d end, RayTraceResult original)` Ray traces through the blocks collision from start vector to end vector returning a ray trace hit.
`float`	`getSlipperiness(IBlockState state, IWorldReader world, BlockPos pos, Entity entity)` Gets the slipperiness at the given location at the given state.
`default SoundType`	`getSoundType(IBlockState state, IWorldReader world, BlockPos pos, Entity entity)` Sensitive version of getSoundType
`default IBlockState`	`getStateAtViewpoint(IBlockState state, IBlockReader world, BlockPos pos, Vec3d viewpoint)` Used to determine the state 'viewed' by an entity (see `ActiveRenderInfo#getBlockStateAtEntityViewpoint(World, Entity, float)`).
`default IBlockState`	`getStateForPlacement(IBlockState state, EnumFacing facing, IBlockState state2, IWorld world, BlockPos pos1, BlockPos pos2, EnumHand hand)` //TODO: Re-Evaluate Gets the `IBlockState` to place
`default EnumFacing[]`	`getValidRotations(IBlockState state, IBlockReader world, BlockPos pos)` Get the rotations that can apply to the block at the specified coordinates.
`default boolean`	`getWeakChanges(IBlockState state, IWorldReader world, BlockPos pos)` If this block should be notified of weak changes.
`default boolean`	`hasTileEntity(IBlockState state)` Called throughout the code as a replacement for block instanceof BlockContainer Moving this to the Block base class allows for mods that wish to extend vanilla blocks, and also want to have a tile entity on that block, may.
`default boolean`	`isAir(IBlockState state, IBlockReader world, BlockPos pos)` Determines this block should be treated as an air block by the rest of the code.
`default boolean`	`isBeaconBase(IBlockState state, IWorldReader world, BlockPos pos, BlockPos beacon)` Determines if this block can be used as the base of a beacon.
`default boolean`	`isBed(IBlockState state, IBlockReader world, BlockPos pos, Entity player)` Determines if this block is classified as a Bed, Allowing players to sleep in it, though the block has to specifically perform the sleeping functionality in it's activated event.
`default boolean`	`isBedFoot(IBlockState state, IWorldReader world, BlockPos pos)` Determines if the current block is the foot half of the bed.
`default boolean`	`isBurning(IBlockState state, IBlockReader world, BlockPos pos)` Determines if this block should set fire and deal fire damage to entities coming into contact with it.
`default boolean`	`isFertile(IBlockState state, IBlockReader world, BlockPos pos)` Checks if this soil is fertile, typically this means that growth rates of plants on this soil will be slightly sped up.
`default boolean`	`isFireSource(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing side)` Currently only called by fire when it is on top of this block.
`default boolean`	`isFlammable(IBlockState state, IBlockReader world, BlockPos pos, EnumFacing face)` Called when fire is updating, checks if a block face can catch fire.
`default boolean`	`isFoliage(IBlockState state, IWorldReader world, BlockPos pos)` Used by getTopSoilidOrLiquidBlock while placing biome decorations, villages, etc Also used to determine if the player can spawn in this block.
`default boolean`	`isLadder(IBlockState state, IWorldReader world, BlockPos pos, EntityLivingBase entity)` Checks if a player or entity can use this block to 'climb' like a ladder.
`default boolean`	`isNormalCube(IBlockState state, IBlockReader world, BlockPos pos)` Return true if the block is a normal, solid cube.
`default boolean`	`isReplaceableOreGen(IBlockState state, IWorldReader world, BlockPos pos, java.util.function.Predicate<IBlockState> target)` Determines if the current block is replaceable by Ore veins during world generation.
`default boolean`	`isStickyBlock(IBlockState state)`
`default boolean`	`isToolEffective(IBlockState state, ToolType tool)` Checks if the specified tool type is efficient on this block, meaning that it digs at full speed.
`default boolean`	`isTopSolid(IBlockState state, IWorldReader world, BlockPos pos)` Determines if the top is consider 'solid'.
`default void`	`observedNeighborChange(IBlockState observerState, World world, BlockPos observerPos, Block changedBlock, BlockPos changedBlockPos)` Called on an Observer block whenever an update for an Observer is received.
`default void`	`onBlockExploded(IBlockState state, World world, BlockPos pos, Explosion explosion)` Called when the block is destroyed by an explosion.
`default void`	`onNeighborChange(IBlockState state, IWorldReader world, BlockPos pos, BlockPos neighbor)` Called when a tile entity on a side of this block changes is created or is destroyed.
`default void`	`onPlantGrow(IBlockState state, IWorld world, BlockPos pos, BlockPos source)` Called when a plant grows on this block, only implemented for saplings using the WorldGen*Trees classes right now.
`default boolean`	`recolorBlock(IBlockState state, IWorld world, BlockPos pos, EnumFacing facing, EnumDyeColor color)` //TODO: Re-Evaluate Gathers how much experience this block drops when broken.
`default boolean`	`removedByPlayer(IBlockState state, World world, BlockPos pos, EntityPlayer player, boolean willHarvest, IFluidState fluid)` Called when a player removes a block.
`default IBlockState`	`rotate(IBlockState state, IWorld world, BlockPos pos, Rotation direction)`
`default void`	`setBedOccupied(IBlockState state, IWorldReader world, BlockPos pos, EntityPlayer player, boolean occupied)` Called when a user either starts or stops sleeping in the bed.
`default boolean`	`shouldCheckWeakPower(IBlockState state, IWorldReader world, BlockPos pos, EnumFacing side)` Called to determine whether to allow the a block to handle its own indirect power rather than using the default rules.

- Method Detail
  - getBlock
```
default Block getBlock()
```
  - getSlipperiness
```
float getSlipperiness(IBlockState state,
                      IWorldReader world,
                      BlockPos pos,
                      @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 EntityLivingBase, this is .91. EntityItem uses .98, and EntityFishHook uses .92.
    
    Parameters:
    
    state - state of the block
    
    world - the world
    
    pos - the position in the world
    
    entity - the entity in question
    
    Returns:
    
    the factor by which the entity's motion should be multiplied
  - getLightValue
```
default int getLightValue(IBlockState state,
                          IWorldReader world,
                          BlockPos pos)
```
    Get a light value for this block, taking into account the given state and coordinates, normal ranges are between 0 and 15
    
    Parameters:
    
    state -
    
    world -
    
    pos -
    
    Returns:
    
    The light value
  - isLadder
```
default boolean isLadder(IBlockState state,
                         IWorldReader world,
                         BlockPos pos,
                         EntityLivingBase entity)
```
    Checks if a player or entity can use this block to 'climb' like a ladder.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    entity - The entity trying to use the ladder, CAN be null.
    
    Returns:
    
    True if the block should act like a ladder
  - isNormalCube
```
default boolean isNormalCube(IBlockState state,
                             IBlockReader world,
                             BlockPos pos)
```
    Return true if the block is a normal, solid cube. This determines indirect power state, entity ejection from blocks, and a few others.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True if the block is a full cube
  - doesSideBlockRendering
```
default boolean doesSideBlockRendering(IBlockState state,
                                       IWorldReader world,
                                       BlockPos pos,
                                       EnumFacing face)
```
    Check if the face of a block should block rendering. Faces which are fully opaque should return true, faces with transparency or faces which do not span the full size of the block should return false.
    
    Parameters:
    
    state - The current block state
    
    world - The current world
    
    pos - Block position in world
    
    face - The side to check
    
    Returns:
    
    True if the block is opaque on the specified side.
  - isBurning
```
default boolean isBurning(IBlockState state,
                          IBlockReader world,
                          BlockPos pos)
```
    Determines if this block should set fire and deal fire damage to entities coming into contact with it.
    
    Parameters:
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True if the block should deal damage
  - hasTileEntity
```
default boolean hasTileEntity(IBlockState state)
```
    Called throughout the code as a replacement for block instanceof BlockContainer Moving this to the Block base class allows for mods that wish to extend vanilla blocks, and also want to have a tile entity on that block, may. Return true from this function to specify this block has a tile entity.
    
    Parameters:
    
    state - State of the current block
    
    Returns:
    
    True if block has a tile entity, false otherwise
  - createTileEntity
```
@Nullable
default TileEntity createTileEntity(IBlockState state,
                                              IBlockReader world)
```
    Called throughout the code as a replacement for ITileEntityProvider.createNewTileEntity Return the same thing you would from that function. This will fall back to ITileEntityProvider.createNewTileEntity(World) if this block is a ITileEntityProvider
    
    Parameters:
    
    state - The state of the current block
    
    world - The world to create the TE in
    
    Returns:
    
    A instance of a class extending TileEntity
  - canSilkHarvest
```
boolean canSilkHarvest(IBlockState state,
                       IWorldReader world,
                       BlockPos pos,
                       EntityPlayer player)
```
    Return true from this function if the player with silk touch can harvest this block directly, and not it's normal drops.
    
    Parameters:
    
    state - current block state
    
    world - The world
    
    pos - Block position in world
    
    player - The player doing the harvesting
    
    Returns:
    
    True if the block can be directly harvested using silk touch
  - canHarvestBlock
```
default boolean canHarvestBlock(IBlockState state,
                                IBlockReader world,
                                BlockPos pos,
                                EntityPlayer player)
```
    Determines if the player can harvest this block, obtaining it's drops when the block is destroyed.
    
    Parameters:
    
    world - The current world
    
    pos - The block's current position
    
    player - The player damaging the block
    
    Returns:
    
    True to spawn the drops
  - removedByPlayer
```
default boolean removedByPlayer(IBlockState state,
                                World world,
                                BlockPos pos,
                                EntityPlayer player,
                                boolean willHarvest,
                                IFluidState 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. Note: When used in multiplayer, this is called on both client and server sides!
    
    Parameters:
    
    state - The current state.
    
    world - The current world
    
    player - The player damaging the block, may be null
    
    pos - Block position in world
    
    willHarvest - True if Block.harvestBlock will be called after this, if the return in true. Can be useful to delay the destruction of tile entities till after harvestBlock
    
    fluid - The current fluid state at current position
    
    Returns:
    
    True if the block is actually destroyed.
  - isBed
```
default boolean isBed(IBlockState state,
                      IBlockReader world,
                      BlockPos pos,
                      @Nullable
                      Entity player)
```
    Determines if this block is classified as a Bed, Allowing players to sleep in it, though the block has to specifically perform the sleeping functionality in it's activated event.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    player - The player or camera entity, null in some cases.
    
    Returns:
    
    True to treat this as a bed
  - canCreatureSpawn
```
default boolean canCreatureSpawn(IBlockState state,
                                 IWorldReaderBase world,
                                 BlockPos pos,
                                 EntitySpawnPlacementRegistry.SpawnPlacementType type,
                                 @Nullable
                                 EntityType<? extends EntityLiving> entityType)
```
    Determines if a specified mob type can spawn on this block, returning false will prevent any mob from spawning on the block.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    type - The Mob Category Type
    
    Returns:
    
    True to allow a mob of the specified category to spawn, false to prevent it.
  - getBedSpawnPosition
```
@Nullable
default BlockPos getBedSpawnPosition(IBlockState state,
                                               IBlockReader world,
                                               BlockPos pos,
                                               @Nullable
                                               EntityPlayer player)
```
    Returns the position that the player is moved to upon waking up, or respawning at the bed.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    player - The player or camera entity, null in some cases.
    
    Returns:
    
    The spawn position
  - setBedOccupied
```
default void setBedOccupied(IBlockState state,
                            IWorldReader world,
                            BlockPos pos,
                            EntityPlayer player,
                            boolean occupied)
```
    Called when a user either starts or stops sleeping in the bed.
    
    Parameters:
    
    state -
    
    world - The current world
    
    pos - Block position in world
    
    player - The player 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 EnumFacing getBedDirection(IBlockState state,
                                   IWorldReader world,
                                   BlockPos pos)
```
    Returns the direction of the block. Same values that are returned by BlockDirectional
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    Bed direction
  - isBedFoot
```
default boolean isBedFoot(IBlockState state,
                          IWorldReader world,
                          BlockPos pos)
```
    Determines if the current block is the foot half of the bed.
    
    Parameters:
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True if the current block is the foot side of a bed.
  - beginLeaveDecay
```
default void beginLeaveDecay(IBlockState state,
                             IWorldReader world,
                             BlockPos pos)
```
    Called when a leaf should start its decay process.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
  - isAir
```
default boolean isAir(IBlockState state,
                      IBlockReader world,
                      BlockPos pos)
```
    Determines this block should be treated as an air block by the rest of the code. This method is primarily useful for creating pure logic-blocks that will be invisible to the player and otherwise interact as air would.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True if the block considered air
  - canBeReplacedByLeaves
```
default boolean canBeReplacedByLeaves(IBlockState state,
                                      IWorldReaderBase world,
                                      BlockPos pos)
```
    Used during tree growth to determine if newly generated leaves can replace this block.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    true if this block can be replaced by growing leaves.
  - isReplaceableOreGen
```
default boolean isReplaceableOreGen(IBlockState state,
                                    IWorldReader world,
                                    BlockPos pos,
                                    java.util.function.Predicate<IBlockState> target)
```
    Determines if the current block is replaceable by Ore veins during world generation.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    target - The generic target block the gen is looking for, Standards define stone for overworld generation, and neatherack for the nether.
    
    Returns:
    
    True to allow this block to be replaced by a ore
  - getExplosionResistance
```
default float getExplosionResistance(IBlockState state,
                                     IWorldReader world,
                                     BlockPos pos,
                                     @Nullable
                                     Entity exploder,
                                     Explosion explosion)
```
    Location sensitive version of getExplosionResistance
    
    Parameters:
    
    world - The current world
    
    pos - Block position in world
    
    exploder - The entity that caused the explosion, can be null
    
    explosion - The explosion
    
    Returns:
    
    The amount of the explosion absorbed.
  - onBlockExploded
```
default void onBlockExploded(IBlockState state,
                             World world,
                             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:
    
    world - The current world
    
    pos - Block position in world
    
    explosion - The explosion instance affecting the block
  - canConnectRedstone
```
default boolean canConnectRedstone(IBlockState state,
                                   IBlockReader world,
                                   BlockPos pos,
                                   @Nullable
                                   EnumFacing side)
```
    Determine if this block can make a redstone connection on the side provided, Useful to control which sides are inputs and outputs for redstone wires.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    side - The side that is trying to make the connection, CAN BE NULL
    
    Returns:
    
    True to make the connection
  - canPlaceTorchOnTop
```
default boolean canPlaceTorchOnTop(IBlockState state,
                                   IWorldReaderBase world,
                                   BlockPos pos)
```
    Determines if a torch can be placed on the top surface of this block. Useful for creating your own block that torches can be on, such as fences.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True to allow the torch to be placed
  - getPickBlock
```
default ItemStack getPickBlock(IBlockState state,
                               RayTraceResult target,
                               IBlockReader world,
                               BlockPos pos,
                               EntityPlayer 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.
  - isFoliage
```
default boolean isFoliage(IBlockState state,
                          IWorldReader world,
                          BlockPos pos)
```
    Used by getTopSoilidOrLiquidBlock while placing biome decorations, villages, etc Also used to determine if the player can spawn in this block.
    
    Returns:
    
    False to disallow spawning.
  - addLandingEffects
```
default boolean addLandingEffects(IBlockState state1,
                                  WorldServer worldserver,
                                  BlockPos pos,
                                  IBlockState state2,
                                  EntityLivingBase 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:
    
    worldserver - The current Server World
    
    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(IBlockState state,
                                  World world,
                                  BlockPos pos,
                                  Entity entity)
```
    Allows a block to override the standard vanilla running particles. This is called from Entity.spawnRunningParticles() 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:
    
    state - The BlockState the entity is running on.
    
    world - The world.
    
    pos - The position at the entities feet.
    
    entity - The entity running on the block.
    
    Returns:
    
    True to prevent vanilla running particles from spawning.
  - addHitEffects
```
default boolean addHitEffects(IBlockState state,
                              World worldObj,
                              RayTraceResult target,
                              ParticleManager manager)
```
    Spawn a digging particle effect in the world, this is a wrapper around EffectRenderer.addBlockHitEffects to allow the block more control over the particles. Useful when you have entirely different texture sheets for different sides/locations in the world.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    target - The target the player is looking at {x/y/z/side/sub}
    
    manager - A reference to the current particle manager.
    
    Returns:
    
    True to prevent vanilla digging particles form spawning.
  - addDestroyEffects
```
default boolean addDestroyEffects(IBlockState state,
                                  World world,
                                  BlockPos pos,
                                  ParticleManager manager)
```
    Spawn particles for when the block is destroyed. Due to the nature of how this is invoked, the x/y/z locations are not always guaranteed to host your block. So be sure to do proper sanity checks before assuming that the location is this block.
    
    Parameters:
    
    world - The current world
    
    pos - Position to spawn the particle
    
    manager - A reference to the current particle manager.
    
    Returns:
    
    True to prevent vanilla break particles from spawning.
  - canSustainPlant
```
boolean canSustainPlant(IBlockState state,
                        IBlockReader world,
                        BlockPos pos,
                        EnumFacing 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:
    
    state - The Current state
    
    world - The current world
    
    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.
  - onPlantGrow
```
default void onPlantGrow(IBlockState state,
                         IWorld world,
                         BlockPos pos,
                         BlockPos source)
```
    Called when a plant grows on this block, only implemented for saplings using the WorldGen*Trees classes right now. Modder may implement this for custom plants. This does not use ForgeDirection, because large/huge trees can be located in non-representable direction, so the source location is specified. Currently this just changes the block to dirt if it was grass. Note: This happens DURING the generation, the generation may not be complete when this is called.
    
    Parameters:
    
    state - The current state
    
    world - Current world
    
    pos - Block position in world
    
    source - Source plant's position in world
  - isFertile
```
default boolean isFertile(IBlockState state,
                          IBlockReader world,
                          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:
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True if the soil should be considered fertile.
  - isBeaconBase
```
default boolean isBeaconBase(IBlockState state,
                             IWorldReader world,
                             BlockPos pos,
                             BlockPos beacon)
```
    Determines if this block can be used as the base of a beacon.
    
    Parameters:
    
    world - The current world
    
    pos - Block position in world
    
    beacon - Beacon position in world
    
    Returns:
    
    True, to support the beacon, and make it active with this block.
  - getExpDrop
```
default int getExpDrop(IBlockState state,
                       IWorldReader world,
                       BlockPos pos,
                       int fortune)
```
    Gathers how much experience this block drops when broken.
    
    Parameters:
    
    state - The current state
    
    world - The world
    
    pos - Block position
    
    fortune -
    
    Returns:
    
    Amount of XP from breaking this block.
  - rotate
```
default IBlockState rotate(IBlockState state,
                           IWorld world,
                           BlockPos pos,
                           Rotation direction)
```
  - getValidRotations
```
@Nullable
default EnumFacing[] getValidRotations(IBlockState state,
                                                 IBlockReader world,
                                                 BlockPos pos)
```
    Get the rotations that can apply to the block at the specified coordinates. Null means no rotations are possible. Note, this is up to the block to decide. It may not be accurate or representative.
    
    Parameters:
    
    state - The current state
    
    world - The world
    
    pos - Block position in world
    
    Returns:
    
    An array of valid axes to rotate around, or null for none or unknown
  - getEnchantPowerBonus
```
default float getEnchantPowerBonus(IBlockState state,
                                   IWorldReader world,
                                   BlockPos pos)
```
    Determines the amount of enchanting power this block can provide to an enchanting table.
    
    Parameters:
    
    world - The World
    
    pos - Block position in world
    
    Returns:
    
    The amount of enchanting power this block produces.
  - recolorBlock
```
default boolean recolorBlock(IBlockState state,
                             IWorld world,
                             BlockPos pos,
                             EnumFacing facing,
                             EnumDyeColor color)
```
    //TODO: Re-Evaluate Gathers how much experience this block drops when broken.
    
    Parameters:
    
    state - The current state
    
    world - The world
    
    pos - Block position
    
    fortune -
    
    Returns:
    
    Amount of XP from breaking this block.
  - onNeighborChange
```
default void onNeighborChange(IBlockState state,
                              IWorldReader world,
                              BlockPos pos,
                              BlockPos neighbor)
```
    Called when a tile entity on a side of this block changes is created or is destroyed.
    
    Parameters:
    
    world - The world
    
    pos - Block position in world
    
    neighbor - Block position of neighbor
  - observedNeighborChange
```
default void observedNeighborChange(IBlockState observerState,
                                    World world,
                                    BlockPos observerPos,
                                    Block changedBlock,
                                    BlockPos changedBlockPos)
```
    Called on an Observer block whenever an update for an Observer is received.
    
    Parameters:
    
    observerState - The Observer block's state.
    
    world - The current world.
    
    observerPos - The Observer block's position.
    
    changedBlock - The updated block.
    
    changedBlockPos - The updated block's position.
  - shouldCheckWeakPower
```
default boolean shouldCheckWeakPower(IBlockState state,
                                     IWorldReader world,
                                     BlockPos pos,
                                     EnumFacing side)
```
    Called to determine whether to allow the a block to handle its own indirect power rather than using the default rules.
    
    Parameters:
    
    world - The world
    
    pos - Block position in world
    
    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(IBlockState state,
                               IWorldReader world,
                               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:
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    true To be notified of changes
  - getHarvestTool
```
ToolType getHarvestTool(IBlockState state)
```
    Queries the class of tool required to harvest this block, if null is returned we assume that anything can harvest this block.
  - getHarvestLevel
```
int getHarvestLevel(IBlockState state)
```
    Queries the harvest level of this item stack for the specified tool class, Returns -1 if this tool is not of the specified type
    
    Returns:
    
    Harvest level, or -1 if not the specified tool type.
  - isToolEffective
```
default boolean isToolEffective(IBlockState state,
                                ToolType tool)
```
    Checks if the specified tool type is efficient on this block, meaning that it digs at full speed.
  - getExtendedState
```
default IBlockState getExtendedState(IBlockState state,
                                     IBlockReader world,
                                     BlockPos pos)
```
    Can return IExtendedBlockState
  - canRenderInLayer
```
default boolean canRenderInLayer(IBlockState state,
                                 BlockRenderLayer layer)
```
    Queries if this block should render in a given layer. A custom IBakedModel can use MinecraftForgeClient.getRenderLayer() to alter the model based on layer.
  - getSoundType
```
default SoundType getSoundType(IBlockState state,
                               IWorldReader world,
                               BlockPos pos,
                               @Nullable
                               Entity entity)
```
    Sensitive version of getSoundType
    
    Parameters:
    
    state - The state
    
    world - The world
    
    pos - The position. Note that the world 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 float[] getBeaconColorMultiplier(IBlockState state,
                                                   IWorldReader world,
                                                   BlockPos pos,
                                                   BlockPos beaconPos)
```
    Parameters:
    
    state - The state
    
    world - The world
    
    pos - The position of this state
    
    beaconPos - 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
  - getFogColor
```
default Vec3d getFogColor(IBlockState state,
                          IWorldReader world,
                          BlockPos pos,
                          Entity entity,
                          Vec3d originalColor,
                          float partialTicks)
```
    Use this to change the fog color used when the entity is "inside" a material. Vec3d is used here as "r/g/b" 0 - 1 values.
    
    Parameters:
    
    world - The world.
    
    pos - The position at the entity viewport.
    
    state - The state at the entity viewport.
    
    entity - the entity
    
    originalColor - The current fog color, You are not expected to use this, Return as the default if applicable.
    
    Returns:
    
    The new fog color.
  - getStateAtViewpoint
```
default IBlockState getStateAtViewpoint(IBlockState state,
                                        IBlockReader world,
                                        BlockPos pos,
                                        Vec3d viewpoint)
```
    Used to determine the state 'viewed' by an entity (see ActiveRenderInfo#getBlockStateAtEntityViewpoint(World, Entity, float)). Can be used by fluid blocks to determine if the viewpoint is within the fluid or not.
    
    Parameters:
    
    state - the state
    
    world - the world
    
    pos - the position
    
    viewpoint - the viewpoint
    
    Returns:
    
    the block state that should be 'seen'
  - getStateForPlacement
```
default IBlockState getStateForPlacement(IBlockState state,
                                         EnumFacing facing,
                                         IBlockState state2,
                                         IWorld world,
                                         BlockPos pos1,
                                         BlockPos pos2,
                                         EnumHand hand)
```
    //TODO: Re-Evaluate Gets the IBlockState to place
    
    Parameters:
    
    world - The world the block is being placed in
    
    pos - The position the block is being placed at
    
    facing - The side the block is being placed on
    
    hitX - The X coordinate of the hit vector
    
    hitY - The Y coordinate of the hit vector
    
    hitZ - The Z coordinate of the hit vector
    
    meta - The metadata of ItemStack as processed by Item#getMetadata(int)
    
    placer - The entity placing the block
    
    hand - The player hand used to place this block
    
    Returns:
    
    The state to be placed in the world
  - canBeConnectedTo
```
default boolean canBeConnectedTo(IBlockState state,
                                 IBlockReader world,
                                 BlockPos pos,
                                 EnumFacing facing)
```
    Determines if another block can connect to this block
    
    Parameters:
    
    world - The current world
    
    pos - The position of this block
    
    facing - The side the connecting block is on
    
    Returns:
    
    True to allow another block to connect to this block
  - getAiPathNodeType
```
@Nullable
default PathNodeType getAiPathNodeType(IBlockState state,
                                                 IBlockReader world,
                                                 BlockPos pos,
                                                 @Nullable
                                                 EntityLiving entity)
```
    Get the PathNodeType for this block. Return null for vanilla behavior.
    
    Returns:
    
    the PathNodeType
  - doesSideBlockChestOpening
```
default boolean doesSideBlockChestOpening(IBlockState blockState,
                                          IBlockReader world,
                                          BlockPos pos,
                                          EnumFacing side)
```
    Parameters:
    
    blockState - The state for this block
    
    world - The world this block is in
    
    pos - The position of this block
    
    side - The side of this block that the chest lid is trying to open into
    
    Returns:
    
    true if the chest should be prevented from opening by this block
  - isStickyBlock
```
default boolean isStickyBlock(IBlockState state)
```
    Parameters:
    
    state - The state
    
    Returns:
    
    true if the block is sticky block which used for pull or push adjacent blocks (use by piston)
  - getDrops
```
default void getDrops(IBlockState state,
                      NonNullList<ItemStack> drops,
                      World world,
                      BlockPos pos,
                      int fortune)
```
    This gets a complete list of items dropped from this block.
    
    Parameters:
    
    state - Current state
    
    drops - add all items this block drops to this drops list
    
    world - The current world, Currently hard 'World' and not 'IBlockReder' because vanilla needs it.
    
    pos - Block position in world
    
    fortune - Breakers fortune level
  - getFlammability
```
default int getFlammability(IBlockState state,
                            IBlockReader world,
                            BlockPos pos,
                            EnumFacing face)
```
    Chance that fire will spread and consume this block. 300 being a 100% chance, 0, being a 0% chance.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    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(IBlockState state,
                            IBlockReader world,
                            BlockPos pos,
                            EnumFacing face)
```
    Called when fire is updating, checks if a block face can catch fire.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    face - The face that the fire is coming from
    
    Returns:
    
    True if the face can be on fire, false otherwise.
  - getFireSpreadSpeed
```
default int getFireSpreadSpeed(IBlockState state,
                               IBlockReader world,
                               BlockPos pos,
                               EnumFacing face)
```
    Called when fire is updating on a neighbor block. The higher the number returned, the faster fire will spread around this block.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    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(IBlockState state,
                             IBlockReader world,
                             BlockPos pos,
                             EnumFacing 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:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    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(IBlockState state,
                                 IBlockReader world,
                                 BlockPos pos,
                                 Entity entity)
```
    Determines if this block is can be destroyed by the specified entities normal behavior.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    Returns:
    
    True to allow the ender dragon to destroy this block
  - isTopSolid
```
default boolean isTopSolid(IBlockState state,
                           IWorldReader world,
                           BlockPos pos)
```
    Determines if the top is consider 'solid'. This is a helper for getBlockFaceShape(UP) == SOLID. Sadly some vanilla logic doesn't sync this value, so we have to have this special function.
    
    Parameters:
    
    world - The world
    
    pos - Block position in world
    
    Returns:
    
    True if the top is considered solid
  - getRayTraceResult
```
@Nullable
default RayTraceResult getRayTraceResult(IBlockState state,
                                                   World world,
                                                   BlockPos pos,
                                                   Vec3d start,
                                                   Vec3d end,
                                                   RayTraceResult original)
```
    Ray traces through the blocks collision from start vector to end vector returning a ray trace hit.
    
    Parameters:
    
    state - The current state
    
    world - The current world
    
    pos - Block position in world
    
    start - The start vector
    
    end - The end vector
    
    original - The original result from Block.collisionRayTrace(IBlockState, World, BlockPos, Vec3d, Vec3d)
    
    Returns:
    
    A result that suits your block

Interface IForgeBlock

Method Summary

Method Detail

getBlock

getSlipperiness

getLightValue

isLadder

isNormalCube

doesSideBlockRendering

isBurning

hasTileEntity

createTileEntity

canSilkHarvest

canHarvestBlock

removedByPlayer

isBed

canCreatureSpawn

getBedSpawnPosition

setBedOccupied

getBedDirection

isBedFoot

beginLeaveDecay

isAir

canBeReplacedByLeaves

isReplaceableOreGen

getExplosionResistance

onBlockExploded

canConnectRedstone

canPlaceTorchOnTop

getPickBlock

isFoliage

addLandingEffects

addRunningEffects

addHitEffects

addDestroyEffects

canSustainPlant

onPlantGrow

isFertile

isBeaconBase

getExpDrop

rotate

getValidRotations

getEnchantPowerBonus

recolorBlock

onNeighborChange

observedNeighborChange

shouldCheckWeakPower

getWeakChanges

getHarvestTool

getHarvestLevel

isToolEffective

getExtendedState

canRenderInLayer

getSoundType

getBeaconColorMultiplier

getFogColor

getStateAtViewpoint

getStateForPlacement

canBeConnectedTo

getAiPathNodeType

doesSideBlockChestOpening

isStickyBlock

getDrops

getFlammability

isFlammable

getFireSpreadSpeed

isFireSource

canEntityDestroy

isTopSolid

getRayTraceResult