diff --git a/CHANGELOG.md b/CHANGELOG.md
index 04e9a2871..51095929c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,7 +19,13 @@ Unless otherwise specified, any version comparison below is the comparison of se
- (API) Added `TextFormat#MATERIAL_RESIN`.
- (API) Entity#teleport method now accepts an extra `Reason` argument.
- (API) Added structure API by @harry-xi.
+- (API) Added a number of new methods to `BlockLiquidBaseComponent`.
+- (API) Added `LiquidFlowEvent`, `LiquidDecayEvent` and `LiquidHardenEvent`.
+- (API) Added `BlockBehavior#afterPlaced` and `BlockBehavior#afterReplaced` that are correspond to
+ `BlockBehavior#onPlace` and `BlockBehavior#onReplace`.
+- (API) Added `BlockStateData#liquidReactionOnTouch`, there are also a number of new methods in `BlockStateData`.
- Added `/structure` command to manage structures.
+- Implemented liquid features including water, lava and related features.
### Changed
@@ -28,10 +34,13 @@ Unless otherwise specified, any version comparison below is the comparison of se
- Improved code readability for I18n module.
- NBT library is now updated to 3.0.10.
- `/gametest` command is now only available in dev build.
+- Removed the `dimension` field in `BlockBreakEvent`, which is duplicated with `blockStateWithPos#dimension`.
### Fixed
- (API) Fixed exception when setting item count or meta to zero.
+- (API) `VoxelShapes#buildLiquidShape` now works correctly.
+- (API) Correct `BlockStateData#canContainLiquid` to `BlockStateData#canContainLiquidSource`.
- Passing non-positive amount or negative meta arguments to `/give` command now will result in a syntax error.
- Entity#teleport method now will reset fall distance correctly.
- Fixed visual flashes when eating chorus fruits.
diff --git a/api/src/main/java/org/allaymc/api/block/component/BlockBaseComponent.java b/api/src/main/java/org/allaymc/api/block/component/BlockBaseComponent.java
index 122783f3e..a5c4a674c 100644
--- a/api/src/main/java/org/allaymc/api/block/component/BlockBaseComponent.java
+++ b/api/src/main/java/org/allaymc/api/block/component/BlockBaseComponent.java
@@ -81,7 +81,14 @@ default boolean canRandomUpdate() {
boolean place(Dimension dimension, BlockState blockState, Vector3ic placeBlockPos, PlayerInteractInfo placementInfo);
/**
- * Called when a block is placed.
+ * Called when place a block.
+ *
+ * Please note that at this moment the block has not been placed yet, so
+ * you can't set a new block state using {@link Dimension#setBlockState}
+ * at this time, as the block state will be placed later and will override
+ * the block state you set here.
+ *
+ * If you want to do the thing said above, consider using {@link BlockBehavior#afterPlaced}.
*
* @param currentBlockState The block that is being replaced.
* @param newBlockState The block that is replacing the current block.
@@ -89,6 +96,15 @@ default boolean canRandomUpdate() {
*/
void onPlace(BlockStateWithPos currentBlockState, BlockState newBlockState, PlayerInteractInfo placementInfo);
+ /**
+ * Called after a block is placed.
+ *
+ * @param oldBlockState The block that is being replaced.
+ * @param newBlockState The block that is replacing the current block.
+ * @param placementInfo The player placement info, can be {@code null}.
+ */
+ void afterPlaced(BlockStateWithPos oldBlockState, BlockState newBlockState, PlayerInteractInfo placementInfo);
+
/**
* Check if the block will drop as item when it is broke by the specified entity using the specified item.
*
@@ -119,6 +135,15 @@ default boolean canRandomUpdate() {
*/
void onReplace(BlockStateWithPos currentBlockState, BlockState newBlockState, PlayerInteractInfo placementInfo);
+ /**
+ * Called after a block is replaced.
+ *
+ * @param oldBlockState the block that is being replaced.
+ * @param newBlockState the block that is replacing the current block.
+ * @param placementInfo the player placement info, can be null.
+ */
+ void afterReplaced(BlockStateWithPos oldBlockState, BlockState newBlockState, PlayerInteractInfo placementInfo);
+
/**
* Called when a neighbor layer block is replaced.
*
@@ -311,6 +336,20 @@ default double calculateBreakTime(BlockState blockState, ItemStack usedItem, Ent
return 1d / speed;
}
+ /**
+ * Check if a position on the side of the block placed in the world at a specific position is
+ * closed. When this returns true (for example, when the side is below the position and the block is a
+ * slab), liquid inside the block won't flow from pos into side.
+ *
+ * @param blockState the block to check.
+ * @param blockFace the side of the block to check.
+ *
+ * @return {@code true} if the side is closed, {@code false} otherwise.
+ */
+ default boolean canLiquidFlowIntoSide(BlockState blockState, BlockFace blockFace) {
+ return true;
+ }
+
private double speedBonusByEfficiency(int efficiencyLevel) {
if (efficiencyLevel == 0) return 0;
return efficiencyLevel * efficiencyLevel + 1;
diff --git a/api/src/main/java/org/allaymc/api/block/component/BlockLiquidBaseComponent.java b/api/src/main/java/org/allaymc/api/block/component/BlockLiquidBaseComponent.java
new file mode 100644
index 000000000..e9079e4a2
--- /dev/null
+++ b/api/src/main/java/org/allaymc/api/block/component/BlockLiquidBaseComponent.java
@@ -0,0 +1,142 @@
+package org.allaymc.api.block.component;
+
+import org.allaymc.api.block.dto.BlockStateWithPos;
+import org.allaymc.api.block.property.type.BlockPropertyTypes;
+import org.allaymc.api.block.type.BlockState;
+import org.allaymc.api.block.type.BlockType;
+import org.allaymc.api.world.DimensionInfo;
+
+/**
+ * BlockLiquidBaseComponent is the base component for liquid blocks.
+ *
+ * @author daoge_cmd
+ */
+public interface BlockLiquidBaseComponent extends BlockBaseComponent {
+ /**
+ * Check if the liquid is falling.
+ *
+ * @param blockState the block state to check.
+ *
+ * @return {@code true} if the liquid is flowing down, {@code false} otherwise.
+ */
+ static boolean isFalling(BlockState blockState) {
+ // The first bit of the liquid depth property is set to 1 if the liquid is falling
+ return (blockState.getPropertyValue(BlockPropertyTypes.LIQUID_DEPTH) & 0b1000) == 0b1000;
+ }
+
+ /**
+ * Get the liquid depth of the block.
+ *
+ * Falling blocks and source blocks have a liquid depth of 8.
+ * Other blocks have a liquid depth between 1 and 7.
+ *
+ * @param blockState the block state to get the liquid depth from.
+ *
+ * @return the liquid depth of the block.
+ */
+ static int getDepth(BlockState blockState) {
+ if (isFalling(blockState) || isSource(blockState)) {
+ return 8;
+ }
+ return 8 - blockState.getPropertyValue(BlockPropertyTypes.LIQUID_DEPTH) & 0b0111;
+ }
+
+ /**
+ * Check if the block state represents a liquid source.
+ *
+ * @param blockState the block state to check.
+ *
+ * @return {@code true} if the block state represents a liquid source, {@code false} otherwise.
+ */
+ static boolean isSource(BlockState blockState) {
+ return blockState.getPropertyValue(BlockPropertyTypes.LIQUID_DEPTH) == 0;
+ }
+
+ /**
+ * Get the block state of the liquid block with given depth and falling state.
+ *
+ * @param depth the depth of the liquid.
+ * @param falling {@code true} if the liquid is falling, {@code false} otherwise.
+ *
+ * @return the block state of the liquid block with given depth and falling state.
+ */
+ default BlockState getLiquidBlockState(int depth, boolean falling) {
+ return getBlockType().ofState(BlockPropertyTypes.LIQUID_DEPTH.createValue(falling ? 0b1000 | 8 - depth : 8 - depth));
+ }
+
+ /**
+ * Get the block state of the falling block.
+ *
+ * @return the block state of the falling block.
+ */
+ default BlockState getFallingBlockState() {
+ return getBlockType().ofState(BlockPropertyTypes.LIQUID_DEPTH.createValue(0b1000));
+ }
+
+ /**
+ * Get the block state of the source block.
+ *
+ * @return the block state of the source block.
+ */
+ default BlockState getSourceBlockState() {
+ return getBlockType().ofState(BlockPropertyTypes.LIQUID_DEPTH.createValue(0));
+ }
+
+ /**
+ * Check if the liquid can be contained in a block.
+ *
+ * @return {@code true} if the liquid can be contained in a block, {@code false} otherwise.
+ */
+ default boolean canBeContained() {
+ return true;
+ }
+
+ /**
+ * Check if the block should harden when looking at the surrounding blocks and sets the position
+ * to the hardened block when adequate. If the block was hardened, the method returns true.
+ *
+ * @param current the current block.
+ * @param flownIntoBy the block flown into by, can be {@code null}.
+ *
+ * @return {@code true} if the block was hardened, {@code false} otherwise.
+ */
+ default boolean tryHarden(BlockStateWithPos current, BlockStateWithPos flownIntoBy) {
+ return false;
+ }
+
+ /**
+ * Get the flow decay of the liquid.
+ *
+ * Flow decay represents how many liquid levels are lost per block flowed horizontally.
+ * Affects how far the liquid can flow.
+ *
+ * @return the flow decay of the liquid.
+ */
+ int getFlowDecay(DimensionInfo dimensionInfo);
+
+ /**
+ * Get the flow speed of the liquid in ticks.
+ *
+ * Flow speed represents how fast the liquid spreads.
+ *
+ * @return the flow speed of the liquid in ticks.
+ */
+ int getFlowSpeed(DimensionInfo dimensionInfo);
+
+ /**
+ * Check whether the block can become a source block if there are more than
+ * two source block nearby horizontally.
+ *
+ * @return {@code true} if the block can become a source block, {@code false} otherwise.
+ */
+ boolean canFormSource();
+
+ /**
+ * Check if the given block type is the same liquid type as this block type.
+ *
+ * @param blockType the block type to check.
+ *
+ * @return {@code true} if the given block type is the same liquid type as this block type, {@code false} otherwise.
+ */
+ boolean isSameLiquidType(BlockType blockType);
+}
diff --git a/api/src/main/java/org/allaymc/api/block/component/data/BlockStateData.java b/api/src/main/java/org/allaymc/api/block/component/data/BlockStateData.java
index f221fc877..160f237e5 100644
--- a/api/src/main/java/org/allaymc/api/block/component/data/BlockStateData.java
+++ b/api/src/main/java/org/allaymc/api/block/component/data/BlockStateData.java
@@ -58,7 +58,9 @@ public class BlockStateData {
color.getGreen(),
color.getBlue(),
Integer.parseInt(str.substring(7), 16));
- }).create();
+ })
+ .registerTypeAdapter(LiquidReactionOnTouch.class, (JsonDeserializer