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

    Class BlockWaterContainerComponentBeta

    Represents a fluid container block that currently contains water.

    Hierarchy (View Summary)

    Index

    Properties

    block fillLevel typeId componentId

    Methods

    addDye getCustomColor isValid isValidLiquid setCustomColor

    Properties

    block: Block

    Block instance that this component pertains to.

    fillLevel: number

    Relative fill level of the liquid container.

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

    typeId: string

    Identifier of the component.

    componentId: "minecraft:waterContainer" = 'minecraft:waterContainer'

    Methods

    • Beta

      Parameters

      Returns void

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

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

      This function can throw errors.

    • Beta

      Returns RGBA

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

      Retrieves a custom base color used for the sign text.

      This function can throw errors.

    • Beta

      Returns boolean

      Whether the component is valid.

      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.

    • Beta

      Returns boolean

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

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

    • Beta

      Parameters

      Returns void

      Sets a custom base color used for the sign text.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods