net.minecraftforge.common.extensions

Interface IForgeBlock

All Known Implementing Classes:

AbstractBannerBlock, AbstractButtonBlock, AbstractChestBlock, AbstractCoralPlantBlock, AbstractFurnaceBlock, AbstractGlassBlock, AbstractPressurePlateBlock, AbstractRailBlock, AbstractSignBlock, AbstractSkullBlock, AirBlock, AnvilBlock, AttachedStemBlock, BambooBlock, BambooSaplingBlock, BannerBlock, BarrelBlock, BarrierBlock, BeaconBlock, BedBlock, BedrockBlock, BeehiveBlock, BeetrootBlock, BellBlock, BlastFurnaceBlock, Block, BreakableBlock, BrewingStandBlock, BubbleColumnBlock, BushBlock, CactusBlock, CakeBlock, CampfireBlock, CarpetBlock, CarrotBlock, CartographyTableBlock, CarvedPumpkinBlock, CauldronBlock, ChestBlock, ChorusFlowerBlock, ChorusPlantBlock, CocoaBlock, CommandBlockBlock, ComparatorBlock, ComposterBlock, ConcretePowderBlock, ConduitBlock, ContainerBlock, CoralBlock, CoralFanBlock, CoralFinBlock, CoralPlantBlock, CoralWallFanBlock, CraftingTableBlock, CropsBlock, CustomPlantTypeTest.CustomBlock, CustomPlantTypeTest.CustomPlantBlock, DaylightDetectorBlock, DeadBushBlock, DeadCoralPlantBlock, DeadCoralWallFanBlock, DetectorRailBlock, DirectionalBlock, DispenserBlock, DoorBlock, DoublePlantBlock, DragonEggBlock, DropperBlock, EnchantingTableBlock, EnderChestBlock, EndGatewayBlock, EndPortalBlock, EndPortalFrameBlock, EndRodBlock, FallingBlock, FarmlandBlock, FenceBlock, FenceGateBlock, FireBlock, FletchingTableBlock, FlowerBlock, FlowerPotBlock, FlowingFluidBlock, FourWayBlock, FrostedIceBlock, FurnaceBlock, GameData.BlockCallbacks.BlockDummyAir, GlassBlock, GlazedTerracottaBlock, GrassBlock, GrassPathBlock, GravelBlock, GrindstoneBlock, HayBlock, HoneyBlock, HopperBlock, HorizontalBlock, HorizontalFaceBlock, HugeMushroomBlock, IceBlock, JigsawBlock, JukeboxBlock, KelpBlock, KelpTopBlock, LadderBlock, LanternBlock, LeavesBlock, LecternBlock, LeverBlock, LilyPadBlock, LogBlock, LoomBlock, MagmaBlock, MelonBlock, MovingPistonBlock, MushroomBlock, MyceliumBlock, NetherPortalBlock, NetherWartBlock, NewFluidTest.FluidloggableBlock, NoteBlock, ObserverBlock, OreBlock, PaneBlock, PistonBlock, PistonHeadBlock, PotatoBlock, PoweredRailBlock, PressurePlateBlock, PumpkinBlock, RailBlock, RedstoneBlock, RedstoneDiodeBlock, RedstoneLampBlock, RedstoneOreBlock, RedstoneTorchBlock, RedstoneWallTorchBlock, RedstoneWireBlock, RepeaterBlock, RotatedPillarBlock, SandBlock, SaplingBlock, ScaffoldingBlock, SeaGrassBlock, SeaPickleBlock, ShearableDoublePlantBlock, ShulkerBoxBlock, SilverfishBlock, SixWayBlock, SkullBlock, SkullPlayerBlock, SkullWallPlayerBlock, SlabBlock, SlimeBlock, SmithingTableBlock, SmokerBlock, SnowBlock, SnowyDirtBlock, SoulSandBlock, SpawnerBlock, SpongeBlock, SpreadableSnowyDirtBlock, StainedGlassBlock, StainedGlassPaneBlock, StairsBlock, StandingSignBlock, StemBlock, StemGrownBlock, StoneButtonBlock, StonecutterBlock, StructureBlock, StructureVoidBlock, SugarCaneBlock, SweetBerryBushBlock, TallFlowerBlock, TallGrassBlock, TallSeaGrassBlock, TNTBlock, TorchBlock, TrapDoorBlock, TrappedChestBlock, TripWireBlock, TripWireHookBlock, TurtleEggBlock, VineBlock, WallBannerBlock, WallBlock, WallSignBlock, WallSkullBlock, WallTorchBlock, WebBlock, WeightedPressurePlateBlock, WetSpongeBlock, WitherRoseBlock, WitherSkeletonSkullBlock, WitherSkeletonWallSkullBlock, WoodButtonBlock

public interface IForgeBlock

Method Summary

Modifier and Type	Method and Description
default boolean	addDestroyEffects(BlockState state, World world, BlockPos pos, ParticleManager manager) Spawn particles for when the block is destroyed.
default boolean	addHitEffects(BlockState 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(BlockState state1, ServerWorld worldserver, 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.
default boolean	addRunningEffects(BlockState state, World world, BlockPos pos, Entity entity) Allows a block to override the standard vanilla running particles.
default void	beginLeaveDecay(BlockState state, IWorldReader world, BlockPos pos) Called when a leaf should start its decay process.
default boolean	canBeConnectedTo(BlockState state, IBlockReader world, BlockPos pos, Direction facing) Determines if another block can connect to this block
default boolean	canBeReplacedByLeaves(BlockState state, IWorldReader world, BlockPos pos) Used during tree growth to determine if newly generated leaves can replace this block.
default boolean	canBeReplacedByLogs(BlockState state, IWorldReader world, BlockPos pos) Used during tree growth to determine if newly generated logs can replace this block.
default boolean	canConnectRedstone(BlockState state, IBlockReader world, BlockPos pos, Direction 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(BlockState state, IBlockReader world, BlockPos pos, EntitySpawnPlacementRegistry.PlacementType type, EntityType<?> 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	canDropFromExplosion(BlockState state, IBlockReader world, BlockPos pos, Explosion explosion) Determines if this block should drop loot when exploded.
default boolean	canEntityDestroy(BlockState state, IBlockReader world, BlockPos pos, Entity entity) Determines if this block is can be destroyed by the specified entities normal behavior.
default boolean	canHarvestBlock(BlockState state, IBlockReader world, BlockPos pos, PlayerEntity player) Determines if the player can harvest this block, obtaining it's drops when the block is destroyed.
default boolean	canStickTo(BlockState state, BlockState other) Determines if this block can stick to another block when pushed by a piston.
boolean	canSustainPlant(BlockState state, IBlockReader world, BlockPos pos, Direction facing, IPlantable plantable) Determines if this block can support the passed in plant, allowing it to be planted and grow.
default void	catchFire(BlockState state, World world, BlockPos pos, Direction face, LivingEntity igniter) If the block is flammable, this is called when it gets lit on fire.
default boolean	collisionExtendsVertically(BlockState state, IBlockReader world, BlockPos pos, Entity collidingEntity) Determines if this block's collision box should be treated as though it can extend above its block space.
default TileEntity	createTileEntity(BlockState state, IBlockReader world) Called throughout the code as a replacement for ITileEntityProvider.createNewTileEntity Return the same thing you would from that function.
default PathNodeType	getAiPathNodeType(BlockState state, IBlockReader world, BlockPos pos, MobEntity entity) Get the PathNodeType for this block.
default float[]	getBeaconColorMultiplier(BlockState state, IWorldReader world, BlockPos pos, BlockPos beaconPos)
default Direction	getBedDirection(BlockState state, IWorldReader world, BlockPos pos) Returns the direction of the block.
default java.util.Optional<Vec3d>	getBedSpawnPosition(EntityType<?> entityType, BlockState state, IWorldReader world, BlockPos pos, LivingEntity sleeper) Returns the position that the sleeper is moved to upon waking up, or respawning at the bed.
default Block	getBlock()
default float	getEnchantPowerBonus(BlockState state, IWorldReader world, BlockPos pos) Determines the amount of enchanting power this block can provide to an enchanting table.
default int	getExpDrop(BlockState state, IWorldReader world, BlockPos pos, int fortune, int silktouch) Gathers how much experience this block drops when broken.
default float	getExplosionResistance(BlockState state, IWorldReader world, BlockPos pos, Entity exploder, Explosion explosion) Location sensitive version of getExplosionResistance
default BlockState	getExtendedState(BlockState state, IBlockReader world, BlockPos pos) Can return IExtendedBlockState
default int	getFireSpreadSpeed(BlockState state, IBlockReader world, BlockPos pos, Direction face) Called when fire is updating on a neighbor block.
default int	getFlammability(BlockState state, IBlockReader world, BlockPos pos, Direction face) Chance that fire will spread and consume this block.
default Vec3d	getFogColor(BlockState 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(BlockState 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(BlockState 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(BlockState state, IBlockReader 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(BlockState state, RayTraceResult target, IBlockReader world, BlockPos pos, PlayerEntity player) Called when A user uses the creative pick block button on this block
default RayTraceResult	getRayTraceResult(BlockState 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(BlockState state, IWorldReader world, BlockPos pos, Entity entity) Gets the slipperiness at the given location at the given state.
default SoundType	getSoundType(BlockState state, IWorldReader world, BlockPos pos, Entity entity) Sensitive version of getSoundType
default BlockState	getStateAtViewpoint(BlockState state, IBlockReader world, BlockPos pos, Vec3d viewpoint) Used to determine the state 'viewed' by an entity (see ActiveRenderInfo#getBlockStateAtEntityViewpoint(World, Entity, float)).
default BlockState	getStateForPlacement(BlockState state, Direction facing, BlockState state2, IWorld world, BlockPos pos1, BlockPos pos2, Hand hand) //TODO: Re-Evaluate Gets the IBlockState to place
java.util.Set<ResourceLocation>	getTags() Retrieves a list of tags names this is known to be associated with.
default Direction[]	getValidRotations(BlockState state, IBlockReader world, BlockPos pos) Get the rotations that can apply to the block at the specified coordinates.
default boolean	getWeakChanges(BlockState state, IWorldReader world, BlockPos pos) If this block should be notified of weak changes.
default boolean	hasTileEntity(BlockState 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(BlockState state, IBlockReader world, BlockPos pos) Determines this block should be treated as an air block by the rest of the code.
default boolean	isBeaconBase(BlockState state, IWorldReader world, BlockPos pos, BlockPos beacon) Determines if this block can be used as the base of a beacon.
default boolean	isBed(BlockState 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(BlockState state, IWorldReader world, BlockPos pos) Determines if the current block is the foot half of the bed.
default boolean	isBurning(BlockState 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	isConduitFrame(BlockState state, IWorldReader world, BlockPos pos, BlockPos conduit) Determines if this block can be used as the frame of a conduit.
default boolean	isFertile(BlockState 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(BlockState state, IBlockReader world, BlockPos pos, Direction side) Currently only called by fire when it is on top of this block.
default boolean	isFlammable(BlockState state, IBlockReader world, BlockPos pos, Direction face) Called when fire is updating, checks if a block face can catch fire.
default boolean	isFoliage(BlockState 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(BlockState state, IWorldReader world, BlockPos pos, LivingEntity entity) Checks if a player or entity can use this block to 'climb' like a ladder.
default boolean	isPortalFrame(BlockState state, IWorldReader world, BlockPos pos) Determines if this block can be used as part of a frame of a nether portal.
default boolean	isReplaceableOreGen(BlockState state, IWorldReader world, BlockPos pos, java.util.function.Predicate<BlockState> target) Determines if the current block is replaceable by Ore veins during world generation.
default boolean	isSlimeBlock(BlockState state)
default boolean	isStickyBlock(BlockState state)
default boolean	isToolEffective(BlockState state, ToolType tool) Checks if the specified tool type is efficient on this block, meaning that it digs at full speed.
default void	observedNeighborChange(BlockState 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(BlockState state, World world, BlockPos pos, Explosion explosion) Called when the block is destroyed by an explosion.
default void	onNeighborChange(BlockState 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(BlockState 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(BlockState state, IWorld world, BlockPos pos, Direction facing, DyeColor color) //TODO: Re-Evaluate Gathers how much experience this block drops when broken.
default boolean	removedByPlayer(BlockState state, World world, BlockPos pos, PlayerEntity player, boolean willHarvest, IFluidState fluid) Called when a player removes a block.
default BlockState	rotate(BlockState state, IWorld world, BlockPos pos, Rotation direction)
default void	setBedOccupied(BlockState state, IWorldReader world, BlockPos pos, LivingEntity sleeper, boolean occupied) Called when a user either starts or stops sleeping in the bed.
default boolean	shouldCheckWeakPower(BlockState state, IWorldReader world, BlockPos pos, Direction side) Called to determine whether to allow the a block to handle its own indirect power rather than using the default rules.
default boolean	shouldDisplayFluidOverlay(BlockState state, ILightReader world, BlockPos pos, IFluidState fluidState) Called to determine whether this block should use the fluid overlay texture or flowing texture when it is placed under the fluid.

Method Detail

getBlock

default Block getBlock()

getSlipperiness

float getSlipperiness(BlockState 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 net.minecraft.entity.EntityLivingBase, this is .91. net.minecraft.entity.item.EntityItem uses .98, and net.minecraft.entity.projectile.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(BlockState state,
                          IBlockReader 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(BlockState state,
                         IWorldReader world,
                         BlockPos pos,
                         LivingEntity 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

isBurning

default boolean isBurning(BlockState 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(BlockState 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(BlockState 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

canHarvestBlock

default boolean canHarvestBlock(BlockState state,
                                IBlockReader world,
                                BlockPos pos,
                                PlayerEntity 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(BlockState state,
                                World world,
                                BlockPos pos,
                                PlayerEntity 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(BlockState 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(BlockState state,
                                 IBlockReader world,
                                 BlockPos pos,
                                 EntitySpawnPlacementRegistry.PlacementType type,
                                 @Nullable
                                 EntityType<?> 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

default java.util.Optional<Vec3d> getBedSpawnPosition(EntityType<?> entityType,
                                                      BlockState state,
                                                      IWorldReader world,
                                                      BlockPos pos,
                                                      @Nullable
                                                      LivingEntity sleeper)

Returns the position that the sleeper 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

sleeper - The sleeper or camera entity, null in some cases.

Returns:

The spawn position

setBedOccupied

default void setBedOccupied(BlockState state,
                            IWorldReader world,
                            BlockPos pos,
                            LivingEntity sleeper,
                            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

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(BlockState state,
                                  IWorldReader world,
                                  BlockPos pos)

Returns the direction of the block. Same values that are returned by BlockDirectional. Called every frame tick for every living entity. Be VERY fast.

Parameters:

state - The current state

world - The current world

pos - Block position in world

Returns:

Bed direction

isBedFoot

default boolean isBedFoot(BlockState 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(BlockState 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(BlockState 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(BlockState state,
                                      IWorldReader 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.

canBeReplacedByLogs

default boolean canBeReplacedByLogs(BlockState state,
                                    IWorldReader world,
                                    BlockPos pos)

Used during tree growth to determine if newly generated logs 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(BlockState state,
                                    IWorldReader world,
                                    BlockPos pos,
                                    java.util.function.Predicate<BlockState> 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(BlockState 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.

canConnectRedstone

default boolean canConnectRedstone(BlockState state,
                                   IBlockReader world,
                                   BlockPos pos,
                                   @Nullable
                                   Direction 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

getPickBlock

default ItemStack getPickBlock(BlockState state,
                               RayTraceResult target,
                               IBlockReader world,
                               BlockPos pos,
                               PlayerEntity 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(BlockState 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(BlockState state1,
                                  ServerWorld worldserver,
                                  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:

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(BlockState 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(BlockState 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(BlockState 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(BlockState state,
                        IBlockReader world,
                        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:

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(BlockState 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(BlockState 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(BlockState 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.

isConduitFrame

default boolean isConduitFrame(BlockState state,
                               IWorldReader world,
                               BlockPos pos,
                               BlockPos conduit)

Determines if this block can be used as the frame of a conduit.

Parameters:

world - The current world

pos - Block position in world

conduit - Conduit position in world

Returns:

True, to support the conduit, and make it active with this block.

isPortalFrame

default boolean isPortalFrame(BlockState state,
                              IWorldReader world,
                              BlockPos pos)

Determines if this block can be used as part of a frame of a nether portal.

Parameters:

state - The current state

world - The current world

pos - Block position in world

Returns:

True, to support being part of a nether portal frame, false otherwise.

getExpDrop

default int getExpDrop(BlockState state,
                       IWorldReader world,
                       BlockPos pos,
                       int fortune,
                       int silktouch)

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 BlockState rotate(BlockState state,
                          IWorld world,
                          BlockPos pos,
                          Rotation direction)

getValidRotations

@Nullable
default Direction[] getValidRotations(BlockState 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(BlockState 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(BlockState state,
                             IWorld world,
                             BlockPos pos,
                             Direction facing,
                             DyeColor 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(BlockState 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(BlockState 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(BlockState state,
                                     IWorldReader world,
                                     BlockPos pos,
                                     Direction 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(BlockState 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(BlockState 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(BlockState 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(BlockState state,
                                ToolType tool)

Checks if the specified tool type is efficient on this block, meaning that it digs at full speed.

getExtendedState

default BlockState getExtendedState(BlockState state,
                                    IBlockReader world,
                                    BlockPos pos)

Can return IExtendedBlockState

getSoundType

default SoundType getSoundType(BlockState 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(BlockState 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(BlockState 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 BlockState getStateAtViewpoint(BlockState 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 BlockState getStateForPlacement(BlockState state,
                                        Direction facing,
                                        BlockState state2,
                                        IWorld world,
                                        BlockPos pos1,
                                        BlockPos pos2,
                                        Hand 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(BlockState state,
                                 IBlockReader world,
                                 BlockPos pos,
                                 Direction 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(BlockState state,
                                                 IBlockReader world,
                                                 BlockPos pos,
                                                 @Nullable
                                                 MobEntity entity)

Get the PathNodeType for this block. Return null for vanilla behavior.

Returns:

the PathNodeType

isSlimeBlock

default boolean isSlimeBlock(BlockState state)

Parameters:

state - The state

Returns:

true if the block is sticky block which used for pull or push adjacent blocks (use by piston)

isStickyBlock

default boolean isStickyBlock(BlockState state)

Parameters:

state - The state

Returns:

true if the block is sticky block which used for pull or push adjacent blocks (use by piston)

canStickTo

default boolean canStickTo(BlockState state,
                           BlockState other)

Determines if this block can stick to another block when pushed by a piston.

Parameters:

state - My state

other - Other block

Returns:

True to link blocks

getFlammability

default int getFlammability(BlockState state,
                            IBlockReader world,
                            BlockPos pos,
                            Direction 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(BlockState state,
                            IBlockReader world,
                            BlockPos pos,
                            Direction 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.

catchFire

default void catchFire(BlockState state,
                       World world,
                       BlockPos pos,
                       @Nullable
                       Direction face,
                       @Nullable
                       LivingEntity igniter)

If the block is flammable, this is called when it gets lit on fire.

Parameters:

state - The current state

world - The current world

pos - Block position in world

face - The face that the fire is coming from

igniter - The entity that lit the fire

getFireSpreadSpeed

default int getFireSpreadSpeed(BlockState state,
                               IBlockReader world,
                               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:

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(BlockState state,
                             IBlockReader world,
                             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:

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(BlockState 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

getRayTraceResult

@Nullable
default RayTraceResult getRayTraceResult(BlockState 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

canDropFromExplosion

default boolean canDropFromExplosion(BlockState state,
                                     IBlockReader world,
                                     BlockPos pos,
                                     Explosion explosion)

Determines if this block should drop loot when exploded.

getTags

java.util.Set<ResourceLocation> getTags()

Retrieves a list of tags names this is known to be associated with. This should be used in favor of TagCollection.getOwningTags, as this caches the result and automatically updates when the TagCollection changes.

onBlockExploded

default void onBlockExploded(BlockState 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

collisionExtendsVertically

default boolean collisionExtendsVertically(BlockState state,
                                           IBlockReader world,
                                           BlockPos pos,
                                           Entity collidingEntity)

Determines if this block's collision box should be treated as though it can extend above its block space. Use this to replicate fence and wall behavior.

shouldDisplayFluidOverlay

default boolean shouldDisplayFluidOverlay(BlockState state,
                                          ILightReader world,
                                          BlockPos pos,
                                          IFluidState fluidState)

Called to determine whether this block should use the fluid overlay texture or flowing texture when it is placed under the fluid.

Parameters:

state - The current state

world - The world

pos - Block position in world

fluidState - The state of the fluid

Returns:

Whether the fluid overlay texture should be used