Script API - v1.21.80
    Preparing search index...

    Class BlockFluidContainerComponent

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    block fillLevel fluidColor typeId componentId

    Methods

    addDye getFluidType isValid setFluidType setPotion

    Constructors

    Properties

    block: Block

    Block instance that this component pertains to.

    fillLevel: number

    Relative fill level of the fluid container.

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

    fluidColor: RGBA

    Custom color of the fluid in the container.

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

    typeId: string

    Identifier of the component.

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

    Methods

    • Parameters

      Returns void

      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.

      This function can throw errors.

    • Returns FluidType

      Gets the current fluid type in the container.

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

      This function can throw errors.

    • Returns boolean

      Whether the component is valid.

      This function is deprecated and will be removed in 2.0.0.

      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.

    • Parameters

      Returns void

      Sets the current fluid type in the container.

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

      This function can throw errors.

    • Parameters

      Returns void

      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.

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods