Class: BlockWaterContainerComponent

Represents a fluid container block that currently contains water.

Extends

• BlockLiquidContainerComponent

Constructors

new BlockWaterContainerComponent()

private new BlockWaterContainerComponent(): BlockWaterContainerComponent

Returns

BlockWaterContainerComponent

Overrides

BlockLiquidContainerComponent . constructor

Properties

block

readonly block: Block

Remarks

Block instance that this component pertains to.

Inherited from

BlockLiquidContainerComponent . block

---

fillLevel

fillLevel: number

Remarks

Relative fill level of the liquid container.

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

Inherited from

BlockLiquidContainerComponent . fillLevel

---

typeId

readonly typeId: string

Remarks

Identifier of the component.

Inherited from

BlockLiquidContainerComponent . typeId

---

componentId

static readonly componentId: "minecraft:waterContainer" = 'minecraft:waterContainer'

Methods

addDye()

addDye(itemType): void

Parameters

Parameter	Type
itemType	ItemType

Returns

void

Remarks

Adds an item and colors the water based on a dye item type.

This function can't be called in read-only mode.

Throws

This function can throw errors.

---

getCustomColor()

getCustomColor(): RGBA

Returns

RGBA

Color that is used as the base color for sign text.

Remarks

Retrieves a custom base color used for the sign text.

Throws

This function can throw errors.

---

isValid()

isValid(): boolean

Returns

boolean

Whether the component is valid.

Inherited from

BlockLiquidContainerComponent . 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.

Inherited from

BlockLiquidContainerComponent . isValidLiquid

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.)

---

setCustomColor()

setCustomColor(color): void

Parameters

Parameter	Type
color	RGBA

Returns

void

Remarks

Sets a custom base color used for the sign text.

This function can't be called in read-only mode.

Throws

This function can throw errors.