@minecraft/server

---

@minecraft/server / BlockFluidContainerComponent

Class: BlockFluidContainerComponent

Defined in: @minecraft/server/index.d.ts:4856

Represents the fluid container of a block in the world. Used with blocks like cauldrons.

Extends

• BlockComponent

Properties

block

readonly block: Block

Defined in: @minecraft/server/index.d.ts:4377

Remarks

Block instance that this component pertains to.

Inherited from

BlockComponent.block

---

fillLevel

fillLevel: number

Defined in: @minecraft/server/index.d.ts:4865

Remarks

Relative fill level of the fluid container.

This property can't be edited in restricted-execution mode.

---

fluidColor

fluidColor: RGBA

Defined in: @minecraft/server/index.d.ts:4873

Remarks

Custom color of the fluid in the container.

This property can't be edited in restricted-execution mode.

---

isValid

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

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.

Inherited from

BlockComponent.isValid

---

typeId

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks

Identifier of the component.

Inherited from

BlockComponent.typeId

---

componentId

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

Defined in: @minecraft/server/index.d.ts:4874

Methods

addDye()

addDye(dye): void

Defined in: @minecraft/server/index.d.ts:4884

Parameters

dye

ItemType

Returns

void

Remarks

Adds a dye to the fluid. The dye color is combined with any existing custom color.

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.

---

getFluidType()

getFluidType(): FluidType

Defined in: @minecraft/server/index.d.ts:4893

Returns

FluidType

Remarks

Gets the current fluid type in the container.

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.

---

setFluidType()

setFluidType(fluidType): void

Defined in: @minecraft/server/index.d.ts:4902

Parameters

fluidType

FluidType

Returns

void

Remarks

Sets the current fluid type in the container.

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.

---

setPotion()

setPotion(itemStack): void

Defined in: @minecraft/server/index.d.ts:4912

Parameters

itemStack

ItemStack

Returns

void

Remarks

Sets a potion item in the container. Changes the container's fluid type to potion.

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.