Class BlockFluidContainerComponentBeta

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

Hierarchy

Constructors

constructor

Properties

block fillLevel fluidColor typeId componentId

Methods

addDye getFluidType isValid setFluidType setPotion

Constructors

Private constructor

Properties

Readonly block

block: Block

Remarks

Block instance that this component pertains to.

fillLevel

fillLevel: number

Remarks

Relative fill level of the fluid container.

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

fluidColor

fluidColor: RGBA

Remarks

Custom color of the fluid in the container.

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

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

componentId: "minecraft:fluidContainer" = 'minecraft:fluidContainer'

Methods

addDye

  • Parameters

    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 read-only mode.

    Throws

    This function can throw errors.

    Error

getFluidType

  • Returns FluidType

    Remarks

    Gets the current fluid type in the container.

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

    Throws

    This function can throw errors.

    Error

isValid

  • Returns boolean

    Whether the component is valid.

    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.

setFluidType

  • Parameters

    Returns void

    Remarks

    Sets the current fluid type in the container.

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

    Throws

    This function can throw errors.

    Error

setPotion

  • Parameters

    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 read-only mode.

    Throws

    This function can throw errors.

    Error

Settings

Member Visibility

Theme

On This Page