-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
1,235 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 142 additions & 0 deletions
142
api/src/main/java/org/allaymc/api/block/component/BlockLiquidBaseComponent.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| * <p> | ||
| * 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. | ||
| * <p> | ||
| * 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. | ||
| * <p> | ||
| * 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); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
api/src/main/java/org/allaymc/api/block/component/data/LiquidReactionOnTouch.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package org.allaymc.api.block.component.data; | ||
|
|
||
| /** | ||
| * @author daoge_cmd | ||
| */ | ||
| public enum LiquidReactionOnTouch { | ||
| /** | ||
| * The block will be broken without dropping anything. | ||
| */ | ||
| BROKEN, | ||
| /** | ||
| * The block will drop itself. | ||
| */ | ||
| POPPED, | ||
| /** | ||
| * The block will prevent the liquid from flowing into. | ||
| * Compared to {@link BlockStateData#canContainLiquidSource}, this only | ||
| * affects flowing liquid, not source liquid. That's mean the block | ||
| * may still can contain source liquid block. | ||
| */ | ||
| BLOCKING, | ||
| /** | ||
| * The block won't have any reaction, also won't have any impact on the liquid just like air. | ||
| */ | ||
| NOREACTION; | ||
|
|
||
| /** | ||
| * Check if the block should be removed when touched by liquid. | ||
| * | ||
| * @return {@code true} if the block should be removed when touched by liquid. | ||
| */ | ||
| public boolean removedOnTouch() { | ||
| return this == BROKEN || this == POPPED; | ||
| } | ||
|
|
||
| /** | ||
| * Check if liquid can flow into this block. | ||
| * <p> | ||
| * Please note that this method only checks if the liquid can flow into this block, | ||
| * it doesn't mean the block can contain the liquid source block. | ||
| * | ||
| * @return {@code true} if liquid can flow into this block. | ||
| */ | ||
| public boolean canLiquidFlowInto() { | ||
| return this == NOREACTION; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 2 additions & 1 deletion
3
api/src/main/java/org/allaymc/api/block/interfaces/BlockLiquidBehavior.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| package org.allaymc.api.block.interfaces; | ||
|
|
||
| import org.allaymc.api.block.BlockBehavior; | ||
| import org.allaymc.api.block.component.BlockLiquidBaseComponent; | ||
|
|
||
| public interface BlockLiquidBehavior extends BlockBehavior { | ||
| public interface BlockLiquidBehavior extends BlockBehavior, BlockLiquidBaseComponent { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.