net.minecraftforge.fluids

Class BlockFluidBase

java.lang.Object

net.minecraftforge.registries.IForgeRegistryEntry.Impl<Block>

net.minecraft.block.Block

net.minecraftforge.fluids.BlockFluidBase

All Implemented Interfaces:

IFluidBlock, IForgeRegistryEntry<Block>

Direct Known Subclasses:

BlockFluidClassic, BlockFluidFinite

public abstract class BlockFluidBase
extends Block
implements IFluidBlock

This is a base implementation for Fluid blocks. It is highly recommended that you extend this class or one of the Forge-provided child classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BlockFluidBase.UnlistedPropertyBool

Nested classes/interfaces inherited from class net.minecraft.block.Block

Block.EnumOffsetType

Nested classes/interfaces inherited from interface net.minecraftforge.registries.IForgeRegistryEntry

IForgeRegistryEntry.Impl<T extends IForgeRegistryEntry<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Map<Block,java.lang.Boolean>	defaultDisplacements
protected Fluid	definedFluid This is the fluid used in the constructor.
protected int	density
protected int	densityDir
protected java.util.Map<Block,java.lang.Boolean>	displacements
static PropertyFloat	FLOW_DIRECTION
static com.google.common.collect.ImmutableList<IUnlistedProperty<?>>	FLUID_RENDER_PROPS
protected java.lang.String	fluidName
static PropertyInteger	LEVEL
static PropertyFloat[]	LEVEL_CORNERS
protected int	maxScaledLight
protected float	quantaFraction
protected int	quantaPerBlock
protected float	quantaPerBlockFloat
protected BlockRenderLayer	renderLayer
static BlockFluidBase.UnlistedPropertyBool[]	SIDE_OVERLAYS
protected int	temperature
protected int	tickRate

Fields inherited from class net.minecraft.block.Block

BLOCK_STATE_IDS, blockHardness, blockMapColor, blockMaterial, blockParticleGravity, blockResistance, blockSoundType, blockState, capturedDrops, captureDrops, enableStats, FULL_BLOCK_AABB, fullBlock, harvesters, hasTileEntity, lightOpacity, lightValue, needsRandomTick, NULL_AABB, RANDOM, REGISTRY, slipperiness, translucent, useNeighborBrightness

Fields inherited from class net.minecraftforge.registries.IForgeRegistryEntry.Impl

delegate

Constructor Summary

Constructors

Constructor and Description
BlockFluidBase(Fluid fluid, Material material)
BlockFluidBase(Fluid fluid, Material material, MapColor mapColor)

Method Summary

Modifier and Type	Method and Description
abstract boolean	canCollideCheck(IBlockState state, boolean fullHit)
boolean	canDisplace(IBlockAccess world, BlockPos pos) Returns true if the block at (pos) is displaceable.
protected boolean	causesDownwardCurrent(IBlockAccess world, BlockPos pos, EnumFacing face)
protected BlockStateContainer	createBlockState()
boolean	displaceIfPossible(World world, BlockPos pos) Attempt to displace the block at (pos), return true if it was displaced.
BlockFaceShape	getBlockFaceShape(IBlockAccess worldIn, IBlockState state, BlockPos pos, EnumFacing face)
BlockRenderLayer	getBlockLayer()
float	getBlockLiquidHeight(World world, BlockPos pos, IBlockState state, Material material) Called when entities are swimming in the given liquid and returns the relative height (used by EntityBoat)
AxisAlignedBB	getCollisionBoundingBox(IBlockState blockState, IBlockAccess worldIn, BlockPos pos)
int	getDensity()
static int	getDensity(IBlockAccess world, BlockPos pos)
(package private) int	getEffectiveQuanta(IBlockAccess world, BlockPos pos)
IBlockState	getExtendedState(IBlockState oldState, IBlockAccess world, BlockPos pos) Can return IExtendedBlockState
float	getFilledPercentage(IBlockAccess world, BlockPos pos)
float	getFilledPercentage(World world, BlockPos pos) Returns the amount of a single block is filled.
private int	getFlowDecay(IBlockAccess world, BlockPos pos)
static double	getFlowDirection(IBlockAccess world, BlockPos pos)
Vec3d	getFlowVector(IBlockAccess world, BlockPos pos)
Fluid	getFluid() Returns the Fluid associated with this Block.
private static Fluid	getFluid(IBlockState state)
float	getFluidHeightAverage(float... flow)
float	getFluidHeightForRender(IBlockAccess world, BlockPos pos, IBlockState up)
Vec3d	getFogColor(World world, BlockPos pos, IBlockState state, Entity entity, Vec3d originalColor, float partialTicks) Use this to change the fog color used when the entity is "inside" a material.
Item	getItemDropped(IBlockState state, java.util.Random rand, int fortune)
int	getLightValue(IBlockState state, IBlockAccess 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
abstract int	getMaxRenderHeightMeta()
int	getMetaFromState(IBlockState state)
int	getPackedLightmapCoords(IBlockState state, IBlockAccess world, BlockPos pos)
float	getQuantaPercentage(IBlockAccess world, BlockPos pos)
abstract int	getQuantaValue(IBlockAccess world, BlockPos pos)
int	getQuantaValueAbove(IBlockAccess world, BlockPos pos, int aboveThis)
int	getQuantaValueBelow(IBlockAccess world, BlockPos pos, int belowThis)
IBlockState	getStateAtViewpoint(IBlockState state, IBlockAccess world, BlockPos pos, Vec3d viewpoint) Used to determine the state 'viewed' by an entity (see ActiveRenderInfo.getBlockStateAtEntityViewpoint(World, Entity, float)).
IBlockState	getStateFromMeta(int meta) Deprecated.
int	getTemperature()
static int	getTemperature(IBlockAccess world, BlockPos pos)
(package private) boolean	hasVerticalFlow(IBlockAccess world, BlockPos pos)
private static boolean	isFluid(IBlockState blockstate)
boolean	isFullCube(IBlockState state)
boolean	isOpaqueCube(IBlockState state)
boolean	isPassable(IBlockAccess world, BlockPos pos)
private boolean	isWithinFluid(IBlockAccess world, BlockPos pos, Vec3d vec)
Vec3d	modifyAcceleration(World world, BlockPos pos, Entity entity, Vec3d vec)
void	neighborChanged(IBlockState state, World world, BlockPos pos, Block neighborBlock, BlockPos neighbourPos)
void	onBlockAdded(World world, BlockPos pos, IBlockState state)
int	quantityDropped(java.util.Random par1Random)
boolean	requiresUpdates()
BlockFluidBase	setDensity(int density)
BlockFluidBase	setMaxScaledLight(int maxScaledLight)
BlockFluidBase	setQuantaPerBlock(int quantaPerBlock)
BlockFluidBase	setRenderLayer(BlockRenderLayer renderLayer)
BlockFluidBase	setTemperature(int temperature)
BlockFluidBase	setTickRate(int tickRate)
boolean	shouldSideBeRendered(IBlockState state, IBlockAccess world, BlockPos pos, EnumFacing side)
int	tickRate(World world)

Methods inherited from class net.minecraft.block.Block

addCollisionBoxToList, addCollisionBoxToList, addDestroyEffects, addHitEffects, addInformation, addLandingEffects, addRunningEffects, beginLeavesDecay, breakBlock, canBeConnectedTo, canBeReplacedByLeaves, canConnectRedstone, canCreatureSpawn, canDropFromExplosion, canEntityDestroy, canEntitySpawn, canHarvestBlock, canPlaceBlockAt, canPlaceBlockOnSide, canPlaceTorchOnTop, canProvidePower, canRenderInLayer, canSilkHarvest, canSilkHarvest, canSpawnInBlock, canSustainLeaves, canSustainPlant, captureDrops, causesSuffocation, collisionRayTrace, createTileEntity, damageDropped, disableStats, doesSideBlockChestOpening, doesSideBlockRendering, dropBlockAsItem, dropBlockAsItemWithChance, dropXpOnBlockBreak, eventReceived, fillWithRain, getActualState, getAiPathNodeType, getAiPathNodeType, getAmbientOcclusionLightValue, getBeaconColorMultiplier, getBedDirection, getBedSpawnPosition, getBlockById, getBlockFromItem, getBlockFromName, getBlockHardness, getBlockState, getBoundingBox, getComparatorInputOverride, getCreativeTabToDisplayOn, getDefaultState, getDrops, getDrops, getEnableStats, getEnchantPowerBonus, getExpDrop, getExplosionResistance, getExplosionResistance, getFireSpreadSpeed, getFlammability, getHarvestLevel, getHarvestTool, getIdFromBlock, getItem, getLightOpacity, getLightOpacity, getLightValue, getLocalizedName, getMapColor, getMaterial, getMobilityFlag, getOffset, getOffsetType, getPickBlock, getPlayerRelativeBlockHardness, getRenderType, getSelectedBoundingBox, getSilkTouchDrop, getSlipperiness, getSoundType, getSoundType, getStateById, getStateForPlacement, getStateForPlacement, getStateId, getStrongPower, getSubBlocks, getTickRandomly, getUnlocalizedName, getUseNeighborBrightness, getValidRotations, getWeakChanges, getWeakPower, harvestBlock, hasComparatorInputOverride, hasCustomBreakingProgress, hasTileEntity, hasTileEntity, isAABBInsideLiquid, isAABBInsideMaterial, isAir, isAssociatedBlock, isBeaconBase, isBed, isBedFoot, isBlockNormalCube, isBurning, isCollidable, isEntityInsideMaterial, isEqualTo, isExceptBlockForAttachWithPiston, isExceptionBlockForAttaching, isFertile, isFireSource, isFlammable, isFoliage, isFullBlock, isLadder, isLeaves, isNormalCube, isNormalCube, isReplaceable, isReplaceableOreGen, isSideSolid, isStickyBlock, isToolEffective, isTopSolid, isTranslucent, isWood, observedNeighborChange, onBlockActivated, onBlockClicked, onBlockDestroyedByExplosion, onBlockDestroyedByPlayer, onBlockExploded, onBlockHarvested, onBlockPlacedBy, onEntityCollidedWithBlock, onEntityWalk, onFallenUpon, onLanded, onNeighborChange, onPlantGrow, quantityDropped, quantityDroppedWithBonus, randomDisplayTick, randomTick, rayTrace, recolorBlock, registerBlocks, removedByPlayer, rotateBlock, setBedOccupied, setBlockUnbreakable, setCreativeTab, setDefaultSlipperiness, setDefaultState, setHardness, setHarvestLevel, setHarvestLevel, setLightLevel, setLightOpacity, setResistance, setSoundType, setTickRandomly, setUnlocalizedName, shouldCheckWeakPower, spawnAsEntity, toString, updateTick, withMirror, withRotation

Methods inherited from class net.minecraftforge.registries.IForgeRegistryEntry.Impl

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.fluids.IFluidBlock

canDrain, drain, place

Field Detail

defaultDisplacements

protected static final java.util.Map<Block,java.lang.Boolean> defaultDisplacements

displacements

protected java.util.Map<Block,java.lang.Boolean> displacements

LEVEL

public static final PropertyInteger LEVEL

LEVEL_CORNERS

public static final PropertyFloat[] LEVEL_CORNERS

FLOW_DIRECTION

public static final PropertyFloat FLOW_DIRECTION

SIDE_OVERLAYS

public static final BlockFluidBase.UnlistedPropertyBool[] SIDE_OVERLAYS

FLUID_RENDER_PROPS

public static final com.google.common.collect.ImmutableList<IUnlistedProperty<?>> FLUID_RENDER_PROPS

quantaPerBlock

protected int quantaPerBlock

quantaPerBlockFloat

protected float quantaPerBlockFloat

quantaFraction

protected float quantaFraction

density

protected int density

densityDir

protected int densityDir

temperature

protected int temperature

tickRate

protected int tickRate

renderLayer

protected BlockRenderLayer renderLayer

maxScaledLight

protected int maxScaledLight

fluidName

protected final java.lang.String fluidName

definedFluid

protected final Fluid definedFluid

This is the fluid used in the constructor. Use this reference to configure things like icons for your block. It might not be active in the registry, so do NOT expose it.

Constructor Detail

BlockFluidBase

public BlockFluidBase(Fluid fluid,
                      Material material,
                      MapColor mapColor)

BlockFluidBase

public BlockFluidBase(Fluid fluid,
                      Material material)

Method Detail

createBlockState

@Nonnull
protected BlockStateContainer createBlockState()

Overrides:

createBlockState in class Block

getMetaFromState

public int getMetaFromState(@Nonnull
                            IBlockState state)

Overrides:

getMetaFromState in class Block

getStateFromMeta

@Deprecated
 @Nonnull
public IBlockState getStateFromMeta(int meta)

Deprecated.

Overrides:

getStateFromMeta in class Block

setQuantaPerBlock

public BlockFluidBase setQuantaPerBlock(int quantaPerBlock)

setDensity

public BlockFluidBase setDensity(int density)

setTemperature

public BlockFluidBase setTemperature(int temperature)

setTickRate

public BlockFluidBase setTickRate(int tickRate)

setRenderLayer

public BlockFluidBase setRenderLayer(BlockRenderLayer renderLayer)

setMaxScaledLight

public BlockFluidBase setMaxScaledLight(int maxScaledLight)

getDensity

public final int getDensity()

getTemperature

public final int getTemperature()

canDisplace

public boolean canDisplace(IBlockAccess world,
                           BlockPos pos)

Returns true if the block at (pos) is displaceable. Does not displace the block.

displaceIfPossible

public boolean displaceIfPossible(World world,
                                  BlockPos pos)

Attempt to displace the block at (pos), return true if it was displaced.

getQuantaValue

public abstract int getQuantaValue(IBlockAccess world,
                                   BlockPos pos)

canCollideCheck

public abstract boolean canCollideCheck(@Nonnull
                                        IBlockState state,
                                        boolean fullHit)

Overrides:

canCollideCheck in class Block

getMaxRenderHeightMeta

public abstract int getMaxRenderHeightMeta()

onBlockAdded

public void onBlockAdded(@Nonnull
                         World world,
                         @Nonnull
                         BlockPos pos,
                         @Nonnull
                         IBlockState state)

Overrides:

onBlockAdded in class Block

neighborChanged

public void neighborChanged(@Nonnull
                            IBlockState state,
                            @Nonnull
                            World world,
                            @Nonnull
                            BlockPos pos,
                            @Nonnull
                            Block neighborBlock,
                            @Nonnull
                            BlockPos neighbourPos)

Overrides:

neighborChanged in class Block

requiresUpdates

public boolean requiresUpdates()

Overrides:

requiresUpdates in class Block

isPassable

public boolean isPassable(@Nonnull
                          IBlockAccess world,
                          @Nonnull
                          BlockPos pos)

Overrides:

isPassable in class Block

getItemDropped

@Nonnull
public Item getItemDropped(@Nonnull
                                    IBlockState state,
                                    @Nonnull
                                    java.util.Random rand,
                                    int fortune)

Overrides:

getItemDropped in class Block

quantityDropped

public int quantityDropped(@Nonnull
                           java.util.Random par1Random)

Overrides:

quantityDropped in class Block

tickRate

public int tickRate(@Nonnull
                    World world)

Overrides:

tickRate in class Block

modifyAcceleration

@Nonnull
public Vec3d modifyAcceleration(@Nonnull
                                         World world,
                                         @Nonnull
                                         BlockPos pos,
                                         @Nonnull
                                         Entity entity,
                                         @Nonnull
                                         Vec3d vec)

Overrides:

modifyAcceleration in class Block

getLightValue

public int getLightValue(@Nonnull
                         IBlockState state,
                         @Nonnull
                         IBlockAccess world,
                         @Nonnull
                         BlockPos pos)

Description copied from class: Block

Get a light value for this block, taking into account the given state and coordinates, normal ranges are between 0 and 15

Overrides:

getLightValue in class Block

Parameters:

state - Block state

world - The current world

pos - Block position in world

Returns:

The light value

isOpaqueCube

public boolean isOpaqueCube(@Nonnull
                            IBlockState state)

Overrides:

isOpaqueCube in class Block

isFullCube

public boolean isFullCube(@Nonnull
                          IBlockState state)

Overrides:

isFullCube in class Block

getPackedLightmapCoords

public int getPackedLightmapCoords(@Nonnull
                                   IBlockState state,
                                   @Nonnull
                                   IBlockAccess world,
                                   @Nonnull
                                   BlockPos pos)

Overrides:

getPackedLightmapCoords in class Block

getBlockLayer

@Nonnull
public BlockRenderLayer getBlockLayer()

Overrides:

getBlockLayer in class Block

getBlockFaceShape

@Nonnull
public BlockFaceShape getBlockFaceShape(@Nonnull
                                                 IBlockAccess worldIn,
                                                 @Nonnull
                                                 IBlockState state,
                                                 @Nonnull
                                                 BlockPos pos,
                                                 @Nonnull
                                                 EnumFacing face)

Overrides:

getBlockFaceShape in class Block

shouldSideBeRendered

public boolean shouldSideBeRendered(@Nonnull
                                    IBlockState state,
                                    @Nonnull
                                    IBlockAccess world,
                                    @Nonnull
                                    BlockPos pos,
                                    @Nonnull
                                    EnumFacing side)

Overrides:

shouldSideBeRendered in class Block

isFluid

private static boolean isFluid(@Nonnull
                               IBlockState blockstate)

getExtendedState

@Nonnull
public IBlockState getExtendedState(@Nonnull
                                             IBlockState oldState,
                                             @Nonnull
                                             IBlockAccess world,
                                             @Nonnull
                                             BlockPos pos)

Description copied from class: Block

Can return IExtendedBlockState

Overrides:

getExtendedState in class Block

getDensity

public static int getDensity(IBlockAccess world,
                             BlockPos pos)

getTemperature

public static int getTemperature(IBlockAccess world,
                                 BlockPos pos)

getFluid

@Nullable
private static Fluid getFluid(IBlockState state)

getFlowDirection

public static double getFlowDirection(IBlockAccess world,
                                      BlockPos pos)

getQuantaValueBelow

public final int getQuantaValueBelow(IBlockAccess world,
                                     BlockPos pos,
                                     int belowThis)

getQuantaValueAbove

public final int getQuantaValueAbove(IBlockAccess world,
                                     BlockPos pos,
                                     int aboveThis)

getQuantaPercentage

public final float getQuantaPercentage(IBlockAccess world,
                                       BlockPos pos)

getFluidHeightAverage

public float getFluidHeightAverage(float... flow)

getFluidHeightForRender

public float getFluidHeightForRender(IBlockAccess world,
                                     BlockPos pos,
                                     @Nonnull
                                     IBlockState up)

getFlowVector

public Vec3d getFlowVector(IBlockAccess world,
                           BlockPos pos)

getFlowDecay

private int getFlowDecay(IBlockAccess world,
                         BlockPos pos)

getEffectiveQuanta

final int getEffectiveQuanta(IBlockAccess world,
                             BlockPos pos)

hasVerticalFlow

final boolean hasVerticalFlow(IBlockAccess world,
                              BlockPos pos)

causesDownwardCurrent

protected boolean causesDownwardCurrent(IBlockAccess world,
                                        BlockPos pos,
                                        EnumFacing face)

getFluid

public Fluid getFluid()

Description copied from interface: IFluidBlock

Returns the Fluid associated with this Block.

Specified by:

getFluid in interface IFluidBlock

getFilledPercentage

public float getFilledPercentage(World world,
                                 BlockPos pos)

Description copied from interface: IFluidBlock

Returns the amount of a single block is filled. Value between 0 and 1. 1 meaning the entire 1x1x1 cube is full, 0 meaning completely empty. If the return value is negative. It will be treated as filling the block from the top down instead of bottom up.

Specified by:

getFilledPercentage in interface IFluidBlock

Returns:

getFilledPercentage

public float getFilledPercentage(IBlockAccess world,
                                 BlockPos pos)

getCollisionBoundingBox

public AxisAlignedBB getCollisionBoundingBox(@Nonnull
                                             IBlockState blockState,
                                             @Nonnull
                                             IBlockAccess worldIn,
                                             @Nonnull
                                             BlockPos pos)

Overrides:

getCollisionBoundingBox in class Block

getFogColor

public Vec3d getFogColor(World world,
                         BlockPos pos,
                         IBlockState state,
                         Entity entity,
                         Vec3d originalColor,
                         float partialTicks)

Description copied from class: Block

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.

Overrides:

getFogColor in class Block

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

public IBlockState getStateAtViewpoint(IBlockState state,
                                       IBlockAccess world,
                                       BlockPos pos,
                                       Vec3d viewpoint)

Description copied from class: Block

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.

Overrides:

getStateAtViewpoint in class Block

Parameters:

state - the state

world - the world

pos - the position

viewpoint - the viewpoint

Returns:

the block state that should be 'seen'

isWithinFluid

private boolean isWithinFluid(IBlockAccess world,
                              BlockPos pos,
                              Vec3d vec)

getBlockLiquidHeight

public float getBlockLiquidHeight(World world,
                                  BlockPos pos,
                                  IBlockState state,
                                  Material material)

Description copied from class: Block

Called when entities are swimming in the given liquid and returns the relative height (used by EntityBoat)

Overrides:

getBlockLiquidHeight in class Block

Parameters:

world - world that is being tested.

pos - block thats being tested.

state - state at world/pos

material - liquid thats being tested.

Returns:

relative height of the given liquid (material), a value between 0 and 1