Skip to content

Fix detection rule properties #970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
legopitstop wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix detection rule properties #970

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions ...tent/BlockReference/Examples/BlockComponents/minecraftBlock_liquid_detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,21 @@ Experimental toggles required: Upcoming Creator Features (in format versions bef

## Liquid Detection Properties

|Name |Default Value |Type |Description |Example Values |
|:----------|:-------------|:----|:-----------|:------------- |
| can_contain_liquid | false | Boolean true/false | Whether this block can contain the liquid. For example, if the liquid type is `water`, this means the block can be waterlogged. | |
| detection_rules | *not set* | Array of [Detection Rules](#detection-rules) items | | Block Fabricator: `[{"liquid_type":"water","on_liquid_touches":"broken"}]` |
| liquid_type | water | String | The type of liquid this detection rule is for. Currently, `water` is the only supported liquid type. If this field is omitted, `water` will be the liquid type by default. | |
| on_liquid_touches | blocking | [Minecraft Event Trigger](../Definitions/NestedTables/triggers.md) | How the block reacts to flowing water. Must be one of the following options:<br>"blocking" - The default value for this field. The block stops the liquid from flowing.<br>"broken" - The block is destroyed completely.<br>"popped" - The block is destroyed and its item is spawned.<br>"no_reaction" - The block is unaffected; visually, the liquid will flow through the block. | |
| stops_liquid_flowing_from_direction | *not set* | Array of strings | When a block contains a liquid, controls the directions in which the liquid can't flow out from the block. Also controls the directions in which a block can stop liquid flowing into it if `no_reaction` is set for the `on_liquid_touches` field. Can be a list of the following directions: "up", "down", "north", "south", "east", "west". The default is an empty list; this means that liquid can flow out of all directions by default. | |
| use_liquid_clipping | false | Boolean true/false | Whether this block uses the encompassing collider to visually clip the liquid. The encompassing collider is the smallest single AABB that contains all of the block's colliders. | |
|Name |Default Value |Type |Example Values |
|:----------|:-------------|:----|:------------- |
| detection_rules | *not set* | Array of [Detection Rules](#detection-rules) items | Block Fabricator: `[{"liquid_type":"water","on_liquid_touches":"broken"}]` |

## Detection Rules

#### Detection rules Properties

|Name |Default Value |Type |Description |Example Values |
|:----------|:-------------|:----|:-----------|:------------- |
| liquid_type | *not set* | String | | Block Fabricator: `"water"` |
| on_liquid_touches | *not set* | String | | Block Fabricator: `"broken"` |
| can_contain_liquid | false | Boolean true/false | Whether this block can contain the liquid. For example, if the liquid type is `water`, this means the block can be waterlogged. | |
| liquid_type | *not set* | String | The type of liquid this detection rule is for. Currently, `water` is the only supported liquid type. If this field is omitted, `water` will be the liquid type by default. | Block Fabricator: `"water"` |
| on_liquid_touches | *not set* | String | How the block reacts to flowing water. Must be one of the following options:<br>"blocking" - The default value for this field. The block stops the liquid from flowing.<br>"broken" - The block is destroyed completely.<br>"popped" - The block is destroyed and its item is spawned.<br>"no_reaction" - The block is unaffected; visually, the liquid will flow through the block. | Block Fabricator: `"broken"` |
| stops_liquid_flowing_from_direction | *not set* | Array of strings | When a block contains a liquid, controls the directions in which the liquid can't flow out from the block. Also controls the directions in which a block can stop liquid flowing into it if `no_reaction` is set for the `on_liquid_touches` field. Can be a list of the following directions: "up", "down", "north", "south", "east", "west". The default is an empty list; this means that liquid can flow out of all directions by default. | |
| use_liquid_clipping | false | Boolean true/false | Whether this block uses the encompassing collider to visually clip the liquid. The encompassing collider is the smallest single AABB that contains all of the block's colliders. | |

## Samples

Expand Down