Skip to main content

Class: BlockLiquidContainerComponent

For blocks that can contain a liquid (e.g., a cauldron), this is a base component for liquid containers.

Extends​

Extended by​

Constructors​

new BlockLiquidContainerComponent()​

private new BlockLiquidContainerComponent(): BlockLiquidContainerComponent

Returns​

BlockLiquidContainerComponent

Overrides​

BlockComponent . constructor

Properties​

block​

readonly block: Block

Remarks​

Block instance that this component pertains to.

Inherited from​

BlockComponent . block

fillLevel​

fillLevel: number

Remarks​

Relative fill level of the liquid container.

This property can't be edited in read-only mode.

typeId​

readonly typeId: string

Remarks​

Identifier of the component.

Inherited from​

BlockComponent . typeId

Methods​

isValid()​

isValid(): boolean

Returns​

boolean

Whether the component is valid.

Inherited from​

BlockComponent . isValid

Remarks​

Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

isValidLiquid()​

isValidLiquid(): boolean

Returns​

boolean

True if this liquid container still exists, is valid and contains the expected liquid type.

Remarks​

Returns true if this reference to a liquid container is still valid and contains the liquid of the type you have a reference for (for example, if the block is unloaded, no longer a liquid container or contains lava when you have a potion container component, isValidLiquid will not be true.)