Interface IForgeFluidState

Method Details

• self

  private FluidState self()

• getExplosionResistance

  default float getExplosionResistance(BlockGetter level, BlockPos pos, Explosion explosion)

  Returns the explosion resistance of the fluid.

  Parameters:

  level - the level the fluid is in

  pos - the position of the fluid

  explosion - the explosion the fluid is absorbing

  Returns:

  the amount of the explosion the fluid can absorb

• getFluidType

  default FluidType getFluidType()

  Returns the type of this fluid.

  Returns:

  the type of this fluid

• move

  default boolean move(LivingEntity entity, Vec3 movementVector, double gravity)

  Performs how an entity moves when within the fluid. If using custom movement logic, the method should return true. Otherwise, the movement logic will default to water.

  Parameters:

  entity - the entity moving within the fluid

  movementVector - the velocity of how the entity wants to move

  gravity - the gravity to apply to the entity

  Returns:

  true if custom movement logic is performed, false otherwise

• canConvertToSource

  default boolean canConvertToSource(LevelReader reader, BlockPos pos)

  Returns whether the fluid can create a source.

  Parameters:

  reader - the reader that can get the fluid

  pos - the location of the fluid

  Returns:

  true if the fluid can create a source, false otherwise

• supportsBoating

  default boolean supportsBoating(Boat boat)

  Returns whether the boat can be used on the fluid.

  Parameters:

  boat - the boat trying to be used on the fluid

  Returns:

  true if the boat can be used, false otherwise

• getBlockPathType

  @Nullable default @Nullable BlockPathTypes getBlockPathType(BlockGetter level, BlockPos pos, @Nullable @Nullable Mob mob, boolean canFluidLog)

  Gets the path type of this fluid when an entity is pathfinding. When null, uses vanilla behavior.

  Parameters:

  level - the level which contains this fluid

  pos - the position of the fluid

  mob - the mob currently pathfinding, may be null

  canFluidLog - true if the path is being applied for fluids that can log blocks, should be checked against if the fluid can log a block

  Returns:

  the path type of this fluid

• getAdjacentBlockPathType

  @Nullable default @Nullable BlockPathTypes getAdjacentBlockPathType(BlockGetter level, BlockPos pos, @Nullable @Nullable Mob mob, BlockPathTypes originalType)

  Gets the path type of the adjacent fluid to a pathfinding entity. Path types with a negative malus are not traversable for the entity. Pathfinding entities will favor paths consisting of a lower malus. When null, uses vanilla behavior.

  Parameters:

  level - the level which contains this fluid

  pos - the position of the fluid

  mob - the mob currently pathfinding, may be null

  originalType - the path type of the source the entity is on

  Returns:

  the path type of this fluid

• canHydrate

  default boolean canHydrate(BlockGetter getter, BlockPos pos, BlockState source, BlockPos sourcePos)

  Returns whether the block can be hydrated by a fluid.

  Hydration is an arbitrary word which depends on the block.

  • A farmland has moisture
  • A sponge can soak up the liquid
  • A coral can live

  Parameters:

  getter - the getter which can get the fluid

  pos - the position of the fluid

  source - the state of the block being hydrated

  sourcePos - the position of the block being hydrated

  Returns:

  true if the block can be hydrated, false otherwise

• canExtinguish

  default boolean canExtinguish(BlockGetter getter, BlockPos pos)

  Returns whether the block can be extinguished by this fluid.

  Parameters:

  getter - the getter which can get the fluid

  pos - the position of the fluid

  Returns:

  true if the block can be extinguished, false otherwise